Undertow 2.3.12.Final · io.undertow.servlet.api.DeploymentInfo

Modifier and Type	Field and Description
private boolean	allowNonStandardWrappers
private boolean	allowOrphanSession
private Executor	asyncExecutor
private final Map<String, AuthenticationMechanismFactory>	authenticationMechanisms
private AuthenticationMode	authenticationMode
private AuthorizationManager	authorizationManager
private boolean	changeSessionIdOnLogin
private boolean	checkOtherSessionManagers
private ClassIntrospecter	classIntrospecter
private ClassLoader	classLoader
private ConfidentialPortManager	confidentialPortManager
private int	containerMajorVersion
private int	containerMinorVersion
private int	contentTypeCacheSize Cache of common content types, to prevent allocations when parsing the charset
private String	contextPath
private CrawlerSessionManagerConfig	crawlerSessionManagerConfig Config for the `io.undertow.servlet.handlers.CrawlerSessionManagerHandler`
private static final int	DEFAULT_MAJOR_VERSION
private int	defaultCookieVersion
private String	defaultEncoding
private MultipartConfigElement	defaultMultipartConfig Multipart config that will be applied to all servlets that do not have an explicit config
private String	defaultRequestEncoding
private String	defaultResponseEncoding
private DefaultServletConfig	defaultServletConfig References Deprecated `DefaultServletConfig` is deprecated or references (maybe indirectly) at least one deprecated element.
private int	defaultSessionTimeout
private boolean	denyUncoveredHttpMethods
private final List<ServletContextListener>	deploymentCompleteListeners
private String	deploymentName
private boolean	disableCachingForSecuredPages
private String	displayName
private boolean	eagerFilterInit
private final List<ErrorPage>	errorPages
private boolean	escapeErrorMessage
private ExceptionHandler	exceptionHandler
private Executor	executor
private final Map<String, FilterInfo>	filters
private final List<FilterMappingInfo>	filterServletNameMappings
private final List<FilterMappingInfo>	filterUrlMappings
private String	hostName
private IdentityManager	identityManager
private boolean	ignoreFlush
private final List<HandlerWrapper>	initialHandlerChainWrappers Wrappers that are applied before the servlet initial handler, and before any servlet related object have been created.
private HandlerWrapper	initialSecurityWrapper A handler chain wrapper to wrap the initial stages of the security handlers, if this is set it is assumed it is taking over the responsibility of setting the `io.undertow.security.api.SecurityContext` that can handle authentication and the remaining Undertow handlers specific to authentication will be skipped.
private final Map<String, String>	initParameters
private final List<HandlerWrapper>	innerHandlerChainWrappers Handler chain wrappers that are applied just before the servlet request is dispatched.
private boolean	invalidateSessionOnLogout
private AuthenticationMechanism	jaspiAuthenticationMechanism
private JspConfigDescriptor	jspConfigDescriptor
private final List<LifecycleInterceptor>	lifecycleInterceptors
private final List<ListenerInfo>	listeners
private final Map<String, String>	localeCharsetMapping
private LoginConfig	loginConfig
private int	majorVersion
private MetricsCollector	metricsCollector
private final List<MimeMapping>	mimeMappings
private int	minorVersion
private final List<NotificationReceiver>	notificationReceivers
private final List<HandlerWrapper>	outerHandlerChainWrappers Handler chain wrappers that are applied outside all other handlers, including security but after the initial servlet handler.
private final Map<String, String>	preCompressedResources A map of content encoding to file extension for pre compressed resource (e.g. gzip -> .gz)
private boolean	preservePathOnForward
private final Map<String, Set<String>>	principalVersusRolesMap map of additional roles that should be applied to the given principal.
private ResourceManager	resourceManager
private final List<SecurityConstraint>	securityConstraints
private SecurityContextFactory	securityContextFactory References Deprecated `SecurityContextFactory` is deprecated or references (maybe indirectly) at least one deprecated element.
private boolean	securityDisabled
private final Set<String>	securityRoles
private final List<HandlerWrapper>	securityWrappers Handler chain wrappers that are applied just before the authentication mechanism is called.
private boolean	sendCustomReasonPhraseOnError
private String	serverName
private final List<ServletContainerInitializerInfo>	servletContainerInitializers
private ConcurrentMap<String, Object>	servletContextAttributeBackingMap
private final Map<String, Object>	servletContextAttributes
private final List<ServletExtension>	servletExtensions additional servlet extensions
private final Map<String, ServletInfo>	servlets
private ServletSessionConfig	servletSessionConfig
private ServletStackTraces	servletStackTraces
private SessionConfigWrapper	sessionConfigWrapper
private SessionIdGenerator	sessionIdGenerator
private final List<SessionListener>	sessionListeners
private SessionManagerFactory	sessionManagerFactory
private SessionPersistenceManager	sessionPersistenceManager
private Path	tempDir
private final List<ThreadSetupHandler>	threadSetupActions
private String	urlEncoding
private boolean	useCachedAuthenticationMechanism
private final List<String>	welcomePages

Access	Constructor and Description
public	DeploymentInfo()

Method Summary

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

Inherited from java.lang.Object:: equals finalize getClass hashCode notify notifyAll toString wait wait wait

public Class DeploymentInfo

Field Summary

Constructor Summary

Method Summary