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)

• addServletContainerInitalizer

  public DeploymentInfo addServletContainerInitalizer(ServletContainerInitializerInfo servletContainerInitializer)

• addServletContainerInitalizers

  public DeploymentInfo addServletContainerInitalizers(ServletContainerInitializerInfo... servletContainerInitializer)

• addServletContainerInitalizers

  public DeploymentInfo addServletContainerInitalizers(List<ServletContainerInitializerInfo> servletContainerInitializer)

• 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()

• 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.

• clone

  public DeploymentInfo clone()

  Overrides:

  clone in class Object