DeploymentInfo (Undertow Servlet 2.1.1.Final API)

java.lang.Object
- io.undertow.servlet.api.DeploymentInfo

All Implemented Interfaces:

Cloneable
```
public class DeploymentInfo
extends Object
implements Cloneable
```
Represents a servlet deployment.

Author:

Stuart Douglas

Constructor Summary

Constructors
Constructor and Description

DeploymentInfo()

Constructors
Constructor and Description
`DeploymentInfo()`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`DeploymentInfo`	`addAuthenticationMechanism(String name, AuthenticationMechanismFactory factory)` Adds an authentication mechanism.
`DeploymentInfo`	`addDeploymentCompleteListener(javax.servlet.ServletContextListener servletContextListener)` Add's a listener that is only invoked once all other deployment steps have been completed The listeners `contextDestroyed` method will be called after all undeployment steps are undertaken
`DeploymentInfo`	`addErrorPage(ErrorPage errorPage)`
`DeploymentInfo`	`addErrorPages(Collection<ErrorPage> errorPages)`
`DeploymentInfo`	`addErrorPages(ErrorPage... errorPages)`
`DeploymentInfo`	`addFilter(FilterInfo filter)`
`DeploymentInfo`	`addFilters(Collection<FilterInfo> filters)`
`DeploymentInfo`	`addFilters(FilterInfo... filters)`
`DeploymentInfo`	`addFilterServletNameMapping(String filterName, String mapping, javax.servlet.DispatcherType dispatcher)`
`DeploymentInfo`	`addFilterUrlMapping(String filterName, String mapping, javax.servlet.DispatcherType dispatcher)`
`DeploymentInfo`	`addFirstAuthenticationMechanism(String name, AuthenticationMechanism mechanism)` Adds an authentication mechanism directly to the deployment.
`DeploymentInfo`	`addInitialHandlerChainWrapper(HandlerWrapper wrapper)`
`DeploymentInfo`	`addInitParameter(String name, String value)`
`DeploymentInfo`	`addInnerHandlerChainWrapper(HandlerWrapper wrapper)` Adds an inner handler chain wrapper.
`DeploymentInfo`	`addLastAuthenticationMechanism(String name, AuthenticationMechanism mechanism)` Adds an authentication mechanism directly to the deployment.
`DeploymentInfo`	`addLifecycleInterceptor(LifecycleInterceptor interceptor)`
`DeploymentInfo`	`addListener(ListenerInfo listener)`
`DeploymentInfo`	`addListeners(Collection<ListenerInfo> listeners)`
`DeploymentInfo`	`addListeners(ListenerInfo... listeners)`
`DeploymentInfo`	`addLocaleCharsetMapping(String locale, String charset)`
`DeploymentInfo`	`addMimeMapping(MimeMapping mimeMappings)`
`DeploymentInfo`	`addMimeMappings(Collection<MimeMapping> mimeMappings)`
`DeploymentInfo`	`addMimeMappings(MimeMapping... mimeMappings)`
`DeploymentInfo`	`addNotificactionReceivers(NotificationReceiver... notificationReceivers)`
`DeploymentInfo`	`addNotificationReceiver(NotificationReceiver notificationReceiver)`
`DeploymentInfo`	`addNotificationReceivers(Collection<NotificationReceiver> notificationReceivers)`
`DeploymentInfo`	`addOuterHandlerChainWrapper(HandlerWrapper wrapper)` Adds an outer handler wrapper.
`DeploymentInfo`	`addPreCompressedResourceEncoding(String encoding, String extension)` Adds a pre compressed resource encoding and maps it to a file extension
`DeploymentInfo`	`addPrincipalVsRoleMapping(String principal, String mapping)`
`DeploymentInfo`	`addPrincipalVsRoleMappings(String principal, Collection<String> mappings)`
`DeploymentInfo`	`addPrincipalVsRoleMappings(String principal, String... mappings)`
`DeploymentInfo`	`addSecurityConstraint(SecurityConstraint securityConstraint)`
`DeploymentInfo`	`addSecurityConstraints(Collection<SecurityConstraint> securityConstraints)`
`DeploymentInfo`	`addSecurityConstraints(SecurityConstraint... securityConstraints)`
`DeploymentInfo`	`addSecurityRole(String role)`
`DeploymentInfo`	`addSecurityRoles(Collection<String> roles)`
`DeploymentInfo`	`addSecurityRoles(String... roles)`
`DeploymentInfo`	`addSecurityWrapper(HandlerWrapper wrapper)` Adds a security handler.
`DeploymentInfo`	`addServlet(ServletInfo servlet)`
`DeploymentInfo`	`addServletContainerInitalizer(ServletContainerInitializerInfo servletContainerInitializer)` Deprecated.
`DeploymentInfo`	`addServletContainerInitalizers(List<ServletContainerInitializerInfo> servletContainerInitializers)` Deprecated.
`DeploymentInfo`	`addServletContainerInitalizers(ServletContainerInitializerInfo... servletContainerInitializer)` Deprecated.
`DeploymentInfo`	`addServletContainerInitializer(ServletContainerInitializerInfo servletContainerInitializer)`
`DeploymentInfo`	`addServletContainerInitializers(List<ServletContainerInitializerInfo> servletContainerInitializer)`
`DeploymentInfo`	`addServletContainerInitializers(ServletContainerInitializerInfo... servletContainerInitializer)`
`DeploymentInfo`	`addServletContextAttribute(String name, Object value)`
`DeploymentInfo`	`addServletExtension(ServletExtension servletExtension)` Adds an additional servlet extension to the deployment.
`DeploymentInfo`	`addServlets(Collection<ServletInfo> servlets)`
`DeploymentInfo`	`addServlets(ServletInfo... servlets)`
`DeploymentInfo`	`addSessionListener(SessionListener sessionListener)`
`DeploymentInfo`	`addThreadSetupAction(ThreadSetupAction action)` Deprecated.
`DeploymentInfo`	`addThreadSetupAction(ThreadSetupHandler action)`
`DeploymentInfo`	`addWelcomePage(String welcomePage)`
`DeploymentInfo`	`addWelcomePages(Collection<String> welcomePages)`
`DeploymentInfo`	`addWelcomePages(String... welcomePages)`
`DeploymentInfo`	`clearLoginMethods()` Removes all configured authentication mechanisms from the deployment.
`DeploymentInfo`	`clone()`
`Executor`	`getAsyncExecutor()`
`Map<String,AuthenticationMechanismFactory>`	`getAuthenticationMechanisms()`
`AuthenticationMode`	`getAuthenticationMode()`
`AuthorizationManager`	`getAuthorizationManager()`
`ClassIntrospecter`	`getClassIntrospecter()`
`ClassLoader`	`getClassLoader()`
`ConfidentialPortManager`	`getConfidentialPortManager()`
`int`	`getContainerMajorVersion()`
`int`	`getContainerMinorVersion()`
`int`	`getContentTypeCacheSize()`
`String`	`getContextPath()`
`CrawlerSessionManagerConfig`	`getCrawlerSessionManagerConfig()`
`int`	`getDefaultCookieVersion()`
`String`	`getDefaultEncoding()`
`javax.servlet.MultipartConfigElement`	`getDefaultMultipartConfig()`
`String`	`getDefaultRequestEncoding()`
`String`	`getDefaultResponseEncoding()`
`DefaultServletConfig`	`getDefaultServletConfig()`
`int`	`getDefaultSessionTimeout()`
`List<javax.servlet.ServletContextListener>`	`getDeploymentCompleteListeners()`
`String`	`getDeploymentName()`
`String`	`getDisplayName()`
`List<ErrorPage>`	`getErrorPages()`
`ExceptionHandler`	`getExceptionHandler()` Returns the exception handler that is used by this deployment.
`Executor`	`getExecutor()`
`List<FilterMappingInfo>`	`getFilterMappings()`
`Map<String,FilterInfo>`	`getFilters()`
`String`	`getHostName()`
`IdentityManager`	`getIdentityManager()`
`List<HandlerWrapper>`	`getInitialHandlerChainWrappers()`
`HandlerWrapper`	`getInitialSecurityWrapper()`
`Map<String,String>`	`getInitParameters()`
`List<HandlerWrapper>`	`getInnerHandlerChainWrappers()`
`AuthenticationMechanism`	`getJaspiAuthenticationMechanism()`
`javax.servlet.descriptor.JspConfigDescriptor`	`getJspConfigDescriptor()`
`List<LifecycleInterceptor>`	`getLifecycleInterceptors()`
`List<ListenerInfo>`	`getListeners()`
`Map<String,String>`	`getLocaleCharsetMapping()`
`LoginConfig`	`getLoginConfig()`
`int`	`getMajorVersion()`
`MetricsCollector`	`getMetricsCollector()`
`List<MimeMapping>`	`getMimeMappings()`
`int`	`getMinorVersion()`
`List<NotificationReceiver>`	`getNotificationReceivers()`
`List<HandlerWrapper>`	`getOuterHandlerChainWrappers()`
`Map<String,String>`	`getPreCompressedResources()`
`Map<String,Set<String>>`	`getPrincipalVersusRolesMap()`
`ResourceManager`	`getResourceManager()`
`List<SecurityConstraint>`	`getSecurityConstraints()`
`SecurityContextFactory`	`getSecurityContextFactory()`
`Set<String>`	`getSecurityRoles()`
`List<HandlerWrapper>`	`getSecurityWrappers()`
`String`	`getServerName()`
`List<ServletContainerInitializerInfo>`	`getServletContainerInitializers()`
`ConcurrentMap<String,Object>`	`getServletContextAttributeBackingMap()`
`Map<String,Object>`	`getServletContextAttributes()`
`List<ServletExtension>`	`getServletExtensions()`
`Map<String,ServletInfo>`	`getServlets()`
`ServletSessionConfig`	`getServletSessionConfig()`
`ServletStackTraces`	`getServletStackTraces()`
`SessionConfigWrapper`	`getSessionConfigWrapper()`
`SessionIdGenerator`	`getSessionIdGenerator()`
`List<SessionListener>`	`getSessionListeners()`
`SessionManagerFactory`	`getSessionManagerFactory()`
`SessionPersistenceManager`	`getSessionPersistenceManager()`
`File`	`getTempDir()`
`Path`	`getTempPath()`
`List<ThreadSetupHandler>`	`getThreadSetupActions()`
`String`	`getUrlEncoding()`
`List<String>`	`getWelcomePages()`
`DeploymentInfo`	`insertFilterServletNameMapping(int pos, String filterName, String mapping, javax.servlet.DispatcherType dispatcher)`
`DeploymentInfo`	`insertFilterUrlMapping(int pos, String filterName, String mapping, javax.servlet.DispatcherType dispatcher)`
`boolean`	`isAllowNonStandardWrappers()`
`boolean`	`isAuthenticationMechanismPresent(String mechanismName)` Returns true if the specified mechanism is present in the login config
`boolean`	`isChangeSessionIdOnLogin()`
`boolean`	`isCheckOtherSessionManagers()`
`boolean`	`isDenyUncoveredHttpMethods()`
`boolean`	`isDisableCachingForSecuredPages()`
`boolean`	`isEagerFilterInit()`
`boolean`	`isEscapeErrorMessage()`
`boolean`	`isIgnoreFlush()`
`boolean`	`isInvalidateSessionOnLogout()`
`boolean`	`isPreservePathOnForward()`
`boolean`	`isSecurityDisabled()`
`boolean`	`isSendCustomReasonPhraseOnError()`
`boolean`	`isUseCachedAuthenticationMechanism()`
`Path`	`requireTempPath()`
`DeploymentInfo`	`setAllowNonStandardWrappers(boolean allowNonStandardWrappers)`
`DeploymentInfo`	`setAsyncExecutor(Executor asyncExecutor)` Sets the executor that is used to run async tasks.
`DeploymentInfo`	`setAuthenticationMode(AuthenticationMode authenticationMode)` Sets if this deployment should use pro-active authentication and always authenticate if the credentials are present or constraint driven auth which will only call the authentication mechanisms for protected resources.
`DeploymentInfo`	`setAuthorizationManager(AuthorizationManager authorizationManager)`
`DeploymentInfo`	`setChangeSessionIdOnLogin(boolean changeSessionIdOnLogin)`
`DeploymentInfo`	`setCheckOtherSessionManagers(boolean checkOtherSessionManagers)` If this is true then when an existing invalid session id is found all other deployments in the container will have their session managers checked to see if it represents a valid session.
`DeploymentInfo`	`setClassIntrospecter(ClassIntrospecter classIntrospecter)`
`DeploymentInfo`	`setClassLoader(ClassLoader classLoader)`
`DeploymentInfo`	`setConfidentialPortManager(ConfidentialPortManager confidentialPortManager)`
`DeploymentInfo`	`setContainerMajorVersion(int containerMajorVersion)`
`DeploymentInfo`	`setContainerMinorVersion(int containerMinorVersion)`
`DeploymentInfo`	`setContentTypeCacheSize(int contentTypeCacheSize)`
`DeploymentInfo`	`setContextPath(String contextPath)`
`DeploymentInfo`	`setCrawlerSessionManagerConfig(CrawlerSessionManagerConfig crawlerSessionManagerConfig)`
`DeploymentInfo`	`setDefaultCookieVersion(int defaultCookieVersion)`
`DeploymentInfo`	`setDefaultEncoding(String defaultEncoding)` Sets the default encoding that will be used for servlet responses
`DeploymentInfo`	`setDefaultMultipartConfig(javax.servlet.MultipartConfigElement defaultMultipartConfig)`
`DeploymentInfo`	`setDefaultRequestEncoding(String defaultRequestEncoding)`
`DeploymentInfo`	`setDefaultResponseEncoding(String defaultResponseEncoding)`
`DeploymentInfo`	`setDefaultServletConfig(DefaultServletConfig defaultServletConfig)`
`DeploymentInfo`	`setDefaultSessionTimeout(int defaultSessionTimeout)`
`DeploymentInfo`	`setDenyUncoveredHttpMethods(boolean denyUncoveredHttpMethods)`
`DeploymentInfo`	`setDeploymentName(String deploymentName)`
`DeploymentInfo`	`setDisableCachingForSecuredPages(boolean disableCachingForSecuredPages)`
`DeploymentInfo`	`setDisplayName(String displayName)`
`DeploymentInfo`	`setEagerFilterInit(boolean eagerFilterInit)`
`DeploymentInfo`	`setEscapeErrorMessage(boolean escapeErrorMessage)` Set if if the message passed to `HttpServletResponse.sendError(int, String)` should be escaped.
`DeploymentInfo`	`setExceptionHandler(ExceptionHandler exceptionHandler)` Sets the default exception handler for this deployment
`DeploymentInfo`	`setExecutor(Executor executor)` Sets the executor that will be used to run servlet invocations.
`DeploymentInfo`	`setHostName(String hostName)`
`DeploymentInfo`	`setIdentityManager(IdentityManager identityManager)`
`DeploymentInfo`	`setIgnoreFlush(boolean ignoreFlush)`
`DeploymentInfo`	`setInitialSecurityWrapper(HandlerWrapper wrapper)` Sets the initial handler wrapper that will take over responsibility for establishing a security context that will handle authentication for the request.
`DeploymentInfo`	`setInvalidateSessionOnLogout(boolean invalidateSessionOnLogout)`
`DeploymentInfo`	`setJaspiAuthenticationMechanism(AuthenticationMechanism jaspiAuthenticationMechanism)`
`DeploymentInfo`	`setJspConfigDescriptor(javax.servlet.descriptor.JspConfigDescriptor jspConfigDescriptor)`
`DeploymentInfo`	`setLoginConfig(LoginConfig loginConfig)`
`DeploymentInfo`	`setMajorVersion(int majorVersion)`
`DeploymentInfo`	`setMetricsCollector(MetricsCollector metricsCollector)`
`DeploymentInfo`	`setMinorVersion(int minorVersion)`
`void`	`setPreservePathOnForward(boolean preservePathOnForward)`
`DeploymentInfo`	`setResourceManager(ResourceManager resourceManager)`
`DeploymentInfo`	`setSecurityContextFactory(SecurityContextFactory securityContextFactory)`
`DeploymentInfo`	`setSecurityDisabled(boolean securityDisabled)`
`DeploymentInfo`	`setSendCustomReasonPhraseOnError(boolean sendCustomReasonPhraseOnError)` If this is true then the message parameter of `HttpServletResponse.sendError(int, String)` and `HttpServletResponse.setStatus(int, String)` will be used as the HTTP reason phrase in the response.
`DeploymentInfo`	`setServerName(String serverName)`
`DeploymentInfo`	`setServletContextAttributeBackingMap(ConcurrentMap<String,Object> servletContextAttributeBackingMap)` Sets the map that will be used by the ServletContext implementation to store attributes.
`DeploymentInfo`	`setServletSessionConfig(ServletSessionConfig servletSessionConfig)`
`DeploymentInfo`	`setServletStackTraces(ServletStackTraces servletStackTraces)`
`DeploymentInfo`	`setSessionConfigWrapper(SessionConfigWrapper sessionConfigWrapper)`
`DeploymentInfo`	`setSessionIdGenerator(SessionIdGenerator sessionIdGenerator)`
`DeploymentInfo`	`setSessionManagerFactory(SessionManagerFactory sessionManagerFactory)`
`DeploymentInfo`	`setSessionPersistenceManager(SessionPersistenceManager sessionPersistenceManager)`
`DeploymentInfo`	`setTempDir(File tempDir)`
`DeploymentInfo`	`setTempDir(Path tempDir)`
`DeploymentInfo`	`setUrlEncoding(String urlEncoding)` Sets the URL encoding.
`DeploymentInfo`	`setUseCachedAuthenticationMechanism(boolean useCachedAuthenticationMechanism)` If this is set to false the the cached authenticated session mechanism won't be installed.
`void`	`validate()`

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

