Class FailedContext
- All Implemented Interfaces:
- MBeanRegistration,- Container,- Context,- JmxEnabled,- Lifecycle,- ContextBind
Context that is used as a place-holder for deployed applications when their deployment
 fails and a Context instance (usually StandardContext but may be any Context
 implementation) cannot be created.- 
Nested Class SummaryNested classes/interfaces inherited from interface org.apache.catalina.LifecycleLifecycle.SingleUse
- 
Field SummaryFieldsFields inherited from interface org.apache.catalina.ContainerADD_CHILD_EVENT, ADD_VALVE_EVENT, REMOVE_CHILD_EVENT, REMOVE_VALVE_EVENTFields inherited from interface org.apache.catalina.ContextADD_WELCOME_FILE_EVENT, CHANGE_SESSION_ID_EVENT, CLEAR_WELCOME_FILES_EVENT, REMOVE_WELCOME_FILE_EVENT, WEBAPP_PROTOCOLFields 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
- 
Method SummaryModifier and TypeMethodDescriptionvoidaddApplicationListener(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.voidAdd a new child Container to those associated with this Container, if supported.voidaddConstraint(SecurityConstraint constraint) Add a security constraint to the set for this web application.voidaddContainerListener(ContainerListener listener) Add a container event listener to this component.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.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(String locale, String encoding) Add a Locale Encoding Mapping (see Sec 5.4 of Servlet spec 2.4)voidaddMimeMapping(String extension, String mimeType) Add a new MIME mapping, replacing any existing mapping for the specified extension.voidaddParameter(String name, String value) Add a new context initialization parameter, replacing any existing value for the specified name.voidaddPostConstructMethod(String clazz, 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(String clazz, 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.voidAdd a property change listener to this component.voidaddRoleMapping(String role, String link) Add a security role reference for this web application.voidaddSecurityRole(String role) Add a new security role for this web application.voidaddServletContainerInitializer(ServletContainerInitializer sci, Set<Class<?>> classes) Add a ServletContainerInitializer instance to this web application.voidaddServletMappingDecoded(String pattern, String name, boolean jspWildcard) Add a new servlet mapping, replacing any existing mapping for the specified pattern.addServletSecurity(ServletRegistration.Dynamic registration, ServletSecurityElement servletSecurityElement) Notification that Servlet security has been dynamically set in aServletRegistration.DynamicvoidvoidaddWatchedResource(String name) Add a resource which will be watched for reloading by the host auto deployer.voidaddWelcomeFile(String name) Add a new welcome file to the set recognized by this Context.voidaddWrapperLifecycle(String listener) Add the classname of a LifecycleListener to be added to each Wrapper appended to this Context.voidaddWrapperListener(String listener) Add the classname of a ContainerListener to be added to each Wrapper appended to this Context.voidExecute a periodic task, such as reloading, etc.bind(boolean usePrivilegedAction, ClassLoader originalClassLoader) Change the current thread context class loader to the web application class loader.Factory method to create and return a new InstanceManager instance.Factory method to create and return a new Wrapper instance, of the Java implementation class appropriate for this Context implementation.voidString[]Obtain a child Container by name.Obtain the child Containers associated with this Container.Obtain the container listeners associated with this Container.findErrorPage(int errorCode) findErrorPage(Throwable throwable) 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.findFilterDef(String filterName) findMimeMapping(String extension) String[]findParameter(String name) String[]findPostConstructMethod(String clazz) Returns the method name that is specified as post construct method for the given class, if it exists; otherwiseNULLwill be returned.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.findPreDestroyMethod(String clazz) Returns the method name that is specified as pre destroy method for the given class, if it exists; otherwiseNULLwill be returned.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.findRoleMapping(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(String role) String[]findServletMapping(String pattern) String[]String[]booleanfindWelcomeFile(String name) String[]String[]String[]voidfireContainerEvent(String type, Object data) Notify all container event listeners that a particular event has occurred for this Container.booleanfireRequestDestroyEvent(ServletRequest request) Notify allServletRequestListeners that a request has ended.booleanfireRequestInitEvent(ServletRequest request) Notify allServletRequestListeners that a request has started.Obtain the AccessLog to use to log a request/response that is destined for this container.booleanbooleanReturnstrueif requests mapped to servlets without "multipart config" to parse multipart/form-data requests anyway.booleanWhen returning a context path fromHttpServletRequest.getContextPath(), is it allowed to contain multiple leading '/' characters?Return the alternate Deployment Descriptor name.booleanIf this istrue, every request that is associated with a session will cause the session's last accessed time to be updated regardless of whether or not the request explicitly accesses the session.Object[]Obtain the registered application event listeners.Object[]Obtain the registered application lifecycle listeners.intGet the delay between the invocation of the backgroundProcess method on this container and its children.Obtain the location of CATALINA_BASE.Obtain the location of CATALINA_HOME.getCharset(Locale locale) Obtain the character set name to use with the given Locale.Get the Cluster for this container.Return the URL of the XML descriptor for this context.booleanReturn the "correctly configured" flag for this Context.Obtains the regular expression that specifies which container provided SCIs should be filtered out and not used for this context.booleanIf this istruethen the path passed toServletContext.getResource()orServletContext.getResourceAsStream()must start with "/".booleanReturn the "use cookies for session ids" flag.booleanWill 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?booleanReturn the "allow crossing servlet contexts" flag.booleanReturn the deny-uncovered-http-methods flag for this web application.booleanAre paths used in calls to obtain a request dispatcher expected to be encoded?booleanIf this istruethen any wrapped request or response object passed to an application dispatcher will be checked to ensure that it has wrapped the original request or response.Return the display name of this web application.booleanGet the distributable flag for this web application.Obtain the document root for this Context.protected StringMethod implemented by sub-classes to identify the domain in which MBeans should be registered.intintReturn the URL encoded context pathbooleanbooleanDetermine if annotations parsing is currently disabledGet the Jar Scanner to be used to scan for JAR resources for this context.booleanShould the effective web.xml for this context be logged on context start?Obtain the log to which events for this container should be logged.Return the logger name that the container will use.booleanDetermines if requests for a web application context root will be redirected (adding a trailing slash) by the Mapper.booleanDetermines if requests for a directory will be redirected (adding a trailing slash) by the Mapper.Calculate the key properties string to be added to an object'sObjectNameto indicate that it is associated with this container.getName()Return a name string (suitable for use by humans) that describes this Container.protected StringAllow sub-classes to specify the key properties component of theObjectNamethat will be used to register this component.booleanbooleanGet the parent container.Get the parent class loader.getPath()booleanIs this Context paused whilst it is reloaded?Return the Pipeline object that manages the Valves associated with this Container.booleanbooleangetRealm()Obtain the Realm with which this Container is associated.getRealPath(String path) booleanGet the default request body encoding for this web application.Obtains the list of Servlets that expect a resource to be present.Get the default response body encoding for this web application.booleanGets the domain to use for session cookies.Gets the name to use for session cookies.Gets the path to use for session cookies.booleanIs 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.intintObtain the number of threads available for starting and stopping any children associated with this container.booleanIf this istrue, then following a forward the response will be unwrapped to suspend the Catalina response instead of simply closing the top level response.booleanReturnstrueif remaining request data will be read (swallowed) even the request violates a data size constraint.booleanbooleanWill the parsing of *.tld files for this Context be performed by a validating parser?booleanbooleanGets the value of the use HttpOnly cookies for session cookies flag.booleanShould thePartitionedattribute be added to session cookies created for this web application.booleanWill HTTP 1.1 and later location headers generated by a call toHttpServletResponse.sendRedirect(String)use relative or absolute redirects.booleanWill client provided session IDs be validated (seeContext.setValidateClientProvidedNewSessionId(boolean)) before use?booleanWill the parsing of web.xml, web-fragment.xml, *.tld, *.jspx, *.tagx and tagplugin.xml files for this Context block the use of external entities?booleanWill the parsing of web.xml and web-fragment.xml files for this Context be performed by a namespace aware parser?booleanWill the parsing of web.xml and web-fragment.xml files for this Context be performed by a validating parser?voidbooleanisResourceOnlyServlet(String servletName) Checks the named Servlet to see if it expects a resource to be present.booleanIs this context using version 2.2 of the Servlet spec?voidLog a request/response that was destined for this container but has been handled earlier in the processing chain so that the request/response still appears in the correct access logs.voidreload()Reload this web application, if reloading is supported.voidremoveApplicationListener(String listener) Remove the specified application listener class from the set of listeners for this application.voidRemove the application parameter with the specified name from the set for this application.voidremoveChild(Container child) Remove an existing child Container from association with this parent Container.voidremoveConstraint(SecurityConstraint constraint) Remove the specified security constraint from this web application.voidremoveContainerListener(ContainerListener listener) Remove a container event listener from this component.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.voidremoveMimeMapping(String extension) Remove the MIME mapping for the specified extension, if it exists; otherwise, no action is taken.voidremoveParameter(String name) Remove the context initialization parameter with the specified name, if it exists; otherwise, no action is taken.voidremovePostConstructMethod(String clazz) Removes the post construct method definition for the given class, if it exists; otherwise, no action is taken.voidremovePreDestroyMethod(String clazz) Removes the pre destroy method definition for the given class, if it exists; otherwise, no action is taken.voidRemove a property change listener from this component.voidremoveRoleMapping(String role) Remove any security role reference for the specified namevoidremoveSecurityRole(String role) Remove any security role with the specified name.voidremoveServletMapping(String pattern) Remove any servlet mapping for the specified pattern, if it exists; otherwise, no action is taken.voidremoveWatchedResource(String name) Remove the specified watched resource name from the list associated with this Context.voidremoveWelcomeFile(String name) Remove the specified welcome file name from the list recognized by this Context.voidremoveWrapperLifecycle(String listener) Remove a class name from the set of LifecycleListener classes that will be added to newly created Wrappers.voidremoveWrapperListener(String listener) Remove a class name from the set of ContainerListener classes that will be added to newly created Wrappers.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(String altDDName) Set an alternate Deployment Descriptor name.voidsetAlwaysAccessSession(boolean alwaysAccessSession) Set the session access behavior.voidsetApplicationEventListeners(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(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.voidsetBackgroundProcessorDelay(int delay) Set the delay between the invocation of the execute method on this container and its children.voidsetCluster(Cluster cluster) Set the Cluster with which this Container is associated.voidsetConfigFile(URL configFile) Set the URL of the XML descriptor for this context.voidsetConfigured(boolean configured) Set the "correctly configured" flag for this Context.voidsetContainerSciFilter(String containerSciFilter) Sets the regular expression that specifies which container provided SCIs should be filtered out and not used for this context.voidsetContextGetResourceRequiresSlash(boolean contextGetResourceRequiresSlash) Allow usingServletContext.getResource()orServletContext.getResourceAsStream()without a leading "/".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.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.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?voidsetDispatcherWrapsSameObject(boolean dispatcherWrapsSameObject) Allow disabling the object wrap check in the request dispatcher.voidsetDisplayName(String displayName) Set the display name of this web application.voidsetDistributable(boolean distributable) Set the distributable flag for this web application.voidsetDocBase(String docBase) Set the document root for this Context.voidsetEffectiveMajorVersion(int major) Set the effective major version of the Servlet spec used by this context.voidsetEffectiveMinorVersion(int minor) Set the effective minor version of the Servlet spec used by this context.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.voidsetJarScanner(JarScanner jarScanner) Set the Jar Scanner to be used to scan for JAR resources for this context.voidsetJspConfigDescriptor(JspConfigDescriptor descriptor) Set the JspConfigDescriptor for this context.voidSet 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.voidSet a name string (suitable for use by humans) that describes this Container.voidsetNamingResources(NamingResourcesImpl namingResources) Set the naming resources for this web application.voidsetOverride(boolean override) Set the override flag for this web application.voidsetParallelAnnotationScanning(boolean parallelAnnotationScanning) Set the parallel annotation scanning value.voidSet the parent Container to which this Container is being added as a child.voidsetParentClassLoader(ClassLoader parent) Set the parent class loader for this component.voidSet the context path for this web application.voidsetPreemptiveAuthentication(boolean enable) 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(String publicId) Set the public identifier of the deployment descriptor DTD that is currently being parsed.voidSet the Realm with which this Container is associated.voidsetReloadable(boolean reloadable) Set the reloadable flag for this web application.voidsetRequestCharacterEncoding(String encoding) Set the default request body encoding for this web application.voidsetResourceOnlyServlets(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(String encoding) Set the default response body encoding for this web application.voidsetSendRedirectBody(boolean enable) Configures if a response body is included when a redirect response is sent to the client.voidsetSessionCookieDomain(String sessionCookieDomain) Sets the domain to use for session cookies.voidsetSessionCookieName(String sessionCookieName) Sets the name to use for session cookies.voidsetSessionCookiePath(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.voidsetStartStopThreads(int startStopThreads) Sets the number of threads available for starting and stopping any children associated with this container.voidsetSuspendWrappedResponseAfterForward(boolean suspendWrappedResponseAfterForward) Allows unwrapping the response object to suspend the response following a forward.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.voidsetTldValidation(boolean tldValidation) Controls whether the parsing of *.tld files for this Context will be performed by a validating parser.voidsetUseBloomFilterForArchives(boolean useBloomFilterForArchives) Set bloom filter flag value.voidsetUseHttpOnly(boolean useHttpOnly) Sets the use HttpOnly cookies for session cookies flag.voidsetUsePartitioned(boolean usePartitioned) Configure whether thePartitionedattribute should be added to session cookies created for this web application.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(String webappVersion) Set the version of this web application - used to differentiate different versions of the same web application when using parallel deployment.voidsetWrapperClass(String wrapperClass) 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 xmlNamespaceAware) 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 xmlValidation) Controls whether the parsing of web.xml and web-fragment.xml files for this Context will be performed by a validating parser.protected voidSub-classes must ensure that the state is changed toLifecycleState.STARTINGduring the execution of this method.protected voidSub-classes must ensure that the state is changed toLifecycleState.STOPPINGduring the execution of this method.toString()voidunbind(boolean usePrivilegedAction, ClassLoader originalClassLoader) Restore the current thread context class loader to the original class loader in used beforeContextBind.bind(boolean, ClassLoader)was called.Methods inherited from class org.apache.catalina.util.LifecycleMBeanBasedestroyInternal, getDomain, getObjectName, initInternal, postDeregister, postRegister, preDeregister, preRegister, register, setDomain, unregister, unregisterMethods inherited from class org.apache.catalina.util.LifecycleBaseaddLifecycleListener, destroy, findLifecycleListeners, fireLifecycleEvent, getState, getStateName, getThrowOnFailure, init, removeLifecycleListener, setState, setState, setThrowOnFailure, start, stopMethods inherited from class java.lang.Objectclone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods inherited from interface org.apache.catalina.ContainergetDomain, getObjectNameMethods inherited from interface org.apache.catalina.ContextaddServletMappingDecoded, findConfigFileResource, isParallelAnnotationScanningMethods inherited from interface org.apache.catalina.LifecycleaddLifecycleListener, destroy, findLifecycleListeners, getState, getStateName, init, removeLifecycleListener, start, stop
- 
Field Details- 
sm
 
- 
- 
Constructor Details- 
FailedContextpublic FailedContext()
 
- 
- 
Method Details- 
getConfigFileDescription 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
 
- 
setConfigFileDescription 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.
 
- 
getDocBaseDescription 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.
 
- 
setDocBaseDescription 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
 
- 
getNameDescription copied from interface:ContainerReturn a name string (suitable for use by humans) that describes this Container. Within the set of child containers belonging to a particular parent, Container names must be unique.
- 
setNameDescription copied from interface:ContainerSet a name string (suitable for use by humans) that describes this Container. Within the set of child containers belonging to a particular parent, Container names must be unique.
- 
getParentDescription copied from interface:ContainerGet the parent container.
- 
setParentDescription copied from interface:ContainerSet the parent Container to which this Container is being added as a child. This Container may refuse to become attached to the specified Container by throwing an exception.
- 
getPath
- 
setPathDescription copied from interface:ContextSet the context path for this web application.
- 
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.
 
- 
setWebappVersionDescription 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
 
- 
getDomainInternalDescription copied from class:LifecycleMBeanBaseMethod implemented by sub-classes to identify the domain in which MBeans should be registered.- Specified by:
- getDomainInternalin class- LifecycleMBeanBase
- Returns:
- The name of the domain to use to register MBeans.
 
- 
getMBeanKeyPropertiesDescription copied from interface:ContainerCalculate the key properties string to be added to an object'sObjectNameto indicate that it is associated with this container.- Specified by:
- getMBeanKeyPropertiesin interface- Container
- Returns:
- A string suitable for appending to the ObjectName
 
- 
getObjectNameKeyPropertiesDescription 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
 
- 
startInternalDescription copied from class:LifecycleBaseSub-classes must ensure that the state is changed toLifecycleState.STARTINGduring the execution of this method. Changing state will trigger theLifecycle.START_EVENTevent. If a component fails to start it may either throw aLifecycleExceptionwhich will cause it's parent to fail to start or it can place itself in the error state in which caseLifecycleBase.stop()will be called on the failed component but the parent component will continue to start normally.- Specified by:
- startInternalin class- LifecycleBase
- Throws:
- LifecycleException- Start error occurred
 
- 
stopInternalDescription copied from class:LifecycleBaseSub-classes must ensure that the state is changed toLifecycleState.STOPPINGduring the execution of this method. Changing state will trigger theLifecycle.STOP_EVENTevent.- Specified by:
- stopInternalin class- LifecycleBase
- Throws:
- LifecycleException- Stop error occurred
 
- 
addWatchedResourceDescription copied from interface:ContextAdd a resource which will be watched for reloading by the host auto deployer. Note: this will not be used in embedded mode.- Specified by:
- addWatchedResourcein interface- Context
- Parameters:
- name- Path to the resource, relative to docBase
 
- 
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.
 
- 
removeWatchedResourceDescription copied from interface:ContextRemove 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
 
- 
addChildDescription copied from interface:ContainerAdd a new child Container to those associated with this Container, if supported. Prior to adding this Container to the set of children, the child'ssetParent()method must be called, with this Container as an argument. This method may thrown anIllegalArgumentExceptionif this Container chooses not to be attached to the specified Container, in which case it is not added
- 
findChildDescription copied from interface:ContainerObtain a child Container by name.
- 
findChildrenDescription copied from interface:ContainerObtain the child Containers associated with this Container.- Specified by:
- findChildrenin interface- Container
- Returns:
- An array containing all children of this container. If this Container has no children, a zero-length array is returned.
 
- 
removeChildDescription copied from interface:ContainerRemove an existing child Container from association with this parent Container.- Specified by:
- removeChildin interface- Container
- Parameters:
- child- Existing child Container to be removed
 
- 
toString
- 
getLoader
- 
setLoaderDescription copied from interface:ContextSet the Loader with which this Context is associated.
- 
getLoggerDescription copied from interface:ContainerObtain the log to which events for this container should be logged.
- 
getLogNameDescription copied from interface:ContainerReturn the logger name that the container will use.- Specified by:
- getLogNamein interface- Container
- Returns:
- the abbreviated name of this container for logging messages
 
- 
getManager- Specified by:
- getManagerin interface- Context
- Returns:
- the Manager with which this Context is associated.  If there is
 no associated Manager, return null.
 
- 
setManagerDescription copied from interface:ContextSet the Manager with which this Context is associated.- Specified by:
- setManagerin interface- Context
- Parameters:
- manager- The newly associated Manager
 
- 
getPipelineDescription copied from interface:ContainerReturn the Pipeline object that manages the Valves associated with this Container.- Specified by:
- getPipelinein interface- Container
- Returns:
- The Pipeline
 
- 
getClusterDescription copied from interface:ContainerGet the Cluster for this container.- Specified by:
- getClusterin interface- Container
- Returns:
- The Cluster with which this Container is associated. If there is
         no associated Cluster, return the Cluster associated with our
         parent Container (if any); otherwise return null.
 
- 
setClusterDescription copied from interface:ContainerSet the Cluster with which this Container is associated.- Specified by:
- setClusterin interface- Container
- Parameters:
- cluster- the Cluster with which this Container is associated.
 
- 
getBackgroundProcessorDelaypublic int getBackgroundProcessorDelay()Description copied from interface:ContainerGet the delay between the invocation of the backgroundProcess method on this container and its children. Child containers will not be invoked if their delay value is positive (which would mean they are using their own thread). Setting this to a positive value will cause a thread to be spawned. After waiting the specified amount of time, the thread will invoke theContainer.backgroundProcess()method on this container and all children with non-positive delay values.- Specified by:
- getBackgroundProcessorDelayin interface- Container
- Returns:
- The delay between the invocation of the backgroundProcess method on this container and its children. A non-positive value indicates that background processing will be managed by the parent.
 
- 
setBackgroundProcessorDelaypublic void setBackgroundProcessorDelay(int delay) Description copied from interface:ContainerSet the delay between the invocation of the execute method on this container and its children.- Specified by:
- setBackgroundProcessorDelayin interface- Container
- Parameters:
- delay- The delay in seconds between the invocation of backgroundProcess methods
 
- 
getParentClassLoaderDescription copied from interface:ContainerGet the parent class loader.- Specified by:
- getParentClassLoaderin interface- Container
- Returns:
- the parent class loader for this component. If not set, return
         Container.getParent().Container.getParentClassLoader(). If no parent has been set, return the system class loader.
 
- 
setParentClassLoaderDescription copied from interface:ContainerSet the parent class loader for this component. ForContexts this call is meaningful only before a Loader has been configured, and the specified value (if non-null) should be passed as an argument to the class loader constructor.- Specified by:
- setParentClassLoaderin interface- Container
- Parameters:
- parent- The new parent class loader
 
- 
getRealmDescription copied from interface:ContainerObtain the Realm with which this Container is associated.
- 
setRealmDescription copied from interface:ContainerSet the Realm with which this Container is associated.
- 
getResources- Specified by:
- getResourcesin interface- Context
- Returns:
- the Resources with which this Context is associated.
 
- 
setResourcesDescription copied from interface:ContextSet the Resources object with which this Context is associated.- Specified by:
- setResourcesin interface- Context
- Parameters:
- resources- The newly associated Resources
 
- 
backgroundProcesspublic void backgroundProcess()Description copied from interface:ContainerExecute 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
 
- 
addContainerListenerDescription copied from interface:ContainerAdd a container event listener to this component.- Specified by:
- addContainerListenerin interface- Container
- Parameters:
- listener- The listener to add
 
- 
findContainerListenersDescription copied from interface:ContainerObtain the container listeners associated with this Container.- Specified by:
- findContainerListenersin interface- Container
- Returns:
- An array containing the container listeners associated with this Container. If this Container has no registered container listeners, a zero-length array is returned.
 
- 
removeContainerListenerDescription copied from interface:ContainerRemove a container event listener from this component.- Specified by:
- removeContainerListenerin interface- Container
- Parameters:
- listener- The listener to remove
 
- 
addPropertyChangeListenerDescription copied from interface:ContainerAdd a property change listener to this component.- Specified by:
- addPropertyChangeListenerin interface- Container
- Parameters:
- listener- The listener to add
 
- 
removePropertyChangeListenerDescription copied from interface:ContainerRemove a property change listener from this component.- Specified by:
- removePropertyChangeListenerin interface- Container
- Parameters:
- listener- The listener to remove
 
- 
fireContainerEventDescription copied from interface:ContainerNotify all container event listeners that a particular event has occurred for this Container. The default implementation performs this notification synchronously using the calling thread.- Specified by:
- fireContainerEventin interface- Container
- Parameters:
- type- Event type
- data- Event data
 
- 
logAccessDescription copied from interface:ContainerLog a request/response that was destined for this container but has been handled earlier in the processing chain so that the request/response still appears in the correct access logs.- Specified by:
- logAccessin interface- Container
- Parameters:
- request- Request (associated with the response) to log
- response- Response (associated with the request) to log
- time- Time taken to process the request/response in milliseconds (use 0 if not known)
- useDefault- Flag that indicates that the request/response should be logged in the engine's default access log
 
- 
getAccessLogDescription copied from interface:ContainerObtain the AccessLog to use to log a request/response that is destined for this container. This is typically used when the request/response was handled (and rejected) earlier in the processing chain so that the request/response still appears in the correct access logs.- Specified by:
- getAccessLogin interface- Container
- Returns:
- The AccessLog to use for a request/response destined for this container
 
- 
getStartStopThreadspublic int getStartStopThreads()Description copied from interface:ContainerObtain the number of threads available for starting and stopping any children associated with this container. This allows start/stop calls to children to be processed in parallel.- Specified by:
- getStartStopThreadsin interface- Container
- Returns:
- The currently configured number of threads used to start/stop children associated with this container
 
- 
setStartStopThreadspublic void setStartStopThreads(int startStopThreads) Description copied from interface:ContainerSets the number of threads available for starting and stopping any children associated with this container. This allows start/stop calls to children to be processed in parallel.- Specified by:
- setStartStopThreadsin interface- Container
- Parameters:
- startStopThreads- The new number of threads to be used
 
- 
getAllowCasualMultipartParsingpublic boolean getAllowCasualMultipartParsing()Description copied from interface:ContextReturnstrueif 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.
 
- 
setAllowCasualMultipartParsingpublic void setAllowCasualMultipartParsing(boolean allowCasualMultipartParsing) Description copied from interface:ContextSet 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.
 
- 
getApplicationEventListenersDescription 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
 
- 
setApplicationEventListenersDescription copied from interface:ContextStore the set of initialized application event listener objects, in the order they were specified in the web application deployment descriptor, for this application.- Specified by:
- setApplicationEventListenersin interface- Context
- Parameters:
- listeners- The set of instantiated listener objects.
 
- 
getApplicationLifecycleListenersDescription 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
 
- 
setApplicationLifecycleListenersDescription copied from interface:ContextStore 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.
 
- 
getCharsetDescription 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
 
- 
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) Description copied from interface:ContextSet 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) Description copied from interface:ContextSet the "use cookies for session ids" flag.- Specified by:
- setCookiesin interface- Context
- Parameters:
- cookies- The new flag
 
- 
getSessionCookieNameDescription copied from interface:ContextGets 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
 
- 
setSessionCookieNameDescription copied from interface:ContextSets 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()Description copied from interface:ContextGets 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) Description copied from interface:ContextSets the use HttpOnly cookies for session cookies flag.- Specified by:
- setUseHttpOnlyin interface- Context
- Parameters:
- useHttpOnly- Set to- trueto use HttpOnly cookies for session cookies
 
- 
getUsePartitionedpublic boolean getUsePartitioned()Description copied from interface:ContextShould thePartitionedattribute be added to session cookies created for this web application.The name of the attribute used to indicate a partitioned cookie as part of CHIPS is not defined by an RFC and may change in a non-backwards compatible way once equivalent functionality is included in an RFC. - Specified by:
- getUsePartitionedin interface- Context
- Returns:
- trueif the- Partitionedattribute should be added to session cookies created for this web application, otherwise- false
 
- 
setUsePartitionedpublic void setUsePartitioned(boolean usePartitioned) Description copied from interface:ContextConfigure whether thePartitionedattribute should be added to session cookies created for this web application.The name of the attribute used to indicate a partitioned cookie as part of CHIPS is not defined by an RFC and may change in a non-backwards compatible way once equivalent functionality is included in an RFC. - Specified by:
- setUsePartitionedin interface- Context
- Parameters:
- usePartitioned-- trueif the- Partitionedattribute should be added to session cookies created for this web application, otherwise- false
 
- 
getSessionCookieDomainDescription copied from interface:ContextGets 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
 
- 
setSessionCookieDomainDescription copied from interface:ContextSets 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
 
- 
getSessionCookiePathDescription copied from interface:ContextGets 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
 
- 
setSessionCookiePathDescription copied from interface:ContextSets 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) Description copied from interface:ContextSet the "allow crossing servlet contexts" flag.- Specified by:
- setCrossContextin interface- Context
- Parameters:
- crossContext- The new cross contexts flag
 
- 
getAltDDNameDescription copied from interface:ContextReturn the alternate Deployment Descriptor name.- Specified by:
- getAltDDNamein interface- Context
- Returns:
- the name
 
- 
setAltDDNameDescription copied from interface:ContextSet an alternate Deployment Descriptor name.- Specified by:
- setAltDDNamein interface- Context
- Parameters:
- altDDName- The new name
 
- 
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
 
- 
getDisplayNameDescription copied from interface:ContextReturn the display name of this web application.- Specified by:
- getDisplayNamein interface- Context
- Returns:
- The display name
 
- 
setDisplayNameDescription copied from interface:ContextSet 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 value of the distributable flag for this web application.
 
- 
setDistributablepublic void setDistributable(boolean distributable) Description copied from interface:ContextSet the distributable flag for this web application.- Specified by:
- setDistributablein interface- Context
- Parameters:
- distributable- The new distributable flag
 
- 
getEncodedPathDescription copied from interface:ContextReturn the URL encoded context path- Specified by:
- getEncodedPathin interface- Context
- Returns:
- The URL encoded (with UTF-8) context path
 
- 
getIgnoreAnnotationspublic boolean getIgnoreAnnotations()Description copied from interface:ContextDetermine if annotations parsing is currently disabled- Specified by:
- getIgnoreAnnotationsin interface- Context
- Returns:
- trueif annotation parsing is disabled for this web application
 
- 
setIgnoreAnnotationspublic void setIgnoreAnnotations(boolean ignoreAnnotations) Description copied from interface:ContextSet the boolean on the annotations parsing for this web application.- Specified by:
- setIgnoreAnnotationsin interface- Context
- Parameters:
- ignoreAnnotations- The boolean on the annotations parsing
 
- 
getLoginConfig- Specified by:
- getLoginConfigin interface- Context
- Returns:
- the login configuration descriptor for this web application.
 
- 
setLoginConfigDescription copied from interface:ContextSet the login configuration descriptor for this web application.- Specified by:
- setLoginConfigin interface- Context
- Parameters:
- config- The new login configuration
 
- 
getNamingResources- Specified by:
- getNamingResourcesin interface- Context
- Returns:
- the naming resources associated with this web application.
 
- 
setNamingResourcesDescription copied from interface:ContextSet the naming resources for this web application.- Specified by:
- setNamingResourcesin interface- Context
- Parameters:
- namingResources- The new naming resources
 
- 
getPublicId- Specified by:
- getPublicIdin interface- Context
- Returns:
- the public identifier of the deployment descriptor DTD that is currently being parsed.
 
- 
setPublicIdDescription copied from interface:ContextSet 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.
 
- 
setReloadablepublic void setReloadable(boolean reloadable) Description copied from interface:ContextSet the reloadable flag for this web application.- Specified by:
- setReloadablein interface- Context
- Parameters:
- reloadable- The new reloadable flag
 
- 
getOverridepublic boolean getOverride()- Specified by:
- getOverridein interface- Context
- Returns:
- the override flag for this web application.
 
- 
setOverridepublic void setOverride(boolean override) Description copied from interface:ContextSet the override flag for this web application.- Specified by:
- setOverridein interface- Context
- Parameters:
- override- The new override flag
 
- 
getPrivilegedpublic boolean getPrivileged()- Specified by:
- getPrivilegedin interface- Context
- Returns:
- the privileged flag for this web application.
 
- 
setPrivilegedpublic void setPrivileged(boolean privileged) Description copied from interface:ContextSet the privileged flag for this web application.- Specified by:
- setPrivilegedin interface- Context
- Parameters:
- privileged- The new privileged flag
 
- 
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) Description copied from interface:ContextSet the default session timeout (in minutes) for this web application.- Specified by:
- setSessionTimeoutin interface- Context
- Parameters:
- timeout- The new default session timeout
 
- 
getSwallowAbortedUploadspublic boolean getSwallowAbortedUploads()Description copied from interface:ContextReturnstrueif 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.
 
- 
setSwallowAbortedUploadspublic void setSwallowAbortedUploads(boolean swallowAbortedUploads) Description copied from interface:ContextSet 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).
 
