HttpManagerBuilder (milton-server-ce 3.0.0.215 API)

java.lang.Object
- io.milton.config.HttpManagerBuilder

```
public class HttpManagerBuilder
extends Object
```
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
Modifier and Type Class and Description

static class HttpManagerBuilder.CreationException

Nested Classes
Modifier and Type	Class and Description
`static class`	`HttpManagerBuilder.CreationException`

Field Summary

Fields
Modifier and Type	Field and Description
`protected List<AuthenticationHandler>`	`authenticationHandlers`
`protected AuthenticationService`	`authenticationService`
`protected AuthorisationListener`	`authorisationListener`
`protected BasicAuthHandler`	`basicHandler`
`protected BeanPropertySource`	`beanPropertySource`
`protected DefaultHttp11ResponseHandler.BUFFERING`	`buffering`
`protected CacheControlHelper`	`cacheControlHelper`
`protected ContentGenerator`	`contentGenerator`
`protected String`	`contextPath`
`protected String`	`controllerClassNames`
`protected String`	`controllerPackagesToScan`
`protected List`	`controllers`
`protected CookieAuthenticationHandler`	`cookieAuthenticationHandler`
`protected List<AuthenticationHandler>`	`cookieDelegateHandlers`
`protected String`	`defaultPassword`
`protected Filter`	`defaultStandardFilter`
`protected String`	`defaultUser`
`protected DigestAuthenticationHandler`	`digestHandler`
`protected DisplayNameFormatter`	`displayNameFormatter`
`protected boolean`	`enableBasicAuth`
`protected boolean`	`enableCompression`
`protected boolean`	`enableCookieAuth`
`protected boolean`	`enabledCkBrowser`
`protected boolean`	`enableDigestAuth`
`protected boolean`	`enabledJson`
`protected boolean`	`enableEarlyAuth`
`protected boolean`	`enableExpectContinue`
`protected boolean`	`enableFormAuth`
`protected boolean`	`enableOptionsAuth`
`protected boolean`	`enableTextContentProperty`
`protected EntityTransport`	`entityTransport`
`protected ETagGenerator`	`eTagGenerator`
`protected EventManager`	`eventManager`
`protected ExpiredNonceRemover`	`expiredNonceRemover`
`protected List<AuthenticationHandler>`	`extraAuthenticationHandlers`
`protected List<PropertySource>`	`extraPropertySources`
`protected FileContentService`	`fileContentService`
`protected List<Filter>`	`filters`
`protected FormAuthenticationHandler`	`formAuthenticationHandler`
`protected String`	`fsRealm`
`protected HandlerHelper`	`handlerHelper`
`protected Http11ResponseHandler`	`http11ResponseHandler`
`protected boolean`	`initDone`
`protected List<InitListener>`	`listeners`
`protected String`	`loginPage`
`protected List<String>`	`loginPageExcludePaths`
`protected LoginResponseHandler.LoginPageTypeHandler`	`loginPageTypeHandler`
`protected LoginResponseHandler`	`loginResponseHandler`
`protected ResourceFactory`	`mainResourceFactory`
`protected Map<String,String>`	`mapOfNameAndPasswords`
`protected MatchHelper`	`matchHelper`
`protected MultiNamespaceCustomPropertySource`	`multiNamespaceCustomPropertySource`
`protected boolean`	`multiNamespaceCustomPropertySourceEnabled`
`protected NonceProvider`	`nonceProvider`
`protected Map<UUID,Nonce>`	`nonces`
`protected int`	`nonceValiditySeconds`
`protected ResourceFactory`	`outerResourceFactory`
`protected WebDavResponseHandler`	`outerWebdavResponseHandler`
`protected PartialGetHelper`	`partialGetHelper`
`protected PropertyAuthoriser`	`propertyAuthoriser`
`protected List<PropertySource>`	`propertySources`
`protected PropFindXmlGenerator`	`propFindXmlGenerator`
`protected PropPatchSetter`	`propPatchSetter`
`protected ProtocolHandlers`	`protocolHandlers`
`protected ArrayList<HttpExtension>`	`protocols`
`protected QuotaDataAccessor`	`quotaDataAccessor`
`protected ResourceHandlerHelper`	`resourceHandlerHelper`
`protected ResourceTypeHelper`	`resourceTypeHelper`
`protected File`	`rootDir`
`protected SecurityManager`	`securityManager`
`protected List<Stoppable>`	`shutdownHandlers`
`protected UrlAdapter`	`urlAdapter`
`protected UserAgentHelper`	`userAgentHelper`
`protected ValueWriters`	`valueWriters`
`protected boolean`	`webdavEnabled`
`protected WebDavProtocol`	`webDavProtocol`
`protected WebDavResponseHandler`	`webdavResponseHandler`

Constructor Summary

Constructors
Constructor and Description

HttpManagerBuilder()