Constructor Detail
- DeploymentInfo
```
public DeploymentInfo()
```

Method Detail

validate
```
public void validate()
```

getDeploymentName
```
public String getDeploymentName()
```

setDeploymentName

public DeploymentInfo setDeploymentName(String deploymentName)

getDisplayName
```
public String getDisplayName()
```

setDisplayName

public DeploymentInfo setDisplayName(String displayName)

getContextPath
```
public String getContextPath()
```

setContextPath

public DeploymentInfo setContextPath(String contextPath)

getClassLoader
```
public ClassLoader getClassLoader()
```

setClassLoader

public DeploymentInfo setClassLoader(ClassLoader classLoader)

getResourceManager

public ResourceManager getResourceManager()

setResourceManager

public DeploymentInfo setResourceManager(ResourceManager resourceManager)

getClassIntrospecter

public ClassIntrospecter getClassIntrospecter()

setClassIntrospecter

public DeploymentInfo setClassIntrospecter(ClassIntrospecter classIntrospecter)

isAllowNonStandardWrappers

public boolean isAllowNonStandardWrappers()

setAllowNonStandardWrappers

public DeploymentInfo setAllowNonStandardWrappers(boolean allowNonStandardWrappers)

getDefaultSessionTimeout
```
public int getDefaultSessionTimeout()
```