- 
getSwallowOutputpublic boolean getSwallowOutput()- Specified by:
- getSwallowOutputin interface- Context
- Returns:
- the value of the swallowOutput flag.
 
- 
setSwallowOutputpublic void setSwallowOutput(boolean swallowOutput) Description copied from interface:ContextSet 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
 
- 
getWrapperClass- Specified by:
- getWrapperClassin interface- Context
- Returns:
- the Java class name of the Wrapper implementation used for servlets registered in this Context.
 
- 
setWrapperClassDescription copied from interface:ContextSet the Java class name of the Wrapper implementation used for servlets registered in this Context.- Specified by:
- setWrapperClassin interface- Context
- Parameters:
- wrapperClass- The new wrapper class
 
- 
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 xmlNamespaceAware) 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:
- xmlNamespaceAware- true to enable namespace awareness
 
- 
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.
 
- 
setXmlValidationpublic void setXmlValidation(boolean xmlValidation) 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:
- xmlValidation- true to enable xml validation
 
- 
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
 
- 
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
 
- 
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.
 
- 
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
 
- 
getJarScannerDescription 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.
 
- 
setJarScannerDescription 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.
 
- 
getAuthenticator- Specified by:
- getAuthenticatorin interface- Context
- Returns:
- the Authenticatorthat is used by this context. This is always non-nullfor a started Context
 
