Top Description Methods
io.undertow.servlet.api

public Interface Deployment

Known Direct Implementers
io.undertow.servlet.core.DeploymentImpl
Imports
java.nio.charset.Charset, java.util.List, .Map, .Set, java.util.concurrent.Executor, io.undertow.security.api.AuthenticationMechanism, io.undertow.server.HttpHandler, io.undertow.server.session.SessionManager, io.undertow.servlet.core.ManagedFilters, .ApplicationListeners, .ManagedServlets, .ErrorPages, io.undertow.servlet.handlers.ServletPathMatches, io.undertow.servlet.spec.ServletContextImpl

Runtime representation of a deployment.
Author
Stuart Douglas

Method Summary

Modifier and TypeMethod and Description
public <T, C> ThreadSetupHandler.Action<T, C>
public ApplicationListeners
public Executor

Returns:

The executor used for async request dispatches. May be null in which case the XNIO worker is used
getAsyncExecutor
()

public List<AuthenticationMechanism>

Returns:

The list of authentication mechanisms configured for this deployment
getAuthenticationMechanisms
()

public Charset
getDefaultCharset()
Deprecated

public Charset
public Charset
public DeploymentInfo
public DeploymentManager.State
public ErrorPages
public Executor

Returns:

The executor used for servlet requests. May be null in which case the XNIO worker is used
getExecutor
()

public ManagedFilters
public HttpHandler
public Map<String, String>
public ServletContainer
public ServletContextImpl
public ServletDispatcher
public ServletPathMatches
public ManagedServlets
public SessionManager

Returns:

The session manager
getSessionManager
()

public Set<String>

Returns:

true if the addition was sucessful
tryAddServletMappings
(ServletInfo servletInfo, String... urlPatterns)

Attempts to add a servlet mapping using jakarta.servlet.ServletRegistration#addMapping(String...)

Method Detail

createThreadSetupActionback to summary
public <T, C> ThreadSetupHandler.Action<T, C> createThreadSetupAction(ThreadSetupHandler.Action<T, C> target)
getApplicationListenersback to summary
public ApplicationListeners getApplicationListeners()
getAsyncExecutorback to summary
public Executor getAsyncExecutor()
Returns:Executor

The executor used for async request dispatches. May be null in which case the XNIO worker is used

getAuthenticationMechanismsback to summary
public List<AuthenticationMechanism> getAuthenticationMechanisms()
Returns:List<AuthenticationMechanism>

The list of authentication mechanisms configured for this deployment

getDefaultCharsetback to summary
public Charset getDefaultCharset()

Deprecated

Annotations
@Deprecated
getDefaultRequestCharsetback to summary
public Charset getDefaultRequestCharset()
getDefaultResponseCharsetback to summary
public Charset getDefaultResponseCharset()
getDeploymentInfoback to summary
public DeploymentInfo getDeploymentInfo()
getDeploymentStateback to summary
public DeploymentManager.State getDeploymentState()
getErrorPagesback to summary
public ErrorPages getErrorPages()
getExecutorback to summary
public Executor getExecutor()
Returns:Executor

The executor used for servlet requests. May be null in which case the XNIO worker is used

getFiltersback to summary
public ManagedFilters getFilters()
getHandlerback to summary
public HttpHandler getHandler()
getMimeExtensionMappingsback to summary
public Map<String, String> getMimeExtensionMappings()
getServletContainerback to summary
public ServletContainer getServletContainer()
getServletContextback to summary
public ServletContextImpl getServletContext()
getServletDispatcherback to summary
public ServletDispatcher getServletDispatcher()
getServletPathsback to summary
public ServletPathMatches getServletPaths()
getServletsback to summary
public ManagedServlets getServlets()
getSessionManagerback to summary
public SessionManager getSessionManager()
Returns:SessionManager

The session manager

tryAddServletMappingsback to summary
public Set<String> tryAddServletMappings(ServletInfo servletInfo, String... urlPatterns)

Attempts to add a servlet mapping using jakarta.servlet.ServletRegistration#addMapping(String...)

Returns:Set<String>

true if the addition was sucessful