setDefaultSessionTimeout
```
public DeploymentInfo setDefaultSessionTimeout(int defaultSessionTimeout)
```
Parameters:

defaultSessionTimeout - The default session timeout, in seconds

getDefaultEncoding
```
public String getDefaultEncoding()
```

setDefaultEncoding
```
public DeploymentInfo setDefaultEncoding(String defaultEncoding)
```
Sets the default encoding that will be used for servlet responses

Parameters:

defaultEncoding - The default encoding

getUrlEncoding
```
public String getUrlEncoding()
```

setUrlEncoding
```
public DeploymentInfo setUrlEncoding(String urlEncoding)
```
Sets the URL encoding. This will only take effect if the UndertowOptions.DECODE_URL parameter has been set to false. This allows multiple deployments in the same server to use a different URL encoding

Parameters:

urlEncoding - The encoding to use

addServlet

public DeploymentInfo addServlet(ServletInfo servlet)

addServlets

public DeploymentInfo addServlets(ServletInfo... servlets)

addServlets

public DeploymentInfo addServlets(Collection<ServletInfo> servlets)

getServlets

public Map<String,ServletInfo> getServlets()

addFilter

public DeploymentInfo addFilter(FilterInfo filter)

addFilters

public DeploymentInfo addFilters(FilterInfo... filters)

