Class StandardContext
- java.lang.Object
- 
- org.apache.catalina.util.LifecycleBase
- 
- org.apache.catalina.util.LifecycleMBeanBase
- 
- org.apache.catalina.core.ContainerBase
- 
- org.apache.catalina.core.StandardContext
 
 
 
 
- 
- All Implemented Interfaces:
- javax.management.MBeanRegistration,- javax.management.NotificationBroadcaster,- javax.management.NotificationEmitter,- Container,- Context,- JmxEnabled,- Lifecycle,- ContextBind
 - Direct Known Subclasses:
- ReplicatedContext
 
 public class StandardContext extends ContainerBase implements Context, javax.management.NotificationEmitter Standard implementation of the Context interface. Each child container must be a Wrapper implementation to process the requests directed to a particular servlet.- Author:
- Craig R. McClanahan, Remy Maucherat
 
- 
- 
Nested Class Summary- 
Nested classes/interfaces inherited from class org.apache.catalina.core.ContainerBaseContainerBase.ContainerBackgroundProcessor, ContainerBase.ContainerBackgroundProcessorMonitor, ContainerBase.PrivilegedAddChild
 - 
Nested classes/interfaces inherited from interface org.apache.catalina.LifecycleLifecycle.SingleUse
 
- 
 - 
Field SummaryFields Modifier and Type Field Description protected booleanallowCasualMultipartParsingAllow multipart/form-data requests to be parsed even when the target servlet doesn't specify @MultipartConfig or have a <multipart-config> element.protected ApplicationContextcontextThe ServletContext implementation associated with this Context.protected static ThreadBindingListenerDEFAULT_NAMING_LISTENERprotected ManagermanagerThe Manager implementation with which this Container is associated.protected ThreadBindingListenerthreadBindingListener- 
Fields inherited from class org.apache.catalina.core.ContainerBaseaccessLog, backgroundProcessorDelay, backgroundProcessorFuture, children, cluster, listeners, logger, logName, monitorFuture, name, parent, parentClassLoader, pipeline, sm, startChildren, startStopExecutor, support
 - 
Fields inherited from class org.apache.catalina.util.LifecycleMBeanBasemserver
 - 
Fields inherited from interface org.apache.catalina.ContainerADD_CHILD_EVENT, ADD_VALVE_EVENT, REMOVE_CHILD_EVENT, REMOVE_VALVE_EVENT
 - 
Fields inherited from interface org.apache.catalina.ContextADD_WELCOME_FILE_EVENT, CHANGE_SESSION_ID_EVENT, CLEAR_WELCOME_FILES_EVENT, REMOVE_WELCOME_FILE_EVENT, WEBAPP_PROTOCOL
 - 
Fields inherited from interface org.apache.catalina.LifecycleAFTER_DESTROY_EVENT, AFTER_INIT_EVENT, AFTER_START_EVENT, AFTER_STOP_EVENT, BEFORE_DESTROY_EVENT, BEFORE_INIT_EVENT, BEFORE_START_EVENT, BEFORE_STOP_EVENT, CONFIGURE_START_EVENT, CONFIGURE_STOP_EVENT, PERIODIC_EVENT, START_EVENT, STOP_EVENT
 
- 
 - 
Constructor SummaryConstructors Constructor Description StandardContext()Create a new StandardContext component with the default basic Valve.
 - 