Constructors
Constructor and Description
`HttpManagerBuilder()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`afterInit()` Overridable method called after init but before build
`HttpManager`	`buildHttpManager()`
`protected JsonResourceFactory`	`buildJsonResourceFactory()`
`protected void`	`buildOuterResourceFactory()`
`protected PropPatchSetter`	`buildPatchSetter()`
`protected void`	`buildProtocolHandlers(WebDavResponseHandler webdavResponseHandler, ResourceTypeHelper resourceTypeHelper)`
`protected void`	`buildResourceTypeHelper()`
`protected DefaultHttp11ResponseHandler`	`createDefaultHttp11ResponseHandler(AuthenticationService authenticationService)`
`List<AuthenticationHandler>`	`getAuthenticationHandlers()`
`AuthenticationService`	`getAuthenticationService()`
`AuthorisationListener`	`getAuthorisationListener()`
`BasicAuthHandler`	`getBasicHandler()`
`BeanPropertySource`	`getBeanPropertySource()`
`DefaultHttp11ResponseHandler.BUFFERING`	`getBuffering()`
`CacheControlHelper`	`getCacheControlHelper()`
`CacheManager`	`getCacheManager()`
`ContentGenerator`	`getContentGenerator()`
`String`	`getContextPath()` Used to set context path on certain implementations of ResourceFactory Alias for fsContentPath
`String`	`getControllerClassNames()` As an alternative to package scanning via the controllerPackagesToScan property, set this property to a comma seperated list of class names.
`String`	`getControllerPackagesToScan()` If not null, is expected to be a comma seperated list of package names.
`List`	`getControllers()` Instead of setting controller packages to scan or controller class names, you can set a list of actual controller instances
`CookieAuthenticationHandler`	`getCookieAuthenticationHandler()`
`List<AuthenticationHandler>`	`getCookieDelegateHandlers()`
`List<String>`	`getCookieSigningKeys()` If set will be used as the list of keys to validate cookie signatures, and the last will be used to sign new cookies
`String`	`getCookieSigningKeysFile()` If present is assumed to be a text file containing lines, where each line is a cookie signing key.
`String`	`getDefaultPassword()`
`Filter`	`getDefaultStandardFilter()`
`String`	`getDefaultUser()`
`List`	`getDependencies()` Just a list of objects to be made available to auto-created objects via injection
`DigestAuthenticationHandler`	`getDigestHandler()`
`DisplayNameFormatter`	`getDisplayNameFormatter()`
`EntityTransport`	`getEntityTransport()`
`ETagGenerator`	`geteTagGenerator()`
`EventManager`	`getEventManager()`
`ExpiredNonceRemover`	`getExpiredNonceRemover()`
`List<AuthenticationHandler>`	`getExtraAuthenticationHandlers()` You can add some extra auth handlers here, which will be added to the default auth handler structure such as basic, digest and cookie.
`List<PropertySource>`	`getExtraPropertySources()`
`FileContentService`	`getFileContentService()`
`List<Filter>`	`getFilters()`
`FormAuthenticationHandler`	`getFormAuthenticationHandler()`
`String`	`getFsContextPath()` Passed to FilesystemResourceFactory when its created
`String`	`getFsHomeDir()` Set this if you're using the FileSystemResourceFactory and you want to explicitly set a home directory.
`String`	`getFsRealm()`
`HandlerHelper`	`getHandlerHelper()`
`Http11ResponseHandler`	`getHttp11ResponseHandler()`
`List<InitListener>`	`getListeners()`
`String`	`getLoginPage()`
`List<String>`	`getLoginPageExcludePaths()`
`LoginResponseHandler.LoginPageTypeHandler`	`getLoginPageTypeHandler()`
`LoginResponseHandler`	`getLoginResponseHandler()`
`ResourceFactory`	`getMainResourceFactory()` This is your own resource factory, which provides access to your data repository.
`Map<String,String>`	`getMapOfNameAndPasswords()`
`MatchHelper`	`getMatchHelper()`
`Long`	`getMaxAgeSeconds()` Default max-age to use for certain resource types which can use a default value
`MultiNamespaceCustomPropertySource`	`getMultiNamespaceCustomPropertySource()`
`NonceProvider`	`getNonceProvider()`
`Map<UUID,Nonce>`	`getNonces()` Map holding nonce values issued in Digest authentication challenges
`int`	`getNonceValiditySeconds()`
`OAuth2AuthenticationHandler`	`getoAuth2Handler()`
`OAuth2AuthenticationHandler`	`getOAuth2Handler()`
`ResourceFactory`	`getOuterResourceFactory()` Usually set by milton, this will enhance the main resource factory with additional resources, such as .well-known support
`WebDavResponseHandler`	`getOuterWebdavResponseHandler()`
`PartialGetHelper`	`getPartialGetHelper()`
`PropertyAuthoriser`	`getPropertyAuthoriser()`
`List<PropertySource>`	`getPropertySources()`
`PropFindPropertyBuilder`	`getPropFindPropertyBuilder()`
`PropFindRequestFieldParser`	`getPropFindRequestFieldParser()`
`PropFindXmlGenerator`	`getPropFindXmlGenerator()`
`PropPatchSetter`	`getPropPatchSetter()`
`ProtocolHandlers`	`getProtocolHandlers()`
`ArrayList<HttpExtension>`	`getProtocols()`
`QuotaDataAccessor`	`getQuotaDataAccessor()`
`ResourceFactory`	`getResourceFactory()`
`ResourceHandlerHelper`	`getResourceHandlerHelper()`
`ResourceTypeHelper`	`getResourceTypeHelper()`
`RootContext`	`getRootContext()`
`File`	`getRootDir()` used by FileSystemResourceFactory when its created as default resource factory
`SecurityManager`	`getSecurityManager()` Mainly used when creating filesystem resourcfe factory, but can also be used by other resoruce factories that want to delegate security management
`List<Stoppable>`	`getShutdownHandlers()`
`UrlAdapter`	`getUrlAdapter()`
`UserAgentHelper`	`getUserAgentHelper()`
`ValueWriters`	`getValueWriters()`
`WebDavProtocol`	`getWebDavProtocol()`
`WebDavResponseHandler`	`getWebdavResponseHandler()`
`void`	`init()` This method creates instances of required objects which have not been set on the builder.
`protected BeanPropertySource`	`initBeanPropertySource()`
`protected void`	`initCookieSigningKeys()`
`protected List<PropertySource>`	`initDefaultPropertySources(ResourceTypeHelper resourceTypeHelper)`
`protected PropertyAuthoriser`	`initPropertyAuthoriser()`
`protected void`	`initWebdavProtocol()`
`boolean`	`isEnableBasicAuth()`
`boolean`	`isEnableCompression()`
`boolean`	`isEnableCookieAuth()`
`boolean`	`isEnabledCkBrowser()` Whether to enable support for CK Editor server browser support.
`boolean`	`isEnableDigestAuth()`
`boolean`	`isEnabledJson()`
`boolean`	`isEnableEarlyAuth()`
`boolean`	`isEnableExpectContinue()` If true milton will response to Expect: Continue requests.
`boolean`	`isEnableFormAuth()`
`boolean`	`isEnableOAuth2()`
`boolean`	`isEnableOptionsAuth()` False by default, which means that OPTIONS requests will not trigger authentication.
`boolean`	`isEnableQuota()` If quota is enabled, then extension properties to report quota information are available.
`boolean`	`isInitDone()`
`boolean`	`isMultiNamespaceCustomPropertySourceEnabled()`
`boolean`	`isUseLongLivedCookies()` If true signed cookies for authentication will be long-lived, as defined in CookieAuthenticationHandler.SECONDS_PER_YEAR
`boolean`	`isWebdavEnabled()`
`protected PropFindPropertyBuilder`	`propFindPropertyBuilder()`
`protected PropFindRequestFieldParser`	`propFindRequestFieldParser()`
`protected SecurityManager`	`securityManager()`
`void`	`setAuthenticationHandlers(List<AuthenticationHandler> authenticationHandlers)`
`void`	`setAuthenticationService(AuthenticationService authenticationService)`
`void`	`setAuthorisationListener(AuthorisationListener authorisationListener)`
`void`	`setBasicHandler(BasicAuthHandler basicHandler)`
`void`	`setBeanPropertySource(BeanPropertySource beanPropertySource)`
`void`	`setBuffering(DefaultHttp11ResponseHandler.BUFFERING buffering)`
`void`	`setCacheControlHelper(CacheControlHelper cacheControlHelper)`
`void`	`setCacheManager(CacheManager cacheManager)`
`void`	`setContentGenerator(ContentGenerator contentGenerator)`
`void`	`setContextPath(String contextPath)`
`void`	`setControllerClassNames(String controlleClassNames)`
`void`	`setControllerPackagesToScan(String controllerPackagesToScan)`
`void`	`setControllers(List controllers)`
`void`	`setCookieAuthenticationHandler(CookieAuthenticationHandler cookieAuthenticationHandler)`
`void`	`setCookieDelegateHandlers(List<AuthenticationHandler> cookieDelegateHandlers)`
`void`	`setCookieSigningKeys(List<String> cookieSigningKeys)`
`void`	`setCookieSigningKeysFile(String cookieSigningKeysFile)`
`void`	`setDefaultPassword(String defaultPassword)`
`void`	`setDefaultStandardFilter(Filter defaultStandardFilter)`
`void`	`setDefaultUser(String defaultUser)`
`void`	`setDependencies(List dependencies)`
`void`	`setDigestHandler(DigestAuthenticationHandler digestHandler)`
`void`	`setDisplayNameFormatter(DisplayNameFormatter displayNameFormatter)`
`void`	`setEnableBasicAuth(boolean enableBasicAuth)`
`void`	`setEnableCompression(boolean enableCompression)`
`void`	`setEnableCookieAuth(boolean enableCookieAuth)`
`void`	`setEnabledCkBrowser(boolean enabledCkBrowser)`
`void`	`setEnableDigestAuth(boolean enableDigestAuth)`
`void`	`setEnabledJson(boolean enabledJson)`
`void`	`setEnableEarlyAuth(boolean enableEarlyAuth)`
`void`	`setEnableExpectContinue(boolean enableExpectContinue)`
`void`	`setEnableFormAuth(boolean enableFormAuth)`
`void`	`setEnableOAuth2(boolean enableOAuth2)`
`void`	`setEnableOptionsAuth(boolean enableOptionsAuth)`
`void`	`setEnableQuota(boolean enableQuota)`
`void`	`setEntityTransport(EntityTransport entityTransport)`
`void`	`seteTagGenerator(ETagGenerator eTagGenerator)`
`void`	`setEventManager(EventManager eventManager)`
`void`	`setExpiredNonceRemover(ExpiredNonceRemover expiredNonceRemover)`
`void`	`setExtraAuthenticationHandlers(List<AuthenticationHandler> extraAuthenticationHandlers)`
`void`	`setExtraPropertySources(List<PropertySource> extraPropertySources)`
`void`	`setFileContentService(FileContentService fileContentService)`
`void`	`setFilters(List<Filter> filters)`
`void`	`setFormAuthenticationHandler(FormAuthenticationHandler formAuthenticationHandler)`
`void`	`setFsContextPath(String fsContextPath)`
`void`	`setFsHomeDir(String fsHomeDir)`
`void`	`setFsRealm(String fsRealm)`
`void`	`setHandlerHelper(HandlerHelper handlerHelper)`
`void`	`setHttp11ResponseHandler(Http11ResponseHandler http11ResponseHandler)`
`void`	`setInitDone(boolean initDone)`
`void`	`setListeners(List<InitListener> listeners)`
`void`	`setLoginPage(String loginPage)`
`void`	`setLoginPageExcludePaths(List<String> loginPageExcludePaths)`
`void`	`setLoginPageTypeHandler(LoginResponseHandler.LoginPageTypeHandler loginPageTypeHandler)`
`void`	`setLoginResponseHandler(LoginResponseHandler loginResponseHandler)`
`void`	`setMainResourceFactory(ResourceFactory mainResourceFactory)`
`void`	`setMapOfNameAndPasswords(Map<String,String> mapOfNameAndPasswords)`
`void`	`setMatchHelper(MatchHelper matchHelper)`
`void`	`setMaxAgeSeconds(Long maxAgeSeconds)`
`void`	`setMultiNamespaceCustomPropertySource(MultiNamespaceCustomPropertySource multiNamespaceCustomPropertySource)`
`void`	`setMultiNamespaceCustomPropertySourceEnabled(boolean multiNamespaceCustomPropertySourceEnabled)`
`void`	`setNonceProvider(NonceProvider nonceProvider)`
`void`	`setNonces(Map<UUID,Nonce> nonces)`
`void`	`setNonceValiditySeconds(int nonceValiditySeconds)`
`void`	`setoAuth2Handler(OAuth2AuthenticationHandler oAuth2Handler)`
`void`	`setOAuth2Handler(OAuth2AuthenticationHandler oAuth2Handler)`
`void`	`setOuterResourceFactory(ResourceFactory outerResourceFactory)`
`void`	`setOuterWebdavResponseHandler(WebDavResponseHandler outerWebdavResponseHandler)`
`void`	`setPartialGetHelper(PartialGetHelper partialGetHelper)`
`void`	`setPropertyAuthoriser(PropertyAuthoriser propertyAuthoriser)`
`void`	`setPropertySources(List<PropertySource> propertySources)`
`void`	`setPropFindPropertyBuilder(PropFindPropertyBuilder propFindPropertyBuilder)`
`void`	`setPropFindRequestFieldParser(PropFindRequestFieldParser propFindRequestFieldParser)`
`void`	`setPropFindXmlGenerator(PropFindXmlGenerator propFindXmlGenerator)`
`void`	`setPropPatchSetter(PropPatchSetter propPatchSetter)`
`void`	`setProtocolHandlers(ProtocolHandlers protocolHandlers)`
`void`	`setProtocols(ArrayList<HttpExtension> protocols)`
`void`	`setQuotaDataAccessor(QuotaDataAccessor quotaDataAccessor)`
`void`	`setResourceFactory(ResourceFactory resourceFactory)`
`void`	`setResourceHandlerHelper(ResourceHandlerHelper resourceHandlerHelper)`
`void`	`setResourceTypeHelper(ResourceTypeHelper resourceTypeHelper)`
`void`	`setRootDir(File rootDir)`
`void`	`setSecurityManager(SecurityManager securityManager)`
`void`	`setShutdownHandlers(List<Stoppable> shutdownHandlers)`
`void`	`setUrlAdapter(UrlAdapter urlAdapter)`
`void`	`setUseLongLivedCookies(boolean useLongLivedCookies)`
`void`	`setUserAgentHelper(UserAgentHelper userAgentHelper)`
`void`	`setValueWriters(ValueWriters valueWriters)`
`void`	`setWebdavEnabled(boolean webdavEnabled)`
`void`	`setWebDavProtocol(WebDavProtocol webDavProtocol)`
`void`	`setWebdavResponseHandler(WebDavResponseHandler webdavResponseHandler)`
`protected void`	`showLog(String propertyName, Object defaultedTo)`
`protected UserAgentHelper`	`userAgentHelper()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