addFilters

public DeploymentInfo addFilters(Collection<FilterInfo> filters)

getFilters

public Map<String,FilterInfo> getFilters()

addFilterUrlMapping

public DeploymentInfo addFilterUrlMapping(String filterName,
                                          String mapping,
                                          javax.servlet.DispatcherType dispatcher)

addFilterServletNameMapping

public DeploymentInfo addFilterServletNameMapping(String filterName,
                                                  String mapping,
                                                  javax.servlet.DispatcherType dispatcher)

insertFilterUrlMapping

public DeploymentInfo insertFilterUrlMapping(int pos,
                                             String filterName,
                                             String mapping,
                                             javax.servlet.DispatcherType dispatcher)

insertFilterServletNameMapping

public DeploymentInfo insertFilterServletNameMapping(int pos,
                                                     String filterName,
                                                     String mapping,
                                                     javax.servlet.DispatcherType dispatcher)

getFilterMappings

public List<FilterMappingInfo> getFilterMappings()

addListener

public DeploymentInfo addListener(ListenerInfo listener)

addListeners

public DeploymentInfo addListeners(ListenerInfo... listeners)

addListeners

public DeploymentInfo addListeners(Collection<ListenerInfo> listeners)

getListeners

public List<ListenerInfo> getListeners()

getMajorVersion
```
public int getMajorVersion()
```

setMajorVersion

public DeploymentInfo setMajorVersion(int majorVersion)

getMinorVersion
```
public int getMinorVersion()
```

setMinorVersion

public DeploymentInfo setMinorVersion(int minorVersion)

addServletContainerInitializer

public DeploymentInfo addServletContainerInitializer(ServletContainerInitializerInfo servletContainerInitializer)

addServletContainerInitalizer

@Deprecated
public DeploymentInfo addServletContainerInitalizer(ServletContainerInitializerInfo servletContainerInitializer)

Deprecated.

addServletContainerInitializers

public DeploymentInfo addServletContainerInitializers(ServletContainerInitializerInfo... servletContainerInitializer)