- 
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
 
- 
addApplicationListenerDescription copied from interface:ContextAdd 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
 
- 
findApplicationListeners- Specified by:
- findApplicationListenersin interface- Context
- Returns:
- the set of application listener class names configured for this application.
 
- 
removeApplicationListenerDescription copied from interface:ContextRemove 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
 
- 
addApplicationParameterDescription copied from interface:ContextAdd a new application parameter for this application.- Specified by:
- addApplicationParameterin interface- Context
- Parameters:
- parameter- The new application parameter
 
- 
findApplicationParameters- Specified by:
- findApplicationParametersin interface- Context
- Returns:
- the set of application parameters for this application.
 
- 
removeApplicationParameterDescription copied from interface:ContextRemove 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
 
- 
addConstraintDescription copied from interface:ContextAdd a security constraint to the set for this web application.- Specified by:
- addConstraintin interface- Context
- Parameters:
- constraint- The security constraint that should be added
 
- 
findConstraints- 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.
 
- 
removeConstraintDescription copied from interface:ContextRemove the specified security constraint from this web application.- Specified by:
- removeConstraintin interface- Context
- Parameters:
- constraint- Constraint to be removed
 
- 
addErrorPageDescription copied from interface:ContextAdd an error page for the specified error or Java exception.- Specified by:
- addErrorPagein interface- Context
- Parameters:
- errorPage- The error page definition to be added
 