listeners
```
protected List<InitListener> listeners
```

mainResourceFactory

protected ResourceFactory mainResourceFactory

outerResourceFactory

protected ResourceFactory outerResourceFactory

fileContentService

protected FileContentService fileContentService

buffering

protected DefaultHttp11ResponseHandler.BUFFERING buffering

authenticationHandlers

protected List<AuthenticationHandler> authenticationHandlers

extraAuthenticationHandlers

protected List<AuthenticationHandler> extraAuthenticationHandlers

cookieDelegateHandlers

protected List<AuthenticationHandler> cookieDelegateHandlers

digestHandler

protected DigestAuthenticationHandler digestHandler

basicHandler

protected BasicAuthHandler basicHandler

cookieAuthenticationHandler

protected CookieAuthenticationHandler cookieAuthenticationHandler

formAuthenticationHandler

protected FormAuthenticationHandler formAuthenticationHandler

nonces
```
protected Map<UUID,Nonce> nonces
```

nonceValiditySeconds
```
protected int nonceValiditySeconds
```

nonceProvider
```
protected NonceProvider nonceProvider
```

authenticationService

protected AuthenticationService authenticationService

expiredNonceRemover

protected ExpiredNonceRemover expiredNonceRemover

shutdownHandlers

protected List<Stoppable> shutdownHandlers