Method SummaryAll Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description voidaddApplicationEventListener(java.lang.Object listener)Add a listener to the end of the list of initialized application event listeners.voidaddApplicationLifecycleListener(java.lang.Object listener)Add a listener to the end of the list of initialized application lifecycle listeners.voidaddApplicationListener(java.lang.String listener)Add a new Listener class name to the set of Listeners configured for this application.voidaddApplicationParameter(ApplicationParameter parameter)Add a new application parameter for this application.voidaddChild(Container child)Add a child Container, only if the proposed child is an implementation of Wrapper.voidaddConstraint(SecurityConstraint constraint)Add a security constraint to the set for this web application.voidaddErrorPage(ErrorPage errorPage)Add an error page for the specified error or Java exception.voidaddFilterDef(FilterDef filterDef)Add a filter definition to this Context.voidaddFilterMap(FilterMap filterMap)Add a filter mapping to this Context at the end of the current set of filter mappings.voidaddFilterMapBefore(FilterMap filterMap)Add a filter mapping to this Context before the mappings defined in the deployment descriptor but after any other mappings added via this method.voidaddLocaleEncodingMappingParameter(java.lang.String locale, java.lang.String encoding)Add a Locale Encoding Mapping (see Sec 5.4 of Servlet spec 2.4)voidaddMessageDestination(MessageDestination md)Add a message destination for this web application.voidaddMessageDestinationRef(MessageDestinationRef mdr)Deprecated.This will be removed in Tomcat 10.voidaddMimeMapping(java.lang.String extension, java.lang.String mimeType)Add a new MIME mapping, replacing any existing mapping for the specified extension.voidaddNotificationListener(javax.management.NotificationListener listener, javax.management.NotificationFilter filter, java.lang.Object object)Add a JMX NotificationListenervoidaddParameter(java.lang.String name, java.lang.String value)Add a new context initialization parameter.voidaddPostConstructMethod(java.lang.String clazz, java.lang.String method)Add a post construct method definition for the given class, if there is an existing definition for the specified class - IllegalArgumentException will be thrown.voidaddPreDestroyMethod(java.lang.String clazz, java.lang.String method)Add a pre destroy method definition for the given class, if there is an existing definition for the specified class - IllegalArgumentException will be thrown.voidaddRoleMapping(java.lang.String role, java.lang.String link)Add a security role reference for this web application.voidaddSecurityRole(java.lang.String role)Add a new security role for this web application.voidaddServletContainerInitializer(ServletContainerInitializer sci, java.util.Set<java.lang.Class<?>> classes)Add a ServletContainerInitializer instance to this web application.voidaddServletMappingDecoded(java.lang.String pattern, java.lang.String name, boolean jspWildCard)Add a new servlet mapping, replacing any existing mapping for the specified pattern.java.util.Set<java.lang.String>addServletSecurity(ServletRegistration.Dynamic registration, ServletSecurityElement servletSecurityElement)Notification that Servlet security has been dynamically set in aServletRegistration.DynamicvoidaddWatchedResource(java.lang.String name)Add a new watched resource to the set recognized by this Context.voidaddWelcomeFile(java.lang.String name)Add a new welcome file to the set recognized by this Context.voidaddWrapperLifecycle(java.lang.String listener)Add the classname of a LifecycleListener to be added to each Wrapper appended to this Context.voidaddWrapperListener(java.lang.String listener)Add the classname of a ContainerListener to be added to each Wrapper appended to this Context.protected java.lang.StringadjustURLPattern(java.lang.String urlPattern)Adjust the URL pattern to begin with a leading slash, if appropriate (i.e. we are running a servlet 2.2 application).voidbackgroundProcess()Execute a periodic task, such as reloading, etc.java.lang.ClassLoaderbind(boolean usePrivilegedAction, java.lang.ClassLoader originalClassLoader)Change the current thread context class loader to the web application class loader.protected java.lang.ClassLoaderbindThread()Bind current thread, both for CL purposes and for JNDI ENC support during : startup, shutdown and reloading of the context.InstanceManagercreateInstanceManager()Factory method to create and return a new InstanceManager instance.WrappercreateWrapper()Factory method to create and return a new Wrapper instance, of the Java implementation class appropriate for this Context implementation.voiddecrementInProgressAsyncCount()protected voiddestroyInternal()Destroy needs to clean up the context completely.voiddynamicServletCreated(Servlet servlet)Hook to track which Servlets were created viaServletContext.createServlet(Class).booleanfilterStart()Configure and initialize the set of filters for this Context.booleanfilterStop()Finalize and release the set of filters for this Context.java.lang.String[]findApplicationListeners()Return the set of application listener class names configured for this application.ApplicationParameter[]findApplicationParameters()Return the set of application parameters for this application.SecurityConstraint[]findConstraints()Return the security constraints for this web application.ErrorPagefindErrorPage(int errorCode)Return the error page entry for the specified HTTP error code, if any; otherwise returnnull.ErrorPagefindErrorPage(java.lang.String exceptionType)Deprecated.ErrorPagefindErrorPage(java.lang.Throwable exceptionType)Find and return the ErrorPage instance for the specified exception's class, or an ErrorPage instance for the closest superclass for which there is such a definition.ErrorPage[]findErrorPages()Return the set of defined error pages for all specified error codes and exception types.FilterConfigfindFilterConfig(java.lang.String name)Find and return the initializedFilterConfigfor the specified filter name, if any; otherwise returnnull.FilterDeffindFilterDef(java.lang.String filterName)Return the filter definition for the specified filter name, if any; otherwise returnnull.FilterDef[]findFilterDefs()FilterMap[]findFilterMaps()MessageDestinationfindMessageDestination(java.lang.String name)MessageDestinationReffindMessageDestinationRef(java.lang.String name)Deprecated.This will be removed in Tomcat 10.MessageDestinationRef[]findMessageDestinationRefs()Deprecated.This will be removed in Tomcat 10.MessageDestination[]findMessageDestinations()java.lang.StringfindMimeMapping(java.lang.String extension)java.lang.String[]findMimeMappings()java.lang.StringfindParameter(java.lang.String name)java.lang.String[]findParameters()java.lang.StringfindPostConstructMethod(java.lang.String clazz)Returns the method name that is specified as post construct method for the given class, if it exists; otherwiseNULLwill be returned.java.util.Map<java.lang.String,java.lang.String>findPostConstructMethods()Returns a map with keys - fully qualified class names of the classes that have post construct methods and the values are the corresponding method names.java.lang.StringfindPreDestroyMethod(java.lang.String clazz)Returns the method name that is specified as pre destroy method for the given class, if it exists; otherwiseNULLwill be returned.java.util.Map<java.lang.String,java.lang.String>findPreDestroyMethods()Returns a map with keys - fully qualified class names of the classes that have pre destroy methods and the values are the corresponding method names.java.lang.StringfindRoleMapping(java.lang.String role)For the given security role (as used by an application), return the corresponding role name (as defined by the underlying Realm) if there is one.booleanfindSecurityRole(java.lang.String role)java.lang.String[]findSecurityRoles()java.lang.StringfindServletMapping(java.lang.String pattern)java.lang.String[]findServletMappings()java.lang.StringfindStatusPage(int status)Deprecated.int[]findStatusPages()Deprecated.java.lang.String[]findWatchedResources()booleanfindWelcomeFile(java.lang.String name)java.lang.String[]findWelcomeFiles()java.lang.String[]findWrapperLifecycles()java.lang.String[]findWrapperListeners()booleanfireRequestDestroyEvent(ServletRequest request)Notify allServletRequestListeners that a request has ended.booleanfireRequestInitEvent(ServletRequest request)Notify allServletRequestListeners that a request has started.booleangetAddWebinfClassesResources()booleangetAllowCasualMultipartParsing()Returnstrueif requests mapped to servlets without "multipart config" to parse multipart/form-data requests anyway.booleangetAllowMultipleLeadingForwardSlashInPath()When returning a context path fromHttpServletRequest.getContextPath(), is it allowed to contain multiple leading '/' characters?java.lang.StringgetAltDDName()Return the alternate Deployment Descriptor name.booleangetAntiResourceLocking()java.lang.Object[]getApplicationEventListeners()Obtain the registered application event listeners.java.lang.Object[]getApplicationLifecycleListeners()Obtain the registered application lifecycle listeners.AuthenticatorgetAuthenticator()java.lang.StringgetBaseName()java.lang.StringgetCharset(java.util.Locale locale)Obtain the character set name to use with the given Locale.CharsetMappergetCharsetMapper()java.lang.StringgetCharsetMapperClass()booleangetClearReferencesHttpClientKeepAliveThread()booleangetClearReferencesObjectStreamClassCaches()booleangetClearReferencesRmiTargets()booleangetClearReferencesStopThreads()booleangetClearReferencesStopTimerThreads()booleangetClearReferencesThreadLocals()protected booleangetComputedFailCtxIfServletStartFails()java.net.URLgetConfigFile()Return the URL of the XML descriptor for this context.booleangetConfigured()Return the "correctly configured" flag for this Context.java.lang.StringgetContainerSciFilter()Obtains the regular expression that specifies which container provided SCIs should be filtered out and not used for this context.CookieProcessorgetCookieProcessor()booleangetCookies()Return the "use cookies for session ids" flag.booleangetCopyXML()Flag which indicates if bundled context.xml files should be copied to the config folder.booleangetCreateUploadTargets()Will Tomcat attempt to create an upload target used by this web application if it does not exist when the web application attempts to use it?booleangetCrossContext()Return the "allow crossing servlet contexts" flag.java.lang.StringgetDefaultContextXml()java.lang.StringgetDefaultWebXml()booleangetDelegate()Return the "follow standard delegation model" flag used to configure our ClassLoader.booleangetDenyUncoveredHttpMethods()Return the deny-uncovered-http-methods flag for this web application.booleangetDispatchersUseEncodedPaths()Are paths used in calls to obtain a request dispatcher expected to be encoded?java.lang.StringgetDisplayName()Return the display name of this web application.booleangetDistributable()Get the distributable flag for this web application.java.lang.StringgetDocBase()Obtain the document root for this Context.intgetEffectiveMajorVersion()intgetEffectiveMinorVersion()java.lang.StringgetEncodedPath()Return the URL encoded context pathintgetErrorCount()Gets the cumulative error count of all servlets in this StandardContext.java.lang.BooleangetFailCtxIfServletStartFails()booleangetFireRequestListenersOnForwards()booleangetIgnoreAnnotations()Determine if annotations parsing is currently disabledlonggetInProgressAsyncCount()InstanceManagergetInstanceManager()java.lang.StringgetJ2EEApplication()java.lang.StringgetJ2EEServer()JarScannergetJarScanner()Get the Jar Scanner to be used to scan for JAR resources for this context.java.lang.String[]getJavaVMs()Deprecated.Unused.booleangetJndiExceptionOnFailedWrite()JspConfigDescriptorgetJspConfigDescriptor()LoadergetLoader()booleangetLogEffectiveWebXml()Should the effective web.xml for this context be logged on context start?LoginConfiggetLoginConfig()ManagergetManager()booleangetMapperContextRootRedirectEnabled()Determines if requests for a web application context root will be redirected (adding a trailing slash) by the Mapper.booleangetMapperDirectoryRedirectEnabled()Determines if requests for a directory will be redirected (adding a trailing slash) by the Mapper.longgetMaxTime()Gets the maximum processing time of all servlets in this StandardContext.longgetMinTime()Gets the minimum processing time of all servlets in this StandardContext.NamingContextListenergetNamingContextListener()Naming context listener accessor.NamingResourcesImplgetNamingResources()java.lang.ObjectgetNamingToken()javax.management.MBeanNotificationInfo[]getNotificationInfo()Get JMX Broadcaster Infoprotected java.lang.StringgetObjectNameKeyProperties()Allow sub-classes to specify the key properties component of theObjectNamethat will be used to register this component.java.lang.StringgetOriginalDocBase()booleangetOverride()booleangetParallelAnnotationScanning()java.lang.ClassLoadergetParentClassLoader()Return the parent class loader (if any) for this web application.java.lang.StringgetPath()booleangetPaused()Is this Context paused whilst it is reloaded?booleangetPreemptiveAuthentication()booleangetPrivileged()longgetProcessingTime()Gets the cumulative processing times of all servlets in this StandardContext.java.lang.StringgetPublicId()java.lang.StringgetRealPath(java.lang.String path)Return the real path for a given virtual path, if possible; otherwise returnnull.booleangetReloadable()booleangetRenewThreadsWhenStoppingContext()java.lang.StringgetRequestCharacterEncoding()Get the default request body encoding for this web application.intgetRequestCount()Gets the cumulative request count of all servlets in this StandardContext.java.lang.StringgetResourceOnlyServlets()Obtains the list of Servlets that expect a resource to be present.WebResourceRootgetResources()java.lang.StringgetResponseCharacterEncoding()Get the default response body encoding for this web application.booleangetSendRedirectBody()java.lang.StringgetServer()ServletContextgetServletContext()java.lang.StringgetSessionCookieDomain()Gets the domain to use for session cookies.java.lang.StringgetSessionCookieName()Gets the name to use for session cookies.java.lang.StringgetSessionCookiePath()Gets the path to use for session cookies.booleangetSessionCookiePathUsesTrailingSlash()Is a / added to the end of the session cookie path to ensure browsers, particularly IE, don't send a session cookie for context /foo with requests intended for context /foobar.intgetSessionTimeout()booleangetSkipMemoryLeakChecksOnJvmShutdown()longgetStartTime()Gets the time this context was started.longgetStartupTime()Gets the time (in milliseconds) it took to start this context.booleangetSwallowAbortedUploads()Returnstrueif remaining request data will be read (swallowed) even the request violates a data size constraint.booleangetSwallowOutput()ThreadBindingListenergetThreadBindingListener()longgetTldScanTime()booleangetTldValidation()Will the parsing of *.tld files for this Context be performed by a validating parser?longgetUnloadDelay()booleangetUnpackWAR()booleangetUseBloomFilterForArchives()Deprecated.booleangetUseHttpOnly()Gets the value of the use HttpOnly cookies for session cookies flag.booleangetUseRelativeRedirects()Will HTTP 1.1 and later location headers generated by a call toHttpServletResponse.sendRedirect(String)use relative or absolute redirects.booleangetValidateClientProvidedNewSessionId()Will client provided session IDs be validated (seeContext.setValidateClientProvidedNewSessionId(boolean)) before use?java.lang.StringgetWebappVersion()java.lang.String[]getWelcomeFiles()java.lang.StringgetWorkDir()java.lang.StringgetWorkPath()Get the absolute path to the work dir.java.lang.StringgetWrapperClass()booleangetXmlBlockExternal()Will the parsing of web.xml, web-fragment.xml, *.tld, *.jspx, *.tagx and tagplugin.xml files for this Context block the use of external entities?booleangetXmlNamespaceAware()Will the parsing of web.xml and web-fragment.xml files for this Context be performed by a namespace aware parser?booleangetXmlValidation()Will the parsing of web.xml and web-fragment.xml files for this Context be performed by a validating parser?voidincrementInProgressAsyncCount()protected voidinitInternal()Sub-classes wishing to perform additional initialization should override this method, ensuring that super.initInternal() is the first call in the overriding method.booleanisResourceOnlyServlet(java.lang.String servletName)Checks the named Servlet to see if it expects a resource to be present.booleanisServlet22()Are we processing a version 2.2 deployment descriptor?booleanisUseNaming()booleanlistenerStart()Configure the set of instantiated application event listeners for this Context.booleanlistenerStop()Send an application stop event to all interested listeners.booleanloadOnStartup(Container[] children)Load and initialize all servlets marked "load on startup" in the web application deployment descriptor.protected voidpostWorkDirectory()Set the appropriate context attribute for our work directory.voidreload()Reload this web application, if reloading is supported.voidremoveApplicationListener(java.lang.String listener)Remove the specified application listener class from the set of listeners for this application.voidremoveApplicationParameter(java.lang.String name)Remove the application parameter with the specified name from the set for this application.voidremoveChild(Container child)Add a child Container, only if the proposed child is an implementation of Wrapper.voidremoveConstraint(SecurityConstraint constraint)Remove the specified security constraint from this web application.voidremoveErrorPage(ErrorPage errorPage)Remove the error page for the specified error code or Java language exception, if it exists; otherwise, no action is taken.voidremoveFilterDef(FilterDef filterDef)Remove the specified filter definition from this Context, if it exists; otherwise, no action is taken.voidremoveFilterMap(FilterMap filterMap)Remove a filter mapping from this Context.voidremoveMessageDestination(java.lang.String name)Remove any message destination with the specified name.voidremoveMessageDestinationRef(java.lang.String name)Deprecated.This will be removed in Tomcat 10.voidremoveMimeMapping(java.lang.String extension)Remove the MIME mapping for the specified extension, if it exists; otherwise, no action is taken.voidremoveNotificationListener(javax.management.NotificationListener listener)Remove a JMX-NotificationListenervoidremoveNotificationListener(javax.management.NotificationListener listener, javax.management.NotificationFilter filter, java.lang.Object object)Remove a JMX notificationListenervoidremoveParameter(java.lang.String name)Remove the context initialization parameter with the specified name, if it exists; otherwise, no action is taken.voidremovePostConstructMethod(java.lang.String clazz)Removes the post construct method definition for the given class, if it exists; otherwise, no action is taken.voidremovePreDestroyMethod(java.lang.String clazz)Removes the pre destroy method definition for the given class, if it exists; otherwise, no action is taken.voidremoveRoleMapping(java.lang.String role)Remove any security role reference for the specified namevoidremoveSecurityRole(java.lang.String role)Remove any security role with the specified name.voidremoveServletMapping(java.lang.String pattern)Remove any servlet mapping for the specified pattern, if it exists; otherwise, no action is taken.voidremoveWatchedResource(java.lang.String name)Remove the specified watched resource name from the list associated with this Context.voidremoveWelcomeFile(java.lang.String name)Remove the specified welcome file name from the list recognized by this Context.voidremoveWrapperLifecycle(java.lang.String listener)Remove a class name from the set of LifecycleListener classes that will be added to newly created Wrappers.voidremoveWrapperListener(java.lang.String listener)Remove a class name from the set of ContainerListener classes that will be added to newly created Wrappers.voidresourcesStart()Allocate resources, including proxy.booleanresourcesStop()Deallocate resources and destroy proxy.voidsetAddWebinfClassesResources(boolean addWebinfClassesResources)Sets the flag that indicates if /WEB-INF/classes should be treated like an exploded JAR and JAR resources made available as if they were in a JAR.voidsetAllowCasualMultipartParsing(boolean allowCasualMultipartParsing)Set totrueto allow requests mapped to servlets that do not explicitly declare @MultipartConfig or have <multipart-config> specified in web.xml to parse multipart/form-data requests.voidsetAllowMultipleLeadingForwardSlashInPath(boolean allowMultipleLeadingForwardSlashInPath)Configure if, when returning a context path fromHttpServletRequest.getContextPath(), the return value is allowed to contain multiple leading '/' characters.voidsetAltDDName(java.lang.String altDDName)Set an alternate Deployment Descriptor name.voidsetAntiResourceLocking(boolean antiResourceLocking)Set the antiResourceLocking feature for this Context.voidsetApplicationEventListeners(java.lang.Object[] listeners)Store the set of initialized application event listener objects, in the order they were specified in the web application deployment descriptor, for this application.voidsetApplicationLifecycleListeners(java.lang.Object[] listeners)Store the set of initialized application lifecycle listener objects, in the order they were specified in the web application deployment descriptor, for this application.voidsetCharsetMapper(CharsetMapper mapper)Set the Locale to character set mapper for this Context.voidsetCharsetMapperClass(java.lang.String mapper)Set the Locale to character set mapper class for this Context.voidsetClearReferencesHttpClientKeepAliveThread(boolean clearReferencesHttpClientKeepAliveThread)Set the clearReferencesHttpClientKeepAliveThread feature for this Context.voidsetClearReferencesObjectStreamClassCaches(boolean clearReferencesObjectStreamClassCaches)voidsetClearReferencesRmiTargets(boolean clearReferencesRmiTargets)voidsetClearReferencesStopThreads(boolean clearReferencesStopThreads)Set the clearReferencesStopThreads feature for this Context.voidsetClearReferencesStopTimerThreads(boolean clearReferencesStopTimerThreads)Set the clearReferencesStopTimerThreads feature for this Context.voidsetClearReferencesThreadLocals(boolean clearReferencesThreadLocals)voidsetConfigFile(java.net.URL configFile)Set the URL of the XML descriptor for this context.voidsetConfigured(boolean configured)Set the "correctly configured" flag for this Context.voidsetContainerSciFilter(java.lang.String containerSciFilter)Sets the regular expression that specifies which container provided SCIs should be filtered out and not used for this context.voidsetCookieProcessor(CookieProcessor cookieProcessor)Sets theCookieProcessorthat will be used to process cookies for this Context.voidsetCookies(boolean cookies)Set the "use cookies for session ids" flag.voidsetCopyXML(boolean copyXML)Allows copying a bundled context.xml file to the host configuration base folder on deployment.voidsetCreateUploadTargets(boolean createUploadTargets)Configure whether Tomcat will attempt to create an upload target used by this web application if it does not exist when the web application attempts to use it.voidsetCrossContext(boolean crossContext)Set the "allow crossing servlet contexts" flag.voidsetDefaultContextXml(java.lang.String defaultContextXml)Set the location of the default context xml that will be used.voidsetDefaultWebXml(java.lang.String defaultWebXml)Set the location of the default web xml that will be used.voidsetDelegate(boolean delegate)Set the "follow standard delegation model" flag used to configure our ClassLoader.voidsetDenyUncoveredHttpMethods(boolean denyUncoveredHttpMethods)Set the deny-uncovered-http-methods flag for this web application.voidsetDispatchersUseEncodedPaths(boolean dispatchersUseEncodedPaths)Are paths used in calls to obtain a request dispatcher expected to be encoded?voidsetDisplayName(java.lang.String displayName)Set the display name of this web application.voidsetDistributable(boolean distributable)Set the distributable flag for this web application.voidsetDocBase(java.lang.String docBase)Set the document root for this Context.voidsetEffectiveMajorVersion(int effectiveMajorVersion)Set the effective major version of the Servlet spec used by this context.voidsetEffectiveMinorVersion(int effectiveMinorVersion)Set the effective minor version of the Servlet spec used by this context.voidsetFailCtxIfServletStartFails(java.lang.Boolean failCtxIfServletStartFails)voidsetFireRequestListenersOnForwards(boolean enable)Configure whether or not requests listeners will be fired on forwards for this Context.voidsetIgnoreAnnotations(boolean ignoreAnnotations)Set the boolean on the annotations parsing for this web application.voidsetInstanceManager(InstanceManager instanceManager)Set the instance manager associated with this context.voidsetJ2EEApplication(java.lang.String j2EEApplication)voidsetJ2EEServer(java.lang.String j2EEServer)voidsetJarScanner(JarScanner jarScanner)Set the Jar Scanner to be used to scan for JAR resources for this context.java.lang.String[]setJavaVMs(java.lang.String[] javaVMs)Deprecated.Unused.voidsetJndiExceptionOnFailedWrite(boolean jndiExceptionOnFailedWrite)Controls whether or not an attempt to modify the JNDI context will trigger an exception or if the request will be ignored.voidsetJspConfigDescriptor(JspConfigDescriptor descriptor)Set the JspConfigDescriptor for this context.voidsetLoader(Loader loader)Set the Loader with which this Context is associated.voidsetLogEffectiveWebXml(boolean logEffectiveWebXml)Set whether or not the effective web.xml for this context should be logged on context start.voidsetLoginConfig(LoginConfig config)Set the login configuration descriptor for this web application.voidsetManager(Manager manager)Set the Manager with which this Context is associated.voidsetMapperContextRootRedirectEnabled(boolean mapperContextRootRedirectEnabled)If enabled, requests for a web application context root will be redirected (adding a trailing slash) by the Mapper.voidsetMapperDirectoryRedirectEnabled(boolean mapperDirectoryRedirectEnabled)If enabled, requests for a directory will be redirected (adding a trailing slash) by the Mapper.voidsetNamingContextListener(NamingContextListener namingContextListener)Naming context listener setter.voidsetNamingResources(NamingResourcesImpl namingResources)Set the naming resources for this web application.voidsetOriginalDocBase(java.lang.String docBase)Set the original document root for this Context.voidsetOverride(boolean override)Set the default context override flag for this web application.voidsetParallelAnnotationScanning(boolean parallelAnnotationScanning)Set the parallel annotation scanning value.voidsetPath(java.lang.String path)Set the context path for this Context.voidsetPreemptiveAuthentication(boolean preemptiveAuthentication)Configures if a user presents authentication credentials, whether the context will process them when the request is for a non-protected resource.voidsetPrivileged(boolean privileged)Set the privileged flag for this web application.voidsetPublicId(java.lang.String publicId)Set the public identifier of the deployment descriptor DTD that is currently being parsed.voidsetReloadable(boolean reloadable)Set the reloadable flag for this web application.voidsetRenewThreadsWhenStoppingContext(boolean renewThreadsWhenStoppingContext)voidsetReplaceWelcomeFiles(boolean replaceWelcomeFiles)Set the "replace welcome files" property.voidsetRequestCharacterEncoding(java.lang.String requestEncoding)Set the default request body encoding for this web application.voidsetResourceOnlyServlets(java.lang.String resourceOnlyServlets)Sets the (comma separated) list of Servlets that expect a resource to be present.voidsetResources(WebResourceRoot resources)Set the Resources object with which this Context is associated.voidsetResponseCharacterEncoding(java.lang.String responseEncoding)Set the default response body encoding for this web application.voidsetSendRedirectBody(boolean sendRedirectBody)Configures if a response body is included when a redirect response is sent to the client.java.lang.StringsetServer(java.lang.String server)voidsetSessionCookieDomain(java.lang.String sessionCookieDomain)Sets the domain to use for session cookies.voidsetSessionCookieName(java.lang.String sessionCookieName)Sets the name to use for session cookies.voidsetSessionCookiePath(java.lang.String sessionCookiePath)Sets the path to use for session cookies.voidsetSessionCookiePathUsesTrailingSlash(boolean sessionCookiePathUsesTrailingSlash)Configures if a / is added to the end of the session cookie path to ensure browsers, particularly IE, don't send a session cookie for context /foo with requests intended for context /foobar.voidsetSessionTimeout(int timeout)Set the default session timeout (in minutes) for this web application.voidsetSkipMemoryLeakChecksOnJvmShutdown(boolean skipMemoryLeakChecksOnJvmShutdown)voidsetStartupTime(long startupTime)voidsetSwallowAbortedUploads(boolean swallowAbortedUploads)Set tofalseto disable request data swallowing after an upload was aborted due to size constraints.voidsetSwallowOutput(boolean swallowOutput)Set the value of the swallowOutput flag.voidsetThreadBindingListener(ThreadBindingListener threadBindingListener)Get the associated ThreadBindingListener.voidsetTldScanTime(long tldScanTime)voidsetTldValidation(boolean tldValidation)Controls whether the parsing of *.tld files for this Context will be performed by a validating parser.voidsetUnloadDelay(long unloadDelay)Set the value of the unloadDelay flag, which represents the amount of ms that the container will wait when unloading servlets.voidsetUnpackWAR(boolean unpackWAR)Unpack WAR flag mutator.voidsetUseBloomFilterForArchives(boolean useBloomFilterForArchives)Deprecated.voidsetUseHttpOnly(boolean useHttpOnly)Sets the use HttpOnly cookies for session cookies flag.voidsetUseNaming(boolean useNaming)Enables or disables naming.voidsetUseRelativeRedirects(boolean useRelativeRedirects)Controls whether HTTP 1.1 and later location headers generated by a call toHttpServletResponse.sendRedirect(String)will use relative or absolute redirects.voidsetValidateClientProvidedNewSessionId(boolean validateClientProvidedNewSessionId)When a client provides the ID for a new session, should that ID be validated?voidsetWebappVersion(java.lang.String webappVersion)Set the version of this web application - used to differentiate different versions of the same web application when using parallel deployment.voidsetWorkDir(java.lang.String workDir)Set the work directory for this Context.voidsetWrapperClass(java.lang.String wrapperClassName)Set the Java class name of the Wrapper implementation used for servlets registered in this Context.voidsetXmlBlockExternal(boolean xmlBlockExternal)Controls whether the parsing of web.xml, web-fragment.xml, *.tld, *.jspx, *.tagx and tagplugin.xml files for this Context will block the use of external entities.voidsetXmlNamespaceAware(boolean webXmlNamespaceAware)Controls whether the parsing of web.xml and web-fragment.xml files for this Context will be performed by a namespace aware parser.voidsetXmlValidation(boolean webXmlValidation)Controls whether the parsing of web.xml and web-fragment.xml files for this Context will be performed by a validating parser.protected voidstartInternal()Start this component and implement the requirements ofLifecycleBase.startInternal().protected voidstopInternal()Stop this component and implement the requirements ofLifecycleBase.stopInternal().voidunbind(boolean usePrivilegedAction, java.lang.ClassLoader originalClassLoader)Restore the current thread context class loader to the original class loader in used beforeContextBind.bind(boolean, ClassLoader)was called.protected voidunbindThread(java.lang.ClassLoader oldContextClassLoader)Unbind thread and restore the specified context classloader.booleanwasCreatedDynamicServlet(Servlet servlet)- 
Methods inherited from class org.apache.catalina.core.ContainerBaseaddContainerListener, addPropertyChangeListener, addValve, findChild, findChildren, findContainerListeners, fireContainerEvent, getAccessLog, getBackgroundProcessorDelay, getCatalinaBase, getCatalinaHome, getChildren, getCluster, getClusterInternal, getDomainInternal, getLogger, getLogName, getMBeanKeyProperties, getName, getParent, getPipeline, getRealm, getRealmInternal, getStartChildren, getStartStopThreads, logAccess, removeContainerListener, removePropertyChangeListener, setBackgroundProcessorDelay, setCluster, setName, setParent, setParentClassLoader, setRealm, setStartChildren, setStartStopThreads, threadStart, threadStop, toString
 - 
