io.undertow.servlet.api

Class DeploymentInfo

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

Method Summary

Methods

Modifier and Type	Method and Description
DeploymentInfo	addAuthenticationMechanism(AuthenticationMechanism mechanism)
DeploymentInfo	addAuthenticationMechanisms(AuthenticationMechanism... mechanisms)
DeploymentInfo	addAuthenticationMechanisms(Collection<AuthenticationMechanism> mechanisms)
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	addInitialHandlerChainWrapper(HandlerWrapper wrapper)
DeploymentInfo	addInitParameter(String name, String value)
DeploymentInfo	addInnerHandlerChainWrapper(HandlerWrapper wrapper) Adds an inner handler chain wrapper.
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.
void	addPrincipalVsRoleMapping(String principal, String mapping)
void	addPrincipalVsRoleMappings(String principal, Collection<String> mappings)
void	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	addServlet(ServletInfo servlet)
DeploymentInfo	addServletContainerInitalizer(ServletContainerInitializerInfo servletContainerInitializer)
DeploymentInfo	addServletContainerInitalizers(List<ServletContainerInitializerInfo> servletContainerInitializer)
DeploymentInfo	addServletContainerInitalizers(ServletContainerInitializerInfo... servletContainerInitializer)
DeploymentInfo	addServletContextAttribute(String name, Object value)
DeploymentInfo	addServlets(Collection<ServletInfo> servlets)
DeploymentInfo	addServlets(ServletInfo... servlets)
DeploymentInfo	addThreadSetupAction(ThreadSetupAction action)
DeploymentInfo	addWelcomePage(String welcomePage)
DeploymentInfo	addWelcomePages(Collection<String> welcomePages)
DeploymentInfo	addWelcomePages(String... welcomePages)
DeploymentInfo	clone()
List<AuthenticationMechanism>	getAdditionalAuthenticationMechanisms()
Executor	getAsyncExecutor()
ClassIntrospecter	getClassIntrospecter()
ClassLoader	getClassLoader()
ConfidentialPortManager	getConfidentialPortManager()
String	getContextPath()
int	getDefaultCookieVersion()
DefaultServletConfig	getDefaultServletConfig()
int	getDefaultSessionTimeout()
String	getDeploymentName()
String	getDisplayName()
List<ErrorPage>	getErrorPages()
Executor	getExecutor()
List<FilterMappingInfo>	getFilterMappings()
Map<String,FilterInfo>	getFilters()
String	getHostName()
IdentityManager	getIdentityManager()
List<HandlerWrapper>	getInitialHandlerChainWrappers()
Map<String,String>	getInitParameters()
List<HandlerWrapper>	getInnerHandlerChainWrappers()
javax.servlet.descriptor.JspConfigDescriptor	getJspConfigDescriptor()
List<ListenerInfo>	getListeners()
Map<String,String>	getLocaleCharsetMapping()
LoginConfig	getLoginConfig()
int	getMajorVersion()
List<MimeMapping>	getMimeMappings()
int	getMinorVersion()
List<NotificationReceiver>	getNotificationReceivers()
List<HandlerWrapper>	getOuterHandlerChainWrappers()
Map<String,Set<String>>	getPrincipalVersusRolesMap()
ResourceManager	getResourceManager()
List<SecurityConstraint>	getSecurityConstraints()
Set<String>	getSecurityRoles()
List<ServletContainerInitializerInfo>	getServletContainerInitializers()
ConcurrentMap<String,Object>	getServletContextAttributeBackingMap()
Map<String,Object>	getServletContextAttributes()
Map<String,ServletInfo>	getServlets()
ServletSessionConfig	getServletSessionConfig()
ServletStackTraces	getServletStackTraces()
SessionManagerFactory	getSessionManagerFactory()
SessionPersistenceManager	getSessionPersistenceManager()
File	getTempDir()
List<ThreadSetupAction>	getThreadSetupActions()
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	isDenyUncoveredHttpMethods()
boolean	isIgnoreStandardAuthenticationMechanism()
boolean	isInvalidateSessionOnLogout()
DeploymentInfo	setAllowNonStandardWrappers(boolean allowNonStandardWrappers)
void	setAsyncExecutor(Executor asyncExecutor) Sets the executor that is used to run async tasks.
DeploymentInfo	setClassIntrospecter(ClassIntrospecter classIntrospecter)
DeploymentInfo	setClassLoader(ClassLoader classLoader)
DeploymentInfo	setConfidentialPortManager(ConfidentialPortManager confidentialPortManager)
DeploymentInfo	setContextPath(String contextPath)
void	setDefaultCookieVersion(int defaultCookieVersion)
DeploymentInfo	setDefaultServletConfig(DefaultServletConfig defaultServletConfig)
void	setDefaultSessionTimeout(int defaultSessionTimeout)
void	setDenyUncoveredHttpMethods(boolean denyUncoveredHttpMethods)
DeploymentInfo	setDeploymentName(String deploymentName)
void	setDisplayName(String displayName)
void	setExecutor(Executor executor) Sets the executor that will be used to run servlet invocations.
DeploymentInfo	setHostName(String hostName)
DeploymentInfo	setIdentityManager(IdentityManager identityManager)
DeploymentInfo	setIgnoreStandardAuthenticationMechanism(boolean ignoreStandardAuthenticationMechanism)
void	setInvalidateSessionOnLogout(boolean invalidateSessionOnLogout)
void	setJspConfigDescriptor(javax.servlet.descriptor.JspConfigDescriptor jspConfigDescriptor)
DeploymentInfo	setLoginConfig(LoginConfig loginConfig)
DeploymentInfo	setMajorVersion(int majorVersion)
DeploymentInfo	setMinorVersion(int minorVersion)
DeploymentInfo	setResourceManager(ResourceManager resourceManager)
void	setServletContextAttributeBackingMap(ConcurrentMap<String,Object> servletContextAttributeBackingMap) Sets the map that will be used by the ServletContext implementation to store attributes.
void	setServletSessionConfig(ServletSessionConfig servletSessionConfig)
DeploymentInfo	setServletStackTraces(ServletStackTraces servletStackTraces)
DeploymentInfo	setSessionManagerFactory(SessionManagerFactory sessionManagerFactory)
DeploymentInfo	setSessionPersistenceManager(SessionPersistenceManager sessionPersistenceManager)
void	setTempDir(File tempDir)
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 void 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 void setDefaultSessionTimeout(int defaultSessionTimeout)

