Top Description Fields Constructors Methods
io.undertow.servlet.core

public Class DeploymentImpl

extends Object
implements Deployment
Class Inheritance
All Implemented Interfaces
io.undertow.servlet.api.Deployment
Imports
java.nio.charset.Charset, .StandardCharsets, java.util.ArrayList, .Arrays, .Collection, .Collections, .HashMap, .HashSet, .List, .Map, .Set, java.util.concurrent.Executor, io.undertow.security.api.AuthenticationMechanism, io.undertow.server.HttpHandler, io.undertow.server.session.SessionManager, io.undertow.servlet.api.Deployment, .DeploymentInfo, .DeploymentManager, .ServletContainer, .ServletDispatcher, .ServletInfo, .ThreadSetupHandler, io.undertow.servlet.handlers.ServletInitialHandler, .ServletPathMatches, io.undertow.servlet.spec.ServletContextImpl

Class that represents the mutable state associated with a servlet deployment that is built up during the bootstrap process.

Classes calling deployment methods during bootstrap must be aware of ordering concerns.

Author
Stuart Douglas

Field Summary

Modifier and TypeField and Description
private volatile ApplicationListeners
private volatile List<AuthenticationMechanism>
private volatile Charset
defaultCharset

Deprecated
private volatile Charset
private volatile Charset
private final DeploymentInfo
private final DeploymentManager
private volatile ErrorPages
private Set<String>
existingUrlPatterns

user for tryAddServletMappings(ServletInfo, String...) https://issues.jboss.org/browse/UNDERTOW-1418

private final ManagedFilters
private volatile HttpHandler
private final List<Lifecycle>
private volatile Map<String, String>
private final ServletContainer
private volatile ServletContextImpl
private volatile ServletInitialHandler
private final ServletPathMatches
private final ManagedServlets
private volatile SessionManager
private volatile List<ThreadSetupHandler>

Constructor Summary

AccessConstructor and Description
public
DeploymentImpl(DeploymentManager deploymentManager, final DeploymentInfo deploymentInfo, ServletContainer servletContainer)

Method Summary

Modifier and TypeMethod and Description
pack-priv void
pack-priv void
addLifecycleObjects(final Lifecycle... objects)

public <C, T> ThreadSetupHandler.Action<C, T>
pack-priv void
public ApplicationListeners
public Executor
public List<AuthenticationMechanism>
public Charset
public Charset
public Charset
public DeploymentInfo
public DeploymentManager.State
public ErrorPages
public Executor
public ManagedFilters
public HttpHandler
public List<Lifecycle>
public Map<String, String>
public ServletContainer
public ServletContextImpl
public ServletDispatcher
public ServletPathMatches
public ManagedServlets
public SessionManager
pack-priv void
setApplicationListeners(final ApplicationListeners applicationListeners)

public void
public void
setDefaultCharset(Charset defaultCharset)
Deprecated

public void
setDefaultRequestCharset(Charset defaultRequestCharset)

public void
setDefaultResponseCharset(Charset defaultResponseCharset)

public void
setErrorPages(final ErrorPages errorPages)

public void
setInitialHandler(final HttpHandler initialHandler)

public void
setMimeExtensionMappings(final Map<String, String> mimeExtensionMappings)

pack-priv void
setServletContext(final ServletContextImpl servletContext)

pack-priv void
pack-priv void
setSessionManager(final SessionManager sessionManager)

pack-priv void
public Set<String>
Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

applicationListenersback to summary
private volatile ApplicationListeners applicationListeners
authenticationMechanismsback to summary
private volatile List<AuthenticationMechanism> authenticationMechanisms
defaultCharsetback to summary
private volatile Charset defaultCharset

Deprecated

Annotations
@Deprecated
defaultRequestCharsetback to summary
private volatile Charset defaultRequestCharset
defaultResponseCharsetback to summary
private volatile Charset defaultResponseCharset
deploymentInfoback to summary
private final DeploymentInfo deploymentInfo
deploymentManagerback to summary
private final DeploymentManager deploymentManager
errorPagesback to summary
private volatile ErrorPages errorPages
existingUrlPatternsback to summary
private Set<String> existingUrlPatterns

user for tryAddServletMappings(ServletInfo, String...) https://issues.jboss.org/browse/UNDERTOW-1418

filtersback to summary
private final ManagedFilters filters
initialHandlerback to summary
private volatile HttpHandler initialHandler
lifecycleObjectsback to summary
private final List<Lifecycle> lifecycleObjects
mimeExtensionMappingsback to summary
private volatile Map<String, String> mimeExtensionMappings
servletContainerback to summary
private final ServletContainer servletContainer
servletContextback to summary
private volatile ServletContextImpl servletContext
servletHandlerback to summary
private volatile ServletInitialHandler servletHandler
servletPathsback to summary
private final ServletPathMatches servletPaths
servletsback to summary
private final ManagedServlets servlets
sessionManagerback to summary
private volatile SessionManager sessionManager
threadSetupActionsback to summary
private volatile List<ThreadSetupHandler> threadSetupActions

Constructor Detail

DeploymentImplback to summary
public DeploymentImpl(DeploymentManager deploymentManager, final DeploymentInfo deploymentInfo, ServletContainer servletContainer)

Method Detail

addLifecycleObjectsback to summary
pack-priv void addLifecycleObjects(final Collection<Lifecycle> objects)
addLifecycleObjectsback to summary
pack-priv void addLifecycleObjects(final Lifecycle... objects)
createThreadSetupActionback to summary
public <C, T> ThreadSetupHandler.Action<C, T> createThreadSetupAction(ThreadSetupHandler.Action<C, T> target)