- 
findErrorPage- 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.
 
- 
findErrorPageDescription 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:
- throwable- 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.
 
- 
findErrorPages- Specified by:
- findErrorPagesin interface- Context
- Returns:
- the set of defined error pages for all specified error codes and exception types.
 
- 
removeErrorPageDescription copied from interface:ContextRemove 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
 
- 
addFilterDefDescription copied from interface:ContextAdd a filter definition to this Context.- Specified by:
- addFilterDefin interface- Context
- Parameters:
- filterDef- The filter definition to be added
 
- 
findFilterDef- 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.
 
- 
findFilterDefs- Specified by:
- findFilterDefsin interface- Context
- Returns:
- the set of defined filters for this Context.
 
- 
removeFilterDefDescription copied from interface:ContextRemove 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
 
- 
addFilterMapDescription copied from interface:ContextAdd a filter mapping to this Context.- Specified by:
- addFilterMapin interface- Context
- Parameters:
- filterMap- The filter mapping to be added
 
- 
addFilterMapBeforeDescription copied from interface:ContextAdd 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
 
- 
findFilterMaps- Specified by:
- findFilterMapsin interface- Context
- Returns:
- the set of filter mappings for this Context.
 
- 
removeFilterMapDescription copied from interface:ContextRemove a filter mapping from this Context.- Specified by:
- removeFilterMapin interface- Context
- Parameters:
- filterMap- The filter mapping to be removed
 
