Constructor and Description |
---|
DeploymentInfo() |
public void validate()
public String getDeploymentName()
public DeploymentInfo setDeploymentName(String deploymentName)
public String getDisplayName()
public DeploymentInfo setDisplayName(String displayName)
public String getContextPath()
public DeploymentInfo setContextPath(String contextPath)
public ClassLoader getClassLoader()
public DeploymentInfo setClassLoader(ClassLoader classLoader)
public ResourceManager getResourceManager()
public DeploymentInfo setResourceManager(ResourceManager resourceManager)
public ClassIntrospecter getClassIntrospecter()
public DeploymentInfo setClassIntrospecter(ClassIntrospecter classIntrospecter)
public boolean isAllowNonStandardWrappers()
public DeploymentInfo setAllowNonStandardWrappers(boolean allowNonStandardWrappers)
public int getDefaultSessionTimeout()
public DeploymentInfo setDefaultSessionTimeout(int defaultSessionTimeout)
defaultSessionTimeout
- The default session timeout, in secondspublic String getDefaultEncoding()
public DeploymentInfo setDefaultEncoding(String defaultEncoding)
defaultEncoding
- The default encodingpublic String getUrlEncoding()
public DeploymentInfo setUrlEncoding(String urlEncoding)
UndertowOptions.DECODE_URL
parameter has been set to false. This allows multiple deployments in the same server to use a different URL encodingurlEncoding
- The encoding to usepublic DeploymentInfo addServlet(ServletInfo servlet)
public DeploymentInfo addServlets(ServletInfo... servlets)
public DeploymentInfo addServlets(Collection<ServletInfo> servlets)
public Map<String,ServletInfo> getServlets()
public DeploymentInfo addFilter(FilterInfo filter)
public DeploymentInfo addFilters(FilterInfo... filters)
public DeploymentInfo addFilters(Collection<FilterInfo> filters)
public Map<String,FilterInfo> getFilters()
public DeploymentInfo addFilterUrlMapping(String filterName, String mapping, javax.servlet.DispatcherType dispatcher)
public DeploymentInfo addFilterServletNameMapping(String filterName, String mapping, javax.servlet.DispatcherType dispatcher)
public DeploymentInfo insertFilterUrlMapping(int pos, String filterName, String mapping, javax.servlet.DispatcherType dispatcher)
public DeploymentInfo insertFilterServletNameMapping(int pos, String filterName, String mapping, javax.servlet.DispatcherType dispatcher)
public List<FilterMappingInfo> getFilterMappings()
public DeploymentInfo addListener(ListenerInfo listener)
public DeploymentInfo addListeners(ListenerInfo... listeners)
public DeploymentInfo addListeners(Collection<ListenerInfo> listeners)
public List<ListenerInfo> getListeners()
public int getMajorVersion()
public DeploymentInfo setMajorVersion(int majorVersion)
public int getMinorVersion()
public DeploymentInfo setMinorVersion(int minorVersion)
public DeploymentInfo addServletContainerInitializer(ServletContainerInitializerInfo servletContainerInitializer)
@Deprecated public DeploymentInfo addServletContainerInitalizer(ServletContainerInitializerInfo servletContainerInitializer)
public DeploymentInfo addServletContainerInitializers(ServletContainerInitializerInfo... servletContainerInitializer)
@Deprecated public DeploymentInfo addServletContainerInitalizers(ServletContainerInitializerInfo... servletContainerInitializer)
public DeploymentInfo addServletContainerInitializers(List<ServletContainerInitializerInfo> servletContainerInitializer)
@Deprecated public DeploymentInfo addServletContainerInitalizers(List<ServletContainerInitializerInfo> servletContainerInitializers)
public List<ServletContainerInitializerInfo> getServletContainerInitializers()
@Deprecated public DeploymentInfo addThreadSetupAction(ThreadSetupAction action)
public DeploymentInfo addThreadSetupAction(ThreadSetupHandler action)
public List<ThreadSetupHandler> getThreadSetupActions()
public boolean isEagerFilterInit()
public DeploymentInfo setEagerFilterInit(boolean eagerFilterInit)
public DeploymentInfo addInitParameter(String name, String value)
public DeploymentInfo addServletContextAttribute(String name, Object value)
public DeploymentInfo addWelcomePage(String welcomePage)
public DeploymentInfo addWelcomePages(String... welcomePages)
public DeploymentInfo addWelcomePages(Collection<String> welcomePages)
public DeploymentInfo addErrorPage(ErrorPage errorPage)
public DeploymentInfo addErrorPages(ErrorPage... errorPages)
public DeploymentInfo addErrorPages(Collection<ErrorPage> errorPages)
public DeploymentInfo addMimeMapping(MimeMapping mimeMappings)
public DeploymentInfo addMimeMappings(MimeMapping... mimeMappings)
public DeploymentInfo addMimeMappings(Collection<MimeMapping> mimeMappings)
public List<MimeMapping> getMimeMappings()
public DeploymentInfo addSecurityConstraint(SecurityConstraint securityConstraint)
public DeploymentInfo addSecurityConstraints(SecurityConstraint... securityConstraints)
public DeploymentInfo addSecurityConstraints(Collection<SecurityConstraint> securityConstraints)
public List<SecurityConstraint> getSecurityConstraints()
public Executor getExecutor()
public DeploymentInfo setExecutor(Executor executor)
Individual servlets may use a different executor
If this is null then the current executor is used, which is generally the XNIO worker pool
executor
- The executorServletInfo.executor
public Executor getAsyncExecutor()
public DeploymentInfo setAsyncExecutor(Executor asyncExecutor)
If this is null then executor
is used, if this is also null then the default is used
asyncExecutor
- The executorpublic File getTempDir()
public Path getTempPath()
public Path requireTempPath()
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
public DeploymentInfo setTempDir(File tempDir)
public DeploymentInfo setTempDir(Path tempDir)
public boolean isIgnoreFlush()
public DeploymentInfo setIgnoreFlush(boolean ignoreFlush)
public javax.servlet.descriptor.JspConfigDescriptor getJspConfigDescriptor()
public DeploymentInfo setJspConfigDescriptor(javax.servlet.descriptor.JspConfigDescriptor jspConfigDescriptor)
public DefaultServletConfig getDefaultServletConfig()
public DeploymentInfo setDefaultServletConfig(DefaultServletConfig defaultServletConfig)
public DeploymentInfo addLocaleCharsetMapping(String locale, String charset)
public SessionManagerFactory getSessionManagerFactory()
public DeploymentInfo setSessionManagerFactory(SessionManagerFactory sessionManagerFactory)
public LoginConfig getLoginConfig()
public DeploymentInfo setLoginConfig(LoginConfig loginConfig)
public IdentityManager getIdentityManager()
public DeploymentInfo setIdentityManager(IdentityManager identityManager)
public ConfidentialPortManager getConfidentialPortManager()
public DeploymentInfo setConfidentialPortManager(ConfidentialPortManager confidentialPortManager)
public DeploymentInfo addSecurityRole(String role)
public DeploymentInfo addSecurityRoles(String... roles)
public DeploymentInfo addSecurityRoles(Collection<String> roles)
public DeploymentInfo addOuterHandlerChainWrapper(HandlerWrapper wrapper)
wrapper
- The wrapperpublic List<HandlerWrapper> getOuterHandlerChainWrappers()
public DeploymentInfo addInnerHandlerChainWrapper(HandlerWrapper wrapper)
wrapper
- The wrapperpublic List<HandlerWrapper> getInnerHandlerChainWrappers()
public DeploymentInfo addInitialHandlerChainWrapper(HandlerWrapper wrapper)
public List<HandlerWrapper> getInitialHandlerChainWrappers()
public DeploymentInfo setInitialSecurityWrapper(HandlerWrapper wrapper)
SecurityContext.authenticate()
as required.wrapper
- the HandlerWrapper
to handle the initial security context installation.this
to allow chaining.public HandlerWrapper getInitialSecurityWrapper()
public DeploymentInfo addSecurityWrapper(HandlerWrapper wrapper)
wrapper
- public List<HandlerWrapper> getSecurityWrappers()
public DeploymentInfo addNotificationReceiver(NotificationReceiver notificationReceiver)
public DeploymentInfo addNotificactionReceivers(NotificationReceiver... notificationReceivers)
public DeploymentInfo addNotificationReceivers(Collection<NotificationReceiver> notificationReceivers)
public List<NotificationReceiver> getNotificationReceivers()
public ConcurrentMap<String,Object> getServletContextAttributeBackingMap()
public DeploymentInfo setServletContextAttributeBackingMap(ConcurrentMap<String,Object> servletContextAttributeBackingMap)
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.
servletContextAttributeBackingMap
- The backing mappublic ServletSessionConfig getServletSessionConfig()
public DeploymentInfo setServletSessionConfig(ServletSessionConfig servletSessionConfig)
public String getHostName()
public DeploymentInfo setHostName(String hostName)
public boolean isDenyUncoveredHttpMethods()
public DeploymentInfo setDenyUncoveredHttpMethods(boolean denyUncoveredHttpMethods)
public ServletStackTraces getServletStackTraces()
public DeploymentInfo setServletStackTraces(ServletStackTraces servletStackTraces)
public boolean isInvalidateSessionOnLogout()
public DeploymentInfo setInvalidateSessionOnLogout(boolean invalidateSessionOnLogout)
public int getDefaultCookieVersion()
public DeploymentInfo setDefaultCookieVersion(int defaultCookieVersion)
public SessionPersistenceManager getSessionPersistenceManager()
public DeploymentInfo setSessionPersistenceManager(SessionPersistenceManager sessionPersistenceManager)
public AuthorizationManager getAuthorizationManager()
public DeploymentInfo setAuthorizationManager(AuthorizationManager authorizationManager)
public DeploymentInfo addPrincipalVsRoleMapping(String principal, String mapping)
public DeploymentInfo addPrincipalVsRoleMappings(String principal, String... mappings)
public DeploymentInfo addPrincipalVsRoleMappings(String principal, Collection<String> mappings)
public DeploymentInfo clearLoginMethods()
public DeploymentInfo addFirstAuthenticationMechanism(String name, AuthenticationMechanism mechanism)
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()
.name
- The authentication mechanism namemechanism
- The mechanismpublic DeploymentInfo addLastAuthenticationMechanism(String name, AuthenticationMechanism mechanism)
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()
.name
- The authentication mechanism namemechanism
- The mechanismpublic DeploymentInfo addAuthenticationMechanism(String name, AuthenticationMechanismFactory factory)
name
- The namefactory
- The factorypublic Map<String,AuthenticationMechanismFactory> getAuthenticationMechanisms()
public boolean isAuthenticationMechanismPresent(String mechanismName)
mechanismName
- The mechanism namepublic DeploymentInfo addServletExtension(ServletExtension servletExtension)
servletExtension
- The servlet extensionpublic List<ServletExtension> getServletExtensions()
public AuthenticationMechanism getJaspiAuthenticationMechanism()
public DeploymentInfo setJaspiAuthenticationMechanism(AuthenticationMechanism jaspiAuthenticationMechanism)
public SecurityContextFactory getSecurityContextFactory()
public DeploymentInfo setSecurityContextFactory(SecurityContextFactory securityContextFactory)
public String getServerName()
public DeploymentInfo setServerName(String serverName)
public DeploymentInfo setMetricsCollector(MetricsCollector metricsCollector)
public MetricsCollector getMetricsCollector()
public SessionConfigWrapper getSessionConfigWrapper()
public DeploymentInfo setSessionConfigWrapper(SessionConfigWrapper sessionConfigWrapper)
public boolean isDisableCachingForSecuredPages()
public DeploymentInfo setDisableCachingForSecuredPages(boolean disableCachingForSecuredPages)
public DeploymentInfo addLifecycleInterceptor(LifecycleInterceptor interceptor)
public List<LifecycleInterceptor> getLifecycleInterceptors()
public ExceptionHandler getExceptionHandler()
public DeploymentInfo setExceptionHandler(ExceptionHandler exceptionHandler)
exceptionHandler
- The exception handlerpublic boolean isEscapeErrorMessage()
public DeploymentInfo setEscapeErrorMessage(boolean escapeErrorMessage)
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 messageescapeErrorMessage
- If the error message should be escapedpublic DeploymentInfo addSessionListener(SessionListener sessionListener)
public List<SessionListener> getSessionListeners()
public AuthenticationMode getAuthenticationMode()
public DeploymentInfo setAuthenticationMode(AuthenticationMode authenticationMode)
authenticationMode
- The authentication mode to usepublic javax.servlet.MultipartConfigElement getDefaultMultipartConfig()
public DeploymentInfo setDefaultMultipartConfig(javax.servlet.MultipartConfigElement defaultMultipartConfig)
public int getContentTypeCacheSize()
public DeploymentInfo setContentTypeCacheSize(int contentTypeCacheSize)
public SessionIdGenerator getSessionIdGenerator()
public DeploymentInfo setSessionIdGenerator(SessionIdGenerator sessionIdGenerator)
public boolean isSendCustomReasonPhraseOnError()
public CrawlerSessionManagerConfig getCrawlerSessionManagerConfig()
public DeploymentInfo setCrawlerSessionManagerConfig(CrawlerSessionManagerConfig crawlerSessionManagerConfig)
public DeploymentInfo setSendCustomReasonPhraseOnError(boolean sendCustomReasonPhraseOnError)
HttpServletResponse.sendError(int, String)
and HttpServletResponse.setStatus(int, String)
will be used as the HTTP reason phrase in the response.sendCustomReasonPhraseOnError
- If the parameter to sendError should be used as a HTTP reason phrasepublic boolean isChangeSessionIdOnLogin()
public DeploymentInfo setChangeSessionIdOnLogin(boolean changeSessionIdOnLogin)
public boolean isUseCachedAuthenticationMechanism()
public DeploymentInfo setUseCachedAuthenticationMechanism(boolean useCachedAuthenticationMechanism)
useCachedAuthenticationMechanism
- If Undertow should use its internal authentication cache mechanismpublic boolean isSecurityDisabled()
public DeploymentInfo setSecurityDisabled(boolean securityDisabled)
public boolean isCheckOtherSessionManagers()
public DeploymentInfo setCheckOtherSessionManagers(boolean checkOtherSessionManagers)
public String getDefaultRequestEncoding()
public DeploymentInfo setDefaultRequestEncoding(String defaultRequestEncoding)
public String getDefaultResponseEncoding()
public DeploymentInfo setDefaultResponseEncoding(String defaultResponseEncoding)
public DeploymentInfo addPreCompressedResourceEncoding(String encoding, String extension)
encoding
- The content encodingextension
- The file extensionpublic int getContainerMajorVersion()
public DeploymentInfo setContainerMajorVersion(int containerMajorVersion)
public int getContainerMinorVersion()
public DeploymentInfo setContainerMinorVersion(int containerMinorVersion)
public boolean isPreservePathOnForward()
public void setPreservePathOnForward(boolean preservePathOnForward)
public DeploymentInfo addDeploymentCompleteListener(javax.servlet.ServletContextListener servletContextListener)
contextDestroyed
method will be called after all undeployment steps are undertakenservletContextListener
- public List<javax.servlet.ServletContextListener> getDeploymentCompleteListeners()
public DeploymentInfo clone()
Copyright © 2020 JBoss by Red Hat. All rights reserved.