io.milton.ent.config

Class HttpManagerBuilderEnt

java.lang.Object

io.milton.config.HttpManagerBuilder

io.milton.ent.config.HttpManagerBuilderEnt

public class HttpManagerBuilderEnt
extends HttpManagerBuilder

Manages the options for configuring a HttpManager. To use it just set properties on this class, then call init, then call buildHttpManager to get a reference to the HttpManager.

Note that this uses a two-step construction process: init() buildHttpManager()

The first step creates instances of any objects which have not been set and the second binds them onto the HttpManager. You might want to modify the objects created in the first step, eg setting properties on default implementations. Note that you should not modify the structure of the resultant object graph, because you could then end up with an inconsistent configuration

Where possible, default implementations are created when this class is constructed allowing them to be overwritten where needed. However this is only done for objects and values which are "leaf" nodes in the config object graph. This is to avoid inconsistent configuration where different parts of milton end up with different implementations of the same concern. For example, PropFind and PropPatch could end up using different property sources

Author:

brad

Nested Class Summary

Nested classes/interfaces inherited from class io.milton.config.HttpManagerBuilder

HttpManagerBuilder.CreationException

Field Summary

Fields inherited from class io.milton.config.HttpManagerBuilder

authenticationHandlers, authenticationService, authorisationListener, basicHandler, beanPropertySource, buffering, cacheControlHelper, contentGenerator, contextPath, controllerClassNames, controllerPackagesToScan, controllers, cookieAuthenticationHandler, cookieDelegateHandlers, defaultPassword, defaultStandardFilter, defaultUser, digestHandler, displayNameFormatter, enableBasicAuth, enableCompression, enableCookieAuth, enabledCkBrowser, enableDigestAuth, enabledJson, enableEarlyAuth, enableExpectContinue, enableFormAuth, enableOptionsAuth, enableTextContentProperty, entityTransport, eTagGenerator, eventManager, expiredNonceRemover, extraAuthenticationHandlers, extraPropertySources, fileContentService, filters, formAuthenticationHandler, fsRealm, handlerHelper, http11ResponseHandler, initDone, listeners, loginPage, loginPageExcludePaths, loginPageTypeHandler, loginResponseHandler, mainResourceFactory, mapOfNameAndPasswords, matchHelper, multiNamespaceCustomPropertySource, multiNamespaceCustomPropertySourceEnabled, nonceProvider, nonces, nonceValiditySeconds, outerResourceFactory, outerWebdavResponseHandler, partialGetHelper, propertyAuthoriser, propertySources, propFindXmlGenerator, propPatchSetter, protocolHandlers, protocols, quotaDataAccessor, resourceHandlerHelper, resourceTypeHelper, rootDir, securityManager, shutdownHandlers, urlAdapter, userAgentHelper, valueWriters, webdavEnabled, webDavProtocol, webdavResponseHandler

Constructor Summary

Constructors

Constructor and Description
HttpManagerBuilderEnt()

Method Summary

Modifier and Type	Method and Description
protected void	afterInit()
protected void	buildOuterResourceFactory()
protected void	buildProtocolHandlers(WebDavResponseHandler webdavResponseHandler, ResourceTypeHelper resourceTypeHelper)
protected void	buildResourceTypeHelper()
ACLProtocol	getAclProtocol()
AnnotationsCalendarSearchService	getAnnotationsCalendarSearchService() By default this wraps the default calendarsearchservice, and is only used for resources which have appropriate annotations, otherwise processing falls through to the default
CalDavProtocol	getCalDavProtocol()
io.milton.http.caldav.CalendarSearchService	getCalendarSearchService() This is the instance that gets wired directly into the stack.
CardDavProtocol	getCardDavProtocol()
LockManager	getLockManager() Only required for AnnotationResourceFactory
io.milton.principal.PrincipalSearchService	getPrincipalSearchService() Search service used to satisfy principal property search reports.
WebDavLevel2Protocol	getWebDavLevel2Protocol()
List<WellKnownResourceFactory.WellKnownHandler>	getWellKnownHandlers()
boolean	isAclEnabled()
boolean	isCaldavEnabled()
boolean	isCarddavEnabled()
boolean	isEnableWellKnown()
boolean	isWebdavLevel2Enabled()
void	setAclEnabled(boolean aclEnabled)
void	setAclProtocol(ACLProtocol aclProtocol)
void	setAnnotationsCalendarSearchService(AnnotationsCalendarSearchService annotationsCalendarSearchService)
void	setCaldavEnabled(boolean caldavEnabled)
void	setCalDavProtocol(CalDavProtocol calDavProtocol)
void	setCalendarSearchService(io.milton.http.caldav.CalendarSearchService calendarSearchService)
void	setCarddavEnabled(boolean carddavEnabled)
void	setCardDavProtocol(CardDavProtocol cardDavProtocol)
void	setEnableWellKnown(boolean enableWellKnown)
void	setLockManager(LockManager lockManager)
void	setPrincipalSearchService(io.milton.principal.PrincipalSearchService principalSearchService)
void	setWebdavLevel2Enabled(boolean webdavLevel2Enabled)
void	setWebDavLevel2Protocol(WebDavLevel2Protocol webDavLevel2Protocol)
void	setWellKnownHandlers(List<WellKnownResourceFactory.WellKnownHandler> wellKnownHandlers)