- 
addLocaleEncodingMappingParameterDescription copied from interface:ContextAdd 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
 
- 
addMimeMappingDescription copied from interface:ContextAdd 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
 
- 
findMimeMapping- 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.
 
- 
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.
 
- 
removeMimeMappingDescription copied from interface:ContextRemove 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
 
- 
addParameterDescription copied from interface:ContextAdd a new context initialization parameter, replacing any existing value for the specified name.- Specified by:
- addParameterin interface- Context
- Parameters:
- name- Name of the new parameter
- value- Value of the new parameter
 
- 
findParameter- 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.
 
- 
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.
 
- 
removeParameterDescription copied from interface:ContextRemove 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
 
- 
addRoleMappingDescription copied from interface:ContextAdd 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
 
- 
findRoleMappingDescription copied from interface:ContextFor 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 that was mapped to the specified role
 
- 
removeRoleMappingDescription copied from interface:ContextRemove any security role reference for the specified name- Specified by:
- removeRoleMappingin interface- Context
- Parameters:
- role- Security role (as used in the application) to remove
 
- 
addSecurityRoleDescription copied from interface:ContextAdd a new security role for this web application.- Specified by:
- addSecurityRolein interface- Context
- Parameters:
- role- New security role
 
- 
findSecurityRole- 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.
 