Methods inherited from class org.apache.catalina.util.LifecycleMBeanBasegetDomain, getObjectName, postDeregister, postRegister, preDeregister, preRegister, register, setDomain, unregister, unregister
 - 
Methods inherited from class org.apache.catalina.util.LifecycleBaseaddLifecycleListener, destroy, findLifecycleListeners, fireLifecycleEvent, getState, getStateName, getThrowOnFailure, init, removeLifecycleListener, setState, setState, setThrowOnFailure, start, stop
 - 
Methods inherited from class java.lang.Objectclone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 - 
Methods inherited from interface org.apache.catalina.ContaineraddContainerListener, addPropertyChangeListener, findChild, findChildren, findContainerListeners, fireContainerEvent, getAccessLog, getBackgroundProcessorDelay, getCatalinaBase, getCatalinaHome, getCluster, getDomain, getLogger, getLogName, getMBeanKeyProperties, getName, getObjectName, getParent, getPipeline, getRealm, getStartStopThreads, logAccess, removeContainerListener, removePropertyChangeListener, setBackgroundProcessorDelay, setCluster, setName, setParent, setParentClassLoader, setRealm, setStartStopThreads
 - 
Methods inherited from interface org.apache.catalina.ContextaddServletMappingDecoded, findConfigFileResource, isParallelAnnotationScanning
 - 
Methods inherited from interface org.apache.catalina.LifecycleaddLifecycleListener, destroy, findLifecycleListeners, getState, getStateName, init, removeLifecycleListener, start, stop
 
- 
 
- 
- 
- 
Field Detail- 
allowCasualMultipartParsingprotected boolean allowCasualMultipartParsing Allow multipart/form-data requests to be parsed even when the target servlet doesn't specify @MultipartConfig or have a <multipart-config> element.
 - 
contextprotected ApplicationContext context The ServletContext implementation associated with this Context.
 - 
managerprotected Manager manager The Manager implementation with which this Container is associated.
 - 
DEFAULT_NAMING_LISTENERprotected static final ThreadBindingListener DEFAULT_NAMING_LISTENER 
 - 
threadBindingListenerprotected ThreadBindingListener threadBindingListener 
 
- 
 - 
Method Detail- 
setCreateUploadTargetspublic void setCreateUploadTargets(boolean createUploadTargets) Description copied from interface:ContextConfigure whether Tomcat will attempt to create an upload target used by this web application if it does not exist when the web application attempts to use it.- Specified by:
- setCreateUploadTargetsin interface- Context
- Parameters:
- createUploadTargets-- trueif Tomcat should attempt to create the upload target, otherwise- false
 
 - 
getCreateUploadTargetspublic boolean getCreateUploadTargets() Description copied from interface:ContextWill Tomcat attempt to create an upload target used by this web application if it does not exist when the web application attempts to use it?- Specified by:
- getCreateUploadTargetsin interface- Context
- Returns:
- trueif Tomcat will attempt to create an upload target otherwise- false
 
 - 
incrementInProgressAsyncCountpublic void incrementInProgressAsyncCount() - Specified by:
- incrementInProgressAsyncCountin interface- Context
 
 - 
decrementInProgressAsyncCountpublic void decrementInProgressAsyncCount() - Specified by:
- decrementInProgressAsyncCountin interface- Context
 
 - 
getInProgressAsyncCountpublic long getInProgressAsyncCount() 
 - 
setAllowMultipleLeadingForwardSlashInPathpublic void setAllowMultipleLeadingForwardSlashInPath(boolean allowMultipleLeadingForwardSlashInPath) Description copied from interface:ContextConfigure if, when returning a context path fromHttpServletRequest.getContextPath(), the return value is allowed to contain multiple leading '/' characters.- Specified by:
- setAllowMultipleLeadingForwardSlashInPathin interface- Context
- Parameters:
- allowMultipleLeadingForwardSlashInPath- The new value for the flag
 
 - 
getAllowMultipleLeadingForwardSlashInPathpublic boolean getAllowMultipleLeadingForwardSlashInPath() Description copied from interface:ContextWhen returning a context path fromHttpServletRequest.getContextPath(), is it allowed to contain multiple leading '/' characters?- Specified by:
- getAllowMultipleLeadingForwardSlashInPathin interface- Context
- Returns:
- trueif multiple leading '/' characters are allowed, otherwise- false
 
 - 
getRequestCharacterEncodingpublic java.lang.String getRequestCharacterEncoding() Description copied from interface:ContextGet the default request body encoding for this web application.- Specified by:
- getRequestCharacterEncodingin interface- Context
- Returns:
- The default request body encoding
 
 - 
setRequestCharacterEncodingpublic void setRequestCharacterEncoding(java.lang.String requestEncoding) Description copied from interface:ContextSet the default request body encoding for this web application.- Specified by:
- setRequestCharacterEncodingin interface- Context
- Parameters:
- requestEncoding- The default encoding
 
 - 
getResponseCharacterEncodingpublic java.lang.String getResponseCharacterEncoding() Description copied from interface:ContextGet the default response body encoding for this web application.- Specified by:
- getResponseCharacterEncodingin interface- Context
- Returns:
- The default response body encoding
 
 - 
setResponseCharacterEncodingpublic void setResponseCharacterEncoding(java.lang.String responseEncoding) Description copied from interface:ContextSet the default response body encoding for this web application.- Specified by:
- setResponseCharacterEncodingin interface- Context
- Parameters:
- responseEncoding- The default encoding
 
 - 
setDispatchersUseEncodedPathspublic void setDispatchersUseEncodedPaths(boolean dispatchersUseEncodedPaths) Description copied from interface:ContextAre paths used in calls to obtain a request dispatcher expected to be encoded? This affects both how Tomcat handles calls to obtain a request dispatcher as well as how Tomcat generates paths used to obtain request dispatchers internally.- Specified by:
- setDispatchersUseEncodedPathsin interface- Context
- Parameters:
- dispatchersUseEncodedPaths-- trueto use encoded paths, otherwise- false
 
 - 
getDispatchersUseEncodedPathspublic boolean getDispatchersUseEncodedPaths() Are paths used in calls to obtain a request dispatcher expected to be encoded? This applies to both how Tomcat handles calls to obtain a request dispatcher as well as how Tomcat generates paths used to obtain request dispatchers internally.The default value for this implementation is true.- Specified by:
- getDispatchersUseEncodedPathsin interface- Context
- Returns:
- trueif encoded paths will be used, otherwise- false
 
 - 
setUseRelativeRedirectspublic void setUseRelativeRedirects(boolean useRelativeRedirects) Description copied from interface:ContextControls whether HTTP 1.1 and later location headers generated by a call toHttpServletResponse.sendRedirect(String)will use relative or absolute redirects.Relative redirects are more efficient but may not work with reverse proxies that change the context path. It should be noted that it is not recommended to use a reverse proxy to change the context path because of the multiple issues it creates. Absolute redirects should work with reverse proxies that change the context path but may cause issues with the RemoteIpFilterif the filter is changing the scheme and/or port.- Specified by:
- setUseRelativeRedirectsin interface- Context
- Parameters:
- useRelativeRedirects-- trueto use relative redirects and- falseto use absolute redirects
 
 - 
getUseRelativeRedirectspublic boolean getUseRelativeRedirects() Will HTTP 1.1 and later location headers generated by a call toHttpServletResponse.sendRedirect(String)use relative or absolute redirects.The default value for this implementation is true.- Specified by:
- getUseRelativeRedirectsin interface- Context
- Returns:
- trueif relative redirects will be used- falseif absolute redirects are used.
- See Also:
- Context.setUseRelativeRedirects(boolean)
 
 - 
setMapperContextRootRedirectEnabledpublic void setMapperContextRootRedirectEnabled(boolean mapperContextRootRedirectEnabled) Description copied from interface:ContextIf enabled, requests for a web application context root will be redirected (adding a trailing slash) by the Mapper. This is more efficient but has the side effect of confirming that the context path is valid.- Specified by:
- setMapperContextRootRedirectEnabledin interface- Context
- Parameters:
- mapperContextRootRedirectEnabled- Should the redirects be enabled?
 
 - 
getMapperContextRootRedirectEnabledpublic boolean getMapperContextRootRedirectEnabled() Determines if requests for a web application context root will be redirected (adding a trailing slash) by the Mapper. This is more efficient but has the side effect of confirming that the context path is valid.The default value for this implementation is false.- Specified by:
- getMapperContextRootRedirectEnabledin interface- Context
- Returns:
- trueif the Mapper level redirect is enabled for this Context.
 
 - 
setMapperDirectoryRedirectEnabledpublic void setMapperDirectoryRedirectEnabled(boolean mapperDirectoryRedirectEnabled) Description copied from interface:ContextIf enabled, requests for a directory will be redirected (adding a trailing slash) by the Mapper. This is more efficient but has the side effect of confirming that the directory is valid.- Specified by:
- setMapperDirectoryRedirectEnabledin interface- Context
- Parameters:
- mapperDirectoryRedirectEnabled- Should the redirects be enabled?
 
 - 
getMapperDirectoryRedirectEnabledpublic boolean getMapperDirectoryRedirectEnabled() Determines if requests for a directory will be redirected (adding a trailing slash) by the Mapper. This is more efficient but has the side effect of confirming that the directory is valid.The default value for this implementation is false.- Specified by:
- getMapperDirectoryRedirectEnabledin interface- Context
- Returns:
- trueif the Mapper level redirect is enabled for this Context.
 
 - 
setValidateClientProvidedNewSessionIdpublic void setValidateClientProvidedNewSessionId(boolean validateClientProvidedNewSessionId) Description copied from interface:ContextWhen a client provides the ID for a new session, should that ID be validated? The only use case for using a client provided session ID is to have a common session ID across multiple web applications. Therefore, any client provided session ID should already exist in another web application. If this check is enabled, the client provided session ID will only be used if the session ID exists in at least one other web application for the current host. Note that the following additional tests are always applied, irrespective of this setting:- The session ID is provided by a cookie
- The session cookie has a path of /
 - Specified by:
- setValidateClientProvidedNewSessionIdin interface- Context
- Parameters:
- validateClientProvidedNewSessionId-- trueif validation should be applied
 
 - 
getValidateClientProvidedNewSessionIdpublic boolean getValidateClientProvidedNewSessionId() Will client provided session IDs be validated (seeContext.setValidateClientProvidedNewSessionId(boolean)) before use?The default value for this implementation is true.- Specified by:
- getValidateClientProvidedNewSessionIdin interface- Context
- Returns:
- trueif validation will be applied. Otherwise,- false
 
 - 
setCookieProcessorpublic void setCookieProcessor(CookieProcessor cookieProcessor) Description copied from interface:ContextSets theCookieProcessorthat will be used to process cookies for this Context.- Specified by:
- setCookieProcessorin interface- Context
- Parameters:
- cookieProcessor- The new cookie processor
 
 - 
getCookieProcessorpublic CookieProcessor getCookieProcessor() - Specified by:
- getCookieProcessorin interface- Context
- Returns:
- the CookieProcessorthat will be used to process cookies for this Context.
 
 - 
getNamingTokenpublic java.lang.Object getNamingToken() - Specified by:
- getNamingTokenin interface- Context
- Returns:
- the token necessary for operations on the associated JNDI naming context.
 
 - 
setContainerSciFilterpublic void setContainerSciFilter(java.lang.String containerSciFilter) Description copied from interface:ContextSets the regular expression that specifies which container provided SCIs should be filtered out and not used for this context. Matching usesMatcher.find()so the regular expression only has to match a sub-string of the fully qualified class name of the container provided SCI for it to be filtered out.- Specified by:
- setContainerSciFilterin interface- Context
- Parameters:
- containerSciFilter- The regular expression against which the fully qualified class name of each container provided SCI should be checked
 
 - 