Methods inherited from class io.milton.config.HttpManagerBuilder

buildHttpManager, buildJsonResourceFactory, buildPatchSetter, createDefaultHttp11ResponseHandler, getAuthenticationHandlers, getAuthenticationService, getAuthorisationListener, getBasicHandler, getBeanPropertySource, getBuffering, getCacheControlHelper, getCacheManager, getContentGenerator, getContextPath, getControllerClassNames, getControllerPackagesToScan, getControllers, getCookieAuthenticationHandler, getCookieDelegateHandlers, getCookieSigningKeys, getCookieSigningKeysFile, getDefaultPassword, getDefaultStandardFilter, getDefaultUser, getDependencies, getDigestHandler, getDisplayNameFormatter, getEntityTransport, geteTagGenerator, getEventManager, getExpiredNonceRemover, getExtraAuthenticationHandlers, getExtraPropertySources, getFileContentService, getFilters, getFormAuthenticationHandler, getFsContextPath, getFsHomeDir, getFsRealm, getHandlerHelper, getHttp11ResponseHandler, getListeners, getLoginPage, getLoginPageExcludePaths, getLoginPageTypeHandler, getLoginResponseHandler, getMainResourceFactory, getMapOfNameAndPasswords, getMatchHelper, getMaxAgeSeconds, getMultiNamespaceCustomPropertySource, getNonceProvider, getNonces, getNonceValiditySeconds, getoAuth2Handler, getOAuth2Handler, getOuterResourceFactory, getOuterWebdavResponseHandler, getPartialGetHelper, getPropertyAuthoriser, getPropertySources, getPropFindPropertyBuilder, getPropFindRequestFieldParser, getPropFindXmlGenerator, getPropPatchSetter, getProtocolHandlers, getProtocols, getQuotaDataAccessor, getResourceFactory, getResourceHandlerHelper, getResourceTypeHelper, getRootContext, getRootDir, getSecurityManager, getShutdownHandlers, getUrlAdapter, getUserAgentHelper, getValueWriters, getWebDavProtocol, getWebdavResponseHandler, init, initBeanPropertySource, initCookieSigningKeys, initDefaultPropertySources, initPropertyAuthoriser, initWebdavProtocol, isEnableBasicAuth, isEnableCompression, isEnableCookieAuth, isEnabledCkBrowser, isEnableDigestAuth, isEnabledJson, isEnableEarlyAuth, isEnableExpectContinue, isEnableFormAuth, isEnableOAuth2, isEnableOptionsAuth, isEnableQuota, isInitDone, isMultiNamespaceCustomPropertySourceEnabled, isUseLongLivedCookies, isWebdavEnabled, propFindPropertyBuilder, propFindRequestFieldParser, securityManager, setAuthenticationHandlers, setAuthenticationService, setAuthorisationListener, setBasicHandler, setBeanPropertySource, setBuffering, setCacheControlHelper, setCacheManager, setContentGenerator, setContextPath, setControllerClassNames, setControllerPackagesToScan, setControllers, setCookieAuthenticationHandler, setCookieDelegateHandlers, setCookieSigningKeys, setCookieSigningKeysFile, setDefaultPassword, setDefaultStandardFilter, setDefaultUser, setDependencies, setDigestHandler, setDisplayNameFormatter, setEnableBasicAuth, setEnableCompression, setEnableCookieAuth, setEnabledCkBrowser, setEnableDigestAuth, setEnabledJson, setEnableEarlyAuth, setEnableExpectContinue, setEnableFormAuth, setEnableOAuth2, setEnableOptionsAuth, setEnableQuota, setEntityTransport, seteTagGenerator, setEventManager, setExpiredNonceRemover, setExtraAuthenticationHandlers, setExtraPropertySources, setFileContentService, setFilters, setFormAuthenticationHandler, setFsContextPath, setFsHomeDir, setFsRealm, setHandlerHelper, setHttp11ResponseHandler, setInitDone, setListeners, setLoginPage, setLoginPageExcludePaths, setLoginPageTypeHandler, setLoginResponseHandler, setMainResourceFactory, setMapOfNameAndPasswords, setMatchHelper, setMaxAgeSeconds, setMultiNamespaceCustomPropertySource, setMultiNamespaceCustomPropertySourceEnabled, setNonceProvider, setNonces, setNonceValiditySeconds, setoAuth2Handler, setOAuth2Handler, setOuterResourceFactory, setOuterWebdavResponseHandler, setPartialGetHelper, setPropertyAuthoriser, setPropertySources, setPropFindPropertyBuilder, setPropFindRequestFieldParser, setPropFindXmlGenerator, setPropPatchSetter, setProtocolHandlers, setProtocols, setQuotaDataAccessor, setResourceFactory, setResourceHandlerHelper, setResourceTypeHelper, setRootDir, setSecurityManager, setShutdownHandlers, setUrlAdapter, setUseLongLivedCookies, setUserAgentHelper, setValueWriters, setWebdavEnabled, setWebDavProtocol, setWebdavResponseHandler, showLog, userAgentHelper

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