resourceTypeHelper

protected ResourceTypeHelper resourceTypeHelper

webdavResponseHandler

protected WebDavResponseHandler webdavResponseHandler

outerWebdavResponseHandler

protected WebDavResponseHandler outerWebdavResponseHandler

contentGenerator

protected ContentGenerator contentGenerator

cacheControlHelper

protected CacheControlHelper cacheControlHelper

handlerHelper
```
protected HandlerHelper handlerHelper
```

authorisationListener

protected AuthorisationListener authorisationListener

protocols

protected ArrayList<HttpExtension> protocols

protocolHandlers

protected ProtocolHandlers protocolHandlers

entityTransport

protected EntityTransport entityTransport

eventManager
```
protected EventManager eventManager
```

propertyAuthoriser

protected PropertyAuthoriser propertyAuthoriser

propertySources

protected List<PropertySource> propertySources

extraPropertySources

protected List<PropertySource> extraPropertySources

eTagGenerator
```
protected ETagGenerator eTagGenerator
```

http11ResponseHandler

protected Http11ResponseHandler http11ResponseHandler

valueWriters
```
protected ValueWriters valueWriters
```

propFindXmlGenerator

protected PropFindXmlGenerator propFindXmlGenerator

filters
```
protected List<Filter> filters
```

defaultStandardFilter
```
protected Filter defaultStandardFilter
```

urlAdapter
```
protected UrlAdapter urlAdapter
```

quotaDataAccessor

protected QuotaDataAccessor quotaDataAccessor

propPatchSetter

protected PropPatchSetter propPatchSetter

enableOptionsAuth
```
protected boolean enableOptionsAuth
```

resourceHandlerHelper

protected ResourceHandlerHelper resourceHandlerHelper

initDone
```
protected boolean initDone
```

enableCompression
```
protected boolean enableCompression
```

enabledJson
```
protected boolean enabledJson
```

enableBasicAuth
```
protected boolean enableBasicAuth
```

enableDigestAuth
```
protected boolean enableDigestAuth
```

enableFormAuth
```
protected boolean enableFormAuth
```