getContainerSciFilterpublic java.lang.String getContainerSciFilter() Description copied from interface:ContextObtains the regular expression that specifies which container provided SCIs should be filtered out and not used for this context. Matching usesMatcher.find()so the regular expression only has to match a sub-string of the fully qualified class name of the container provided SCI for it to be filtered out.- Specified by:
- getContainerSciFilterin interface- Context
- Returns:
- The regular expression against which the fully qualified class name of each container provided SCI will be checked
 
 - 
getSendRedirectBodypublic boolean getSendRedirectBody() - Specified by:
- getSendRedirectBodyin interface- Context
- Returns:
- if the context is configured to include a response body as part of a redirect response.
 
 - 
setSendRedirectBodypublic void setSendRedirectBody(boolean sendRedirectBody) Description copied from interface:ContextConfigures if a response body is included when a redirect response is sent to the client.- Specified by:
- setSendRedirectBodyin interface- Context
- Parameters:
- sendRedirectBody-- trueto send a response body for redirects
 
 - 
getPreemptiveAuthenticationpublic boolean getPreemptiveAuthentication() - Specified by:
- getPreemptiveAuthenticationin interface- Context
- Returns:
- if a user presents authentication credentials, will the context will process them when the request is for a non-protected resource.
 
 - 
setPreemptiveAuthenticationpublic void setPreemptiveAuthentication(boolean preemptiveAuthentication) Description copied from interface:ContextConfigures if a user presents authentication credentials, whether the context will process them when the request is for a non-protected resource.- Specified by:
- setPreemptiveAuthenticationin interface- Context
- Parameters:
- preemptiveAuthentication-- trueto perform authentication even outside security constraints
 
 - 
setFireRequestListenersOnForwardspublic void setFireRequestListenersOnForwards(boolean enable) Description copied from interface:ContextConfigure whether or not requests listeners will be fired on forwards for this Context.- Specified by:
- setFireRequestListenersOnForwardsin interface- Context
- Parameters:
- enable-- trueto fire request listeners when forwarding
 
 - 
getFireRequestListenersOnForwardspublic boolean getFireRequestListenersOnForwards() - Specified by:
- getFireRequestListenersOnForwardsin interface- Context
- Returns:
- whether or not requests listeners will be fired on forwards for this Context.
 
 - 
setAddWebinfClassesResourcespublic void setAddWebinfClassesResources(boolean addWebinfClassesResources) Description copied from interface:ContextSets the flag that indicates if /WEB-INF/classes should be treated like an exploded JAR and JAR resources made available as if they were in a JAR.- Specified by:
- setAddWebinfClassesResourcesin interface- Context
- Parameters:
- addWebinfClassesResources- The new value for the flag
 
 - 
getAddWebinfClassesResourcespublic boolean getAddWebinfClassesResources() - Specified by:
- getAddWebinfClassesResourcesin interface- Context
- Returns:
- the flag that indicates if /WEB-INF/classes should be treated like an exploded JAR and JAR resources made available as if they were in a JAR.
 
 - 
setWebappVersionpublic void setWebappVersion(java.lang.String webappVersion) Description copied from interface:ContextSet the version of this web application - used to differentiate different versions of the same web application when using parallel deployment.- Specified by:
- setWebappVersionin interface- Context
- Parameters:
- webappVersion- The webapp version associated with the context, which should be unique
 
 - 
getWebappVersionpublic java.lang.String getWebappVersion() - Specified by:
- getWebappVersionin interface- Context
- Returns:
- The version of this web application, used to differentiate different versions of the same web application when using parallel deployment. If not specified, defaults to the empty string.
 
 - 
getBaseNamepublic java.lang.String getBaseName() - Specified by:
- getBaseNamein interface- Context
- Returns:
- the base name to use for WARs, directories or context.xml files for this context.
 
 - 
getResourceOnlyServletspublic java.lang.String getResourceOnlyServlets() Description copied from interface:ContextObtains the list of Servlets that expect a resource to be present.- Specified by:
- getResourceOnlyServletsin interface- Context
- Returns:
- A comma separated list of Servlet names as used in web.xml
 
 - 
setResourceOnlyServletspublic void setResourceOnlyServlets(java.lang.String resourceOnlyServlets) Description copied from interface:ContextSets the (comma separated) list of Servlets that expect a resource to be present. Used to ensure that welcome files associated with Servlets that expect a resource to be present are not mapped when there is no resource.- Specified by:
- setResourceOnlyServletsin interface- Context
- Parameters:
- resourceOnlyServlets- The Servlet names comma separated list
 
 - 
isResourceOnlyServletpublic boolean isResourceOnlyServlet(java.lang.String servletName) Description copied from interface:ContextChecks the named Servlet to see if it expects a resource to be present.- Specified by:
- isResourceOnlyServletin interface- Context
- Parameters:
- servletName- Name of the Servlet (as per web.xml) to check
- Returns:
- trueif the Servlet expects a resource, otherwise- false
 
 - 
getEffectiveMajorVersionpublic int getEffectiveMajorVersion() - Specified by:
- getEffectiveMajorVersionin interface- Context
- Returns:
- the effective major version of the Servlet spec used by this context.
 
 - 
setEffectiveMajorVersionpublic void setEffectiveMajorVersion(int effectiveMajorVersion) Description copied from interface:ContextSet the effective major version of the Servlet spec used by this context.- Specified by:
- setEffectiveMajorVersionin interface- Context
- Parameters:
- effectiveMajorVersion- Set the version number
 
 - 
getEffectiveMinorVersionpublic int getEffectiveMinorVersion() - Specified by:
- getEffectiveMinorVersionin interface- Context
- Returns:
- the effective minor version of the Servlet spec used by this context.
 
 - 
setEffectiveMinorVersionpublic void setEffectiveMinorVersion(int effectiveMinorVersion) Description copied from interface:ContextSet the effective minor version of the Servlet spec used by this context.- Specified by:
- setEffectiveMinorVersionin interface- Context
- Parameters:
- effectiveMinorVersion- Set the version number
 
 - 
setLogEffectiveWebXmlpublic void setLogEffectiveWebXml(boolean logEffectiveWebXml) Description copied from interface:ContextSet whether or not the effective web.xml for this context should be logged on context start.- Specified by:
- setLogEffectiveWebXmlin interface- Context
- Parameters:
- logEffectiveWebXml- set to- trueto log the complete web.xml that will be used for the webapp
 
 - 
getLogEffectiveWebXmlpublic boolean getLogEffectiveWebXml() Description copied from interface:ContextShould the effective web.xml for this context be logged on context start?- Specified by:
- getLogEffectiveWebXmlin interface- Context
- Returns:
- true if the reconstructed web.xml that will be used for the webapp should be logged
 
 - 
getAuthenticatorpublic Authenticator getAuthenticator() - Specified by:
- getAuthenticatorin interface- Context
- Returns:
- the Authenticatorthat is used by this context. This is always non-nullfor a started Context
 
 - 
getJarScannerpublic JarScanner getJarScanner() Description copied from interface:ContextGet the Jar Scanner to be used to scan for JAR resources for this context.- Specified by:
- getJarScannerin interface- Context
- Returns:
- The Jar Scanner configured for this context.
 
 - 
setJarScannerpublic void setJarScanner(JarScanner jarScanner) Description copied from interface:ContextSet the Jar Scanner to be used to scan for JAR resources for this context.- Specified by:
- setJarScannerin interface- Context
- Parameters:
- jarScanner- The Jar Scanner to be used for this context.
 
 - 
getInstanceManagerpublic InstanceManager getInstanceManager() - Specified by:
- getInstanceManagerin interface- Context
- Returns:
- the instance manager associated with this context.
 
 - 
setInstanceManagerpublic void setInstanceManager(InstanceManager instanceManager) Description copied from interface:ContextSet the instance manager associated with this context.- Specified by:
- setInstanceManagerin interface- Context
- Parameters:
- instanceManager- the new instance manager instance
 
 - 
getEncodedPathpublic java.lang.String getEncodedPath() Description copied from interface:ContextReturn the URL encoded context path- Specified by:
- getEncodedPathin interface- Context
- Returns:
- The URL encoded (with UTF-8) context path
 
 - 
setAllowCasualMultipartParsingpublic void setAllowCasualMultipartParsing(boolean allowCasualMultipartParsing) Set totrueto allow requests mapped to servlets that do not explicitly declare @MultipartConfig or have <multipart-config> specified in web.xml to parse multipart/form-data requests.- Specified by:
- setAllowCasualMultipartParsingin interface- Context
- Parameters:
- allowCasualMultipartParsing-- trueto allow such casual parsing,- falseotherwise.
 
 - 
getAllowCasualMultipartParsingpublic boolean getAllowCasualMultipartParsing() Returnstrueif requests mapped to servlets without "multipart config" to parse multipart/form-data requests anyway.- Specified by:
- getAllowCasualMultipartParsingin interface- Context
- Returns:
- trueif requests mapped to servlets without "multipart config" to parse multipart/form-data requests,- falseotherwise.
 
 - 
setSwallowAbortedUploadspublic void setSwallowAbortedUploads(boolean swallowAbortedUploads) Set tofalseto disable request data swallowing after an upload was aborted due to size constraints.- Specified by:
- setSwallowAbortedUploadsin interface- Context
- Parameters:
- swallowAbortedUploads-- falseto disable swallowing,- trueotherwise (default).
 
 - 
getSwallowAbortedUploadspublic boolean getSwallowAbortedUploads() Returnstrueif remaining request data will be read (swallowed) even the request violates a data size constraint.- Specified by:
- getSwallowAbortedUploadsin interface- Context
- Returns:
- trueif data will be swallowed (default),- falseotherwise.
 
 - 
addServletContainerInitializerpublic void addServletContainerInitializer(ServletContainerInitializer sci, java.util.Set<java.lang.Class<?>> classes) Add a ServletContainerInitializer instance to this web application.- Specified by:
- addServletContainerInitializerin interface- Context
- Parameters:
- sci- The instance to add
- classes- The classes in which the initializer expressed an interest
 
 - 
getDelegatepublic boolean getDelegate() Return the "follow standard delegation model" flag used to configure our ClassLoader.- Returns:
- trueif classloading delegates to the parent classloader first
 
 - 
setDelegatepublic void setDelegate(boolean delegate) Set the "follow standard delegation model" flag used to configure our ClassLoader.- Parameters:
- delegate- The new flag
 
 - 
isUseNamingpublic boolean isUseNaming() - Returns:
- true if the internal naming support is used.
 
 - 
setUseNamingpublic void setUseNaming(boolean useNaming) Enables or disables naming.- Parameters:
- useNaming-- trueto enable the naming environment
 
 - 
getApplicationEventListenerspublic java.lang.Object[] getApplicationEventListeners() Description copied from interface:ContextObtain the registered application event listeners.- Specified by:
- getApplicationEventListenersin interface- Context
- Returns:
- An array containing the application event listener instances for this web application in the order they were specified in the web application deployment descriptor
 
 - 
setApplicationEventListenerspublic void setApplicationEventListeners(java.lang.Object[] listeners) Store the set of initialized application event listener objects, in the order they were specified in the web application deployment descriptor, for this application. Note that this implementation is not thread safe. If two threads call this method concurrently, the result may be either set of listeners or a the union of both.- Specified by:
- setApplicationEventListenersin interface- Context
- Parameters:
- listeners- The set of instantiated listener objects.
 
 - 
addApplicationEventListenerpublic void addApplicationEventListener(java.lang.Object listener) Add a listener to the end of the list of initialized application event listeners.- Parameters:
- listener- The listener to add
 
 - 
getApplicationLifecycleListenerspublic java.lang.Object[] getApplicationLifecycleListeners() Description copied from interface:ContextObtain the registered application lifecycle listeners.- Specified by:
- getApplicationLifecycleListenersin interface- Context
- Returns:
- An array containing the application lifecycle listener instances for this web application in the order they were specified in the web application deployment descriptor
 
 - 
setApplicationLifecycleListenerspublic void setApplicationLifecycleListeners(java.lang.Object[] listeners) Store the set of initialized application lifecycle listener objects, in the order they were specified in the web application deployment descriptor, for this application.- Specified by:
- setApplicationLifecycleListenersin interface- Context
- Parameters:
- listeners- The set of instantiated listener objects.
 
 - 
addApplicationLifecycleListenerpublic void addApplicationLifecycleListener(java.lang.Object listener) Add a listener to the end of the list of initialized application lifecycle listeners.- Parameters:
- listener- The listener to add
 
 - 
getAntiResourceLockingpublic boolean getAntiResourceLocking() - Returns:
- the antiResourceLocking flag for this Context.
 
 - 
setAntiResourceLockingpublic void setAntiResourceLocking(boolean antiResourceLocking) Set the antiResourceLocking feature for this Context.- Parameters:
- antiResourceLocking- The new flag value
 
 - 
getUseBloomFilterForArchives@Deprecated public boolean getUseBloomFilterForArchives() Deprecated.- Specified by:
- getUseBloomFilterForArchivesin interface- Context
- Returns:
- trueif the resources archive lookup will use a bloom filter.
 
 - 
setUseBloomFilterForArchives@Deprecated public void setUseBloomFilterForArchives(boolean useBloomFilterForArchives) Deprecated.Description copied from interface:ContextSet bloom filter flag value.- Specified by:
- setUseBloomFilterForArchivesin interface- Context
- Parameters:
- useBloomFilterForArchives- The new fast class path scan flag
 
 - 
setParallelAnnotationScanningpublic void setParallelAnnotationScanning(boolean parallelAnnotationScanning) Description copied from interface:ContextSet the parallel annotation scanning value.- Specified by:
- setParallelAnnotationScanningin interface- Context
- Parameters:
- parallelAnnotationScanning- new parallel annotation scanning flag
 
 - 
getParallelAnnotationScanningpublic boolean getParallelAnnotationScanning() - Specified by:
- getParallelAnnotationScanningin interface- Context
- Returns:
- the value of the parallel annotation scanning flag. If true, it will dispatch scanning to the utility executor.
 
 - 
getCharsetMapperpublic CharsetMapper getCharsetMapper() - Returns:
- the Locale to character set mapper for this Context.
 
 - 
setCharsetMapperpublic void setCharsetMapper(CharsetMapper mapper) Set the Locale to character set mapper for this Context.- Parameters:
- mapper- The new mapper
 
 - 
getCharsetpublic java.lang.String getCharset(java.util.Locale locale) Description copied from interface:ContextObtain the character set name to use with the given Locale. Note that different Contexts may have different mappings of Locale to character set.- Specified by:
- getCharsetin interface- Context
- Parameters:
- locale- The locale for which the mapped character set should be returned
- Returns:
- The name of the character set to use with the given Locale
 
 - 
getConfigFilepublic java.net.URL getConfigFile() Description copied from interface:ContextReturn the URL of the XML descriptor for this context.- Specified by:
- getConfigFilein interface- Context
- Returns:
- The URL of the XML descriptor for this context
 
 - 