Parameters:

defaultSessionTimeout - The default session timeout, in seconds

isIgnoreStandardAuthenticationMechanism

public boolean isIgnoreStandardAuthenticationMechanism()

Returns:

true If the authentication mechanism specified in web.xml should not be used

setIgnoreStandardAuthenticationMechanism

public DeploymentInfo setIgnoreStandardAuthenticationMechanism(boolean ignoreStandardAuthenticationMechanism)

Parameters:

ignoreStandardAuthenticationMechanism - If the authentication mechanism specified in web.xml should be ignored

addAuthenticationMechanism

public DeploymentInfo addAuthenticationMechanism(AuthenticationMechanism mechanism)

addAuthenticationMechanisms

public DeploymentInfo addAuthenticationMechanisms(AuthenticationMechanism... mechanisms)

addAuthenticationMechanisms

public DeploymentInfo addAuthenticationMechanisms(Collection<AuthenticationMechanism> mechanisms)

getAdditionalAuthenticationMechanisms

public List<AuthenticationMechanism> getAdditionalAuthenticationMechanisms()

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

public DeploymentInfo addThreadSetupAction(ThreadSetupAction action)

getThreadSetupActions

public List<ThreadSetupAction> getThreadSetupActions()

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

setTempDir

public void setTempDir(File tempDir)

getJspConfigDescriptor

public javax.servlet.descriptor.JspConfigDescriptor getJspConfigDescriptor()

setJspConfigDescriptor

public void 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()

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 void 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 void setServletSessionConfig(ServletSessionConfig servletSessionConfig)

getHostName

public String getHostName()

Returns:

the host name

setHostName

public DeploymentInfo setHostName(String hostName)

isDenyUncoveredHttpMethods

public boolean isDenyUncoveredHttpMethods()

setDenyUncoveredHttpMethods

public void setDenyUncoveredHttpMethods(boolean denyUncoveredHttpMethods)

getServletStackTraces

public ServletStackTraces getServletStackTraces()

setServletStackTraces

public DeploymentInfo setServletStackTraces(ServletStackTraces servletStackTraces)

isInvalidateSessionOnLogout

public boolean isInvalidateSessionOnLogout()

setInvalidateSessionOnLogout

public void setInvalidateSessionOnLogout(boolean invalidateSessionOnLogout)

getDefaultCookieVersion

public int getDefaultCookieVersion()

setDefaultCookieVersion

public void setDefaultCookieVersion(int defaultCookieVersion)

getSessionPersistenceManager

public SessionPersistenceManager getSessionPersistenceManager()

setSessionPersistenceManager

public DeploymentInfo setSessionPersistenceManager(SessionPersistenceManager sessionPersistenceManager)

addPrincipalVsRoleMapping

public void addPrincipalVsRoleMapping(String principal,
                             String mapping)

addPrincipalVsRoleMappings

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

addPrincipalVsRoleMappings

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

getPrincipalVersusRolesMap

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

clone

public DeploymentInfo clone()

Overrides:

clone in class Object