Class StandardContext
- All Implemented Interfaces:
MBeanRegistration,NotificationBroadcaster,NotificationEmitter,Container,Context,JmxEnabled,Lifecycle,ContextBind
- Direct Known Subclasses:
ReplicatedContext
- Author:
- Craig R. McClanahan, Remy Maucherat
-
Nested Class Summary
Nested classes/interfaces inherited from class org.apache.catalina.core.ContainerBase
ContainerBase.ContainerBackgroundProcessor, ContainerBase.ContainerBackgroundProcessorMonitorNested classes/interfaces inherited from interface org.apache.catalina.Lifecycle
Lifecycle.SingleUse -
Field Summary
FieldsModifier and TypeFieldDescriptionprotected booleanAllow multipart/form-data requests to be parsed even when the target servlet doesn't specify @MultipartConfig or have a <multipart-config> element.protected ApplicationContextThe ServletContext implementation associated with this Context.protected static final ThreadBindingListenerprotected ManagerThe Manager implementation with which this Container is associated.protected ThreadBindingListenerFields inherited from class org.apache.catalina.core.ContainerBase
accessLog, backgroundProcessorDelay, backgroundProcessorFuture, children, cluster, listeners, logger, logName, monitorFuture, name, parent, parentClassLoader, pipeline, sm, startChildren, startStopExecutor, supportFields inherited from interface org.apache.catalina.Container
ADD_CHILD_EVENT, ADD_VALVE_EVENT, REMOVE_CHILD_EVENT, REMOVE_VALVE_EVENTFields inherited from interface org.apache.catalina.Context
ADD_WELCOME_FILE_EVENT, CHANGE_SESSION_ID_EVENT, CLEAR_WELCOME_FILES_EVENT, REMOVE_WELCOME_FILE_EVENT, WEBAPP_PROTOCOLFields inherited from interface org.apache.catalina.Lifecycle
AFTER_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 Summary
ConstructorsConstructorDescriptionCreate a new StandardContext component with the default basic Valve. -
Method Summary
Modifier and TypeMethodDescriptionvoidaddApplicationEventListener(Object listener) Add a listener to the end of the list of initialized application event listeners.voidaddApplicationLifecycleListener(Object listener) Add a listener to the end of the list of initialized application lifecycle listeners.voidaddApplicationListener(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.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)voidAdd a message destination for this web application.voidaddMimeMapping(String extension, String mimeType) Add a new MIME mapping, replacing any existing mapping for the specified extension.voidaddNotificationListener(NotificationListener listener, NotificationFilter filter, Object object) 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.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.DynamicvoidaddWatchedResource(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.protected StringadjustURLPattern(String urlPattern) Adjust the URL pattern to begin with a leading slash, if appropriate (i.e. we are running a servlet 2.2 application).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.bind(ClassLoader originalClassLoader) Change the current thread context class loader to the web application class loader.protected ClassLoaderBind current thread, both for CL purposes and for JNDI ENC support during : startup, shutdown and reloading of the context.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.voidprotected voidDestroy needs to clean up the context completely.voiddynamicServletCreated(Servlet servlet) Hook to track which Servlets were created viaServletContext.createServlet(Class).booleanConfigure and initialize the set of filters for this Context.booleanFinalize and release the set of filters for this Context.String[]findErrorPage(int errorCode) findErrorPage(Throwable exceptionType) Find and return the ErrorPage instance for the specified exception's class, or an ErrorPage instance for the closest superclass for which there is such a definition.findFilterConfig(String name) Find and return the initializedFilterConfigfor the specified filter name, if any; otherwise returnnull.findFilterDef(String filterName) findMessageDestination(String name) 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[]booleanfireRequestDestroyEvent(ServletRequest request) Notify allServletRequestListeners that a request has ended.booleanfireRequestInitEvent(ServletRequest request) Notify allServletRequestListeners that a request has started.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.booleanObject[]Obtain the registered application event listeners.Object[]Obtain the registered application lifecycle listeners.getCharset(Locale locale) Obtain the character set name to use with the given Locale.booleanbooleanbooleanbooleanbooleanprotected booleanReturn 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.booleanFlag which indicates if bundled context.xml files should be copied to the config folder.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 "follow standard delegation model" flag used to configure our ClassLoader.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.intintReturn the URL encoded context pathObtain the current configuration for the handling of encoded reverse solidus (%5c - \) characters in paths used to obtainRequestDispatcherinstances for thisContext.Obtain the current configuration for the handling of encoded reverse solidus (%5c - \) characters in paths used to obtainRequestDispatcherinstances for thisContext.Obtain the current configuration for the handling of encoded solidus (%2f - /) characters in paths used to obtainRequestDispatcherinstances for thisContext.Obtain the current configuration for the handling of encoded solidus (%2f - /) characters in paths used to obtainRequestDispatcherinstances for thisContext.longGets the cumulative error count of all servlets in this StandardContext.booleanbooleanDetermine if annotations parsing is currently disabledlongGet the Jar Scanner to be used to scan for JAR resources for this context.booleanbooleanShould the effective web.xml for this context be logged on context start?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.longGets the maximum processing time of all servlets in this StandardContext.booleanDetermine if the metadata of the application is complete.longGets the minimum processing time of all servlets in this StandardContext.Naming context listener accessor.intprotected StringAllow sub-classes to specify the key properties component of theObjectNamethat will be used to register this component.booleanbooleanGet the parent class loader.getPath()booleanIs this Context paused whilst it is reloaded?booleanbooleanlongGets the cumulative processing times of all servlets in this StandardContext.getRealPath(String path) booleanbooleanGet the default request body encoding for this web application.longGets the cumulative request count of all servlets in this StandardContext.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.intbooleanlongGets the time this context was started.longGets the time (in milliseconds) it took to start this context.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.booleanlongbooleanWill the parsing of *.tld files for this Context be performed by a validating parser?longbooleanbooleanGets 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?String[]Get the absolute path to the work dir.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?voidprotected voidSub-classes implement this method to perform any instance initialisation required.booleanisResourceOnlyServlet(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?booleanbooleanConfigure the set of instantiated application event listeners for this Context.booleanSend an application stop event to all interested listeners.booleanloadOnStartup(Container[] children) Load and initialize all servlets marked "load on startup" in the web application deployment descriptor.protected voidSet the appropriate context attribute for our work directory.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.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.voidRemove any message destination with the specified name.voidremoveMimeMapping(String extension) Remove the MIME mapping for the specified extension, if it exists; otherwise, no action is taken.voidvoidremoveNotificationListener(NotificationListener listener, NotificationFilter filter, Object object) 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.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.voidAllocate resources, including proxy.booleanDeallocate resources and destroy proxy.voidsetAddWebinfClassesResources(boolean addWebinfClassesResources) Sets the flag that indicates if /WEB-INF/classes should be treated like an exploded JAR and JAR resources made available as if they were in a JAR.voidsetAllowCasualMultipartParsing(boolean allowCasualMultipartParsing) Set totrueto allow requests mapped to servlets that do not explicitly declare @MultipartConfig or have <multipart-config> specified in web.xml to parse multipart/form-data requests.voidsetAllowMultipleLeadingForwardSlashInPath(boolean allowMultipleLeadingForwardSlashInPath) Configure if, when returning a context path fromHttpServletRequest.getContextPath(), the return value is allowed to contain multiple leading '/' characters.voidsetAltDDName(String altDDName) Set an alternate Deployment Descriptor name.voidsetAlwaysAccessSession(boolean alwaysAccessSession) Set the session access behavior.voidsetAntiResourceLocking(boolean antiResourceLocking) Set the antiResourceLocking feature for this Context.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.voidsetCharsetMapper(CharsetMapper mapper) Set the Locale to character set mapper for this Context.voidsetCharsetMapperClass(String mapper) Set the Locale to character set mapper class for this Context.voidsetClearReferencesHttpClientKeepAliveThread(boolean clearReferencesHttpClientKeepAliveThread) Set the clearReferencesHttpClientKeepAliveThread feature for this Context.voidsetClearReferencesRmiTargets(boolean clearReferencesRmiTargets) voidsetClearReferencesStopThreads(boolean clearReferencesStopThreads) Set the clearReferencesStopThreads feature for this Context.voidsetClearReferencesStopTimerThreads(boolean clearReferencesStopTimerThreads) Set the clearReferencesStopTimerThreads feature for this Context.voidsetClearReferencesThreadLocals(boolean clearReferencesThreadLocals) voidsetConfigFile(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.voidsetCopyXML(boolean copyXML) Allows copying a bundled context.xml file to the host configuration base folder on deployment.voidsetCreateUploadTargets(boolean createUploadTargets) Configure whether Tomcat will attempt to create an upload target used by this web application if it does not exist when the web application attempts to use it.voidsetCrossContext(boolean crossContext) Set the "allow crossing servlet contexts" flag.voidsetDefaultContextXml(String defaultContextXml) Set the location of the default context xml that will be used.voidsetDefaultWebXml(String defaultWebXml) Set the location of the default web xml that will be used.voidsetDelegate(boolean delegate) Set the "follow standard delegation model" flag used to configure our ClassLoader.voidsetDenyUncoveredHttpMethods(boolean denyUncoveredHttpMethods) Set the deny-uncovered-http-methods flag for this web application.voidsetDispatchersUseEncodedPaths(boolean dispatchersUseEncodedPaths) Are paths used in calls to obtain a request dispatcher expected to be encoded?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 effectiveMajorVersion) Set the effective major version of the Servlet spec used by this context.voidsetEffectiveMinorVersion(int effectiveMinorVersion) Set the effective minor version of the Servlet spec used by this context.voidsetEncodedReverseSolidusHandling(String encodedReverseSolidusHandling) Configure the handling for encoded reverse solidus (%5c - \) characters in paths used to obtainRequestDispatcherinstances for thisContext.voidsetEncodedSolidusHandling(String encodedSolidusHandling) Configure the handling for encoded solidus (%2f - /) characters in paths used to obtainRequestDispatcherinstances for thisContext.voidsetFailCtxIfServletStartFails(Boolean failCtxIfServletStartFails) voidsetFireRequestListenersOnForwards(boolean enable) Configure whether or not requests listeners will be fired on forwards for this Context.voidsetIgnoreAnnotations(boolean ignoreAnnotations) Set the boolean on the annotations parsing for this web application.voidsetInstanceManager(InstanceManager instanceManager) Set the instance manager associated with this context.voidsetJ2EEApplication(String j2EEApplication) voidsetJ2EEServer(String j2EEServer) voidsetJarScanner(JarScanner jarScanner) Set the Jar Scanner to be used to scan for JAR resources for this context.voidsetJndiExceptionOnFailedWrite(boolean jndiExceptionOnFailedWrite) Controls whether or not an attempt to modify the JNDI context will trigger an exception or if the request will be ignored.voidsetJspConfigDescriptor(JspConfigDescriptor descriptor) Set the JspConfigDescriptor for this context.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.voidsetMetadataComplete(boolean metadataComplete) Set the boolean on the metadata complete flag for this web application.voidsetNamingContextListener(NamingContextListener namingContextListener) Naming context listener setter.voidsetNamingResources(NamingResourcesImpl namingResources) Set the naming resources for this web application.voidsetNotFoundClassResourceCacheSize(int notFoundClassResourceCacheSize) voidsetOriginalDocBase(String docBase) Set the original document root for this Context.voidsetOverride(boolean override) Set the override flag for this web application.voidsetParallelAnnotationScanning(boolean parallelAnnotationScanning) Set the parallel annotation scanning value.voidSet the context path for this web application.voidsetPreemptiveAuthentication(boolean preemptiveAuthentication) Configures if a user presents authentication credentials, whether the context will process them when the request is for a non-protected resource.voidsetPrivileged(boolean privileged) Set the privileged flag for this web application.voidsetPublicId(String publicId) Set the public identifier of the deployment descriptor DTD that is currently being parsed.voidsetReloadable(boolean reloadable) Set the reloadable flag for this web application.voidsetRenewThreadsWhenStoppingContext(boolean renewThreadsWhenStoppingContext) voidsetReplaceWelcomeFiles(boolean replaceWelcomeFiles) Set the "replace welcome files" property.voidsetRequestCharacterEncoding(String requestEncoding) 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 responseEncoding) Set the default response body encoding for this web application.voidsetSendRedirectBody(boolean sendRedirectBody) Configures if a response body is included when a redirect response is sent to the client.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.voidsetSkipMemoryLeakChecksOnJvmShutdown(boolean skipMemoryLeakChecksOnJvmShutdown) voidsetStartupTime(long startupTime) 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.voidsetTldScanTime(long tldScanTime) voidsetTldValidation(boolean tldValidation) Controls whether the parsing of *.tld files for this Context will be performed by a validating parser.voidsetUnloadDelay(long unloadDelay) Set the value of the unloadDelay flag, which represents the amount of ms that the container will wait when unloading servlets.voidsetUnpackWAR(boolean unpackWAR) Unpack WAR flag mutator.voidsetUseHttpOnly(boolean useHttpOnly) Sets the use HttpOnly cookies for session cookies flag.voidsetUseNaming(boolean useNaming) Enables or disables naming.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.voidsetWorkDir(String workDir) Set the work directory for this Context.voidsetWrapperClass(String wrapperClassName) Set the Java class name of the Wrapper implementation used for servlets registered in this Context.voidsetXmlBlockExternal(boolean xmlBlockExternal) Controls whether the parsing of web.xml, web-fragment.xml, *.tld, *.jspx, *.tagx and tagplugin.xml files for this Context will block the use of external entities.voidsetXmlNamespaceAware(boolean webXmlNamespaceAware) Controls whether the parsing of web.xml and web-fragment.xml files for this Context will be performed by a namespace aware parser.voidsetXmlValidation(boolean webXmlValidation) Controls whether the parsing of web.xml and web-fragment.xml files for this Context will be performed by a validating parser.protected voidStart this component and implement the requirements ofLifecycleBase.startInternal().protected voidStop this component and implement the requirements ofLifecycleBase.stopInternal().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.voidunbind(ClassLoader originalClassLoader) Restore the current thread context class loader to the original class loader in used beforeContextBind.bind(boolean, ClassLoader)was called.protected voidunbindThread(ClassLoader oldContextClassLoader) Unbind thread and restore the specified context classloader.booleanwasCreatedDynamicServlet(Servlet servlet) Methods inherited from class org.apache.catalina.core.ContainerBase
addContainerListener, addPropertyChangeListener, addValve, findChild, findChildren, findContainerListeners, fireContainerEvent, getAccessLog, getBackgroundProcessorDelay, getCatalinaBase, getCatalinaHome, getChildren, getCluster, getClusterInternal, getDomainInternal, getLogger, getLogName, getMBeanKeyProperties, getName, getParent, getPipeline, getRealm, getRealmInternal, getStartChildren, getStartStopThreads, logAccess, removeContainerListener, removePropertyChangeListener, setBackgroundProcessorDelay, setCluster, setName, setParent, setParentClassLoader, setRealm, setStartChildren, setStartStopThreads, threadStart, threadStop, toStringMethods inherited from class org.apache.catalina.util.LifecycleMBeanBase
getDomain, getObjectName, postDeregister, postRegister, preDeregister, preRegister, register, setDomain, unregister, unregisterMethods inherited from class org.apache.catalina.util.LifecycleBase
addLifecycleListener, destroy, findLifecycleListeners, fireLifecycleEvent, getState, getStateName, getThrowOnFailure, init, removeLifecycleListener, setState, setState, setThrowOnFailure, start, stopMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods inherited from interface org.apache.catalina.Container
addContainerListener, addPropertyChangeListener, findChild, findChildren, findContainerListeners, fireContainerEvent, getAccessLog, getBackgroundProcessorDelay, getCatalinaBase, getCatalinaHome, getCluster, getDomain, getLogger, getLogName, getMBeanKeyProperties, getName, getObjectName, getParent, getPipeline, getRealm, getStartStopThreads, logAccess, removeContainerListener, removePropertyChangeListener, setBackgroundProcessorDelay, setCluster, setName, setParent, setParentClassLoader, setRealm, setStartStopThreadsMethods inherited from interface org.apache.catalina.Context
addServletMappingDecoded, findConfigFileResourceMethods inherited from interface org.apache.catalina.Lifecycle
addLifecycleListener, destroy, findLifecycleListeners, getState, getStateName, init, removeLifecycleListener, start, stop
-
Field Details
-
allowCasualMultipartParsing
protected boolean allowCasualMultipartParsingAllow multipart/form-data requests to be parsed even when the target servlet doesn't specify @MultipartConfig or have a <multipart-config> element. -
context
The ServletContext implementation associated with this Context. -
manager
The Manager implementation with which this Container is associated. -
DEFAULT_NAMING_LISTENER
-
threadBindingListener
-
-
Constructor Details
-
StandardContext
public StandardContext()Create a new StandardContext component with the default basic Valve.
-
-
Method Details
-
getEncodedReverseSolidusHandling
Description copied from interface:ContextObtain the current configuration for the handling of encoded reverse solidus (%5c - \) characters in paths used to obtainRequestDispatcherinstances for thisContext.- Specified by:
getEncodedReverseSolidusHandlingin interfaceContext- Returns:
- Obtain the current configuration for the handling of encoded reverse solidus characters
-
setEncodedReverseSolidusHandling
Description copied from interface:ContextConfigure the handling for encoded reverse solidus (%5c - \) characters in paths used to obtainRequestDispatcherinstances for thisContext.- Specified by:
setEncodedReverseSolidusHandlingin interfaceContext- Parameters:
encodedReverseSolidusHandling- One of the values ofEncodedSolidusHandling
-
getEncodedReverseSolidusHandlingEnum
Description copied from interface:ContextObtain the current configuration for the handling of encoded reverse solidus (%5c - \) characters in paths used to obtainRequestDispatcherinstances for thisContext.- Specified by:
getEncodedReverseSolidusHandlingEnumin interfaceContext- Returns:
- Obtain the current configuration for the handling of encoded reverse solidus characters
-
getEncodedSolidusHandling
Description copied from interface:ContextObtain the current configuration for the handling of encoded solidus (%2f - /) characters in paths used to obtainRequestDispatcherinstances for thisContext.- Specified by:
getEncodedSolidusHandlingin interfaceContext- Returns:
- Obtain the current configuration for the handling of encoded solidus characters
-
setEncodedSolidusHandling
Description copied from interface:ContextConfigure the handling for encoded solidus (%2f - /) characters in paths used to obtainRequestDispatcherinstances for thisContext.- Specified by:
setEncodedSolidusHandlingin interfaceContext- Parameters:
encodedSolidusHandling- One of the values ofEncodedSolidusHandling
-
getEncodedSolidusHandlingEnum
Description copied from interface:ContextObtain the current configuration for the handling of encoded solidus (%2f - /) characters in paths used to obtainRequestDispatcherinstances for thisContext.- Specified by:
getEncodedSolidusHandlingEnumin interfaceContext- Returns:
- Obtain the current configuration for the handling of encoded solidus characters
-
getNotFoundClassResourceCacheSize
public int getNotFoundClassResourceCacheSize() -
setNotFoundClassResourceCacheSize
public void setNotFoundClassResourceCacheSize(int notFoundClassResourceCacheSize) -
setCreateUploadTargets
public 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 interfaceContext- Parameters:
createUploadTargets-trueif Tomcat should attempt to create the upload target, otherwisefalse
-
getCreateUploadTargets
public 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 interfaceContext- Returns:
trueif Tomcat will attempt to create an upload target otherwisefalse
-
incrementInProgressAsyncCount
public void incrementInProgressAsyncCount()- Specified by:
incrementInProgressAsyncCountin interfaceContext
-
decrementInProgressAsyncCount
public void decrementInProgressAsyncCount()- Specified by:
decrementInProgressAsyncCountin interfaceContext
-
getInProgressAsyncCount
public long getInProgressAsyncCount() -
setAllowMultipleLeadingForwardSlashInPath
public 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 interfaceContext- Parameters:
allowMultipleLeadingForwardSlashInPath- The new value for the flag
-
getAllowMultipleLeadingForwardSlashInPath
public boolean getAllowMultipleLeadingForwardSlashInPath()Description copied from interface:ContextWhen returning a context path fromHttpServletRequest.getContextPath(), is it allowed to contain multiple leading '/' characters?- Specified by:
getAllowMultipleLeadingForwardSlashInPathin interfaceContext- Returns:
trueif multiple leading '/' characters are allowed, otherwisefalse
-
getAlwaysAccessSession
public 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 interfaceContext- Returns:
- the flag value
-
setAlwaysAccessSession
public void setAlwaysAccessSession(boolean alwaysAccessSession) Description copied from interface:ContextSet the session access behavior.- Specified by:
setAlwaysAccessSessionin interfaceContext- Parameters:
alwaysAccessSession- the new flag value
-
getContextGetResourceRequiresSlash
public 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 interfaceContext- Returns:
- the flag value
-
setContextGetResourceRequiresSlash
public void setContextGetResourceRequiresSlash(boolean contextGetResourceRequiresSlash) Description copied from interface:ContextAllow usingServletContext.getResource()orServletContext.getResourceAsStream()without a leading "/".- Specified by:
setContextGetResourceRequiresSlashin interfaceContext- Parameters:
contextGetResourceRequiresSlash- the new flag value
-
getDispatcherWrapsSameObject
public 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 interfaceContext- Returns:
- the flag value
-
setDispatcherWrapsSameObject
public void setDispatcherWrapsSameObject(boolean dispatcherWrapsSameObject) Description copied from interface:ContextAllow disabling the object wrap check in the request dispatcher.- Specified by:
setDispatcherWrapsSameObjectin interfaceContext- Parameters:
dispatcherWrapsSameObject- the new flag value
-
getSuspendWrappedResponseAfterForward
public 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 istrue.- Specified by:
getSuspendWrappedResponseAfterForwardin interfaceContext- Returns:
- the flag value
-
setSuspendWrappedResponseAfterForward
public void setSuspendWrappedResponseAfterForward(boolean suspendWrappedResponseAfterForward) Description copied from interface:ContextAllows unwrapping the response object to suspend the response following a forward.- Specified by:
setSuspendWrappedResponseAfterForwardin interfaceContext- Parameters:
suspendWrappedResponseAfterForward- the new flag value
-
getRequestCharacterEncoding
Description copied from interface:ContextGet the default request body encoding for this web application.- Specified by:
getRequestCharacterEncodingin interfaceContext- Returns:
- The default request body encoding
-
setRequestCharacterEncoding
Description copied from interface:ContextSet the default request body encoding for this web application.- Specified by:
setRequestCharacterEncodingin interfaceContext- Parameters:
requestEncoding- The default encoding
-
getResponseCharacterEncoding
Description copied from interface:ContextGet the default response body encoding for this web application.- Specified by:
getResponseCharacterEncodingin interfaceContext- Returns:
- The default response body encoding
-
setResponseCharacterEncoding
Description copied from interface:ContextSet the default response body encoding for this web application.- Specified by:
setResponseCharacterEncodingin interfaceContext- Parameters:
responseEncoding- The default encoding
-
setDispatchersUseEncodedPaths
public 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 interfaceContext- Parameters:
dispatchersUseEncodedPaths-trueto use encoded paths, otherwisefalse
-
getDispatchersUseEncodedPaths
public boolean getDispatchersUseEncodedPaths()Are paths used in calls to obtain a request dispatcher expected to be encoded? This applies to both how Tomcat handles calls to obtain a request dispatcher as well as how Tomcat generates paths used to obtain request dispatchers internally.The default value for this implementation is
true.- Specified by:
getDispatchersUseEncodedPathsin interfaceContext- Returns:
trueif encoded paths will be used, otherwisefalse
-
setUseRelativeRedirects
public 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 interfaceContext- Parameters:
useRelativeRedirects-trueto use relative redirects andfalseto use absolute redirects
-
getUseRelativeRedirects
public boolean getUseRelativeRedirects()Will HTTP 1.1 and later location headers generated by a call toHttpServletResponse.sendRedirect(String)use relative or absolute redirects.The default value for this implementation is
true.- Specified by:
getUseRelativeRedirectsin interfaceContext- Returns:
trueif relative redirects will be usedfalseif absolute redirects are used.- See Also:
-
setMapperContextRootRedirectEnabled
public 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 interfaceContext- Parameters:
mapperContextRootRedirectEnabled- Should the redirects be enabled?
-
getMapperContextRootRedirectEnabled
public boolean getMapperContextRootRedirectEnabled()Determines if requests for a web application context root will be redirected (adding a trailing slash) by the Mapper. This is more efficient but has the side effect of confirming that the context path is valid.The default value for this implementation is
false.- Specified by:
getMapperContextRootRedirectEnabledin interfaceContext- Returns:
trueif the Mapper level redirect is enabled for this Context.
-
setMapperDirectoryRedirectEnabled
public 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 interfaceContext- Parameters:
mapperDirectoryRedirectEnabled- Should the redirects be enabled?
-
getMapperDirectoryRedirectEnabled
public boolean getMapperDirectoryRedirectEnabled()Determines if requests for a directory will be redirected (adding a trailing slash) by the Mapper. This is more efficient but has the side effect of confirming that the directory is valid.The default value for this implementation is
false.- Specified by:
getMapperDirectoryRedirectEnabledin interfaceContext- Returns:
trueif the Mapper level redirect is enabled for this Context.
-
setValidateClientProvidedNewSessionId
public 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 interfaceContext- Parameters:
validateClientProvidedNewSessionId-trueif validation should be applied
-
getValidateClientProvidedNewSessionId
public boolean getValidateClientProvidedNewSessionId()Will client provided session IDs be validated (seeContext.setValidateClientProvidedNewSessionId(boolean)) before use?The default value for this implementation is
true.- Specified by:
getValidateClientProvidedNewSessionIdin interfaceContext- Returns:
trueif validation will be applied. Otherwise,false
-
setCookieProcessor
Description copied from interface:ContextSets theCookieProcessorthat will be used to process cookies for this Context.- Specified by:
setCookieProcessorin interfaceContext- Parameters:
cookieProcessor- The new cookie processor
-
getCookieProcessor
- Specified by:
getCookieProcessorin interfaceContext- Returns:
- the
CookieProcessorthat will be used to process cookies for this Context.
-
getNamingToken
- Specified by:
getNamingTokenin interfaceContext- Returns:
- the token necessary for operations on the associated JNDI naming context.
-
setContainerSciFilter
Description copied from interface:ContextSets the regular expression that specifies which container provided SCIs should be filtered out and not used for this context. Matching usesMatcher.find()so the regular expression only has to match a sub-string of the fully qualified class name of the container provided SCI for it to be filtered out.- Specified by:
setContainerSciFilterin interfaceContext- Parameters:
containerSciFilter- The regular expression against which the fully qualified class name of each container provided SCI should be checked
-
getContainerSciFilter
Description copied from interface:ContextObtains the regular expression that specifies which container provided SCIs should be filtered out and not used for this context. Matching usesMatcher.find()so the regular expression only has to match a sub-string of the fully qualified class name of the container provided SCI for it to be filtered out.- Specified by:
getContainerSciFilterin interfaceContext- Returns:
- The regular expression against which the fully qualified class name of each container provided SCI will be checked
-
getSendRedirectBody
public boolean getSendRedirectBody()- Specified by:
getSendRedirectBodyin interfaceContext- Returns:
- if the context is configured to include a response body as part of a redirect response.
-
setSendRedirectBody
public void setSendRedirectBody(boolean sendRedirectBody) Description copied from interface:ContextConfigures if a response body is included when a redirect response is sent to the client.- Specified by:
setSendRedirectBodyin interfaceContext- Parameters:
sendRedirectBody-trueto send a response body for redirects
-
getPreemptiveAuthentication
public boolean getPreemptiveAuthentication()- Specified by:
getPreemptiveAuthenticationin interfaceContext- Returns:
- if a user presents authentication credentials, will the context will process them when the request is for a non-protected resource.
-
setPreemptiveAuthentication
public void setPreemptiveAuthentication(boolean preemptiveAuthentication) Description copied from interface:ContextConfigures if a user presents authentication credentials, whether the context will process them when the request is for a non-protected resource.- Specified by:
setPreemptiveAuthenticationin interfaceContext- Parameters:
preemptiveAuthentication-trueto perform authentication even outside security constraints
-
setFireRequestListenersOnForwards
public 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 interfaceContext- Parameters:
enable-trueto fire request listeners when forwarding
-
getFireRequestListenersOnForwards
public boolean getFireRequestListenersOnForwards()- Specified by:
getFireRequestListenersOnForwardsin interfaceContext- Returns:
- whether or not requests listeners will be fired on forwards for this Context.
-
setAddWebinfClassesResources
public 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 interfaceContext- Parameters:
addWebinfClassesResources- The new value for the flag
-
getAddWebinfClassesResources
public boolean getAddWebinfClassesResources()- Specified by:
getAddWebinfClassesResourcesin interfaceContext- 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.
-
setWebappVersion
Description copied from interface:ContextSet the version of this web application - used to differentiate different versions of the same web application when using parallel deployment.- Specified by:
setWebappVersionin interfaceContext- Parameters:
webappVersion- The webapp version associated with the context, which should be unique
-
getWebappVersion
- Specified by:
getWebappVersionin interfaceContext- 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.
-
getBaseName
- Specified by:
getBaseNamein interfaceContext- Returns:
- the base name to use for WARs, directories or context.xml files for this context.
-
getResourceOnlyServlets
Description copied from interface:ContextObtains the list of Servlets that expect a resource to be present.- Specified by:
getResourceOnlyServletsin interfaceContext- Returns:
- A comma separated list of Servlet names as used in web.xml
-
setResourceOnlyServlets
Description copied from interface:ContextSets the (comma separated) list of Servlets that expect a resource to be present. Used to ensure that welcome files associated with Servlets that expect a resource to be present are not mapped when there is no resource.- Specified by:
setResourceOnlyServletsin interfaceContext- Parameters:
resourceOnlyServlets- The Servlet names comma separated list
-
isResourceOnlyServlet
Description copied from interface:ContextChecks the named Servlet to see if it expects a resource to be present.- Specified by:
isResourceOnlyServletin interfaceContext- Parameters:
servletName- Name of the Servlet (as per web.xml) to check- Returns:
trueif the Servlet expects a resource, otherwisefalse
-
getEffectiveMajorVersion
public int getEffectiveMajorVersion()- Specified by:
getEffectiveMajorVersionin interfaceContext- Returns:
- the effective major version of the Servlet spec used by this context.
-
setEffectiveMajorVersion
public void setEffectiveMajorVersion(int effectiveMajorVersion) Description copied from interface:ContextSet the effective major version of the Servlet spec used by this context.- Specified by:
setEffectiveMajorVersionin interfaceContext- Parameters:
effectiveMajorVersion- Set the version number
-
getEffectiveMinorVersion
public int getEffectiveMinorVersion()- Specified by:
getEffectiveMinorVersionin interfaceContext- Returns:
- the effective minor version of the Servlet spec used by this context.
-
setEffectiveMinorVersion
public void setEffectiveMinorVersion(int effectiveMinorVersion) Description copied from interface:ContextSet the effective minor version of the Servlet spec used by this context.- Specified by:
setEffectiveMinorVersionin interfaceContext- Parameters:
effectiveMinorVersion- Set the version number
-
setLogEffectiveWebXml
public 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 interfaceContext- Parameters:
logEffectiveWebXml- set totrueto log the complete web.xml that will be used for the webapp
-
getLogEffectiveWebXml
public boolean getLogEffectiveWebXml()Description copied from interface:ContextShould the effective web.xml for this context be logged on context start?- Specified by:
getLogEffectiveWebXmlin interfaceContext- Returns:
- true if the reconstructed web.xml that will be used for the webapp should be logged
-
getAuthenticator
- Specified by:
getAuthenticatorin interfaceContext- Returns:
- the
Authenticatorthat is used by this context. This is always non-nullfor a started Context
-
getJarScanner
Description copied from interface:ContextGet the Jar Scanner to be used to scan for JAR resources for this context.- Specified by:
getJarScannerin interfaceContext- Returns:
- The Jar Scanner configured for this context.
-
setJarScanner
Description copied from interface:ContextSet the Jar Scanner to be used to scan for JAR resources for this context.- Specified by:
setJarScannerin interfaceContext- Parameters:
jarScanner- The Jar Scanner to be used for this context.
-
getInstanceManager
- Specified by:
getInstanceManagerin interfaceContext- Returns:
- the instance manager associated with this context.
-
setInstanceManager
Description copied from interface:ContextSet the instance manager associated with this context.- Specified by:
setInstanceManagerin interfaceContext- Parameters:
instanceManager- the new instance manager instance
-
getEncodedPath
Description copied from interface:ContextReturn the URL encoded context path- Specified by:
getEncodedPathin interfaceContext- Returns:
- The URL encoded (with UTF-8) context path
-
setAllowCasualMultipartParsing
public 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 interfaceContext- Parameters:
allowCasualMultipartParsing-trueto allow such casual parsing,falseotherwise.
-
getAllowCasualMultipartParsing
public boolean getAllowCasualMultipartParsing()Returnstrueif requests mapped to servlets without "multipart config" to parse multipart/form-data requests anyway.The default value for this implementation is
false.- Specified by:
getAllowCasualMultipartParsingin interfaceContext- Returns:
trueif requests mapped to servlets without "multipart config" to parse multipart/form-data requests,falseotherwise.
-
setSwallowAbortedUploads
public 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 interfaceContext- Parameters:
swallowAbortedUploads-falseto disable swallowing,trueotherwise (default).
-
getSwallowAbortedUploads
public boolean getSwallowAbortedUploads()Returnstrueif remaining request data will be read (swallowed) even the request violates a data size constraint.The default value for this implementation is
false.- Specified by:
getSwallowAbortedUploadsin interfaceContext- Returns:
trueif data will be swallowed (default),falseotherwise.
-
addServletContainerInitializer
Description copied from interface:ContextAdd a ServletContainerInitializer instance to this web application.- Specified by:
addServletContainerInitializerin interfaceContext- Parameters:
sci- The instance to addclasses- The classes in which the initializer expressed an interest
-
getDelegate
public boolean getDelegate()Return the "follow standard delegation model" flag used to configure our ClassLoader.- Returns:
trueif classloading delegates to the parent classloader first
-
setDelegate
public void setDelegate(boolean delegate) Set the "follow standard delegation model" flag used to configure our ClassLoader.- Parameters:
delegate- The new flag
-
isUseNaming
public boolean isUseNaming()- Returns:
- true if the internal naming support is used.
-
setUseNaming
public void setUseNaming(boolean useNaming) Enables or disables naming.- Parameters:
useNaming-trueto enable the naming environment
-
getApplicationEventListeners
Description copied from interface:ContextObtain the registered application event listeners.- Specified by:
getApplicationEventListenersin interfaceContext- 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
-
setApplicationEventListeners
Store the set of initialized application event listener objects, in the order they were specified in the web application deployment descriptor, for this application. Note that this implementation is not thread safe. If two threads call this method concurrently, the result may be either set of listeners or a the union of both.- Specified by:
setApplicationEventListenersin interfaceContext- Parameters:
listeners- The set of instantiated listener objects.
-
addApplicationEventListener
Add a listener to the end of the list of initialized application event listeners.- Parameters:
listener- The listener to add
-
getApplicationLifecycleListeners
Description copied from interface:ContextObtain the registered application lifecycle listeners.- Specified by:
getApplicationLifecycleListenersin interfaceContext- 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
-
setApplicationLifecycleListeners
Description 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 interfaceContext- Parameters:
listeners- The set of instantiated listener objects.
-
addApplicationLifecycleListener
Add a listener to the end of the list of initialized application lifecycle listeners.- Parameters:
listener- The listener to add
-
getAntiResourceLocking
public boolean getAntiResourceLocking()- Returns:
- the antiResourceLocking flag for this Context.
-
setAntiResourceLocking
public void setAntiResourceLocking(boolean antiResourceLocking) Set the antiResourceLocking feature for this Context.- Parameters:
antiResourceLocking- The new flag value
-
setParallelAnnotationScanning
public void setParallelAnnotationScanning(boolean parallelAnnotationScanning) Description copied from interface:ContextSet the parallel annotation scanning value.- Specified by:
setParallelAnnotationScanningin interfaceContext- Parameters:
parallelAnnotationScanning- new parallel annotation scanning flag
-
getParallelAnnotationScanning
public boolean getParallelAnnotationScanning()- Specified by:
getParallelAnnotationScanningin interfaceContext- Returns:
- the value of the parallel annotation scanning flag. If true, it will dispatch scanning to the utility executor.
-
getCharsetMapper
- Returns:
- the Locale to character set mapper for this Context.
-
setCharsetMapper
Set the Locale to character set mapper for this Context.- Parameters:
mapper- The new mapper
-
getCharset
Description copied from interface:ContextObtain the character set name to use with the given Locale. Note that different Contexts may have different mappings of Locale to character set.- Specified by:
getCharsetin interfaceContext- 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
-
getConfigFile
Description copied from interface:ContextReturn the URL of the XML descriptor for this context.- Specified by:
getConfigFilein interfaceContext- Returns:
- The URL of the XML descriptor for this context
-
setConfigFile
Description copied from interface:ContextSet the URL of the XML descriptor for this context.- Specified by:
setConfigFilein interfaceContext- Parameters:
configFile- The URL of the XML descriptor for this context.
-
getConfigured
public boolean getConfigured()Description copied from interface:ContextReturn the "correctly configured" flag for this Context.- Specified by:
getConfiguredin interfaceContext- Returns:
trueif the Context has been correctly configured, otherwisefalse
-
setConfigured
public 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 interfaceContext- Parameters:
configured- The new correctly configured flag
-
getCookies
public boolean getCookies()Description copied from interface:ContextReturn the "use cookies for session ids" flag.- Specified by:
getCookiesin interfaceContext- Returns:
trueif it is permitted to use cookies to track session IDs for this web application, otherwisefalse
-
setCookies
public void setCookies(boolean cookies) Description copied from interface:ContextSet the "use cookies for session ids" flag.- Specified by:
setCookiesin interfaceContext- Parameters:
cookies- The new flag
-
getSessionCookieName
Description copied from interface:ContextGets the name to use for session cookies. Overrides any setting that may be specified by the application.- Specified by:
getSessionCookieNamein interfaceContext- Returns:
- The value of the default session cookie name or null if not specified
-
setSessionCookieName
Description copied from interface:ContextSets the name to use for session cookies. Overrides any setting that may be specified by the application.- Specified by:
setSessionCookieNamein interfaceContext- Parameters:
sessionCookieName- The name to use
-
getUseHttpOnly
public boolean getUseHttpOnly()Gets the value of the use HttpOnly cookies for session cookies flag.The default value for this implementation is
true.- Specified by:
getUseHttpOnlyin interfaceContext- Returns:
trueif the HttpOnly flag should be set on session cookies
-
setUseHttpOnly
public void setUseHttpOnly(boolean useHttpOnly) Description copied from interface:ContextSets the use HttpOnly cookies for session cookies flag.- Specified by:
setUseHttpOnlyin interfaceContext- Parameters:
useHttpOnly- Set totrueto use HttpOnly cookies for session cookies
-
getUsePartitioned
public 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 interfaceContext- Returns:
trueif thePartitionedattribute should be added to session cookies created for this web application, otherwisefalse
-
setUsePartitioned
public 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 interfaceContext- Parameters:
usePartitioned-trueif thePartitionedattribute should be added to session cookies created for this web application, otherwisefalse
-
getSessionCookieDomain
Description copied from interface:ContextGets the domain to use for session cookies. Overrides any setting that may be specified by the application.- Specified by:
getSessionCookieDomainin interfaceContext- Returns:
- The value of the default session cookie domain or null if not specified
-
setSessionCookieDomain
Description copied from interface:ContextSets the domain to use for session cookies. Overrides any setting that may be specified by the application.- Specified by:
setSessionCookieDomainin interfaceContext- Parameters:
sessionCookieDomain- The domain to use
-
getSessionCookiePath
Description copied from interface:ContextGets the path to use for session cookies. Overrides any setting that may be specified by the application.- Specified by:
getSessionCookiePathin interfaceContext- Returns:
- The value of the default session cookie path or null if not specified
-
setSessionCookiePath
Description copied from interface:ContextSets the path to use for session cookies. Overrides any setting that may be specified by the application.- Specified by:
setSessionCookiePathin interfaceContext- Parameters:
sessionCookiePath- The path to use
-
getSessionCookiePathUsesTrailingSlash
public 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 interfaceContext- Returns:
trueif the slash is added, otherwisefalse
-
setSessionCookiePathUsesTrailingSlash
public 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 interfaceContext- Parameters:
sessionCookiePathUsesTrailingSlash-trueif the slash is should be added, otherwisefalse
-
getCrossContext
public boolean getCrossContext()Return the "allow crossing servlet contexts" flag.The default value for this implementation is
false.- Specified by:
getCrossContextin interfaceContext- Returns:
trueif cross-contest requests are allowed from this web applications, otherwisefalse
-
setCrossContext
public void setCrossContext(boolean crossContext) Description copied from interface:ContextSet the "allow crossing servlet contexts" flag.- Specified by:
setCrossContextin interfaceContext- Parameters:
crossContext- The new cross contexts flag
-
getDefaultContextXml
-
setDefaultContextXml
Set the location of the default context xml that will be used. If not absolute, it'll be made relative to the engine's base dir ( which defaults to catalina.base system property ).- Parameters:
defaultContextXml- The default web xml
-
getDefaultWebXml
-
setDefaultWebXml
Set the location of the default web xml that will be used. If not absolute, it'll be made relative to the engine's base dir ( which defaults to catalina.base system property ).- Parameters:
defaultWebXml- The default web xml
-
getStartupTime
public long getStartupTime()Gets the time (in milliseconds) it took to start this context.- Returns:
- Time (in milliseconds) it took to start this context.
-
setStartupTime
public void setStartupTime(long startupTime) -
getTldScanTime
public long getTldScanTime() -
setTldScanTime
public void setTldScanTime(long tldScanTime) -
getDenyUncoveredHttpMethods
public boolean getDenyUncoveredHttpMethods()Description copied from interface:ContextReturn the deny-uncovered-http-methods flag for this web application.- Specified by:
getDenyUncoveredHttpMethodsin interfaceContext- Returns:
- The current value of the flag
-
setDenyUncoveredHttpMethods
public void setDenyUncoveredHttpMethods(boolean denyUncoveredHttpMethods) Description copied from interface:ContextSet the deny-uncovered-http-methods flag for this web application.- Specified by:
setDenyUncoveredHttpMethodsin interfaceContext- Parameters:
denyUncoveredHttpMethods- The new deny-uncovered-http-methods flag
-
getDisplayName
Description copied from interface:ContextReturn the display name of this web application.- Specified by:
getDisplayNamein interfaceContext- Returns:
- The display name
-
getAltDDName
Description copied from interface:ContextReturn the alternate Deployment Descriptor name.- Specified by:
getAltDDNamein interfaceContext- Returns:
- the name
-
setAltDDName
Description copied from interface:ContextSet an alternate Deployment Descriptor name.- Specified by:
setAltDDNamein interfaceContext- Parameters:
altDDName- The new name
-
setDisplayName
Description copied from interface:ContextSet the display name of this web application.- Specified by:
setDisplayNamein interfaceContext- Parameters:
displayName- The new display name
-
getDistributable
public boolean getDistributable()Get the distributable flag for this web application.The default value for this implementation is
false.- Specified by:
getDistributablein interfaceContext- Returns:
- The value of the distributable flag for this web application.
-
setDistributable
public void setDistributable(boolean distributable) Description copied from interface:ContextSet the distributable flag for this web application.- Specified by:
setDistributablein interfaceContext- Parameters:
distributable- The new distributable flag
-
getDocBase
Description copied from interface:ContextObtain the document root for this Context.- Specified by:
getDocBasein interfaceContext- Returns:
- An absolute pathname or a relative (to the Host's appBase) pathname.
-
setDocBase
Description copied from interface:ContextSet the document root for this Context. This can be either an absolute pathname or a relative pathname. Relative pathnames are relative to the containing Host's appBase.- Specified by:
setDocBasein interfaceContext- Parameters:
docBase- The new document root
-
getJ2EEApplication
-
setJ2EEApplication
-
getJ2EEServer
-
setJ2EEServer
-
getLoader
-
setLoader
-
getManager
- Specified by:
getManagerin interfaceContext- Returns:
- the Manager with which this Context is associated. If there is no associated Manager, return
null.
-
setManager
Description copied from interface:ContextSet the Manager with which this Context is associated.- Specified by:
setManagerin interfaceContext- Parameters:
manager- The newly associated Manager
-
getIgnoreAnnotations
public boolean getIgnoreAnnotations()Determine if annotations parsing is currently disabledThe default value for this implementation is
false.- Specified by:
getIgnoreAnnotationsin interfaceContext- Returns:
trueif annotation parsing is disabled for this web application
-
setIgnoreAnnotations
public void setIgnoreAnnotations(boolean ignoreAnnotations) Description copied from interface:ContextSet the boolean on the annotations parsing for this web application.- Specified by:
setIgnoreAnnotationsin interfaceContext- Parameters:
ignoreAnnotations- The boolean on the annotations parsing
-
getMetadataComplete
public boolean getMetadataComplete()Description copied from interface:ContextDetermine if the metadata of the application is complete. This typically means annotations which add to the application metadata will be ignored.- Specified by:
getMetadataCompletein interfaceContext- Returns:
trueif metadata is complete for this web application
-
setMetadataComplete
public void setMetadataComplete(boolean metadataComplete) Description copied from interface:ContextSet the boolean on the metadata complete flag for this web application.- Specified by:
setMetadataCompletein interfaceContext- Parameters:
metadataComplete- The boolean on the metadata complete flag
-
getLoginConfig
- Specified by:
getLoginConfigin interfaceContext- Returns:
- the login configuration descriptor for this web application.
-
setLoginConfig
Description copied from interface:ContextSet the login configuration descriptor for this web application.- Specified by:
setLoginConfigin interfaceContext- Parameters:
config- The new login configuration
-
getNamingResources
- Specified by:
getNamingResourcesin interfaceContext- Returns:
- the naming resources associated with this web application.
-
setNamingResources
Description copied from interface:ContextSet the naming resources for this web application.- Specified by:
setNamingResourcesin interfaceContext- Parameters:
namingResources- The new naming resources
-
getPath
-
setPath
-
getPublicId
- Specified by:
getPublicIdin interfaceContext- Returns:
- the public identifier of the deployment descriptor DTD that is currently being parsed.
-
setPublicId
Description copied from interface:ContextSet the public identifier of the deployment descriptor DTD that is currently being parsed.- Specified by:
setPublicIdin interfaceContext- Parameters:
publicId- The public identifier
-
getReloadable
public boolean getReloadable()The default value for this implementation is
false.- Specified by:
getReloadablein interfaceContext- Returns:
- the reloadable flag for this web application.
-
getOverride
public boolean getOverride()The default value for this implementation is
false.- Specified by:
getOverridein interfaceContext- Returns:
- the override flag for this web application.
-
getOriginalDocBase
- Returns:
- the original document root for this Context. This can be an absolute pathname, a relative pathname, or a URL. Is only set as deployment has change docRoot!
-
setOriginalDocBase
Set the original document root for this Context. This can be an absolute pathname, a relative pathname, or a URL.- Parameters:
docBase- The original document root
-
getParentClassLoader
Description copied from interface:ContainerGet the parent class loader.- Specified by:
getParentClassLoaderin interfaceContainer- Overrides:
getParentClassLoaderin classContainerBase- 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.
-
getPrivileged
public boolean getPrivileged()The default value for this implementation is
false.- Specified by:
getPrivilegedin interfaceContext- Returns:
- the privileged flag for this web application.
-
setPrivileged
public void setPrivileged(boolean privileged) Description copied from interface:ContextSet the privileged flag for this web application.- Specified by:
setPrivilegedin interfaceContext- Parameters:
privileged- The new privileged flag
-
setReloadable
public void setReloadable(boolean reloadable) Description copied from interface:ContextSet the reloadable flag for this web application.- Specified by:
setReloadablein interfaceContext- Parameters:
reloadable- The new reloadable flag
-
setOverride
public void setOverride(boolean override) Description copied from interface:ContextSet the override flag for this web application.- Specified by:
setOverridein interfaceContext- Parameters:
override- The new override flag
-
setReplaceWelcomeFiles
public void setReplaceWelcomeFiles(boolean replaceWelcomeFiles) Set the "replace welcome files" property.- Parameters:
replaceWelcomeFiles- The new property value
-
getServletContext
- Specified by:
getServletContextin interfaceContext- Returns:
- the Servlet context for which this Context is a facade.
-
getSessionTimeout
public int getSessionTimeout()The default value for this implementation is 30 minutes.
- Specified by:
getSessionTimeoutin interfaceContext- Returns:
- the default session timeout (in minutes) for this web application.
-
setSessionTimeout
public void setSessionTimeout(int timeout) Description copied from interface:ContextSet the default session timeout (in minutes) for this web application.- Specified by:
setSessionTimeoutin interfaceContext- Parameters:
timeout- The new default session timeout
-
getSwallowOutput
public boolean getSwallowOutput()The default value for this implementation is
false.- Specified by:
getSwallowOutputin interfaceContext- Returns:
- the value of the swallowOutput flag.
-
setSwallowOutput
public 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 interfaceContext- Parameters:
swallowOutput- The new value
-
getUnloadDelay
public long getUnloadDelay()- Returns:
- the value of the unloadDelay flag.
-
setUnloadDelay
public void setUnloadDelay(long unloadDelay) Set the value of the unloadDelay flag, which represents the amount of ms that the container will wait when unloading servlets. Setting this to a small value may cause more requests to fail to complete when stopping a web application.- Parameters:
unloadDelay- The new value
-
getUnpackWAR
public boolean getUnpackWAR()- Returns:
- unpack WAR flag.
-
setUnpackWAR
public void setUnpackWAR(boolean unpackWAR) Unpack WAR flag mutator.- Parameters:
unpackWAR-trueto unpack WARs on deployment
-
getCopyXML
public boolean getCopyXML()Flag which indicates if bundled context.xml files should be copied to the config folder. The doesn't occur by default.- Returns:
trueif theMETA-INF/context.xmlfile included in a WAR will be copied to the host configuration base folder on deployment
-
setCopyXML
public void setCopyXML(boolean copyXML) Allows copying a bundled context.xml file to the host configuration base folder on deployment.- Parameters:
copyXML- the new flag value
-
getWrapperClass
- Specified by:
getWrapperClassin interfaceContext- Returns:
- the Java class name of the Wrapper implementation used for servlets registered in this Context.
-
setWrapperClass
Description copied from interface:ContextSet the Java class name of the Wrapper implementation used for servlets registered in this Context.- Specified by:
setWrapperClassin interfaceContext- Parameters:
wrapperClassName- The new wrapper class
-
getResources
- Specified by:
getResourcesin interfaceContext- Returns:
- the Resources with which this Context is associated.
-
setResources
Description copied from interface:ContextSet the Resources object with which this Context is associated.- Specified by:
setResourcesin interfaceContext- Parameters:
resources- The newly associated Resources
-
getJspConfigDescriptor
- Specified by:
getJspConfigDescriptorin interfaceContext- Returns:
- the JSP configuration for this context. Will be null if there is no JSP configuration.
-
setJspConfigDescriptor
Description copied from interface:ContextSet the JspConfigDescriptor for this context. A null value indicates there is not JSP configuration.- Specified by:
setJspConfigDescriptorin interfaceContext- Parameters:
descriptor- the new JSP configuration
-
getThreadBindingListener
- Specified by:
getThreadBindingListenerin interfaceContext- Returns:
- the associated ThreadBindingListener.
-
setThreadBindingListener
Description copied from interface:ContextGet the associated ThreadBindingListener.- Specified by:
setThreadBindingListenerin interfaceContext- Parameters:
threadBindingListener- Set the listener that will receive notifications when entering and exiting the application scope
-
getJndiExceptionOnFailedWrite
public boolean getJndiExceptionOnFailedWrite()- Returns:
- whether or not an attempt to modify the JNDI context will trigger an exception or if the request will be ignored.
-
setJndiExceptionOnFailedWrite
public void setJndiExceptionOnFailedWrite(boolean jndiExceptionOnFailedWrite) Controls whether or not an attempt to modify the JNDI context will trigger an exception or if the request will be ignored.- Parameters:
jndiExceptionOnFailedWrite-falseto avoid an exception
-
getCharsetMapperClass
- Returns:
- the Locale to character set mapper class for this Context.
-
setCharsetMapperClass
Set the Locale to character set mapper class for this Context.- Parameters:
mapper- The new mapper class
-
getWorkPath
Get the absolute path to the work dir. To avoid duplication.- Returns:
- The work path
-
getWorkDir
- Returns:
- the work directory for this Context.
-
setWorkDir
Set the work directory for this Context.- Parameters:
workDir- The new work directory
-
getClearReferencesRmiTargets
public boolean getClearReferencesRmiTargets() -
setClearReferencesRmiTargets
public void setClearReferencesRmiTargets(boolean clearReferencesRmiTargets) -
getClearReferencesStopThreads
public boolean getClearReferencesStopThreads()- Returns:
- the clearReferencesStopThreads flag for this Context.
-
setClearReferencesStopThreads
public void setClearReferencesStopThreads(boolean clearReferencesStopThreads) Set the clearReferencesStopThreads feature for this Context.- Parameters:
clearReferencesStopThreads- The new flag value
-
getClearReferencesStopTimerThreads
public boolean getClearReferencesStopTimerThreads()- Returns:
- the clearReferencesStopTimerThreads flag for this Context.
-
setClearReferencesStopTimerThreads
public void setClearReferencesStopTimerThreads(boolean clearReferencesStopTimerThreads) Set the clearReferencesStopTimerThreads feature for this Context.- Parameters:
clearReferencesStopTimerThreads- The new flag value
-
getClearReferencesHttpClientKeepAliveThread
public boolean getClearReferencesHttpClientKeepAliveThread()- Returns:
- the clearReferencesHttpClientKeepAliveThread flag for this Context.
-
setClearReferencesHttpClientKeepAliveThread
public void setClearReferencesHttpClientKeepAliveThread(boolean clearReferencesHttpClientKeepAliveThread) Set the clearReferencesHttpClientKeepAliveThread feature for this Context.- Parameters:
clearReferencesHttpClientKeepAliveThread- The new flag value
-
getRenewThreadsWhenStoppingContext
public boolean getRenewThreadsWhenStoppingContext() -
setRenewThreadsWhenStoppingContext
public void setRenewThreadsWhenStoppingContext(boolean renewThreadsWhenStoppingContext) -
getClearReferencesThreadLocals
public boolean getClearReferencesThreadLocals() -
setClearReferencesThreadLocals
public void setClearReferencesThreadLocals(boolean clearReferencesThreadLocals) -
getSkipMemoryLeakChecksOnJvmShutdown
public boolean getSkipMemoryLeakChecksOnJvmShutdown() -
setSkipMemoryLeakChecksOnJvmShutdown
public void setSkipMemoryLeakChecksOnJvmShutdown(boolean skipMemoryLeakChecksOnJvmShutdown) -
getFailCtxIfServletStartFails
-
setFailCtxIfServletStartFails
-
getComputedFailCtxIfServletStartFails
protected boolean getComputedFailCtxIfServletStartFails() -
addApplicationListener
Description copied from interface:ContextAdd a new Listener class name to the set of Listeners configured for this application.- Specified by:
addApplicationListenerin interfaceContext- Parameters:
listener- Java class name of a listener class
-
addApplicationParameter
Description copied from interface:ContextAdd a new application parameter for this application.- Specified by:
addApplicationParameterin interfaceContext- Parameters:
parameter- The new application parameter
-
addChild
Description 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- Specified by:
addChildin interfaceContainer- Overrides:
addChildin classContainerBase- Parameters:
child- New child Container to be added
-
addConstraint
Description copied from interface:ContextAdd a security constraint to the set for this web application.- Specified by:
addConstraintin interfaceContext- Parameters:
constraint- The security constraint that should be added
-
addErrorPage
Description copied from interface:ContextAdd an error page for the specified error or Java exception.- Specified by:
addErrorPagein interfaceContext- Parameters:
errorPage- The error page definition to be added
-
addFilterDef
Description copied from interface:ContextAdd a filter definition to this Context.- Specified by:
addFilterDefin interfaceContext- Parameters:
filterDef- The filter definition to be added
-
addFilterMap
Description copied from interface:ContextAdd a filter mapping to this Context.- Specified by:
addFilterMapin interfaceContext- Parameters:
filterMap- The filter mapping to be added
-
addFilterMapBefore
Description 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 interfaceContext- Parameters:
filterMap- The filter mapping to be added
-
addLocaleEncodingMappingParameter
Description copied from interface:ContextAdd a Locale Encoding Mapping (see Sec 5.4 of Servlet spec 2.4)- Specified by:
addLocaleEncodingMappingParameterin interfaceContext- Parameters:
locale- locale to map an encoding forencoding- encoding to be used for a give locale
-
addMessageDestination
Add a message destination for this web application.- Parameters:
md- New message destination
-
addMimeMapping
Description copied from interface:ContextAdd a new MIME mapping, replacing any existing mapping for the specified extension.- Specified by:
addMimeMappingin interfaceContext- Parameters:
extension- Filename extension being mappedmimeType- Corresponding MIME type
-
addParameter
Description copied from interface:ContextAdd a new context initialization parameter, replacing any existing value for the specified name.- Specified by:
addParameterin interfaceContext- Parameters:
name- Name of the new parametervalue- Value of the new parameter
-
addRoleMapping
Description copied from interface:ContextAdd a security role reference for this web application.- Specified by:
addRoleMappingin interfaceContext- Parameters:
role- Security role used in the applicationlink- Actual security role to check for
-
addSecurityRole
Description copied from interface:ContextAdd a new security role for this web application.- Specified by:
addSecurityRolein interfaceContext- Parameters:
role- New security role
-
addServletMappingDecoded
Description copied from interface:ContextAdd a new servlet mapping, replacing any existing mapping for the specified pattern.- Specified by:
addServletMappingDecodedin interfaceContext- Parameters:
pattern- URL pattern to be mappedname- Name of the corresponding servlet to executejspWildCard- true if name identifies the JspServlet and pattern contains a wildcard; false otherwise
-
addWatchedResource
Description 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 interfaceContext- Parameters:
name- Path to the resource, relative to docBase
-
addWelcomeFile
Description copied from interface:ContextAdd a new welcome file to the set recognized by this Context.- Specified by:
addWelcomeFilein interfaceContext- Parameters:
name- New welcome file name
-
addWrapperLifecycle
Description copied from interface:ContextAdd the classname of a LifecycleListener to be added to each Wrapper appended to this Context.- Specified by:
addWrapperLifecyclein interfaceContext- Parameters:
listener- Java class name of a LifecycleListener class
-
addWrapperListener
Description copied from interface:ContextAdd the classname of a ContainerListener to be added to each Wrapper appended to this Context.- Specified by:
addWrapperListenerin interfaceContext- Parameters:
listener- Java class name of a ContainerListener class
-
createWrapper
Description 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 interfaceContext- Returns:
- a newly created wrapper instance that is used to wrap a Servlet
-
findApplicationListeners
- Specified by:
findApplicationListenersin interfaceContext- Returns:
- the set of application listener class names configured for this application.
-
findApplicationParameters
- Specified by:
findApplicationParametersin interfaceContext- Returns:
- the set of application parameters for this application.
-
findConstraints
- Specified by:
findConstraintsin interfaceContext- Returns:
- the set of security constraints for this web application. If there are none, a zero-length array is returned.
-
findErrorPage
- Specified by:
findErrorPagein interfaceContext- Parameters:
errorCode- Error code to look up- Returns:
- the error page entry for the specified HTTP error code, if any; otherwise return
null.
-
findErrorPage
Description copied from interface:ContextFind and return the ErrorPage instance for the specified exception's class, or an ErrorPage instance for the closest superclass for which there is such a definition. If no associated ErrorPage instance is found, returnnull.- Specified by:
findErrorPagein interfaceContext- Parameters:
exceptionType- The exception type for which to find an ErrorPage- Returns:
- the error page entry for the specified Java exception type, if any; otherwise return
null.
-
findErrorPages
- Specified by:
findErrorPagesin interfaceContext- Returns:
- the set of defined error pages for all specified error codes and exception types.
-
findFilterDef
- Specified by:
findFilterDefin interfaceContext- 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 interfaceContext- Returns:
- the set of defined filters for this Context.
-
findFilterMaps
- Specified by:
findFilterMapsin interfaceContext- Returns:
- the set of filter mappings for this Context.
-
findMessageDestination
- Parameters:
name- Name of the desired message destination- Returns:
- the message destination with the specified name, if any; otherwise, return
null.
-
findMessageDestinations
- Returns:
- the set of defined message destinations for this web application. If none have been defined, a zero-length array is returned.
-
findMimeMapping
- Specified by:
findMimeMappingin interfaceContext- 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 interfaceContext- Returns:
- the extensions for which MIME mappings are defined. If there are none, a zero-length array is returned.
-
findParameter
- Specified by:
findParameterin interfaceContext- 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 interfaceContext- Returns:
- the names of all defined context initialization parameters for this Context. If no parameters are defined, a zero-length array is returned.
-
findRoleMapping
Description 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 interfaceContext- Parameters:
role- Security role to map- Returns:
- The role name that was mapped to the specified role
-
findSecurityRole
- Specified by:
findSecurityRolein interfaceContext- Parameters:
role- Security role to verify- Returns:
trueif the specified security role is defined for this application; otherwise returnfalse.
-
findSecurityRoles
- Specified by:
findSecurityRolesin interfaceContext- Returns:
- the security roles defined for this application. If none have been defined, a zero-length array is returned.
-
findServletMapping
- Specified by:
findServletMappingin interfaceContext- 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 interfaceContext- Returns:
- the patterns of all defined servlet mappings for this Context. If no mappings are defined, a zero-length array is returned.
-
findWelcomeFile
- Specified by:
findWelcomeFilein interfaceContext- Parameters:
name- Welcome file to verify- Returns:
trueif the specified welcome file is defined for this Context; otherwise returnfalse.
-
findWatchedResources
- Specified by:
findWatchedResourcesin interfaceContext- Returns:
- the set of watched resources for this Context. If none are defined, a zero length array will be returned.
-
findWelcomeFiles
- Specified by:
findWelcomeFilesin interfaceContext- Returns:
- the set of welcome files defined for this Context. If none are defined, a zero-length array is returned.
-
findWrapperLifecycles
- Specified by:
findWrapperLifecyclesin interfaceContext- Returns:
- the set of LifecycleListener classes that will be added to newly created Wrappers automatically.
-
findWrapperListeners
- Specified by:
findWrapperListenersin interfaceContext- Returns:
- the set of ContainerListener classes that will be added to newly created Wrappers automatically.
-
reload
public void reload()Reload this web application, if reloading is supported.IMPLEMENTATION NOTE: This method is designed to deal with reloads required by changes to classes in the underlying repositories of our class loader and changes to the web.xml file. It does not handle changes to any context.xml file. If the context.xml has changed, you should stop this Context and create (and start) a new Context instance instead. Note that there is additional code in
CoyoteAdapter#postParseRequest()to handle mapping requests to paused Contexts. -
removeApplicationListener
Description copied from interface:ContextRemove the specified application listener class from the set of listeners for this application.- Specified by:
removeApplicationListenerin interfaceContext- Parameters:
listener- Java class name of the listener to be removed
-
removeApplicationParameter
Description copied from interface:ContextRemove the application parameter with the specified name from the set for this application.- Specified by:
removeApplicationParameterin interfaceContext- Parameters:
name- Name of the application parameter to remove
-
removeChild
Description copied from interface:ContainerRemove an existing child Container from association with this parent Container.- Specified by:
removeChildin interfaceContainer- Overrides:
removeChildin classContainerBase- Parameters:
child- Existing child Container to be removed
-
removeConstraint
Description copied from interface:ContextRemove the specified security constraint from this web application.- Specified by:
removeConstraintin interfaceContext- Parameters:
constraint- Constraint to be removed
-
removeErrorPage
Description 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 interfaceContext- Parameters:
errorPage- The error page definition to be removed
-
removeFilterDef
Description copied from interface:ContextRemove the specified filter definition from this Context, if it exists; otherwise, no action is taken.- Specified by:
removeFilterDefin interfaceContext- Parameters:
filterDef- Filter definition to be removed
-
removeFilterMap
Description copied from interface:ContextRemove a filter mapping from this Context.- Specified by:
removeFilterMapin interfaceContext- Parameters:
filterMap- The filter mapping to be removed
-
removeMessageDestination
Remove any message destination with the specified name.- Parameters:
name- Name of the message destination to remove
-
removeMimeMapping
Description copied from interface:ContextRemove the MIME mapping for the specified extension, if it exists; otherwise, no action is taken.- Specified by:
removeMimeMappingin interfaceContext- Parameters:
extension- Extension to remove the mapping for
-
removeParameter
Description copied from interface:ContextRemove the context initialization parameter with the specified name, if it exists; otherwise, no action is taken.- Specified by:
removeParameterin interfaceContext- Parameters:
name- Name of the parameter to remove
-
removeRoleMapping
Description copied from interface:ContextRemove any security role reference for the specified name- Specified by:
removeRoleMappingin interfaceContext- Parameters:
role- Security role (as used in the application) to remove
-
removeSecurityRole
Description copied from interface:ContextRemove any security role with the specified name.- Specified by:
removeSecurityRolein interfaceContext- Parameters:
role- Security role to remove
-
removeServletMapping
Description copied from interface:ContextRemove any servlet mapping for the specified pattern, if it exists; otherwise, no action is taken.- Specified by:
removeServletMappingin interfaceContext- Parameters:
pattern- URL pattern of the mapping to remove
-
removeWatchedResource
Description copied from interface:ContextRemove the specified watched resource name from the list associated with this Context.- Specified by:
removeWatchedResourcein interfaceContext- Parameters:
name- Name of the watched resource to be removed
-
removeWelcomeFile
Description copied from interface:ContextRemove the specified welcome file name from the list recognized by this Context.- Specified by:
removeWelcomeFilein interfaceContext- Parameters:
name- Name of the welcome file to be removed
-
removeWrapperLifecycle
Description copied from interface:ContextRemove a class name from the set of LifecycleListener classes that will be added to newly created Wrappers.- Specified by:
removeWrapperLifecyclein interfaceContext- Parameters:
listener- Class name of a LifecycleListener class to be removed
-
removeWrapperListener
Description copied from interface:ContextRemove a class name from the set of ContainerListener classes that will be added to newly created Wrappers.- Specified by:
removeWrapperListenerin interfaceContext- Parameters:
listener- Class name of a ContainerListener class to be removed
-
getProcessingTime
public long getProcessingTime()Gets the cumulative processing times of all servlets in this StandardContext.- Returns:
- Cumulative processing times of all servlets in this StandardContext
-
getMaxTime
public long getMaxTime()Gets the maximum processing time of all servlets in this StandardContext.- Returns:
- Maximum processing time of all servlets in this StandardContext
-
getMinTime
public long getMinTime()Gets the minimum processing time of all servlets in this StandardContext.- Returns:
- Minimum processing time of all servlets in this StandardContext
-
getRequestCount
public long getRequestCount()Gets the cumulative request count of all servlets in this StandardContext.- Returns:
- Cumulative request count of all servlets in this StandardContext
-
getErrorCount
public long getErrorCount()Gets the cumulative error count of all servlets in this StandardContext.- Returns:
- Cumulative error count of all servlets in this StandardContext
-
getRealPath
- Specified by:
getRealPathin interfaceContext- Parameters:
path- The path to the desired resource- Returns:
- the real path for a given virtual path, if possible; otherwise return
null.
-
dynamicServletCreated
Hook to track which Servlets were created viaServletContext.createServlet(Class).- Parameters:
servlet- the created Servlet
-
wasCreatedDynamicServlet
-
filterStart
public boolean filterStart()Configure and initialize the set of filters for this Context.- Returns:
trueif all filter initialization completed successfully, orfalseotherwise.
-
filterStop
public boolean filterStop()Finalize and release the set of filters for this Context.- Returns:
trueif all filter finalization completed successfully, orfalseotherwise.
-
findFilterConfig
Find and return the initializedFilterConfigfor the specified filter name, if any; otherwise returnnull.- Parameters:
name- Name of the desired filter- Returns:
- the filter config object
-
listenerStart
public boolean listenerStart()Configure the set of instantiated application event listeners for this Context.- Returns:
trueif all listeners wre initialized successfully, orfalseotherwise.
-
listenerStop
public boolean listenerStop()Send an application stop event to all interested listeners.- Returns:
trueif all events were sent successfully, orfalseotherwise.
-
resourcesStart
Allocate resources, including proxy.- Throws:
LifecycleException- if a start error occurs
-
resourcesStop
public boolean resourcesStop()Deallocate resources and destroy proxy.- Returns:
trueif no error occurred
-
loadOnStartup
Load and initialize all servlets marked "load on startup" in the web application deployment descriptor.- Parameters:
children- Array of wrappers for all currently defined servlets (including those not declared load on startup)- Returns:
trueif load on startup was considered successful
-
startInternal
Description copied from class:ContainerBaseStart this component and implement the requirements ofLifecycleBase.startInternal().- Overrides:
startInternalin classContainerBase- Throws:
LifecycleException- if this component detects a fatal error that prevents this component from being used
-
createInstanceManager
Description copied from interface:ContextFactory method to create and return a new InstanceManager instance. This can be used for framework integration or easier configuration with custom Context implementations.- Specified by:
createInstanceManagerin interfaceContext- Returns:
- the instance manager
-
stopInternal
Description copied from class:ContainerBaseStop this component and implement the requirements ofLifecycleBase.stopInternal().- Overrides:
stopInternalin classContainerBase- Throws:
LifecycleException- if this component detects a fatal error that prevents this component from being used
-
destroyInternal
Destroy needs to clean up the context completely. The problem is that undoing all the config in start() and restoring a 'fresh' state is impossible. After stop()/destroy()/init()/start() we should have the same state as if a fresh start was done - i.e read modified web.xml, etc. This can only be done by completely removing the context object and remapping a new one, or by cleaning up everything.- Overrides:
destroyInternalin classContainerBase- Throws:
LifecycleException- If the destruction fails
-
backgroundProcess
public 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 interfaceContainer- Overrides:
backgroundProcessin classContainerBase
-
adjustURLPattern
Adjust the URL pattern to begin with a leading slash, if appropriate (i.e. we are running a servlet 2.2 application). Otherwise, return the specified URL pattern unchanged.- Parameters:
urlPattern- The URL pattern to be adjusted (if needed) and returned- Returns:
- the URL pattern with a leading slash if needed
-
isServlet22
public boolean isServlet22()Description copied from interface:ContextIs this context using version 2.2 of the Servlet spec?- Specified by:
isServlet22in interfaceContext- Returns:
truefor a legacy Servlet 2.2 webapp
-
addServletSecurity
public 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 interfaceContext- Parameters:
registration- Servlet security was modified forservletSecurityElement- new security constraints for this Servlet- Returns:
- urls currently mapped to this registration that are already present in web.xml
-
bindThread
Bind current thread, both for CL purposes and for JNDI ENC support during : startup, shutdown and reloading of the context.- Returns:
- the previous context class loader
-
unbindThread
Unbind thread and restore the specified context classloader.- Parameters:
oldContextClassLoader- the previous classloader
-
bind
Description copied from interface:ContextBindChange the current thread context class loader to the web application class loader. If no web application class loader is defined, or if the current thread is already using the web application class loader then no change will be made. If the class loader is changed and aThreadBindingListeneris configured thenThreadBindingListener.bind()will be called after the change has been made.- Specified by:
bindin interfaceContextBind- Parameters:
usePrivilegedAction- UnusedoriginalClassLoader- 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.
-
bind
Description copied from interface:ContextBindChange the current thread context class loader to the web application class loader. If no web application class loader is defined, or if the current thread is already using the web application class loader then no change will be made. If the class loader is changed and aThreadBindingListeneris configured thenThreadBindingListener.bind()will be called after the change has been made.- Specified by:
bindin interfaceContextBind- Parameters:
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.
-
unbind
Description copied from interface:ContextBindRestore the current thread context class loader to the original class loader in used beforeContextBind.bind(boolean, ClassLoader)was called. If no original class loader is passed to this method then no change will be made. If the class loader is changed and aThreadBindingListeneris configured thenThreadBindingListener.unbind()will be called before the change is made.- Specified by:
unbindin interfaceContextBind- Parameters:
usePrivilegedAction- UnusedoriginalClassLoader- The class loader to restore as the thread context class loader
-
unbind
Description copied from interface:ContextBindRestore the current thread context class loader to the original class loader in used beforeContextBind.bind(boolean, ClassLoader)was called. If no original class loader is passed to this method then no change will be made. If the class loader is changed and aThreadBindingListeneris configured thenThreadBindingListener.unbind()will be called before the change is made.- Specified by:
unbindin interfaceContextBind- Parameters:
originalClassLoader- The class loader to restore as the thread context class loader
-
getNamingContextListener
Naming context listener accessor.- Returns:
- the naming context listener associated with the webapp
-
setNamingContextListener
Naming context listener setter.- Parameters:
namingContextListener- the new naming context listener
-
getPaused
-
fireRequestInitEvent
Description copied from interface:ContextNotify allServletRequestListeners that a request has started.- Specified by:
fireRequestInitEventin interfaceContext- Parameters:
request- The request object that will be passed to the listener- Returns:
trueif the listeners fire successfully, elsefalse
-
fireRequestDestroyEvent
Description copied from interface:ContextNotify allServletRequestListeners that a request has ended.- Specified by:
fireRequestDestroyEventin interfaceContext- Parameters:
request- The request object that will be passed to the listener- Returns:
trueif the listeners fire successfully, elsefalse
-
addPostConstructMethod
Description copied from interface:ContextAdd a post construct method definition for the given class, if there is an existing definition for the specified class - IllegalArgumentException will be thrown.- Specified by:
addPostConstructMethodin interfaceContext- Parameters:
clazz- Fully qualified class namemethod- Post construct method name
-
removePostConstructMethod
Description copied from interface:ContextRemoves the post construct method definition for the given class, if it exists; otherwise, no action is taken.- Specified by:
removePostConstructMethodin interfaceContext- Parameters:
clazz- Fully qualified class name
-
addPreDestroyMethod
Description copied from interface:ContextAdd a pre destroy method definition for the given class, if there is an existing definition for the specified class - IllegalArgumentException will be thrown.- Specified by:
addPreDestroyMethodin interfaceContext- Parameters:
clazz- Fully qualified class namemethod- Post construct method name
-
removePreDestroyMethod
Description copied from interface:ContextRemoves the pre destroy method definition for the given class, if it exists; otherwise, no action is taken.- Specified by:
removePreDestroyMethodin interfaceContext- Parameters:
clazz- Fully qualified class name
-
findPostConstructMethod
Description copied from interface:ContextReturns the method name that is specified as post construct method for the given class, if it exists; otherwiseNULLwill be returned.- Specified by:
findPostConstructMethodin interfaceContext- 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.
-
findPreDestroyMethod
Description copied from interface:ContextReturns the method name that is specified as pre destroy method for the given class, if it exists; otherwiseNULLwill be returned.- Specified by:
findPreDestroyMethodin interfaceContext- 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.
-
findPostConstructMethods
Description copied from interface:ContextReturns a map with keys - fully qualified class names of the classes that have post construct methods and the values are the corresponding method names. If there are no such classes an empty map will be returned.- Specified by:
findPostConstructMethodsin interfaceContext- 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.
-
findPreDestroyMethods
Description copied from interface:ContextReturns a map with keys - fully qualified class names of the classes that have pre destroy methods and the values are the corresponding method names. If there are no such classes an empty map will be returned.- Specified by:
findPreDestroyMethodsin interfaceContext- 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.
-
postWorkDirectory
protected void postWorkDirectory()Set the appropriate context attribute for our work directory. -
getObjectNameKeyProperties
Description copied from class:LifecycleMBeanBaseAllow sub-classes to specify the key properties component of theObjectNamethat will be used to register this component.- Specified by:
getObjectNameKeyPropertiesin classLifecycleMBeanBase- Returns:
- The string representation of the key properties component of the desired
ObjectName
-
initInternal
Description copied from class:LifecycleBaseSub-classes implement this method to perform any instance initialisation required.- Overrides:
initInternalin classLifecycleMBeanBase- Throws:
LifecycleException- If the initialisation fails
-
removeNotificationListener
public void removeNotificationListener(NotificationListener listener, NotificationFilter filter, Object object) throws ListenerNotFoundException - Specified by:
removeNotificationListenerin interfaceNotificationEmitter- Throws:
ListenerNotFoundException
-
getNotificationInfo
- Specified by:
getNotificationInfoin interfaceNotificationBroadcaster
-
addNotificationListener
public void addNotificationListener(NotificationListener listener, NotificationFilter filter, Object object) throws IllegalArgumentException - Specified by:
addNotificationListenerin interfaceNotificationBroadcaster- Throws:
IllegalArgumentException
-
removeNotificationListener
public void removeNotificationListener(NotificationListener listener) throws ListenerNotFoundException - Specified by:
removeNotificationListenerin interfaceNotificationBroadcaster- Throws:
ListenerNotFoundException
-
getWelcomeFiles
- Returns:
- the naming resources associated with this web application.
-
getXmlNamespaceAware
public 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 interfaceContext- Returns:
- true if namespace awareness is enabled.
-
setXmlNamespaceAware
public void setXmlNamespaceAware(boolean webXmlNamespaceAware) Description copied from interface:ContextControls whether the parsing of web.xml and web-fragment.xml files for this Context will be performed by a namespace aware parser.- Specified by:
setXmlNamespaceAwarein interfaceContext- Parameters:
webXmlNamespaceAware- true to enable namespace awareness
-
setXmlValidation
public void setXmlValidation(boolean webXmlValidation) Description copied from interface:ContextControls whether the parsing of web.xml and web-fragment.xml files for this Context will be performed by a validating parser.- Specified by:
setXmlValidationin interfaceContext- Parameters:
webXmlValidation- true to enable xml validation
-
getXmlValidation
public 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 interfaceContext- Returns:
- true if validation is enabled.
-
setXmlBlockExternal
public 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 interfaceContext- Parameters:
xmlBlockExternal- true to block external entities
-
getXmlBlockExternal
public 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 interfaceContext- Returns:
- true if access to external entities is blocked
-
setTldValidation
public 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 interfaceContext- Parameters:
tldValidation- true to enable xml validation
-
getTldValidation
public boolean getTldValidation()Description copied from interface:ContextWill the parsing of *.tld files for this Context be performed by a validating parser?- Specified by:
getTldValidationin interfaceContext- Returns:
- true if validation is enabled.
-
getServer
-
setServer
-
getStartTime
public long getStartTime()Gets the time this context was started.- Returns:
- Time (in milliseconds since January 1, 1970, 00:00:00) when this context was started
-