HttpManagerBuilderEnt

public HttpManagerBuilderEnt()

Method Detail

afterInit

protected void afterInit()

Overrides:

afterInit in class HttpManagerBuilder

buildOuterResourceFactory

protected void buildOuterResourceFactory()

Overrides:

buildOuterResourceFactory in class HttpManagerBuilder

buildResourceTypeHelper

protected void buildResourceTypeHelper()

Overrides:

buildResourceTypeHelper in class HttpManagerBuilder

buildProtocolHandlers

protected void buildProtocolHandlers(WebDavResponseHandler webdavResponseHandler,
                                     ResourceTypeHelper resourceTypeHelper)

Overrides:

buildProtocolHandlers in class HttpManagerBuilder

getWellKnownHandlers

public List<WellKnownResourceFactory.WellKnownHandler> getWellKnownHandlers()

setWellKnownHandlers

public void setWellKnownHandlers(List<WellKnownResourceFactory.WellKnownHandler> wellKnownHandlers)

isEnableWellKnown

public boolean isEnableWellKnown()

setEnableWellKnown

public void setEnableWellKnown(boolean enableWellKnown)

getCalDavProtocol

public CalDavProtocol getCalDavProtocol()

setCalDavProtocol

public void setCalDavProtocol(CalDavProtocol calDavProtocol)

getCardDavProtocol

public CardDavProtocol getCardDavProtocol()

setCardDavProtocol

public void setCardDavProtocol(CardDavProtocol cardDavProtocol)

getAclProtocol

public ACLProtocol getAclProtocol()

setAclProtocol

public void setAclProtocol(ACLProtocol aclProtocol)

isAclEnabled

public boolean isAclEnabled()

setAclEnabled

public void setAclEnabled(boolean aclEnabled)

isCaldavEnabled

public boolean isCaldavEnabled()

setCaldavEnabled

public void setCaldavEnabled(boolean caldavEnabled)

isCarddavEnabled

public boolean isCarddavEnabled()

setCarddavEnabled

public void setCarddavEnabled(boolean carddavEnabled)

getWebDavLevel2Protocol

public WebDavLevel2Protocol getWebDavLevel2Protocol()

setWebDavLevel2Protocol

public void setWebDavLevel2Protocol(WebDavLevel2Protocol webDavLevel2Protocol)

isWebdavLevel2Enabled

public boolean isWebdavLevel2Enabled()

setWebdavLevel2Enabled

public void setWebdavLevel2Enabled(boolean webdavLevel2Enabled)

getLockManager

public LockManager getLockManager()

Only required for AnnotationResourceFactory

Returns:

setLockManager

public void setLockManager(LockManager lockManager)

getAnnotationsCalendarSearchService

public AnnotationsCalendarSearchService getAnnotationsCalendarSearchService()

By default this wraps the default calendarsearchservice, and is only used for resources which have appropriate annotations, otherwise processing falls through to the default

Returns:

setAnnotationsCalendarSearchService

public void setAnnotationsCalendarSearchService(AnnotationsCalendarSearchService annotationsCalendarSearchService)

getCalendarSearchService

public io.milton.http.caldav.CalendarSearchService getCalendarSearchService()

This is the instance that gets wired directly into the stack. You can set this to prevent any default instances being created

Returns:

setCalendarSearchService

public void setCalendarSearchService(io.milton.http.caldav.CalendarSearchService calendarSearchService)

getPrincipalSearchService

public io.milton.principal.PrincipalSearchService getPrincipalSearchService()

Search service used to satisfy principal property search reports. You can set this to prevent the default search service from being created.

Returns:

Principal search service

setPrincipalSearchService

public void setPrincipalSearchService(io.milton.principal.PrincipalSearchService principalSearchService)