- 
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.
 
- 
removeSecurityRoleDescription copied from interface:ContextRemove any security role with the specified name.- Specified by:
- removeSecurityRolein interface- Context
- Parameters:
- role- Security role to remove
 
- 
addServletMappingDecodedDescription copied from interface:ContextAdd 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
 
- 
findServletMapping- 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.
 
- 
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.
 
- 
removeServletMappingDescription copied from interface:ContextRemove 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
 
- 
addWelcomeFileDescription copied from interface:ContextAdd a new welcome file to the set recognized by this Context.- Specified by:
- addWelcomeFilein interface- Context
- Parameters:
- name- New welcome file name
 
- 
findWelcomeFile- 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.
 
- 
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.
 
- 
removeWelcomeFileDescription copied from interface:ContextRemove 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
 
- 
addWrapperLifecycleDescription copied from interface:ContextAdd 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
 
- 
findWrapperLifecycles- Specified by:
- findWrapperLifecyclesin interface- Context
- Returns:
- the set of LifecycleListener classes that will be added to newly created Wrappers automatically.
 
- 
removeWrapperLifecycleDescription copied from interface:ContextRemove 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
 
- 
addWrapperListenerDescription copied from interface:ContextAdd 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
 
- 
findWrapperListeners- Specified by:
- findWrapperListenersin interface- Context
- Returns:
- the set of ContainerListener classes that will be added to newly created Wrappers automatically.
 