setConfigFilepublic void setConfigFile(java.net.URL configFile) Description copied from interface:ContextSet the URL of the XML descriptor for this context.- Specified by:
- setConfigFilein interface- Context
- Parameters:
- configFile- The URL of the XML descriptor for this context.
 
 - 
getConfiguredpublic boolean getConfigured() Description copied from interface:ContextReturn the "correctly configured" flag for this Context.- Specified by:
- getConfiguredin interface- Context
- Returns:
- trueif the Context has been correctly configured, otherwise- false
 
 - 
setConfiguredpublic void setConfigured(boolean configured) Set the "correctly configured" flag for this Context. This can be set to false by startup listeners that detect a fatal configuration error to avoid the application from being made available.- Specified by:
- setConfiguredin interface- Context
- Parameters:
- configured- The new correctly configured flag
 
 - 
getCookiespublic boolean getCookies() Description copied from interface:ContextReturn the "use cookies for session ids" flag.- Specified by:
- getCookiesin interface- Context
- Returns:
- trueif it is permitted to use cookies to track session IDs for this web application, otherwise- false
 
 - 
setCookiespublic void setCookies(boolean cookies) Set the "use cookies for session ids" flag.- Specified by:
- setCookiesin interface- Context
- Parameters:
- cookies- The new flag
 
 - 
getSessionCookieNamepublic java.lang.String getSessionCookieName() Gets the name to use for session cookies. Overrides any setting that may be specified by the application.- Specified by:
- getSessionCookieNamein interface- Context
- Returns:
- The value of the default session cookie name or null if not specified
 
 - 
setSessionCookieNamepublic void setSessionCookieName(java.lang.String sessionCookieName) Sets the name to use for session cookies. Overrides any setting that may be specified by the application.- Specified by:
- setSessionCookieNamein interface- Context
- Parameters:
- sessionCookieName- The name to use
 
 - 
getUseHttpOnlypublic boolean getUseHttpOnly() Gets the value of the use HttpOnly cookies for session cookies flag.- Specified by:
- getUseHttpOnlyin interface- Context
- Returns:
- trueif the HttpOnly flag should be set on session cookies
 
 - 
setUseHttpOnlypublic void setUseHttpOnly(boolean useHttpOnly) Sets the use HttpOnly cookies for session cookies flag.- Specified by:
- setUseHttpOnlyin interface- Context
- Parameters:
- useHttpOnly- Set to- trueto use HttpOnly cookies for session cookies
 
 - 
getSessionCookieDomainpublic java.lang.String getSessionCookieDomain() Gets the domain to use for session cookies. Overrides any setting that may be specified by the application.- Specified by:
- getSessionCookieDomainin interface- Context
- Returns:
- The value of the default session cookie domain or null if not specified
 
 - 
setSessionCookieDomainpublic void setSessionCookieDomain(java.lang.String sessionCookieDomain) Sets the domain to use for session cookies. Overrides any setting that may be specified by the application.- Specified by:
- setSessionCookieDomainin interface- Context
- Parameters:
- sessionCookieDomain- The domain to use
 
 - 
getSessionCookiePathpublic java.lang.String getSessionCookiePath() Gets the path to use for session cookies. Overrides any setting that may be specified by the application.- Specified by:
- getSessionCookiePathin interface- Context
- Returns:
- The value of the default session cookie path or null if not specified
 
 - 
setSessionCookiePathpublic void setSessionCookiePath(java.lang.String sessionCookiePath) Sets the path to use for session cookies. Overrides any setting that may be specified by the application.- Specified by:
- setSessionCookiePathin interface- Context
- Parameters:
- sessionCookiePath- The path to use
 
 - 
getSessionCookiePathUsesTrailingSlashpublic boolean getSessionCookiePathUsesTrailingSlash() Description copied from interface:ContextIs a / added to the end of the session cookie path to ensure browsers, particularly IE, don't send a session cookie for context /foo with requests intended for context /foobar.- Specified by:
- getSessionCookiePathUsesTrailingSlashin interface- Context
- Returns:
- trueif the slash is added, otherwise- false
 
 - 
setSessionCookiePathUsesTrailingSlashpublic void setSessionCookiePathUsesTrailingSlash(boolean sessionCookiePathUsesTrailingSlash) Description copied from interface:ContextConfigures if a / is added to the end of the session cookie path to ensure browsers, particularly IE, don't send a session cookie for context /foo with requests intended for context /foobar.- Specified by:
- setSessionCookiePathUsesTrailingSlashin interface- Context
- Parameters:
- sessionCookiePathUsesTrailingSlash-- trueif the slash is should be added, otherwise- false
 
 - 
getCrossContextpublic boolean getCrossContext() Description copied from interface:ContextReturn the "allow crossing servlet contexts" flag.- Specified by:
- getCrossContextin interface- Context
- Returns:
- trueif cross-contest requests are allowed from this web applications, otherwise- false
 
 - 
setCrossContextpublic void setCrossContext(boolean crossContext) Set the "allow crossing servlet contexts" flag.- Specified by:
- setCrossContextin interface- Context
- Parameters:
- crossContext- The new cross contexts flag
 
 - 
getDefaultContextXmlpublic java.lang.String getDefaultContextXml() 
 - 
setDefaultContextXmlpublic void setDefaultContextXml(java.lang.String defaultContextXml) Set the location of the default context xml that will be used. If not absolute, it'll be made relative to the engine's base dir ( which defaults to catalina.base system property ).- Parameters:
- defaultContextXml- The default web xml
 
 - 
getDefaultWebXmlpublic java.lang.String getDefaultWebXml() 
 - 
setDefaultWebXmlpublic void setDefaultWebXml(java.lang.String defaultWebXml) Set the location of the default web xml that will be used. If not absolute, it'll be made relative to the engine's base dir ( which defaults to catalina.base system property ).- Parameters:
- defaultWebXml- The default web xml
 
 - 
getStartupTimepublic long getStartupTime() Gets the time (in milliseconds) it took to start this context.- Returns:
- Time (in milliseconds) it took to start this context.
 
 - 
setStartupTimepublic void setStartupTime(long startupTime) 
 - 
getTldScanTimepublic long getTldScanTime() 
 - 
setTldScanTimepublic void setTldScanTime(long tldScanTime) 
 - 
getDenyUncoveredHttpMethodspublic boolean getDenyUncoveredHttpMethods() Description copied from interface:ContextReturn the deny-uncovered-http-methods flag for this web application.- Specified by:
- getDenyUncoveredHttpMethodsin interface- Context
- Returns:
- The current value of the flag
 
 - 
setDenyUncoveredHttpMethodspublic void setDenyUncoveredHttpMethods(boolean denyUncoveredHttpMethods) Description copied from interface:ContextSet the deny-uncovered-http-methods flag for this web application.- Specified by:
- setDenyUncoveredHttpMethodsin interface- Context
- Parameters:
- denyUncoveredHttpMethods- The new deny-uncovered-http-methods flag
 
 - 
getDisplayNamepublic java.lang.String getDisplayName() Description copied from interface:ContextReturn the display name of this web application.- Specified by:
- getDisplayNamein interface- Context
- Returns:
- the display name of this web application.
 
 - 
getAltDDNamepublic java.lang.String getAltDDName() Description copied from interface:ContextReturn the alternate Deployment Descriptor name.- Specified by:
- getAltDDNamein interface- Context
- Returns:
- the alternate Deployment Descriptor name.
 
 - 
setAltDDNamepublic void setAltDDName(java.lang.String altDDName) Set an alternate Deployment Descriptor name.- Specified by:
- setAltDDNamein interface- Context
- Parameters:
- altDDName- The new name
 
 - 
setDisplayNamepublic void setDisplayName(java.lang.String displayName) Set the display name of this web application.- Specified by:
- setDisplayNamein interface- Context
- Parameters:
- displayName- The new display name
 
 - 
getDistributablepublic boolean getDistributable() Description copied from interface:ContextGet the distributable flag for this web application.- Specified by:
- getDistributablein interface- Context
- Returns:
- the distributable flag for this web application.
 
 - 
setDistributablepublic void setDistributable(boolean distributable) Set the distributable flag for this web application.- Specified by:
- setDistributablein interface- Context
- Parameters:
- distributable- The new distributable flag
 
 - 