enableCookieAuth
```
protected boolean enableCookieAuth
```

enabledCkBrowser
```
protected boolean enabledCkBrowser
```

enableEarlyAuth
```
protected boolean enableEarlyAuth
```

enableTextContentProperty
```
protected final boolean enableTextContentProperty
```
See Also:

Constant Field Values

loginPage
```
protected String loginPage
```

loginPageExcludePaths

protected List<String> loginPageExcludePaths

rootDir
```
protected File rootDir
```

securityManager

protected SecurityManager securityManager

contextPath
```
protected String contextPath
```

fsRealm
```
protected String fsRealm
```

mapOfNameAndPasswords

protected Map<String,String> mapOfNameAndPasswords

defaultUser
```
protected String defaultUser
```

defaultPassword
```
protected String defaultPassword
```

userAgentHelper

protected UserAgentHelper userAgentHelper

multiNamespaceCustomPropertySource

protected MultiNamespaceCustomPropertySource multiNamespaceCustomPropertySource

multiNamespaceCustomPropertySourceEnabled

protected boolean multiNamespaceCustomPropertySourceEnabled

beanPropertySource

protected BeanPropertySource beanPropertySource

webDavProtocol

protected WebDavProtocol webDavProtocol

displayNameFormatter

protected DisplayNameFormatter displayNameFormatter

webdavEnabled
```
protected boolean webdavEnabled
```

matchHelper
```
protected MatchHelper matchHelper
```

partialGetHelper

protected PartialGetHelper partialGetHelper

loginResponseHandler

protected LoginResponseHandler loginResponseHandler

loginPageTypeHandler

protected LoginResponseHandler.LoginPageTypeHandler loginPageTypeHandler

enableExpectContinue
```
protected boolean enableExpectContinue
```

controllerPackagesToScan

protected String controllerPackagesToScan

controllerClassNames
```
protected String controllerClassNames
```

controllers
```
protected List controllers
```

Constructor Detail
- HttpManagerBuilder
```
public HttpManagerBuilder()
```

Method Detail

securityManager

protected SecurityManager securityManager()

init
```
public final void init()
```
This method creates instances of required objects which have not been set on the builder. These are subsequently wired together immutably in HttpManager when buildHttpManager is called. You can call this before calling buildHttpManager if you would like to modify property values on the created objects before HttpManager is instantiated. Otherwise, you can call buildHttpManager directly and it will call init if it has not been called

initCookieSigningKeys

protected void initCookieSigningKeys()

buildHttpManager
```
public HttpManager buildHttpManager()
```

afterInit
```
protected void afterInit()
```
Overridable method called after init but before build

initPropertyAuthoriser

protected PropertyAuthoriser initPropertyAuthoriser()

initDefaultPropertySources

protected List<PropertySource> initDefaultPropertySources(ResourceTypeHelper resourceTypeHelper)

initBeanPropertySource

protected BeanPropertySource initBeanPropertySource()

createDefaultHttp11ResponseHandler

protected DefaultHttp11ResponseHandler createDefaultHttp11ResponseHandler(AuthenticationService authenticationService)

buildResourceTypeHelper

protected void buildResourceTypeHelper()

buildProtocolHandlers

protected void buildProtocolHandlers(WebDavResponseHandler webdavResponseHandler,
                                     ResourceTypeHelper resourceTypeHelper)

initWebdavProtocol
```
protected void initWebdavProtocol()
```

propFindRequestFieldParser

protected PropFindRequestFieldParser propFindRequestFieldParser()

buildOuterResourceFactory

protected void buildOuterResourceFactory()

buildJsonResourceFactory

protected JsonResourceFactory buildJsonResourceFactory()

buildPatchSetter

protected PropPatchSetter buildPatchSetter()

getBuffering

public DefaultHttp11ResponseHandler.BUFFERING getBuffering()

setBuffering

public void setBuffering(DefaultHttp11ResponseHandler.BUFFERING buffering)

getResourceFactory

public ResourceFactory getResourceFactory()

setResourceFactory

public void setResourceFactory(ResourceFactory resourceFactory)

getAuthenticationHandlers

public List<AuthenticationHandler> getAuthenticationHandlers()

setAuthenticationHandlers

public void setAuthenticationHandlers(List<AuthenticationHandler> authenticationHandlers)

getExtraAuthenticationHandlers
```
public List<AuthenticationHandler> getExtraAuthenticationHandlers()
```
You can add some extra auth handlers here, which will be added to the default auth handler structure such as basic, digest and cookie.

Returns:

setExtraAuthenticationHandlers

public void setExtraAuthenticationHandlers(List<AuthenticationHandler> extraAuthenticationHandlers)

getNonces
```
public Map<UUID,Nonce> getNonces()
```
Map holding nonce values issued in Digest authentication challenges

Returns:

setNonces

public void setNonces(Map<UUID,Nonce> nonces)

getMainResourceFactory
```
public ResourceFactory getMainResourceFactory()
```
This is your own resource factory, which provides access to your data repository. Not to be confused with outerResourceFactory which is normally used for milton specific things

Returns:

setMainResourceFactory

public void setMainResourceFactory(ResourceFactory mainResourceFactory)

getOuterResourceFactory
```
public ResourceFactory getOuterResourceFactory()
```
Usually set by milton, this will enhance the main resource factory with additional resources, such as .well-known support

Returns:

setOuterResourceFactory

public void setOuterResourceFactory(ResourceFactory outerResourceFactory)

getNonceValiditySeconds
```
public int getNonceValiditySeconds()
```

setNonceValiditySeconds

public void setNonceValiditySeconds(int nonceValiditySeconds)

getNonceProvider

public NonceProvider getNonceProvider()

setNonceProvider

public void setNonceProvider(NonceProvider nonceProvider)

getAuthenticationService

public AuthenticationService getAuthenticationService()

setAuthenticationService

public void setAuthenticationService(AuthenticationService authenticationService)