addServletContainerInitalizers

@Deprecated
public DeploymentInfo addServletContainerInitalizers(ServletContainerInitializerInfo... servletContainerInitializer)

Deprecated.

addServletContainerInitializers

public DeploymentInfo addServletContainerInitializers(List<ServletContainerInitializerInfo> servletContainerInitializer)

addServletContainerInitalizers

@Deprecated
public DeploymentInfo addServletContainerInitalizers(List<ServletContainerInitializerInfo> servletContainerInitializers)

Deprecated.

getServletContainerInitializers

public List<ServletContainerInitializerInfo> getServletContainerInitializers()

addThreadSetupAction

@Deprecated
public DeploymentInfo addThreadSetupAction(ThreadSetupAction action)

Deprecated.

addThreadSetupAction

public DeploymentInfo addThreadSetupAction(ThreadSetupHandler action)

getThreadSetupActions

public List<ThreadSetupHandler> getThreadSetupActions()

isEagerFilterInit
```
public boolean isEagerFilterInit()
```

setEagerFilterInit

public DeploymentInfo setEagerFilterInit(boolean eagerFilterInit)

addInitParameter

public DeploymentInfo addInitParameter(String name,
                                       String value)

getInitParameters

public Map<String,String> getInitParameters()

addServletContextAttribute

public DeploymentInfo addServletContextAttribute(String name,
                                                 Object value)

getServletContextAttributes

public Map<String,Object> getServletContextAttributes()

addWelcomePage

public DeploymentInfo addWelcomePage(String welcomePage)

addWelcomePages

public DeploymentInfo addWelcomePages(String... welcomePages)

addWelcomePages

public DeploymentInfo addWelcomePages(Collection<String> welcomePages)

getWelcomePages
```
public List<String> getWelcomePages()
```

addErrorPage

public DeploymentInfo addErrorPage(ErrorPage errorPage)

addErrorPages

public DeploymentInfo addErrorPages(ErrorPage... errorPages)

addErrorPages

public DeploymentInfo addErrorPages(Collection<ErrorPage> errorPages)

getErrorPages

public List<ErrorPage> getErrorPages()

addMimeMapping

public DeploymentInfo addMimeMapping(MimeMapping mimeMappings)

addMimeMappings

public DeploymentInfo addMimeMappings(MimeMapping... mimeMappings)

addMimeMappings

public DeploymentInfo addMimeMappings(Collection<MimeMapping> mimeMappings)

getMimeMappings

public List<MimeMapping> getMimeMappings()

addSecurityConstraint

public DeploymentInfo addSecurityConstraint(SecurityConstraint securityConstraint)

addSecurityConstraints

public DeploymentInfo addSecurityConstraints(SecurityConstraint... securityConstraints)

addSecurityConstraints

public DeploymentInfo addSecurityConstraints(Collection<SecurityConstraint> securityConstraints)

getSecurityConstraints

public List<SecurityConstraint> getSecurityConstraints()

getExecutor
```
public Executor getExecutor()
```

setExecutor
```
public DeploymentInfo setExecutor(Executor executor)
```
Sets the executor that will be used to run servlet invocations. If this is null then the XNIO worker pool will be used.
Individual servlets may use a different executor
If this is null then the current executor is used, which is generally the XNIO worker pool

Parameters:

executor - The executor

See Also:

ServletInfo.executor

getAsyncExecutor
```
public Executor getAsyncExecutor()
```

setAsyncExecutor
```
public DeploymentInfo setAsyncExecutor(Executor asyncExecutor)
```
Sets the executor that is used to run async tasks.
If this is null then executor is used, if this is also null then the default is used

Parameters:

asyncExecutor - The executor

getTempDir
```
public File getTempDir()
```

getTempPath
```
public Path getTempPath()
```

requireTempPath
```
public Path requireTempPath()
```
Returns:

Returns the temp directory path if it's not null, else returns the system level temporary directory path pointed to by the Java system property java.io.tmpdir

setTempDir

public DeploymentInfo setTempDir(File tempDir)

setTempDir

public DeploymentInfo setTempDir(Path tempDir)

isIgnoreFlush
```
public boolean isIgnoreFlush()
```

setIgnoreFlush

public DeploymentInfo setIgnoreFlush(boolean ignoreFlush)

getJspConfigDescriptor

public javax.servlet.descriptor.JspConfigDescriptor getJspConfigDescriptor()

setJspConfigDescriptor

public DeploymentInfo setJspConfigDescriptor(javax.servlet.descriptor.JspConfigDescriptor jspConfigDescriptor)

getDefaultServletConfig

public DefaultServletConfig getDefaultServletConfig()

setDefaultServletConfig

public DeploymentInfo setDefaultServletConfig(DefaultServletConfig defaultServletConfig)

addLocaleCharsetMapping

public DeploymentInfo addLocaleCharsetMapping(String locale,
                                              String charset)

getLocaleCharsetMapping

public Map<String,String> getLocaleCharsetMapping()

getSessionManagerFactory

public SessionManagerFactory getSessionManagerFactory()

setSessionManagerFactory

public DeploymentInfo setSessionManagerFactory(SessionManagerFactory sessionManagerFactory)

getLoginConfig
```
public LoginConfig getLoginConfig()
```

setLoginConfig

public DeploymentInfo setLoginConfig(LoginConfig loginConfig)

getIdentityManager

public IdentityManager getIdentityManager()

setIdentityManager

public DeploymentInfo setIdentityManager(IdentityManager identityManager)

getConfidentialPortManager

public ConfidentialPortManager getConfidentialPortManager()

setConfidentialPortManager

public DeploymentInfo setConfidentialPortManager(ConfidentialPortManager confidentialPortManager)

addSecurityRole