Implements io.undertow.servlet.api.Deployment.createThreadSetupAction.

destroyback to summary
pack-priv void destroy()
getApplicationListenersback to summary
public ApplicationListeners getApplicationListeners()

Implements io.undertow.servlet.api.Deployment.getApplicationListeners.

Annotations
@Override
getAsyncExecutorback to summary
public Executor getAsyncExecutor()

Implements io.undertow.servlet.api.Deployment.getAsyncExecutor.

Returns:Executor

Doc from io.undertow.servlet.api.Deployment.getAsyncExecutor.

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

Annotations
@Override
getAuthenticationMechanismsback to summary
public List<AuthenticationMechanism> getAuthenticationMechanisms()

Implements io.undertow.servlet.api.Deployment.getAuthenticationMechanisms.

Returns:List<AuthenticationMechanism>

Doc from io.undertow.servlet.api.Deployment.getAuthenticationMechanisms.

The list of authentication mechanisms configured for this deployment

Annotations
@Override
getDefaultCharsetback to summary
public Charset getDefaultCharset()

Implements io.undertow.servlet.api.Deployment.getDefaultCharset.

Deprecated

Annotations
@Deprecated
getDefaultRequestCharsetback to summary
public Charset getDefaultRequestCharset()

Implements io.undertow.servlet.api.Deployment.getDefaultRequestCharset.

Annotations
@Override
getDefaultResponseCharsetback to summary
public Charset getDefaultResponseCharset()

Implements io.undertow.servlet.api.Deployment.getDefaultResponseCharset.

Annotations
@Override
getDeploymentInfoback to summary
public DeploymentInfo getDeploymentInfo()

Implements io.undertow.servlet.api.Deployment.getDeploymentInfo.

Annotations
@Override
getDeploymentStateback to summary
public DeploymentManager.State getDeploymentState()

Implements io.undertow.servlet.api.Deployment.getDeploymentState.

Annotations
@Override
getErrorPagesback to summary
public ErrorPages getErrorPages()

Implements io.undertow.servlet.api.Deployment.getErrorPages.

getExecutorback to summary
public Executor getExecutor()

Implements io.undertow.servlet.api.Deployment.getExecutor.

Returns:Executor

Doc from io.undertow.servlet.api.Deployment.getExecutor.

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

Annotations
@Override
getFiltersback to summary
public ManagedFilters getFilters()

Implements io.undertow.servlet.api.Deployment.getFilters.

getHandlerback to summary
public HttpHandler getHandler()

Implements io.undertow.servlet.api.Deployment.getHandler.

Annotations
@Override
getLifecycleObjectsback to summary
public List<Lifecycle> getLifecycleObjects()
getMimeExtensionMappingsback to summary
public Map<String, String> getMimeExtensionMappings()

Implements io.undertow.servlet.api.Deployment.getMimeExtensionMappings.

Annotations
@Override
getServletContainerback to summary
public ServletContainer getServletContainer()

Implements io.undertow.servlet.api.Deployment.getServletContainer.

Annotations
@Override
getServletContextback to summary
public ServletContextImpl getServletContext()

Implements io.undertow.servlet.api.Deployment.getServletContext.

Annotations
@Override
getServletDispatcherback to summary
public ServletDispatcher getServletDispatcher()

Implements io.undertow.servlet.api.Deployment.getServletDispatcher.

Annotations
@Override
getServletPathsback to summary
public ServletPathMatches getServletPaths()

Implements io.undertow.servlet.api.Deployment.getServletPaths.

Annotations
@Override
getServletsback to summary
public ManagedServlets getServlets()

Implements io.undertow.servlet.api.Deployment.getServlets.

getSessionManagerback to summary
public SessionManager getSessionManager()

Implements io.undertow.servlet.api.Deployment.getSessionManager.

Returns:SessionManager

Doc from io.undertow.servlet.api.Deployment.getSessionManager.

The session manager

Annotations
@Override
setApplicationListenersback to summary
pack-priv void setApplicationListeners(final ApplicationListeners applicationListeners)
setAuthenticationMechanismsback to summary
public void setAuthenticationMechanisms(List<AuthenticationMechanism> authenticationMechanisms)
setDefaultCharsetback to summary
public void setDefaultCharset(Charset defaultCharset)

Deprecated

Annotations
@Deprecated
setDefaultRequestCharsetback to summary
public void setDefaultRequestCharset(Charset defaultRequestCharset)
setDefaultResponseCharsetback to summary
public void setDefaultResponseCharset(Charset defaultResponseCharset)
setErrorPagesback to summary
public void setErrorPages(final ErrorPages errorPages)
setInitialHandlerback to summary
public void setInitialHandler(final HttpHandler initialHandler)
setMimeExtensionMappingsback to summary
public void setMimeExtensionMappings(final Map<String, String> mimeExtensionMappings)
setServletContextback to summary
pack-priv void setServletContext(final ServletContextImpl servletContext)
setServletHandlerback to summary
pack-priv void setServletHandler(final ServletInitialHandler servletHandler)
setSessionManagerback to summary
pack-priv void setSessionManager(final SessionManager sessionManager)
setThreadSetupActionsback to summary
pack-priv void setThreadSetupActions(List<ThreadSetupHandler> threadSetupActions)
tryAddServletMappingsback to summary
public Set<String> tryAddServletMappings(ServletInfo servletInfo, String... urlPatterns)

Implements io.undertow.servlet.api.Deployment.tryAddServletMappings.

Doc from io.undertow.servlet.api.Deployment.tryAddServletMappings.

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

Returns:Set<String>

true if the addition was sucessful

Annotations
@Override