getExpiredNonceRemover

public ExpiredNonceRemover getExpiredNonceRemover()

setExpiredNonceRemover

public void setExpiredNonceRemover(ExpiredNonceRemover expiredNonceRemover)

getShutdownHandlers

public List<Stoppable> getShutdownHandlers()

setShutdownHandlers

public void setShutdownHandlers(List<Stoppable> shutdownHandlers)

getResourceTypeHelper

public ResourceTypeHelper getResourceTypeHelper()

setResourceTypeHelper

public void setResourceTypeHelper(ResourceTypeHelper resourceTypeHelper)

getWebdavResponseHandler

public WebDavResponseHandler getWebdavResponseHandler()

setWebdavResponseHandler

public void setWebdavResponseHandler(WebDavResponseHandler webdavResponseHandler)

getHandlerHelper

public HandlerHelper getHandlerHelper()

setHandlerHelper

public void setHandlerHelper(HandlerHelper handlerHelper)

getProtocols

public ArrayList<HttpExtension> getProtocols()

setProtocols

public void setProtocols(ArrayList<HttpExtension> protocols)

getProtocolHandlers

public ProtocolHandlers getProtocolHandlers()

setProtocolHandlers

public void setProtocolHandlers(ProtocolHandlers protocolHandlers)

getEntityTransport

public EntityTransport getEntityTransport()

setEntityTransport

public void setEntityTransport(EntityTransport entityTransport)

getEventManager
```
public EventManager getEventManager()
```

setEventManager

public void setEventManager(EventManager eventManager)

getPropertyAuthoriser

public PropertyAuthoriser getPropertyAuthoriser()

setPropertyAuthoriser

public void setPropertyAuthoriser(PropertyAuthoriser propertyAuthoriser)

getPropertySources

public List<PropertySource> getPropertySources()

setPropertySources

public void setPropertySources(List<PropertySource> propertySources)

geteTagGenerator

public ETagGenerator geteTagGenerator()

seteTagGenerator

public void seteTagGenerator(ETagGenerator eTagGenerator)

getHttp11ResponseHandler

public Http11ResponseHandler getHttp11ResponseHandler()

setHttp11ResponseHandler

public void setHttp11ResponseHandler(Http11ResponseHandler http11ResponseHandler)

getValueWriters
```
public ValueWriters getValueWriters()
```

setValueWriters

public void setValueWriters(ValueWriters valueWriters)

getPropFindXmlGenerator

public PropFindXmlGenerator getPropFindXmlGenerator()

setPropFindXmlGenerator

public void setPropFindXmlGenerator(PropFindXmlGenerator propFindXmlGenerator)

getFilters
```
public List<Filter> getFilters()
```

setFilters

public void setFilters(List<Filter> filters)

getDefaultStandardFilter

public Filter getDefaultStandardFilter()

setDefaultStandardFilter

public void setDefaultStandardFilter(Filter defaultStandardFilter)

getUrlAdapter
```
public UrlAdapter getUrlAdapter()
```

setUrlAdapter

public void setUrlAdapter(UrlAdapter urlAdapter)

getQuotaDataAccessor

public QuotaDataAccessor getQuotaDataAccessor()

setQuotaDataAccessor

public void setQuotaDataAccessor(QuotaDataAccessor quotaDataAccessor)

getPropPatchSetter

public PropPatchSetter getPropPatchSetter()

setPropPatchSetter

public void setPropPatchSetter(PropPatchSetter propPatchSetter)

isInitDone
```
public boolean isInitDone()
```

setInitDone

public void setInitDone(boolean initDone)

isEnableOptionsAuth
```
public boolean isEnableOptionsAuth()
```
False by default, which means that OPTIONS requests will not trigger authentication. This is required for windows 7

setEnableOptionsAuth

public void setEnableOptionsAuth(boolean enableOptionsAuth)

isEnableCompression
```
public boolean isEnableCompression()
```

setEnableCompression

public void setEnableCompression(boolean enableCompression)

isEnabledJson
```
public boolean isEnabledJson()
```

setEnabledJson

public void setEnabledJson(boolean enabledJson)

getExtraPropertySources

public List<PropertySource> getExtraPropertySources()

setExtraPropertySources

public void setExtraPropertySources(List<PropertySource> extraPropertySources)

showLog

protected void showLog(String propertyName,
                       Object defaultedTo)

Parameters:: propertyName -; defaultedTo -

isEnableBasicAuth
```
public boolean isEnableBasicAuth()
```

setEnableBasicAuth

public void setEnableBasicAuth(boolean enableBasicAuth)

isEnableCookieAuth
```
public boolean isEnableCookieAuth()
```

setEnableCookieAuth

public void setEnableCookieAuth(boolean enableCookieAuth)

isEnableDigestAuth
```
public boolean isEnableDigestAuth()
```

setEnableDigestAuth

public void setEnableDigestAuth(boolean enableDigestAuth)

isEnableFormAuth
```
public boolean isEnableFormAuth()
```

setEnableFormAuth

public void setEnableFormAuth(boolean enableFormAuth)

getBasicHandler

public BasicAuthHandler getBasicHandler()

setBasicHandler

public void setBasicHandler(BasicAuthHandler basicHandler)

getoAuth2Handler

public OAuth2AuthenticationHandler getoAuth2Handler()

setoAuth2Handler

public void setoAuth2Handler(OAuth2AuthenticationHandler oAuth2Handler)

getCookieAuthenticationHandler

public CookieAuthenticationHandler getCookieAuthenticationHandler()

setCookieAuthenticationHandler

public void setCookieAuthenticationHandler(CookieAuthenticationHandler cookieAuthenticationHandler)

getCookieDelegateHandlers

public List<AuthenticationHandler> getCookieDelegateHandlers()

setCookieDelegateHandlers

public void setCookieDelegateHandlers(List<AuthenticationHandler> cookieDelegateHandlers)

getDigestHandler