public DeploymentInfo addSecurityRole(String role)

addSecurityRoles

public DeploymentInfo addSecurityRoles(String... roles)

addSecurityRoles

public DeploymentInfo addSecurityRoles(Collection<String> roles)

getSecurityRoles
```
public Set<String> getSecurityRoles()
```

addOuterHandlerChainWrapper
```
public DeploymentInfo addOuterHandlerChainWrapper(HandlerWrapper wrapper)
```
Adds an outer handler wrapper. This handler will be run after the servlet initial handler, but before any other handlers. These are only run on REQUEST invocations, they are not invoked on a FORWARD or INCLUDE.

Parameters:

wrapper - The wrapper

getOuterHandlerChainWrappers

public List<HandlerWrapper> getOuterHandlerChainWrappers()

addInnerHandlerChainWrapper
```
public DeploymentInfo addInnerHandlerChainWrapper(HandlerWrapper wrapper)
```
Adds an inner handler chain wrapper. This handler will be run after the security handler, but before any other servlet handlers, and will be run for every request

Parameters:

wrapper - The wrapper

getInnerHandlerChainWrappers

public List<HandlerWrapper> getInnerHandlerChainWrappers()

addInitialHandlerChainWrapper

public DeploymentInfo addInitialHandlerChainWrapper(HandlerWrapper wrapper)

getInitialHandlerChainWrappers

public List<HandlerWrapper> getInitialHandlerChainWrappers()

setInitialSecurityWrapper
```
public DeploymentInfo setInitialSecurityWrapper(HandlerWrapper wrapper)
```
Sets the initial handler wrapper that will take over responsibility for establishing a security context that will handle authentication for the request. Undertow specific authentication mechanisms will not be installed but Undertow handlers will still make the decision as to if authentication is required and will subsequently call SecurityContext.authenticate() as required.

Parameters:

wrapper - the HandlerWrapper to handle the initial security context installation.

Returns:

this to allow chaining.

getInitialSecurityWrapper

public HandlerWrapper getInitialSecurityWrapper()

addSecurityWrapper
```
public DeploymentInfo addSecurityWrapper(HandlerWrapper wrapper)
```
Adds a security handler. These are invoked before the authentication mechanism, and are always invoked even if authentication is not required.

Parameters:

wrapper -

Returns:

getSecurityWrappers

public List<HandlerWrapper> getSecurityWrappers()

addNotificationReceiver

public DeploymentInfo addNotificationReceiver(NotificationReceiver notificationReceiver)

addNotificactionReceivers

public DeploymentInfo addNotificactionReceivers(NotificationReceiver... notificationReceivers)

addNotificationReceivers

public DeploymentInfo addNotificationReceivers(Collection<NotificationReceiver> notificationReceivers)

getNotificationReceivers

public List<NotificationReceiver> getNotificationReceivers()

getServletContextAttributeBackingMap

public ConcurrentMap<String,Object> getServletContextAttributeBackingMap()

setServletContextAttributeBackingMap
```
public DeploymentInfo setServletContextAttributeBackingMap(ConcurrentMap<String,Object> servletContextAttributeBackingMap)
```
Sets the map that will be used by the ServletContext implementation to store attributes.
This should usuablly be null, in which case Undertow will create a new map. This is only used in situations where you want multiple deployments to share the same servlet context attributes.

Parameters:

servletContextAttributeBackingMap - The backing map

getServletSessionConfig

public ServletSessionConfig getServletSessionConfig()

setServletSessionConfig

public DeploymentInfo setServletSessionConfig(ServletSessionConfig servletSessionConfig)

getHostName
```
public String getHostName()
```
Returns:

the host name

setHostName

public DeploymentInfo setHostName(String hostName)

isDenyUncoveredHttpMethods

public boolean isDenyUncoveredHttpMethods()

setDenyUncoveredHttpMethods

public DeploymentInfo setDenyUncoveredHttpMethods(boolean denyUncoveredHttpMethods)

getServletStackTraces

public ServletStackTraces getServletStackTraces()

setServletStackTraces

public DeploymentInfo setServletStackTraces(ServletStackTraces servletStackTraces)

isInvalidateSessionOnLogout

public boolean isInvalidateSessionOnLogout()

setInvalidateSessionOnLogout

public DeploymentInfo setInvalidateSessionOnLogout(boolean invalidateSessionOnLogout)

getDefaultCookieVersion
```
public int getDefaultCookieVersion()
```

setDefaultCookieVersion

public DeploymentInfo setDefaultCookieVersion(int defaultCookieVersion)

getSessionPersistenceManager

public SessionPersistenceManager getSessionPersistenceManager()

setSessionPersistenceManager

public DeploymentInfo setSessionPersistenceManager(SessionPersistenceManager sessionPersistenceManager)

getAuthorizationManager

public AuthorizationManager getAuthorizationManager()

setAuthorizationManager

public DeploymentInfo setAuthorizationManager(AuthorizationManager authorizationManager)

addPrincipalVsRoleMapping

public DeploymentInfo addPrincipalVsRoleMapping(String principal,
                                                String mapping)

addPrincipalVsRoleMappings

public DeploymentInfo addPrincipalVsRoleMappings(String principal,
                                                 String... mappings)

addPrincipalVsRoleMappings

public DeploymentInfo addPrincipalVsRoleMappings(String principal,
                                                 Collection<String> mappings)

getPrincipalVersusRolesMap

public Map<String,Set<String>> getPrincipalVersusRolesMap()

clearLoginMethods
```
public DeploymentInfo clearLoginMethods()
```
Removes all configured authentication mechanisms from the deployment.

Returns:

this deployment info