- 
removeWrapperListenerDescription copied from interface:ContextRemove 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
 
- 
createInstanceManagerDescription 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
 
- 
createWrapperDescription copied from interface:ContextFactory 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
 
- 
fireRequestInitEventDescription 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
 
- 
fireRequestDestroyEventDescription 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
 
- 
reloadpublic void reload()Description copied from interface:ContextReload this web application, if reloading is supported.
- 
getRealPath- 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.
 
- 
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 major) Description copied from interface:ContextSet the effective major version of the Servlet spec used by this context.- Specified by:
- setEffectiveMajorVersionin interface- Context
- Parameters:
- major- 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 minor) Description copied from interface:ContextSet the effective minor version of the Servlet spec used by this context.- Specified by:
- setEffectiveMinorVersionin interface- Context
- Parameters:
- minor- Set the version number
 
- 
getJspConfigDescriptor- Specified by:
- getJspConfigDescriptorin interface- Context
- Returns:
- the JSP configuration for this context. Will be null if there is no JSP configuration.
 
- 
setJspConfigDescriptorDescription 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
 
- 
addServletContainerInitializerDescription copied from interface:ContextAdd 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
 
- 
getPausedpublic boolean getPaused()Description copied from interface:ContextIs this Context paused whilst it is reloaded?
- 
isServlet22public boolean isServlet22()Description copied from interface:ContextIs this context using version 2.2 of the Servlet spec?- Specified by:
- isServlet22in interface- Context
- Returns:
- truefor a legacy Servlet 2.2 webapp
 
- 
addServletSecuritypublic Set<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
 
- 
setResourceOnlyServletsDescription 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
 
- 
getResourceOnlyServletsDescription 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
 
- 
isResourceOnlyServletDescription 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
 
- 
getBaseName- Specified by:
- getBaseNamein interface- Context
- Returns:
- the base name to use for WARs, directories or context.xml files for this context.
 
- 
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.
 
- 
setPreemptiveAuthenticationpublic void setPreemptiveAuthentication(boolean enable) 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:
- enable-- trueto perform authentication even outside security constraints
 
- 
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.
 
- 
setSendRedirectBodypublic void setSendRedirectBody(boolean enable) 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:
- enable-- trueto send a response body for redirects
 
- 
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.
 
- 
addValve
- 
getCatalinaBaseDescription copied from interface:ContainerObtain the location of CATALINA_BASE.- Specified by:
- getCatalinaBasein interface- Container
- Returns:
- The location of CATALINA_BASE.
 
- 
getCatalinaHomeDescription copied from interface:ContainerObtain the location of CATALINA_HOME.- Specified by:
- getCatalinaHomein interface- Container
- Returns:
- The location of CATALINA_HOME.
 
- 
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.
 
- 
addPostConstructMethodDescription 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
 
- 
addPreDestroyMethodDescription 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
 
- 
removePostConstructMethodDescription 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
 
- 
removePreDestroyMethodDescription 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
 
- 
findPostConstructMethodDescription 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.
 
- 
findPreDestroyMethodDescription 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.
 
- 
findPostConstructMethodsDescription 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.
 
- 
findPreDestroyMethodsDescription 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.
 
- 
getInstanceManager- Specified by:
- getInstanceManagerin interface- Context
- Returns:
- the instance manager associated with this context.
 
- 
setInstanceManagerDescription copied from interface:ContextSet the instance manager associated with this context.- Specified by:
- setInstanceManagerin interface- Context
- Parameters:
- instanceManager- the new instance manager instance
 
- 
setContainerSciFilterDescription 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
 
- 
getContainerSciFilterDescription 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
 
- 
getThreadBindingListener- Specified by:
- getThreadBindingListenerin interface- Context
- Returns:
- the associated ThreadBindingListener.
 
- 
setThreadBindingListenerDescription 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
 
- 
bindDescription 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.
 
- 
unbindDescription 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
 
- 
getNamingToken- Specified by:
- getNamingTokenin interface- Context
- Returns:
- the token necessary for operations on the associated JNDI naming context.
 
- 
setCookieProcessorDescription 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
 