public DigestAuthenticationHandler getDigestHandler()

setDigestHandler

public void setDigestHandler(DigestAuthenticationHandler digestHandler)

getOAuth2Handler

public OAuth2AuthenticationHandler getOAuth2Handler()

setOAuth2Handler

public void setOAuth2Handler(OAuth2AuthenticationHandler oAuth2Handler)

isEnableOAuth2
```
public boolean isEnableOAuth2()
```

setEnableOAuth2

public void setEnableOAuth2(boolean enableOAuth2)

getFormAuthenticationHandler

public FormAuthenticationHandler getFormAuthenticationHandler()

setFormAuthenticationHandler

public void setFormAuthenticationHandler(FormAuthenticationHandler formAuthenticationHandler)

getLoginPage
```
public String getLoginPage()
```

setLoginPage

public void setLoginPage(String loginPage)

getLoginPageExcludePaths

public List<String> getLoginPageExcludePaths()

setLoginPageExcludePaths

public void setLoginPageExcludePaths(List<String> loginPageExcludePaths)

getResourceHandlerHelper

public ResourceHandlerHelper getResourceHandlerHelper()

setResourceHandlerHelper

public void setResourceHandlerHelper(ResourceHandlerHelper resourceHandlerHelper)

getRootDir
```
public File getRootDir()
```
used by FileSystemResourceFactory when its created as default resource factory

Returns:

setRootDir
```
public void setRootDir(File rootDir)
```

getSecurityManager
```
public SecurityManager getSecurityManager()
```
Mainly used when creating filesystem resourcfe factory, but can also be used by other resoruce factories that want to delegate security management

Returns:

setSecurityManager

public void setSecurityManager(SecurityManager securityManager)

getFsContextPath
```
public String getFsContextPath()
```
Passed to FilesystemResourceFactory when its created

Returns:

setFsContextPath

public void setFsContextPath(String fsContextPath)

getContextPath
```
public String getContextPath()
```
Used to set context path on certain implementations of ResourceFactory Alias for fsContentPath

Returns:

setContextPath

public void setContextPath(String contextPath)

getUserAgentHelper

public UserAgentHelper getUserAgentHelper()

setUserAgentHelper

public void setUserAgentHelper(UserAgentHelper userAgentHelper)

getDefaultPassword
```
public String getDefaultPassword()
```

setDefaultPassword

public void setDefaultPassword(String defaultPassword)

getDefaultUser
```
public String getDefaultUser()
```

setDefaultUser

public void setDefaultUser(String defaultUser)

getFsRealm
```
public String getFsRealm()
```

setFsRealm

public void setFsRealm(String fsRealm)

getMapOfNameAndPasswords

public Map<String,String> getMapOfNameAndPasswords()

setMapOfNameAndPasswords

public void setMapOfNameAndPasswords(Map<String,String> mapOfNameAndPasswords)

getMultiNamespaceCustomPropertySource

public MultiNamespaceCustomPropertySource getMultiNamespaceCustomPropertySource()

setMultiNamespaceCustomPropertySource

public void setMultiNamespaceCustomPropertySource(MultiNamespaceCustomPropertySource multiNamespaceCustomPropertySource)

getBeanPropertySource

public BeanPropertySource getBeanPropertySource()

setBeanPropertySource

public void setBeanPropertySource(BeanPropertySource beanPropertySource)

isEnabledCkBrowser
```
public boolean isEnabledCkBrowser()
```
Whether to enable support for CK Editor server browser support. If enabled this will inject the FckResourceFactory into your ResourceFactory stack. Note this will have no effect if outerResourceFactory is already set, as that is the top of the stack.

Returns:

setEnabledCkBrowser

public void setEnabledCkBrowser(boolean enabledCkBrowser)

getWebDavProtocol

public WebDavProtocol getWebDavProtocol()

setWebDavProtocol

public void setWebDavProtocol(WebDavProtocol webDavProtocol)

isWebdavEnabled
```
public boolean isWebdavEnabled()
```

setWebdavEnabled

public void setWebdavEnabled(boolean webdavEnabled)

getMatchHelper
```
public MatchHelper getMatchHelper()
```

setMatchHelper

public void setMatchHelper(MatchHelper matchHelper)

getPartialGetHelper

public PartialGetHelper getPartialGetHelper()

setPartialGetHelper

public void setPartialGetHelper(PartialGetHelper partialGetHelper)

isMultiNamespaceCustomPropertySourceEnabled

public boolean isMultiNamespaceCustomPropertySourceEnabled()

setMultiNamespaceCustomPropertySourceEnabled

public void setMultiNamespaceCustomPropertySourceEnabled(boolean multiNamespaceCustomPropertySourceEnabled)

getLoginPageTypeHandler

public LoginResponseHandler.LoginPageTypeHandler getLoginPageTypeHandler()

setLoginPageTypeHandler

public void setLoginPageTypeHandler(LoginResponseHandler.LoginPageTypeHandler loginPageTypeHandler)

getLoginResponseHandler

public LoginResponseHandler getLoginResponseHandler()

setLoginResponseHandler

public void setLoginResponseHandler(LoginResponseHandler loginResponseHandler)

getListeners

public List<InitListener> getListeners()

setListeners

public void setListeners(List<InitListener> listeners)

getFileContentService

public FileContentService getFileContentService()

setFileContentService

public void setFileContentService(FileContentService fileContentService)

getCacheControlHelper

public CacheControlHelper getCacheControlHelper()

setCacheControlHelper

public void setCacheControlHelper(CacheControlHelper cacheControlHelper)

getContentGenerator

public ContentGenerator getContentGenerator()

setContentGenerator

public void setContentGenerator(ContentGenerator contentGenerator)

setEnableExpectContinue

public void setEnableExpectContinue(boolean enableExpectContinue)

isEnableExpectContinue
```
public boolean isEnableExpectContinue()
```
If true milton will response to Expect: Continue requests. This can cause a problem on some web servers