addFirstAuthenticationMechanism
```
public DeploymentInfo addFirstAuthenticationMechanism(String name,
                                                      AuthenticationMechanism mechanism)
```
Adds an authentication mechanism directly to the deployment. This mechanism will be first in the list. In general you should just use addAuthenticationMechanism(String, io.undertow.security.api.AuthenticationMechanismFactory) and allow the user to configure the methods they want by name. This method is essentially a convenience method, if is the same as registering a factory under the provided name that returns and authentication mechanism, and then adding it to the login config list. If you want your mechanism to be the only one in the deployment you should first invoke clearLoginMethods().

Parameters:

name - The authentication mechanism name

mechanism - The mechanism

Returns:

this deployment info

addLastAuthenticationMechanism
```
public DeploymentInfo addLastAuthenticationMechanism(String name,
                                                     AuthenticationMechanism mechanism)
```
Adds an authentication mechanism directly to the deployment. This mechanism will be last in the list. In general you should just use addAuthenticationMechanism(String, io.undertow.security.api.AuthenticationMechanismFactory) and allow the user to configure the methods they want by name. This method is essentially a convenience method, if is the same as registering a factory under the provided name that returns and authentication mechanism, and then adding it to the login config list. If you want your mechanism to be the only one in the deployment you should first invoke clearLoginMethods().

Parameters:

name - The authentication mechanism name

mechanism - The mechanism

Returns:

addAuthenticationMechanism

public DeploymentInfo addAuthenticationMechanism(String name,
                                                 AuthenticationMechanismFactory factory)

Adds an authentication mechanism. The name is case insenstive, and will be converted to uppercase internally.

Parameters:: name - The name; factory - The factory
Returns:

getAuthenticationMechanisms

public Map<String,AuthenticationMechanismFactory> getAuthenticationMechanisms()

isAuthenticationMechanismPresent
```
public boolean isAuthenticationMechanismPresent(String mechanismName)
```
Returns true if the specified mechanism is present in the login config

Parameters:

mechanismName - The mechanism name

Returns:

true if the mechanism is enabled

addServletExtension
```
public DeploymentInfo addServletExtension(ServletExtension servletExtension)
```
Adds an additional servlet extension to the deployment. Servlet extensions are generally discovered using META-INF/services entries, however this may not be practical in all environments.

Parameters:

servletExtension - The servlet extension

Returns:

this

getServletExtensions

public List<ServletExtension> getServletExtensions()

getJaspiAuthenticationMechanism

public AuthenticationMechanism getJaspiAuthenticationMechanism()

setJaspiAuthenticationMechanism

public DeploymentInfo setJaspiAuthenticationMechanism(AuthenticationMechanism jaspiAuthenticationMechanism)

getSecurityContextFactory

public SecurityContextFactory getSecurityContextFactory()

setSecurityContextFactory

public DeploymentInfo setSecurityContextFactory(SecurityContextFactory securityContextFactory)

getServerName
```
public String getServerName()
```

setServerName

public DeploymentInfo setServerName(String serverName)

setMetricsCollector

public DeploymentInfo setMetricsCollector(MetricsCollector metricsCollector)

getMetricsCollector

public MetricsCollector getMetricsCollector()

getSessionConfigWrapper

public SessionConfigWrapper getSessionConfigWrapper()

setSessionConfigWrapper

public DeploymentInfo setSessionConfigWrapper(SessionConfigWrapper sessionConfigWrapper)

isDisableCachingForSecuredPages

public boolean isDisableCachingForSecuredPages()

setDisableCachingForSecuredPages

public DeploymentInfo setDisableCachingForSecuredPages(boolean disableCachingForSecuredPages)

addLifecycleInterceptor

public DeploymentInfo addLifecycleInterceptor(LifecycleInterceptor interceptor)

getLifecycleInterceptors

public List<LifecycleInterceptor> getLifecycleInterceptors()

getExceptionHandler
```
public ExceptionHandler getExceptionHandler()
```
Returns the exception handler that is used by this deployment. By default this will simply log unhandled exceptions

setExceptionHandler
```
public DeploymentInfo setExceptionHandler(ExceptionHandler exceptionHandler)
```
Sets the default exception handler for this deployment

Parameters:

exceptionHandler - The exception handler

Returns:

isEscapeErrorMessage
```
public boolean isEscapeErrorMessage()
```

setEscapeErrorMessage
```
public DeploymentInfo setEscapeErrorMessage(boolean escapeErrorMessage)
```
Set if if the message passed to HttpServletResponse.sendError(int, String) should be escaped. If this is false applications must be careful not to use user provided data (such as the URI) in the message

Parameters:

escapeErrorMessage - If the error message should be escaped

addSessionListener

public DeploymentInfo addSessionListener(SessionListener sessionListener)

getSessionListeners

public List<SessionListener> getSessionListeners()

getAuthenticationMode

public AuthenticationMode getAuthenticationMode()

setAuthenticationMode
```
public DeploymentInfo setAuthenticationMode(AuthenticationMode authenticationMode)
```
Sets if this deployment should use pro-active authentication and always authenticate if the credentials are present or constraint driven auth which will only call the authentication mechanisms for protected resources. Pro active auth means that requests for unprotected resources will still be associated with a user, which may be useful for access logging.

Parameters:

authenticationMode - The authentication mode to use

Returns:

getDefaultMultipartConfig

public javax.servlet.MultipartConfigElement getDefaultMultipartConfig()

setDefaultMultipartConfig

public DeploymentInfo setDefaultMultipartConfig(javax.servlet.MultipartConfigElement defaultMultipartConfig)

getContentTypeCacheSize
```
public int getContentTypeCacheSize()
```

setContentTypeCacheSize

public DeploymentInfo setContentTypeCacheSize(int contentTypeCacheSize)

getSessionIdGenerator

public SessionIdGenerator getSessionIdGenerator()