getDocBasepublic java.lang.String getDocBase() Description copied from interface:ContextObtain the document root for this Context.- Specified by:
- getDocBasein interface- Context
- Returns:
- An absolute pathname or a relative (to the Host's appBase) pathname.
 
 - 
setDocBasepublic void setDocBase(java.lang.String docBase) Description copied from interface:ContextSet the document root for this Context. This can be either an absolute pathname or a relative pathname. Relative pathnames are relative to the containing Host's appBase.- Specified by:
- setDocBasein interface- Context
- Parameters:
- docBase- The new document root
 
 - 
getJ2EEApplicationpublic java.lang.String getJ2EEApplication() 
 - 
setJ2EEApplicationpublic void setJ2EEApplication(java.lang.String j2EEApplication) 
 - 
getJ2EEServerpublic java.lang.String getJ2EEServer() 
 - 
setJ2EEServerpublic void setJ2EEServer(java.lang.String j2EEServer) 
 - 
getLoaderpublic Loader getLoader() 
 - 
setLoaderpublic void setLoader(Loader loader) Description copied from interface:ContextSet the Loader with which this Context is associated.
 - 
getManagerpublic Manager getManager() - Specified by:
- getManagerin interface- Context
- Returns:
- the Manager with which this Context is associated.  If there is
 no associated Manager, return null.
 
 - 
setManagerpublic void setManager(Manager manager) Description copied from interface:ContextSet the Manager with which this Context is associated.- Specified by:
- setManagerin interface- Context
- Parameters:
- manager- The newly associated Manager
 
 - 
getIgnoreAnnotationspublic boolean getIgnoreAnnotations() Description copied from interface:ContextDetermine if annotations parsing is currently disabled- Specified by:
- getIgnoreAnnotationsin interface- Context
- Returns:
- the boolean on the annotations parsing.
 
 - 
setIgnoreAnnotationspublic void setIgnoreAnnotations(boolean ignoreAnnotations) Set the boolean on the annotations parsing for this web application.- Specified by:
- setIgnoreAnnotationsin interface- Context
- Parameters:
- ignoreAnnotations- The boolean on the annotations parsing
 
 - 
getLoginConfigpublic LoginConfig getLoginConfig() - Specified by:
- getLoginConfigin interface- Context
- Returns:
- the login configuration descriptor for this web application.
 
 - 
setLoginConfigpublic void setLoginConfig(LoginConfig config) Set the login configuration descriptor for this web application.- Specified by:
- setLoginConfigin interface- Context
- Parameters:
- config- The new login configuration
 
 - 
getNamingResourcespublic NamingResourcesImpl getNamingResources() - Specified by:
- getNamingResourcesin interface- Context
- Returns:
- the naming resources associated with this web application.
 
 - 
setNamingResourcespublic void setNamingResources(NamingResourcesImpl namingResources) Set the naming resources for this web application.- Specified by:
- setNamingResourcesin interface- Context
- Parameters:
- namingResources- The new naming resources
 
 - 
getPathpublic java.lang.String getPath() 
 - 
setPathpublic void setPath(java.lang.String path) Set the context path for this Context.
 - 
getPublicIdpublic java.lang.String getPublicId() - Specified by:
- getPublicIdin interface- Context
- Returns:
- the public identifier of the deployment descriptor DTD that is currently being parsed.
 
 - 
setPublicIdpublic void setPublicId(java.lang.String publicId) Set the public identifier of the deployment descriptor DTD that is currently being parsed.- Specified by:
- setPublicIdin interface- Context
- Parameters:
- publicId- The public identifier
 
 - 
getReloadablepublic boolean getReloadable() - Specified by:
- getReloadablein interface- Context
- Returns:
- the reloadable flag for this web application.
 
 - 
getOverridepublic boolean getOverride() - Specified by:
- getOverridein interface- Context
- Returns:
- the default context override flag for this web application.
 
 - 
getOriginalDocBasepublic java.lang.String getOriginalDocBase() - Returns:
- the original document root for this Context. This can be an absolute pathname, a relative pathname, or a URL. Is only set as deployment has change docRoot!
 
 - 
setOriginalDocBasepublic void setOriginalDocBase(java.lang.String docBase) Set the original document root for this Context. This can be an absolute pathname, a relative pathname, or a URL.- Parameters:
- docBase- The original document root
 
 - 
getParentClassLoaderpublic java.lang.ClassLoader getParentClassLoader() Description copied from class:ContainerBaseReturn the parent class loader (if any) for this web application. This call is meaningful only after a Loader has been configured.- Specified by:
- getParentClassLoaderin interface- Container
- Overrides:
- getParentClassLoaderin class- ContainerBase
- Returns:
- the parent class loader (if any) for this web application. This call is meaningful only after a Loader has been configured.
 
 - 
getPrivilegedpublic boolean getPrivileged() - Specified by:
- getPrivilegedin interface- Context
- Returns:
- the privileged flag for this web application.
 
 - 
setPrivilegedpublic void setPrivileged(boolean privileged) Set the privileged flag for this web application.- Specified by:
- setPrivilegedin interface- Context
- Parameters:
- privileged- The new privileged flag
 
 - 
setReloadablepublic void setReloadable(boolean reloadable) Set the reloadable flag for this web application.- Specified by:
- setReloadablein interface- Context
- Parameters:
- reloadable- The new reloadable flag
 
 - 
setOverridepublic void setOverride(boolean override) Set the default context override flag for this web application.- Specified by:
- setOverridein interface- Context
- Parameters:
- override- The new override flag
 
 - 
setReplaceWelcomeFilespublic void setReplaceWelcomeFiles(boolean replaceWelcomeFiles) Set the "replace welcome files" property.- Parameters:
- replaceWelcomeFiles- The new property value
 
 - 
getServletContextpublic ServletContext getServletContext() - Specified by:
- getServletContextin interface- Context
- Returns:
- the servlet context for which this Context is a facade.
 
 - 
getSessionTimeoutpublic int getSessionTimeout() - Specified by:
- getSessionTimeoutin interface- Context
- Returns:
- the default session timeout (in minutes) for this web application.
 
 - 
setSessionTimeoutpublic void setSessionTimeout(int timeout) Set the default session timeout (in minutes) for this web application.- Specified by:
- setSessionTimeoutin interface- Context
- Parameters:
- timeout- The new default session timeout
 
 - 
getSwallowOutputpublic boolean getSwallowOutput() - Specified by:
- getSwallowOutputin interface- Context
- Returns:
- the value of the swallowOutput flag.
 
 - 
setSwallowOutputpublic void setSwallowOutput(boolean swallowOutput) Set the value of the swallowOutput flag. If set to true, the system.out and system.err will be redirected to the logger during a servlet execution.- Specified by:
- setSwallowOutputin interface- Context
- Parameters:
- swallowOutput- The new value
 
 - 
getUnloadDelaypublic long getUnloadDelay() - Returns:
- the value of the unloadDelay flag.
 
 - 
setUnloadDelaypublic void setUnloadDelay(long unloadDelay) Set the value of the unloadDelay flag, which represents the amount of ms that the container will wait when unloading servlets. Setting this to a small value may cause more requests to fail to complete when stopping a web application.- Parameters:
- unloadDelay- The new value
 
 - 
getUnpackWARpublic boolean getUnpackWAR() - Returns:
- unpack WAR flag.
 
 - 
setUnpackWARpublic void setUnpackWAR(boolean unpackWAR) Unpack WAR flag mutator.- Parameters:
- unpackWAR-- trueto unpack WARs on deployment
 
 - 
getCopyXMLpublic boolean getCopyXML() Flag which indicates if bundled context.xml files should be copied to the config folder. The doesn't occur by default.- Returns:
- trueif the- META-INF/context.xmlfile included in a WAR will be copied to the host configuration base folder on deployment
 
 - 
setCopyXMLpublic void setCopyXML(boolean copyXML) Allows copying a bundled context.xml file to the host configuration base folder on deployment.- Parameters:
- copyXML- the new flag value
 
 - 
getWrapperClasspublic java.lang.String getWrapperClass() - Specified by:
- getWrapperClassin interface- Context
- Returns:
- the Java class name of the Wrapper implementation used for servlets registered in this Context.
 
 - 
setWrapperClasspublic void setWrapperClass(java.lang.String wrapperClassName) Set the Java class name of the Wrapper implementation used for servlets registered in this Context.- Specified by:
- setWrapperClassin interface- Context
- Parameters:
- wrapperClassName- The new wrapper class name
- Throws:
- java.lang.IllegalArgumentException- if the specified wrapper class cannot be found or is not a subclass of StandardWrapper
 
 - 
getResourcespublic WebResourceRoot getResources() - Specified by:
- getResourcesin interface- Context
- Returns:
- the Resources with which this Context is associated.
 
 - 
setResourcespublic void setResources(WebResourceRoot resources) Description copied from interface:ContextSet the Resources object with which this Context is associated.- Specified by:
- setResourcesin interface- Context
- Parameters:
- resources- The newly associated Resources
 
 - 
getJspConfigDescriptorpublic JspConfigDescriptor getJspConfigDescriptor() - Specified by:
- getJspConfigDescriptorin interface- Context
- Returns:
- the JSP configuration for this context. Will be null if there is no JSP configuration.
 
 - 
setJspConfigDescriptorpublic void setJspConfigDescriptor(JspConfigDescriptor descriptor) Description copied from interface:ContextSet the JspConfigDescriptor for this context. A null value indicates there is not JSP configuration.- Specified by:
- setJspConfigDescriptorin interface- Context
- Parameters:
- descriptor- the new JSP configuration
 
 - 
getThreadBindingListenerpublic ThreadBindingListener getThreadBindingListener() - Specified by:
- getThreadBindingListenerin interface- Context
- Returns:
- the associated ThreadBindingListener.
 
 - 
setThreadBindingListenerpublic void setThreadBindingListener(ThreadBindingListener threadBindingListener) Description copied from interface:ContextGet the associated ThreadBindingListener.- Specified by:
- setThreadBindingListenerin interface- Context
- Parameters:
- threadBindingListener- Set the listener that will receive notifications when entering and exiting the application scope
 
 - 
getJndiExceptionOnFailedWritepublic boolean getJndiExceptionOnFailedWrite() - Returns:
- whether or not an attempt to modify the JNDI context will trigger an exception or if the request will be ignored.
 
 - 
setJndiExceptionOnFailedWritepublic void setJndiExceptionOnFailedWrite(boolean jndiExceptionOnFailedWrite) Controls whether or not an attempt to modify the JNDI context will trigger an exception or if the request will be ignored.- Parameters:
- jndiExceptionOnFailedWrite-- falseto avoid an exception
 
 - 
getCharsetMapperClasspublic java.lang.String getCharsetMapperClass() - Returns:
- the Locale to character set mapper class for this Context.
 
 - 
setCharsetMapperClasspublic void setCharsetMapperClass(java.lang.String mapper) Set the Locale to character set mapper class for this Context.- Parameters:
- mapper- The new mapper class
 
 - 
getWorkPathpublic java.lang.String getWorkPath() Get the absolute path to the work dir. To avoid duplication.- Returns:
- The work path
 
 - 
getWorkDirpublic java.lang.String getWorkDir() - Returns:
- the work directory for this Context.
 
 - 
setWorkDirpublic void setWorkDir(java.lang.String workDir) Set the work directory for this Context.- Parameters:
- workDir- The new work directory
 
 - 
getClearReferencesRmiTargetspublic boolean getClearReferencesRmiTargets() 
 - 
setClearReferencesRmiTargetspublic void setClearReferencesRmiTargets(boolean clearReferencesRmiTargets) 
 - 
getClearReferencesStopThreadspublic boolean getClearReferencesStopThreads() - Returns:
- the clearReferencesStopThreads flag for this Context.
 
 - 
setClearReferencesStopThreadspublic void setClearReferencesStopThreads(boolean clearReferencesStopThreads) Set the clearReferencesStopThreads feature for this Context.- Parameters:
- clearReferencesStopThreads- The new flag value
 
 - 
getClearReferencesStopTimerThreadspublic boolean getClearReferencesStopTimerThreads() - Returns:
- the clearReferencesStopTimerThreads flag for this Context.
 
 - 
setClearReferencesStopTimerThreadspublic void setClearReferencesStopTimerThreads(boolean clearReferencesStopTimerThreads) Set the clearReferencesStopTimerThreads feature for this Context.- Parameters:
- clearReferencesStopTimerThreads- The new flag value
 
 - 
getClearReferencesHttpClientKeepAliveThreadpublic boolean getClearReferencesHttpClientKeepAliveThread() - Returns:
- the clearReferencesHttpClientKeepAliveThread flag for this Context.
 
 - 
setClearReferencesHttpClientKeepAliveThreadpublic void setClearReferencesHttpClientKeepAliveThread(boolean clearReferencesHttpClientKeepAliveThread) Set the clearReferencesHttpClientKeepAliveThread feature for this Context.- Parameters:
- clearReferencesHttpClientKeepAliveThread- The new flag value
 
 - 
getRenewThreadsWhenStoppingContextpublic boolean getRenewThreadsWhenStoppingContext() 
 - 
setRenewThreadsWhenStoppingContextpublic void setRenewThreadsWhenStoppingContext(boolean renewThreadsWhenStoppingContext) 
 - 
getClearReferencesObjectStreamClassCachespublic boolean getClearReferencesObjectStreamClassCaches() 
 - 
setClearReferencesObjectStreamClassCachespublic void setClearReferencesObjectStreamClassCaches(boolean clearReferencesObjectStreamClassCaches) 
 - 
getClearReferencesThreadLocalspublic boolean getClearReferencesThreadLocals() 
 - 
setClearReferencesThreadLocalspublic void setClearReferencesThreadLocals(boolean clearReferencesThreadLocals) 
 - 
getSkipMemoryLeakChecksOnJvmShutdownpublic boolean getSkipMemoryLeakChecksOnJvmShutdown() 
 - 
setSkipMemoryLeakChecksOnJvmShutdownpublic void setSkipMemoryLeakChecksOnJvmShutdown(boolean skipMemoryLeakChecksOnJvmShutdown) 
 - 
getFailCtxIfServletStartFailspublic java.lang.Boolean getFailCtxIfServletStartFails() 
 - 
setFailCtxIfServletStartFailspublic void setFailCtxIfServletStartFails(java.lang.Boolean failCtxIfServletStartFails) 
 - 
getComputedFailCtxIfServletStartFailsprotected boolean getComputedFailCtxIfServletStartFails() 
 - 
addApplicationListenerpublic void addApplicationListener(java.lang.String listener) Add a new Listener class name to the set of Listeners configured for this application.- Specified by:
- addApplicationListenerin interface- Context
- Parameters:
- listener- Java class name of a listener class
 
 - 
addApplicationParameterpublic void addApplicationParameter(ApplicationParameter parameter) Add a new application parameter for this application.- Specified by:
- addApplicationParameterin interface- Context
- Parameters:
- parameter- The new application parameter
 
 - 
addChildpublic void addChild(Container child) Add a child Container, only if the proposed child is an implementation of Wrapper.- Specified by:
- addChildin interface- Container
- Overrides:
- addChildin class- ContainerBase
- Parameters:
- child- Child container to be added
- Throws:
- java.lang.IllegalArgumentException- if the proposed container is not an implementation of Wrapper
 
 - 
addConstraintpublic void addConstraint(SecurityConstraint constraint) Add a security constraint to the set for this web application.- Specified by:
- addConstraintin interface- Context
- Parameters:
- constraint- the new security constraint
 
 - 
addErrorPagepublic void addErrorPage(ErrorPage errorPage) Add an error page for the specified error or Java exception.- Specified by:
- addErrorPagein interface- Context
- Parameters:
- errorPage- The error page definition to be added
 
 - 
addFilterDefpublic void addFilterDef(FilterDef filterDef) Add a filter definition to this Context.- Specified by:
- addFilterDefin interface- Context
- Parameters:
- filterDef- The filter definition to be added
 
 - 
addFilterMappublic void addFilterMap(FilterMap filterMap) Add a filter mapping to this Context at the end of the current set of filter mappings.- Specified by:
- addFilterMapin interface- Context
- Parameters:
- filterMap- The filter mapping to be added
- Throws:
- java.lang.IllegalArgumentException- if the specified filter name does not match an existing filter definition, or the filter mapping is malformed
 
 - 
addFilterMapBeforepublic void addFilterMapBefore(FilterMap filterMap) Add a filter mapping to this Context before the mappings defined in the deployment descriptor but after any other mappings added via this method.- Specified by:
- addFilterMapBeforein interface- Context
- Parameters:
- filterMap- The filter mapping to be added
- Throws:
- java.lang.IllegalArgumentException- if the specified filter name does not match an existing filter definition, or the filter mapping is malformed
 
 - 
addLocaleEncodingMappingParameterpublic void addLocaleEncodingMappingParameter(java.lang.String locale, java.lang.String encoding)Add a Locale Encoding Mapping (see Sec 5.4 of Servlet spec 2.4)- Specified by:
- addLocaleEncodingMappingParameterin interface- Context
- Parameters:
- locale- locale to map an encoding for
- encoding- encoding to be used for a give locale
 
 - 
addMessageDestinationpublic void addMessageDestination(MessageDestination md) Add a message destination for this web application.- Parameters:
- md- New message destination
 
 - 
addMessageDestinationRef@Deprecated public void addMessageDestinationRef(MessageDestinationRef mdr) Deprecated.This will be removed in Tomcat 10. UsegetNamingResources()insteadAdd a message destination reference for this web application.- Parameters:
- mdr- New message destination reference
 
 - 
addMimeMappingpublic void addMimeMapping(java.lang.String extension, java.lang.String mimeType)Add a new MIME mapping, replacing any existing mapping for the specified extension.- Specified by:
- addMimeMappingin interface- Context
- Parameters:
- extension- Filename extension being mapped
- mimeType- Corresponding MIME type
 
 - 
addParameterpublic void addParameter(java.lang.String name, java.lang.String value)Add a new context initialization parameter.- Specified by:
- addParameterin interface- Context
- Parameters:
- name- Name of the new parameter
- value- Value of the new parameter
- Throws:
- java.lang.IllegalArgumentException- if the name or value is missing, or if this context initialization parameter has already been registered
 
 - 
addRoleMappingpublic void addRoleMapping(java.lang.String role, java.lang.String link)Add a security role reference for this web application.- Specified by:
- addRoleMappingin interface- Context
- Parameters:
- role- Security role used in the application
- link- Actual security role to check for
 
 - 
addSecurityRolepublic void addSecurityRole(java.lang.String role) Add a new security role for this web application.- Specified by:
- addSecurityRolein interface- Context
- Parameters:
- role- New security role
 
 - 
addServletMappingDecodedpublic void addServletMappingDecoded(java.lang.String pattern, java.lang.String name, boolean jspWildCard)Add a new servlet mapping, replacing any existing mapping for the specified pattern.- Specified by:
- addServletMappingDecodedin interface- Context
- Parameters:
- pattern- URL pattern to be mapped
- name- Name of the corresponding servlet to execute
- jspWildCard- true if name identifies the JspServlet and pattern contains a wildcard; false otherwise
- Throws:
- java.lang.IllegalArgumentException- if the specified servlet name is not known to this Context
 
 - 
addWatchedResourcepublic void addWatchedResource(java.lang.String name) Add a new watched resource to the set recognized by this Context.- Specified by:
- addWatchedResourcein interface- Context
- Parameters:
- name- New watched resource file name
 
 - 
addWelcomeFilepublic void addWelcomeFile(java.lang.String name) Add a new welcome file to the set recognized by this Context.- Specified by:
- addWelcomeFilein interface- Context
- Parameters:
- name- New welcome file name
 
 - 
addWrapperLifecyclepublic void addWrapperLifecycle(java.lang.String listener) Add the classname of a LifecycleListener to be added to each Wrapper appended to this Context.- Specified by:
- addWrapperLifecyclein interface- Context
- Parameters:
- listener- Java class name of a LifecycleListener class
 
 - 
addWrapperListenerpublic void addWrapperListener(java.lang.String listener) Add the classname of a ContainerListener to be added to each Wrapper appended to this Context.- Specified by:
- addWrapperListenerin interface- Context
- Parameters:
- listener- Java class name of a ContainerListener class
 
 - 
createWrapperpublic Wrapper createWrapper() Factory method to create and return a new Wrapper instance, of the Java implementation class appropriate for this Context implementation. The constructor of the instantiated Wrapper will have been called, but no properties will have been set.- Specified by:
- createWrapperin interface- Context
- Returns:
- a newly created wrapper instance that is used to wrap a Servlet
 
 - 
findApplicationListenerspublic java.lang.String[] findApplicationListeners() Return the set of application listener class names configured for this application.- Specified by:
- findApplicationListenersin interface- Context
- Returns:
- the set of application listener class names configured for this application.
 
 - 
findApplicationParameterspublic ApplicationParameter[] findApplicationParameters() Return the set of application parameters for this application.- Specified by:
- findApplicationParametersin interface- Context
- Returns:
- the set of application parameters for this application.
 
 - 
findConstraintspublic SecurityConstraint[] findConstraints() Return the security constraints for this web application. If there are none, a zero-length array is returned.- Specified by:
- findConstraintsin interface- Context
- Returns:
- the set of security constraints for this web application. If there are none, a zero-length array is returned.
 
 - 
findErrorPagepublic ErrorPage findErrorPage(int errorCode) Return the error page entry for the specified HTTP error code, if any; otherwise returnnull.- Specified by:
- findErrorPagein interface- Context
- Parameters:
- errorCode- Error code to look up
- Returns:
- the error page entry for the specified HTTP error code,
 if any; otherwise return null.
 
 - 
findErrorPage@Deprecated public ErrorPage findErrorPage(java.lang.String exceptionType) Deprecated.- Specified by:
- findErrorPagein interface- Context
- Parameters:
- exceptionType- Exception type to look up
- Returns:
- the error page entry for the specified Java exception type,
         if any; otherwise return null.
 
 - 
findErrorPagepublic ErrorPage findErrorPage(java.lang.Throwable exceptionType) Description copied from interface:ContextFind and return the ErrorPage instance for the specified exception's class, or an ErrorPage instance for the closest superclass for which there is such a definition. If no associated ErrorPage instance is found, returnnull.- Specified by:
- findErrorPagein interface- Context
- Parameters:
- exceptionType- The exception type for which to find an ErrorPage
- Returns:
- the error page entry for the specified Java exception type,
         if any; otherwise return null.
 
 - 
findErrorPagespublic ErrorPage[] findErrorPages() Return the set of defined error pages for all specified error codes and exception types.- Specified by:
- findErrorPagesin interface- Context
- Returns:
- the set of defined error pages for all specified error codes and exception types.
 
 - 
findFilterDefpublic FilterDef findFilterDef(java.lang.String filterName) Return the filter definition for the specified filter name, if any; otherwise returnnull.- Specified by:
- findFilterDefin interface- Context
- Parameters:
- filterName- Filter name to look up
- Returns:
- the filter definition for the specified filter name, if any;
 otherwise return null.
 
 - 
findFilterDefspublic FilterDef[] findFilterDefs() - Specified by:
- findFilterDefsin interface- Context
- Returns:
- the set of defined filters for this Context.
 
 - 
findFilterMapspublic FilterMap[] findFilterMaps() - Specified by:
- findFilterMapsin interface- Context
- Returns:
- the set of filter mappings for this Context.
 
 - 
findMessageDestinationpublic MessageDestination findMessageDestination(java.lang.String name) - Parameters:
- name- Name of the desired message destination
- Returns:
- the message destination with the specified name, if any; otherwise, return null.
 
 - 
findMessageDestinationspublic MessageDestination[] findMessageDestinations() - Returns:
- the set of defined message destinations for this web application. If none have been defined, a zero-length array is returned.
 
 - 
findMessageDestinationRef@Deprecated public MessageDestinationRef findMessageDestinationRef(java.lang.String name) Deprecated.This will be removed in Tomcat 10. UsegetNamingResources()instead- Parameters:
- name- Name of the desired message destination ref
- Returns:
- the message destination ref with the specified name, if any; otherwise, return null.
 
 - 
findMessageDestinationRefs@Deprecated public MessageDestinationRef[] findMessageDestinationRefs() Deprecated.This will be removed in Tomcat 10. UsegetNamingResources()instead- Returns:
- the set of defined message destination refs for this web application. If none have been defined, a zero-length array is returned.
 
 - 
findMimeMappingpublic java.lang.String findMimeMapping(java.lang.String extension) - Specified by:
- findMimeMappingin interface- Context
- Parameters:
- extension- Extension to map to a MIME type
- Returns:
- the MIME type to which the specified extension is mapped, if any; otherwise return null.
 
 - 
findMimeMappingspublic java.lang.String[] findMimeMappings() - Specified by:
- findMimeMappingsin interface- Context
- Returns:
- the extensions for which MIME mappings are defined. If there are none, a zero-length array is returned.
 
 - 
findParameterpublic java.lang.String findParameter(java.lang.String name) - Specified by:
- findParameterin interface- Context
- Parameters:
- name- Name of the parameter to return
- Returns:
- the value for the specified context initialization parameter name, if any; otherwise return
             null.
 
 - 
findParameterspublic java.lang.String[] findParameters() - Specified by:
- findParametersin interface- Context
- Returns:
- the names of all defined context initialization parameters for this Context. If no parameters are defined, a zero-length array is returned.
 
 - 
findRoleMappingpublic java.lang.String findRoleMapping(java.lang.String role) For the given security role (as used by an application), return the corresponding role name (as defined by the underlying Realm) if there is one. Otherwise, return the specified role unchanged.- Specified by:
- findRoleMappingin interface- Context
- Parameters:
- role- Security role to map
- Returns:
- the role name
 
 - 
findSecurityRolepublic boolean findSecurityRole(java.lang.String role) - Specified by:
- findSecurityRolein interface- Context
- Parameters:
- role- Security role to verify
- Returns:
- trueif the specified security role is defined for this application; otherwise return- false.
 
 - 
findSecurityRolespublic java.lang.String[] findSecurityRoles() - Specified by:
- findSecurityRolesin interface- Context
- Returns:
- the security roles defined for this application. If none have been defined, a zero-length array is returned.
 
 - 
findServletMappingpublic java.lang.String findServletMapping(java.lang.String pattern) - Specified by:
- findServletMappingin interface- Context
- Parameters:
- pattern- Pattern for which a mapping is requested
- Returns:
- the servlet name mapped by the specified pattern (if any); otherwise return null.
 
 - 
findServletMappingspublic java.lang.String[] findServletMappings() - Specified by:
- findServletMappingsin interface- Context
- Returns:
- the patterns of all defined servlet mappings for this Context. If no mappings are defined, a zero-length array is returned.
 
 - 
findStatusPage@Deprecated public java.lang.String findStatusPage(int status) Deprecated.- Specified by:
- findStatusPagein interface- Context
- Parameters:
- status- HTTP status code to look up
- Returns:
- the context-relative URI of the error page for the specified
 HTTP status code, if any; otherwise return null.
 
 - 
findStatusPages@Deprecated public int[] findStatusPages() Deprecated.- Specified by:
- findStatusPagesin interface- Context
- Returns:
- the set of HTTP status codes for which error pages have been specified. If none are specified, a zero-length array is returned.
 
 - 
findWelcomeFilepublic boolean findWelcomeFile(java.lang.String name) - Specified by:
- findWelcomeFilein interface- Context
- Parameters:
- name- Welcome file to verify
- Returns:
- trueif the specified welcome file is defined for this Context; otherwise return- false.
 
 - 
findWatchedResourcespublic java.lang.String[] findWatchedResources() - Specified by:
- findWatchedResourcesin interface- Context
- Returns:
- the set of watched resources for this Context. If none are defined, a zero length array will be returned.
 
 - 
findWelcomeFilespublic java.lang.String[] findWelcomeFiles() - Specified by:
- findWelcomeFilesin interface- Context
- Returns:
- the set of welcome files defined for this Context. If none are defined, a zero-length array is returned.
 
 - 
findWrapperLifecyclespublic java.lang.String[] findWrapperLifecycles() - Specified by:
- findWrapperLifecyclesin interface- Context
- Returns:
- the set of LifecycleListener classes that will be added to newly created Wrappers automatically.
 
 - 
findWrapperListenerspublic java.lang.String[] findWrapperListeners() - Specified by:
- findWrapperListenersin interface- Context
- Returns:
- the set of ContainerListener classes that will be added to newly created Wrappers automatically.
 
 - 
reloadpublic void reload() Reload this web application, if reloading is supported.IMPLEMENTATION NOTE: This method is designed to deal with reloads required by changes to classes in the underlying repositories of our class loader and changes to the web.xml file. It does not handle changes to any context.xml file. If the context.xml has changed, you should stop this Context and create (and start) a new Context instance instead. Note that there is additional code in CoyoteAdapter#postParseRequest()to handle mapping requests to paused Contexts.
 - 
removeApplicationListenerpublic void removeApplicationListener(java.lang.String listener) Remove the specified application listener class from the set of listeners for this application.- Specified by:
- removeApplicationListenerin interface- Context
- Parameters:
- listener- Java class name of the listener to be removed
 
 - 
removeApplicationParameterpublic void removeApplicationParameter(java.lang.String name) Remove the application parameter with the specified name from the set for this application.- Specified by:
- removeApplicationParameterin interface- Context
- Parameters:
- name- Name of the application parameter to remove
 
 - 
removeChildpublic void removeChild(Container child) Add a child Container, only if the proposed child is an implementation of Wrapper.- Specified by:
- removeChildin interface- Container
- Overrides:
- removeChildin class- ContainerBase
- Parameters:
- child- Child container to be added
- Throws:
- java.lang.IllegalArgumentException- if the proposed container is not an implementation of Wrapper
 
 - 
removeConstraintpublic void removeConstraint(SecurityConstraint constraint) Remove the specified security constraint from this web application.- Specified by:
- removeConstraintin interface- Context
- Parameters:
- constraint- Constraint to be removed
 
 - 
removeErrorPagepublic void removeErrorPage(ErrorPage errorPage) Remove the error page for the specified error code or Java language exception, if it exists; otherwise, no action is taken.- Specified by:
- removeErrorPagein interface- Context
- Parameters:
- errorPage- The error page definition to be removed
 
 - 
removeFilterDefpublic void removeFilterDef(FilterDef filterDef) Remove the specified filter definition from this Context, if it exists; otherwise, no action is taken.- Specified by:
- removeFilterDefin interface- Context
- Parameters:
- filterDef- Filter definition to be removed
 
 - 
removeFilterMappublic void removeFilterMap(FilterMap filterMap) Remove a filter mapping from this Context.- Specified by:
- removeFilterMapin interface- Context
- Parameters:
- filterMap- The filter mapping to be removed
 
 - 
removeMessageDestinationpublic void removeMessageDestination(java.lang.String name) Remove any message destination with the specified name.- Parameters:
- name- Name of the message destination to remove
 
 - 
removeMessageDestinationRef@Deprecated public void removeMessageDestinationRef(java.lang.String name) Deprecated.This will be removed in Tomcat 10. UsegetNamingResources()insteadRemove any message destination ref with the specified name.- Parameters:
- name- Name of the message destination ref to remove
 
 - 
removeMimeMappingpublic void removeMimeMapping(java.lang.String extension) Remove the MIME mapping for the specified extension, if it exists; otherwise, no action is taken.- Specified by:
- removeMimeMappingin interface- Context
- Parameters:
- extension- Extension to remove the mapping for
 
 - 
removeParameterpublic void removeParameter(java.lang.String name) Remove the context initialization parameter with the specified name, if it exists; otherwise, no action is taken.- Specified by:
- removeParameterin interface- Context
- Parameters:
- name- Name of the parameter to remove
 
 - 
removeRoleMappingpublic void removeRoleMapping(java.lang.String role) Remove any security role reference for the specified name- Specified by:
- removeRoleMappingin interface- Context
- Parameters:
- role- Security role (as used in the application) to remove
 
 - 
removeSecurityRolepublic void removeSecurityRole(java.lang.String role) Remove any security role with the specified name.- Specified by:
- removeSecurityRolein interface- Context
- Parameters:
- role- Security role to remove
 
 - 
removeServletMappingpublic void removeServletMapping(java.lang.String pattern) Remove any servlet mapping for the specified pattern, if it exists; otherwise, no action is taken.- Specified by:
- removeServletMappingin interface- Context
- Parameters:
- pattern- URL pattern of the mapping to remove
 
 - 
removeWatchedResourcepublic void removeWatchedResource(java.lang.String name) Remove the specified watched resource name from the list associated with this Context.- Specified by:
- removeWatchedResourcein interface- Context
- Parameters:
- name- Name of the watched resource to be removed
 
 - 
removeWelcomeFilepublic void removeWelcomeFile(java.lang.String name) Remove the specified welcome file name from the list recognized by this Context.- Specified by:
- removeWelcomeFilein interface- Context
- Parameters:
- name- Name of the welcome file to be removed
 
 - 
removeWrapperLifecyclepublic void removeWrapperLifecycle(java.lang.String listener) Remove a class name from the set of LifecycleListener classes that will be added to newly created Wrappers.- Specified by:
- removeWrapperLifecyclein interface- Context
- Parameters:
- listener- Class name of a LifecycleListener class to be removed
 
 - 
removeWrapperListenerpublic void removeWrapperListener(java.lang.String listener) Remove a class name from the set of ContainerListener classes that will be added to newly created Wrappers.- Specified by:
- removeWrapperListenerin interface- Context
- Parameters:
- listener- Class name of a ContainerListener class to be removed
 
 - 
getProcessingTimepublic long getProcessingTime() Gets the cumulative processing times of all servlets in this StandardContext.- Returns:
- Cumulative processing times of all servlets in this StandardContext
 
 - 
getMaxTimepublic long getMaxTime() Gets the maximum processing time of all servlets in this StandardContext.- Returns:
- Maximum processing time of all servlets in this StandardContext
 
 - 
getMinTimepublic long getMinTime() Gets the minimum processing time of all servlets in this StandardContext.- Returns:
- Minimum processing time of all servlets in this StandardContext
 
 - 
getRequestCountpublic int getRequestCount() Gets the cumulative request count of all servlets in this StandardContext.- Returns:
- Cumulative request count of all servlets in this StandardContext
 
 - 
getErrorCountpublic int getErrorCount() Gets the cumulative error count of all servlets in this StandardContext.- Returns:
- Cumulative error count of all servlets in this StandardContext
 
 - 
getRealPathpublic java.lang.String getRealPath(java.lang.String path) Return the real path for a given virtual path, if possible; otherwise returnnull.- Specified by:
- getRealPathin interface- Context
- Parameters:
- path- The path to the desired resource
- Returns:
- the real path for a given virtual path, if possible; otherwise
 return null.
 
 - 
dynamicServletCreatedpublic void dynamicServletCreated(Servlet servlet) Hook to track which Servlets were created viaServletContext.createServlet(Class).- Parameters:
- servlet- the created Servlet
 
 - 
wasCreatedDynamicServletpublic boolean wasCreatedDynamicServlet(Servlet servlet) 
 - 
filterStartpublic boolean filterStart() Configure and initialize the set of filters for this Context.- Returns:
- trueif all filter initialization completed successfully, or- falseotherwise.
 
 - 
filterStoppublic boolean filterStop() Finalize and release the set of filters for this Context.- Returns:
- trueif all filter finalization completed successfully, or- falseotherwise.
 
 - 
findFilterConfigpublic FilterConfig findFilterConfig(java.lang.String name) Find and return the initializedFilterConfigfor the specified filter name, if any; otherwise returnnull.- Parameters:
- name- Name of the desired filter
- Returns:
- the filter config object
 
 - 
listenerStartpublic boolean listenerStart() Configure the set of instantiated application event listeners for this Context.- Returns:
- trueif all listeners wre initialized successfully, or- falseotherwise.
 
 - 
listenerStoppublic boolean listenerStop() Send an application stop event to all interested listeners.- Returns:
- trueif all events were sent successfully, or- falseotherwise.
 
 - 
resourcesStartpublic void resourcesStart() throws LifecycleExceptionAllocate resources, including proxy.- Throws:
- LifecycleException- if a start error occurs
 
 - 
resourcesStoppublic boolean resourcesStop() Deallocate resources and destroy proxy.- Returns:
- trueif no error occurred
 
 - 
loadOnStartuppublic boolean loadOnStartup(Container[] children) Load and initialize all servlets marked "load on startup" in the web application deployment descriptor.- Parameters:
- children- Array of wrappers for all currently defined servlets (including those not declared load on startup)
- Returns:
- trueif load on startup was considered successful
 
 - 
startInternalprotected void startInternal() throws LifecycleExceptionStart this component and implement the requirements ofLifecycleBase.startInternal().- Overrides:
- startInternalin class- ContainerBase
- Throws:
- LifecycleException- if this component detects a fatal error that prevents this component from being used
 
 - 
createInstanceManagerpublic InstanceManager createInstanceManager() Description copied from interface:ContextFactory method to create and return a new InstanceManager instance. This can be used for framework integration or easier configuration with custom Context implementations.- Specified by:
- createInstanceManagerin interface- Context
- Returns:
- the instance manager
 
 - 
stopInternalprotected void stopInternal() throws LifecycleExceptionStop this component and implement the requirements ofLifecycleBase.stopInternal().- Overrides:
- stopInternalin class- ContainerBase
- Throws:
- LifecycleException- if this component detects a fatal error that prevents this component from being used
 
 - 
destroyInternalprotected void destroyInternal() throws LifecycleExceptionDestroy needs to clean up the context completely. The problem is that undoing all the config in start() and restoring a 'fresh' state is impossible. After stop()/destroy()/init()/start() we should have the same state as if a fresh start was done - i.e read modified web.xml, etc. This can only be done by completely removing the context object and remapping a new one, or by cleaning up everything.- Overrides:
- destroyInternalin class- ContainerBase
- Throws:
- LifecycleException- If the destruction fails
 
 - 
backgroundProcesspublic void backgroundProcess() Description copied from class:ContainerBaseExecute a periodic task, such as reloading, etc. This method will be invoked inside the classloading context of this container. Unexpected throwables will be caught and logged.- Specified by:
- backgroundProcessin interface- Container
- Overrides:
- backgroundProcessin class- ContainerBase
 
 - 
adjustURLPatternprotected java.lang.String adjustURLPattern(java.lang.String urlPattern) Adjust the URL pattern to begin with a leading slash, if appropriate (i.e. we are running a servlet 2.2 application). Otherwise, return the specified URL pattern unchanged.- Parameters:
- urlPattern- The URL pattern to be adjusted (if needed) and returned
- Returns:
- the URL pattern with a leading slash if needed
 
 - 
isServlet22public boolean isServlet22() Are we processing a version 2.2 deployment descriptor?- Specified by:
- isServlet22in interface- Context
- Returns:
- trueif running a legacy Servlet 2.2 application
 
 - 
addServletSecuritypublic java.util.Set<java.lang.String> addServletSecurity(ServletRegistration.Dynamic registration, ServletSecurityElement servletSecurityElement) Description copied from interface:ContextNotification that Servlet security has been dynamically set in aServletRegistration.Dynamic- Specified by:
- addServletSecurityin interface- Context
- Parameters:
- registration- Servlet security was modified for
- servletSecurityElement- new security constraints for this Servlet
- Returns:
- urls currently mapped to this registration that are already present in web.xml
 
 - 
bindThreadprotected java.lang.ClassLoader bindThread() Bind current thread, both for CL purposes and for JNDI ENC support during : startup, shutdown and reloading of the context.- Returns:
- the previous context class loader
 
 - 
unbindThreadprotected void unbindThread(java.lang.ClassLoader oldContextClassLoader) Unbind thread and restore the specified context classloader.- Parameters:
- oldContextClassLoader- the previous classloader
 
 - 
bindpublic java.lang.ClassLoader bind(boolean usePrivilegedAction, java.lang.ClassLoader originalClassLoader)Description copied from interface:ContextBindChange the current thread context class loader to the web application class loader. If no web application class loader is defined, or if the current thread is already using the web application class loader then no change will be made. If the class loader is changed and aThreadBindingListeneris configured thenThreadBindingListener.bind()will be called after the change has been made.- Specified by:
- bindin interface- ContextBind
- Parameters:
- usePrivilegedAction- Should a- PrivilegedActionbe used when obtaining the current thread context class loader and setting the new one?
- originalClassLoader- The current class loader if known to save this method having to look it up
- Returns:
- If the class loader has been changed by the method it will return the thread context class loader in use when the method was called. If no change was made then this method returns null.
 
 - 
unbindpublic void unbind(boolean usePrivilegedAction, java.lang.ClassLoader originalClassLoader)Description copied from interface:ContextBindRestore the current thread context class loader to the original class loader in used beforeContextBind.bind(boolean, ClassLoader)was called. If no original class loader is passed to this method then no change will be made. If the class loader is changed and aThreadBindingListeneris configured thenThreadBindingListener.unbind()will be called before the change is made.- Specified by:
- unbindin interface- ContextBind
- Parameters:
- usePrivilegedAction- Should a- PrivilegedActionbe used when setting the current thread context class loader?
- originalClassLoader- The class loader to restore as the thread context class loader
 
 - 
getNamingContextListenerpublic NamingContextListener getNamingContextListener() Naming context listener accessor.- Returns:
- the naming context listener associated with the webapp
 
 - 
setNamingContextListenerpublic void setNamingContextListener(NamingContextListener namingContextListener) Naming context listener setter.- Parameters:
- namingContextListener- the new naming context listener
 
 - 
getPausedpublic boolean getPaused() Description copied from interface:ContextIs this Context paused whilst it is reloaded?
 - 
fireRequestInitEventpublic boolean fireRequestInitEvent(ServletRequest request) Description copied from interface:ContextNotify allServletRequestListeners that a request has started.- Specified by:
- fireRequestInitEventin interface- Context
- Parameters:
- request- The request object that will be passed to the listener
- Returns:
- trueif the listeners fire successfully, else- false
 
 - 
fireRequestDestroyEventpublic boolean fireRequestDestroyEvent(ServletRequest request) Description copied from interface:ContextNotify allServletRequestListeners that a request has ended.- Specified by:
- fireRequestDestroyEventin interface- Context
- Parameters:
- request- The request object that will be passed to the listener
- Returns:
- trueif the listeners fire successfully, else- false
 
 - 
addPostConstructMethodpublic void addPostConstructMethod(java.lang.String clazz, java.lang.String method)Description copied from interface:ContextAdd a post construct method definition for the given class, if there is an existing definition for the specified class - IllegalArgumentException will be thrown.- Specified by:
- addPostConstructMethodin interface- Context
- Parameters:
- clazz- Fully qualified class name
- method- Post construct method name
 
 - 
removePostConstructMethodpublic void removePostConstructMethod(java.lang.String clazz) Description copied from interface:ContextRemoves the post construct method definition for the given class, if it exists; otherwise, no action is taken.- Specified by:
- removePostConstructMethodin interface- Context
- Parameters:
- clazz- Fully qualified class name
 
 - 
addPreDestroyMethodpublic void addPreDestroyMethod(java.lang.String clazz, java.lang.String method)Description copied from interface:ContextAdd a pre destroy method definition for the given class, if there is an existing definition for the specified class - IllegalArgumentException will be thrown.- Specified by:
- addPreDestroyMethodin interface- Context
- Parameters:
- clazz- Fully qualified class name
- method- Post construct method name
 
 - 
removePreDestroyMethodpublic void removePreDestroyMethod(java.lang.String clazz) Description copied from interface:ContextRemoves the pre destroy method definition for the given class, if it exists; otherwise, no action is taken.- Specified by:
- removePreDestroyMethodin interface- Context
- Parameters:
- clazz- Fully qualified class name
 
 - 
findPostConstructMethodpublic java.lang.String findPostConstructMethod(java.lang.String clazz) Description copied from interface:ContextReturns the method name that is specified as post construct method for the given class, if it exists; otherwiseNULLwill be returned.- Specified by:
- findPostConstructMethodin interface- Context
- Parameters:
- clazz- Fully qualified class name
- Returns:
- the method name that is specified as post construct method for
         the given class, if it exists; otherwise NULLwill be returned.
 
 - 
findPreDestroyMethodpublic java.lang.String findPreDestroyMethod(java.lang.String clazz) Description copied from interface:ContextReturns the method name that is specified as pre destroy method for the given class, if it exists; otherwiseNULLwill be returned.- Specified by:
- findPreDestroyMethodin interface- Context
- Parameters:
- clazz- Fully qualified class name
- Returns:
- the method name that is specified as pre destroy method for the
         given class, if it exists; otherwise NULLwill be returned.
 
 - 
findPostConstructMethodspublic java.util.Map<java.lang.String,java.lang.String> findPostConstructMethods() Description copied from interface:ContextReturns a map with keys - fully qualified class names of the classes that have post construct methods and the values are the corresponding method names. If there are no such classes an empty map will be returned.- Specified by:
- findPostConstructMethodsin interface- Context
- Returns:
- a map with keys - fully qualified class names of the classes that have post construct methods and the values are the corresponding method names.
 
 - 
findPreDestroyMethodspublic java.util.Map<java.lang.String,java.lang.String> findPreDestroyMethods() Description copied from interface:ContextReturns a map with keys - fully qualified class names of the classes that have pre destroy methods and the values are the corresponding method names. If there are no such classes an empty map will be returned.- Specified by:
- findPreDestroyMethodsin interface- Context
- Returns:
- a map with keys - fully qualified class names of the classes that have pre destroy methods and the values are the corresponding method names.
 
 - 
postWorkDirectoryprotected void postWorkDirectory() Set the appropriate context attribute for our work directory.
 - 
getObjectNameKeyPropertiesprotected java.lang.String getObjectNameKeyProperties() Description copied from class:LifecycleMBeanBaseAllow sub-classes to specify the key properties component of theObjectNamethat will be used to register this component.- Specified by:
- getObjectNameKeyPropertiesin class- LifecycleMBeanBase
- Returns:
- The string representation of the key properties component of the
          desired ObjectName
 
 - 
initInternalprotected void initInternal() throws LifecycleExceptionDescription copied from class:LifecycleMBeanBaseSub-classes wishing to perform additional initialization should override this method, ensuring that super.initInternal() is the first call in the overriding method.- Overrides:
- initInternalin class- LifecycleMBeanBase
- Throws:
- LifecycleException- If the initialisation fails
 
 - 
removeNotificationListenerpublic void removeNotificationListener(javax.management.NotificationListener listener, javax.management.NotificationFilter filter, java.lang.Object object) throws javax.management.ListenerNotFoundExceptionRemove a JMX notificationListener- Specified by:
- removeNotificationListenerin interface- javax.management.NotificationEmitter
- Throws:
- javax.management.ListenerNotFoundException
- See Also:
- NotificationEmitter.removeNotificationListener(javax.management.NotificationListener, javax.management.NotificationFilter, java.lang.Object)
 
 - 
getNotificationInfopublic javax.management.MBeanNotificationInfo[] getNotificationInfo() Get JMX Broadcaster Info- Specified by:
- getNotificationInfoin interface- javax.management.NotificationBroadcaster
- See Also:
- NotificationBroadcaster.getNotificationInfo()
 
 - 
addNotificationListenerpublic void addNotificationListener(javax.management.NotificationListener listener, javax.management.NotificationFilter filter, java.lang.Object object) throws java.lang.IllegalArgumentExceptionAdd a JMX NotificationListener- Specified by:
- addNotificationListenerin interface- javax.management.NotificationBroadcaster
- Throws:
- java.lang.IllegalArgumentException
- See Also:
- NotificationBroadcaster.addNotificationListener(javax.management.NotificationListener, javax.management.NotificationFilter, java.lang.Object)
 
 - 
removeNotificationListenerpublic void removeNotificationListener(javax.management.NotificationListener listener) throws javax.management.ListenerNotFoundExceptionRemove a JMX-NotificationListener- Specified by:
- removeNotificationListenerin interface- javax.management.NotificationBroadcaster
- Throws:
- javax.management.ListenerNotFoundException
- See Also:
- NotificationBroadcaster.removeNotificationListener(javax.management.NotificationListener)
 
 - 
getWelcomeFilespublic java.lang.String[] getWelcomeFiles() - Returns:
- the naming resources associated with this web application.
 
 - 
getXmlNamespaceAwarepublic boolean getXmlNamespaceAware() Description copied from interface:ContextWill the parsing of web.xml and web-fragment.xml files for this Context be performed by a namespace aware parser?- Specified by:
- getXmlNamespaceAwarein interface- Context
- Returns:
- true if namespace awareness is enabled.
 
 - 
setXmlNamespaceAwarepublic void setXmlNamespaceAware(boolean webXmlNamespaceAware) Description copied from interface:ContextControls whether the parsing of web.xml and web-fragment.xml files for this Context will be performed by a namespace aware parser.- Specified by:
- setXmlNamespaceAwarein interface- Context
- Parameters:
- webXmlNamespaceAware- true to enable namespace awareness
 
 - 
setXmlValidationpublic void setXmlValidation(boolean webXmlValidation) Description copied from interface:ContextControls whether the parsing of web.xml and web-fragment.xml files for this Context will be performed by a validating parser.- Specified by:
- setXmlValidationin interface- Context
- Parameters:
- webXmlValidation- true to enable xml validation
 
 - 
getXmlValidationpublic boolean getXmlValidation() Description copied from interface:ContextWill the parsing of web.xml and web-fragment.xml files for this Context be performed by a validating parser?- Specified by:
- getXmlValidationin interface- Context
- Returns:
- true if validation is enabled.
 
 - 
setXmlBlockExternalpublic void setXmlBlockExternal(boolean xmlBlockExternal) Description copied from interface:ContextControls whether the parsing of web.xml, web-fragment.xml, *.tld, *.jspx, *.tagx and tagplugin.xml files for this Context will block the use of external entities.- Specified by:
- setXmlBlockExternalin interface- Context
- Parameters:
- xmlBlockExternal- true to block external entities
 
 - 
getXmlBlockExternalpublic boolean getXmlBlockExternal() Description copied from interface:ContextWill the parsing of web.xml, web-fragment.xml, *.tld, *.jspx, *.tagx and tagplugin.xml files for this Context block the use of external entities?- Specified by:
- getXmlBlockExternalin interface- Context
- Returns:
- true if access to external entities is blocked
 
 - 
setTldValidationpublic void setTldValidation(boolean tldValidation) Description copied from interface:ContextControls whether the parsing of *.tld files for this Context will be performed by a validating parser.- Specified by:
- setTldValidationin interface- Context
- Parameters:
- tldValidation- true to enable xml validation
 
 - 
getTldValidationpublic boolean getTldValidation() Description copied from interface:ContextWill the parsing of *.tld files for this Context be performed by a validating parser?- Specified by:
- getTldValidationin interface- Context
- Returns:
- true if validation is enabled.
 
 - 
getServerpublic java.lang.String getServer() 
 - 
setServerpublic java.lang.String setServer(java.lang.String server) 
 - 
getJavaVMs@Deprecated public java.lang.String[] getJavaVMs() Deprecated.Unused. Will be removed in Tomcat 10.1.Unused.- Returns:
- The current array.
 
 - 
setJavaVMs@Deprecated public java.lang.String[] setJavaVMs(java.lang.String[] javaVMs) Deprecated.Unused. Will be removed in Tomcat 10.1.Unused.- Parameters:
- javaVMs- The new value for the array.
- Returns:
- The new value for the array.
 
 - 
getStartTimepublic long getStartTime() Gets the time this context was started.- Returns:
- Time (in milliseconds since January 1, 1970, 00:00:00) when this context was started
 
 
- 
 
-