Returns:

getOuterWebdavResponseHandler

public WebDavResponseHandler getOuterWebdavResponseHandler()

setOuterWebdavResponseHandler

public void setOuterWebdavResponseHandler(WebDavResponseHandler outerWebdavResponseHandler)

getControllerPackagesToScan
```
public String getControllerPackagesToScan()
```
If not null, is expected to be a comma seperated list of package names. These will be scanned for classes which contain classes annotated with ResourceController, and those found will be added to the controllers list

Returns:

setControllerPackagesToScan

public void setControllerPackagesToScan(String controllerPackagesToScan)

getControllerClassNames
```
public String getControllerClassNames()
```
As an alternative to package scanning via the controllerPackagesToScan property, set this property to a comma seperated list of class names. These will be loaded and checked for the ResourceController annotation, and if present, will be added to the controllers list

Returns:

setControllerClassNames

public void setControllerClassNames(String controlleClassNames)

getControllers
```
public List getControllers()
```
Instead of setting controller packages to scan or controller class names, you can set a list of actual controller instances

Returns:

setControllers

public void setControllers(List controllers)

isEnableQuota
```
public boolean isEnableQuota()
```
If quota is enabled, then extension properties to report quota information are available.

Returns:

setEnableQuota

public void setEnableQuota(boolean enableQuota)

getMaxAgeSeconds
```
public Long getMaxAgeSeconds()
```
Default max-age to use for certain resource types which can use a default value

Returns:

setMaxAgeSeconds

public void setMaxAgeSeconds(Long maxAgeSeconds)

getDisplayNameFormatter

public DisplayNameFormatter getDisplayNameFormatter()

setDisplayNameFormatter

public void setDisplayNameFormatter(DisplayNameFormatter displayNameFormatter)

getFsHomeDir
```
public String getFsHomeDir()
```
Set this if you're using the FileSystemResourceFactory and you want to explicitly set a home directory. If left null milton will use the user.home System property

Returns:

setFsHomeDir

public void setFsHomeDir(String fsHomeDir)

getCookieSigningKeys
```
public List<String> getCookieSigningKeys()
```
If set will be used as the list of keys to validate cookie signatures, and the last will be used to sign new cookies

Returns:

setCookieSigningKeys

public void setCookieSigningKeys(List<String> cookieSigningKeys)

setUseLongLivedCookies

public void setUseLongLivedCookies(boolean useLongLivedCookies)

isUseLongLivedCookies
```
public boolean isUseLongLivedCookies()
```
If true signed cookies for authentication will be long-lived, as defined in CookieAuthenticationHandler.SECONDS_PER_YEAR

Returns:

getCookieSigningKeysFile
```
public String getCookieSigningKeysFile()
```
If present is assumed to be a text file containing lines, where each line is a cookie signing key. The last will be used to sign cookies, previous will be available to validate Only used if cookieSigningKeys is null

Returns:

setCookieSigningKeysFile

public void setCookieSigningKeysFile(String cookieSigningKeysFile)

getPropFindPropertyBuilder

public PropFindPropertyBuilder getPropFindPropertyBuilder()

setPropFindPropertyBuilder

public void setPropFindPropertyBuilder(PropFindPropertyBuilder propFindPropertyBuilder)

getPropFindRequestFieldParser

public PropFindRequestFieldParser getPropFindRequestFieldParser()

setPropFindRequestFieldParser

public void setPropFindRequestFieldParser(PropFindRequestFieldParser propFindRequestFieldParser)

userAgentHelper

protected UserAgentHelper userAgentHelper()

propFindPropertyBuilder

protected PropFindPropertyBuilder propFindPropertyBuilder()

getRootContext
```
public RootContext getRootContext()
```

getDependencies
```
public List getDependencies()
```
Just a list of objects to be made available to auto-created objects via injection

Returns:

setDependencies

public void setDependencies(List dependencies)

isEnableEarlyAuth
```
public boolean isEnableEarlyAuth()
```

setEnableEarlyAuth

public void setEnableEarlyAuth(boolean enableEarlyAuth)

getCacheManager
```
public CacheManager getCacheManager()
```

setCacheManager

public void setCacheManager(CacheManager cacheManager)

getAuthorisationListener

public AuthorisationListener getAuthorisationListener()

setAuthorisationListener

public void setAuthorisationListener(AuthorisationListener authorisationListener)

Class HttpManagerBuilder

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

listeners

mainResourceFactory

outerResourceFactory

fileContentService

buffering

authenticationHandlers

extraAuthenticationHandlers

cookieDelegateHandlers

digestHandler

basicHandler

cookieAuthenticationHandler

formAuthenticationHandler

nonces

nonceValiditySeconds

nonceProvider

authenticationService

expiredNonceRemover

shutdownHandlers

resourceTypeHelper

webdavResponseHandler

outerWebdavResponseHandler

contentGenerator

cacheControlHelper

handlerHelper

authorisationListener

protocols

protocolHandlers

entityTransport

eventManager

propertyAuthoriser

propertySources

extraPropertySources

eTagGenerator

http11ResponseHandler

valueWriters

propFindXmlGenerator

filters

defaultStandardFilter

urlAdapter

quotaDataAccessor

propPatchSetter

enableOptionsAuth

resourceHandlerHelper

initDone

enableCompression

enabledJson

enableBasicAuth

enableDigestAuth

enableFormAuth

enableCookieAuth

enabledCkBrowser

enableEarlyAuth

enableTextContentProperty

loginPage

loginPageExcludePaths

rootDir

securityManager

contextPath

fsRealm

mapOfNameAndPasswords

defaultUser

defaultPassword

userAgentHelper

multiNamespaceCustomPropertySource

multiNamespaceCustomPropertySourceEnabled

beanPropertySource

webDavProtocol

displayNameFormatter

webdavEnabled

matchHelper

partialGetHelper

loginResponseHandler

loginPageTypeHandler