- 
getCookieProcessor- Specified by:
- getCookieProcessorin interface- Context
- Returns:
- the CookieProcessorthat will be used to process cookies 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()Description copied from interface:ContextWill client provided session IDs be validated (seeContext.setValidateClientProvidedNewSessionId(boolean)) before use?- Specified by:
- getValidateClientProvidedNewSessionIdin interface- Context
- Returns:
- trueif validation will be applied. Otherwise,- false
 
- 
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()Description copied from interface:ContextDetermines 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.- 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()Description copied from interface:ContextDetermines 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.- Specified by:
- getMapperDirectoryRedirectEnabledin interface- Context
- Returns:
- trueif the Mapper level redirect is enabled for this Context.
 
- 
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()Description copied from interface:ContextWill HTTP 1.1 and later location headers generated by a call toHttpServletResponse.sendRedirect(String)use relative or absolute redirects.- Specified by:
- getUseRelativeRedirectsin interface- Context
- Returns:
- trueif relative redirects will be used- falseif absolute redirects are used.
- See Also:
 
- 
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()Description copied from interface:ContextAre 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.- Specified by:
- getDispatchersUseEncodedPathsin interface- Context
- Returns:
- trueif encoded paths will be used, otherwise- false
 
- 
setRequestCharacterEncodingDescription copied from interface:ContextSet the default request body encoding for this web application.- Specified by:
- setRequestCharacterEncodingin interface- Context
- Parameters:
- encoding- The default encoding
 
- 
getRequestCharacterEncodingDescription copied from interface:ContextGet the default request body encoding for this web application.- Specified by:
- getRequestCharacterEncodingin interface- Context
- Returns:
- The default request body encoding
 
- 
setResponseCharacterEncodingDescription copied from interface:ContextSet the default response body encoding for this web application.- Specified by:
- setResponseCharacterEncodingin interface- Context
- Parameters:
- encoding- The default encoding
 
- 
getResponseCharacterEncodingDescription copied from interface:ContextGet the default response body encoding for this web application.- Specified by:
- getResponseCharacterEncodingin interface- Context
- Returns:
- The default response body encoding
 
- 
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
 
- 
incrementInProgressAsyncCountpublic void incrementInProgressAsyncCount()- Specified by:
- incrementInProgressAsyncCountin interface- Context
 
- 
decrementInProgressAsyncCountpublic void decrementInProgressAsyncCount()- Specified by:
- decrementInProgressAsyncCountin interface- Context
 
- 
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
 
- 
getAlwaysAccessSessionpublic boolean getAlwaysAccessSession()Description copied from interface:ContextIf this istrue, every request that is associated with a session will cause the session's last accessed time to be updated regardless of whether or not the request explicitly accesses the session. Iforg.apache.catalina.STRICT_SERVLET_COMPLIANCEis set totrue, the default of this setting will betrue, else the default value will befalse.- Specified by:
- getAlwaysAccessSessionin interface- Context
- Returns:
- the flag value
 
- 
setAlwaysAccessSessionpublic void setAlwaysAccessSession(boolean alwaysAccessSession) Description copied from interface:ContextSet the session access behavior.- Specified by:
- setAlwaysAccessSessionin interface- Context
- Parameters:
- alwaysAccessSession- the new flag value
 
- 
getContextGetResourceRequiresSlashpublic boolean getContextGetResourceRequiresSlash()Description copied from interface:ContextIf this istruethen the path passed toServletContext.getResource()orServletContext.getResourceAsStream()must start with "/". Iffalse, code likegetResource("myfolder/myresource.txt")will work as Tomcat will prepend "/" to the provided path. Iforg.apache.catalina.STRICT_SERVLET_COMPLIANCEis set totrue, the default of this setting will betrue, else the default value will befalse.- Specified by:
- getContextGetResourceRequiresSlashin interface- Context
- Returns:
- the flag value
 
- 
setContextGetResourceRequiresSlashpublic void setContextGetResourceRequiresSlash(boolean contextGetResourceRequiresSlash) Description copied from interface:ContextAllow usingServletContext.getResource()orServletContext.getResourceAsStream()without a leading "/".- Specified by:
- setContextGetResourceRequiresSlashin interface- Context
- Parameters:
- contextGetResourceRequiresSlash- the new flag value
 
- 
getDispatcherWrapsSameObjectpublic boolean getDispatcherWrapsSameObject()Description copied from interface:ContextIf this istruethen any wrapped request or response object passed to an application dispatcher will be checked to ensure that it has wrapped the original request or response. Iforg.apache.catalina.STRICT_SERVLET_COMPLIANCEis set totrue, the default of this setting will betrue, else the default value will befalse.- Specified by:
- getDispatcherWrapsSameObjectin interface- Context
- Returns:
- the flag value
 
- 
setDispatcherWrapsSameObjectpublic void setDispatcherWrapsSameObject(boolean dispatcherWrapsSameObject) Description copied from interface:ContextAllow disabling the object wrap check in the request dispatcher.- Specified by:
- setDispatcherWrapsSameObjectin interface- Context
- Parameters:
- dispatcherWrapsSameObject- the new flag value
 
- 
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.
 
- 
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
 
- 
getUseBloomFilterForArchivespublic boolean getUseBloomFilterForArchives()- Specified by:
- getUseBloomFilterForArchivesin interface- Context
- Returns:
- trueif the resources archive lookup will use a bloom filter.
 
- 
setUseBloomFilterForArchivespublic void setUseBloomFilterForArchives(boolean useBloomFilterForArchives) Description copied from interface:ContextSet bloom filter flag value.- Specified by:
- setUseBloomFilterForArchivesin interface- Context
- Parameters:
- useBloomFilterForArchives- The new fast class path scan flag
 
- 
getSuspendWrappedResponseAfterForwardpublic boolean getSuspendWrappedResponseAfterForward()Description copied from interface:ContextIf this istrue, then following a forward the response will be unwrapped to suspend the Catalina response instead of simply closing the top level response. The default value isfalse.- Specified by:
- getSuspendWrappedResponseAfterForwardin interface- Context
- Returns:
- the flag value
 
- 
setSuspendWrappedResponseAfterForwardpublic void setSuspendWrappedResponseAfterForward(boolean suspendWrappedResponseAfterForward) Description copied from interface:ContextAllows unwrapping the response object to suspend the response following a forward.- Specified by:
- setSuspendWrappedResponseAfterForwardin interface- Context
- Parameters:
- suspendWrappedResponseAfterForward- the new flag value
 
 
-