setSessionIdGenerator

public DeploymentInfo setSessionIdGenerator(SessionIdGenerator sessionIdGenerator)

isSendCustomReasonPhraseOnError

public boolean isSendCustomReasonPhraseOnError()

getCrawlerSessionManagerConfig

public CrawlerSessionManagerConfig getCrawlerSessionManagerConfig()

setCrawlerSessionManagerConfig

public DeploymentInfo setCrawlerSessionManagerConfig(CrawlerSessionManagerConfig crawlerSessionManagerConfig)

setSendCustomReasonPhraseOnError
```
public DeploymentInfo setSendCustomReasonPhraseOnError(boolean sendCustomReasonPhraseOnError)
```
If this is true then the message parameter of HttpServletResponse.sendError(int, String) and HttpServletResponse.setStatus(int, String) will be used as the HTTP reason phrase in the response.

Parameters:

sendCustomReasonPhraseOnError - If the parameter to sendError should be used as a HTTP reason phrase

Returns:

this

isChangeSessionIdOnLogin

public boolean isChangeSessionIdOnLogin()

setChangeSessionIdOnLogin

public DeploymentInfo setChangeSessionIdOnLogin(boolean changeSessionIdOnLogin)

isUseCachedAuthenticationMechanism

public boolean isUseCachedAuthenticationMechanism()

setUseCachedAuthenticationMechanism
```
public DeploymentInfo setUseCachedAuthenticationMechanism(boolean useCachedAuthenticationMechanism)
```
If this is set to false the the cached authenticated session mechanism won't be installed. If you want FORM and other auth methods that require caching to work then you need to install another caching based auth method (such as SSO).

Parameters:

useCachedAuthenticationMechanism - If Undertow should use its internal authentication cache mechanism

Returns:

this

isSecurityDisabled
```
public boolean isSecurityDisabled()
```

setSecurityDisabled

public DeploymentInfo setSecurityDisabled(boolean securityDisabled)

isCheckOtherSessionManagers

public boolean isCheckOtherSessionManagers()

setCheckOtherSessionManagers
```
public DeploymentInfo setCheckOtherSessionManagers(boolean checkOtherSessionManagers)
```
If this is true then when an existing invalid session id is found all other deployments in the container will have their session managers checked to see if it represents a valid session. If it does then the session id will be re-used.

getDefaultRequestEncoding

public String getDefaultRequestEncoding()

setDefaultRequestEncoding

public DeploymentInfo setDefaultRequestEncoding(String defaultRequestEncoding)

getDefaultResponseEncoding

public String getDefaultResponseEncoding()

setDefaultResponseEncoding

public DeploymentInfo setDefaultResponseEncoding(String defaultResponseEncoding)

addPreCompressedResourceEncoding

public DeploymentInfo addPreCompressedResourceEncoding(String encoding,
                                                       String extension)

Adds a pre compressed resource encoding and maps it to a file extension

Parameters:: encoding - The content encoding; extension - The file extension
Returns:: this builder

getPreCompressedResources

public Map<String,String> getPreCompressedResources()

getContainerMajorVersion
```
public int getContainerMajorVersion()
```

setContainerMajorVersion

public DeploymentInfo setContainerMajorVersion(int containerMajorVersion)

getContainerMinorVersion
```
public int getContainerMinorVersion()
```

setContainerMinorVersion

public DeploymentInfo setContainerMinorVersion(int containerMinorVersion)

isPreservePathOnForward

public boolean isPreservePathOnForward()

setPreservePathOnForward

public void setPreservePathOnForward(boolean preservePathOnForward)

addDeploymentCompleteListener
```
public DeploymentInfo addDeploymentCompleteListener(javax.servlet.ServletContextListener servletContextListener)
```
Add's a listener that is only invoked once all other deployment steps have been completed The listeners contextDestroyed method will be called after all undeployment steps are undertaken

Parameters:

servletContextListener -

Returns:

getDeploymentCompleteListeners

public List<javax.servlet.ServletContextListener> getDeploymentCompleteListeners()

clone
```
public DeploymentInfo clone()
```
Overrides:

clone in class Object

Class DeploymentInfo

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DeploymentInfo

Method Detail

validate

getDeploymentName

setDeploymentName

getDisplayName

setDisplayName

getContextPath

setContextPath

getClassLoader

setClassLoader

getResourceManager

setResourceManager

getClassIntrospecter

setClassIntrospecter

isAllowNonStandardWrappers

setAllowNonStandardWrappers

getDefaultSessionTimeout

setDefaultSessionTimeout

getDefaultEncoding

setDefaultEncoding

getUrlEncoding

setUrlEncoding

addServlet

addServlets

addServlets

getServlets

addFilter

addFilters

addFilters

getFilters

addFilterUrlMapping

addFilterServletNameMapping

insertFilterUrlMapping

insertFilterServletNameMapping

getFilterMappings

addListener

addListeners

addListeners

getListeners

getMajorVersion

setMajorVersion

getMinorVersion

setMinorVersion

addServletContainerInitializer

addServletContainerInitalizer

addServletContainerInitializers

addServletContainerInitalizers

addServletContainerInitializers

addServletContainerInitalizers

getServletContainerInitializers

addThreadSetupAction

addThreadSetupAction

getThreadSetupActions

isEagerFilterInit

setEagerFilterInit

addInitParameter

getInitParameters

addServletContextAttribute

getServletContextAttributes

addWelcomePage

addWelcomePages

addWelcomePages

getWelcomePages

addErrorPage

addErrorPages

addErrorPages

getErrorPages

addMimeMapping

addMimeMappings

addMimeMappings

getMimeMappings

addSecurityConstraint

addSecurityConstraints

addSecurityConstraints