Class StandardContext
- java.lang.Object
-
- org.apache.catalina.util.LifecycleBase
-
- org.apache.catalina.util.LifecycleMBeanBase
-
- org.apache.catalina.core.ContainerBase
-
- org.apache.catalina.core.StandardContext
-
- All Implemented Interfaces:
MBeanRegistration,NotificationBroadcaster,NotificationEmitter,Container,Context,JmxEnabled,Lifecycle,ContextBind
- Direct Known Subclasses:
ReplicatedContext
public class StandardContext extends ContainerBase implements Context, NotificationEmitter
Standard implementation of the Context interface. Each child container must be a Wrapper implementation to process the requests directed to a particular servlet.- Author:
- Craig R. McClanahan, Remy Maucherat
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class org.apache.catalina.core.ContainerBase
ContainerBase.ContainerBackgroundProcessor, ContainerBase.ContainerBackgroundProcessorMonitor, ContainerBase.PrivilegedAddChild
-
Nested classes/interfaces inherited from interface org.apache.catalina.Lifecycle
Lifecycle.SingleUse
-
-
Field Summary
Fields Modifier and Type Field Description protected booleanallowCasualMultipartParsingAllow multipart/form-data requests to be parsed even when the target servlet doesn't specify @MultipartConfig or have a <multipart-config> element.protected ApplicationContextcontextThe ServletContext implementation associated with this Context.protected static ThreadBindingListenerDEFAULT_NAMING_LISTENERprotected ManagermanagerThe Manager implementation with which this Container is associated.protected ThreadBindingListenerthreadBindingListener-
Fields inherited from class org.apache.catalina.core.ContainerBase
accessLog, backgroundProcessorDelay, backgroundProcessorFuture, children, cluster, listeners, logger, logName, monitorFuture, name, parent, parentClassLoader, pipeline, sm, startChildren, startStopExecutor, support
-
Fields inherited from class org.apache.catalina.util.LifecycleMBeanBase
mserver
-
Fields inherited from interface org.apache.catalina.Container
ADD_CHILD_EVENT, ADD_VALVE_EVENT, REMOVE_CHILD_EVENT, REMOVE_VALVE_EVENT
-
Fields inherited from interface org.apache.catalina.Context
ADD_WELCOME_FILE_EVENT, CHANGE_SESSION_ID_EVENT, CLEAR_WELCOME_FILES_EVENT, REMOVE_WELCOME_FILE_EVENT
-
Fields 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
Constructors Constructor Description StandardContext()Create a new StandardContext component with the default basic Valve.
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description voidaddApplicationEventListener(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.voidaddChild(Container child)Add a child Container, only if the proposed child is an implementation of Wrapper.voidaddConstraint(SecurityConstraint constraint)Add a security constraint to the set for this web application.voidaddErrorPage(ErrorPage errorPage)Add an error page for the specified error or Java exception.voidaddFilterDef(FilterDef filterDef)Add a filter definition to this Context.voidaddFilterMap(FilterMap filterMap)Add a filter mapping to this Context at the end of the current set of filter mappings.voidaddFilterMapBefore(FilterMap filterMap)Add a filter mapping to this Context before the mappings defined in the deployment descriptor but after any other mappings added via this method.voidaddLocaleEncodingMappingParameter(String locale, String encoding)Add a Locale Encoding Mapping (see Sec 5.4 of Servlet spec 2.4)voidaddMessageDestination(MessageDestination md)Add a message destination for this web application.voidaddMessageDestinationRef(MessageDestinationRef mdr)Deprecated.This will be removed in Tomcat 10.voidaddMimeMapping(String extension, String mimeType)Add a new MIME mapping, replacing any existing mapping for the specified extension.voidaddNotificationListener(NotificationListener listener, NotificationFilter filter, Object object)Add a JMX NotificationListenervoidaddParameter(String name, String value)Add a new context initialization parameter.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.Set<String>addServletSecurity(ServletRegistration.Dynamic registration, ServletSecurityElement servletSecurityElement)Notification that Servlet security has been dynamically set in aServletRegistration.DynamicvoidaddWatchedResource(String name)Add a new watched resource to the set recognized by this Context.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).voidbackgroundProcess()Execute a periodic task, such as reloading, etc.ClassLoaderbind(boolean usePrivilegedAction, ClassLoader originalClassLoader)Change the current thread context class loader to the web application class loader.protected ClassLoaderbindThread()Bind current thread, both for CL purposes and for JNDI ENC support during : startup, shutdown and reloading of the context.InstanceManagercreateInstanceManager()Factory method to create and return a new InstanceManager instance.WrappercreateWrapper()Factory method to create and return a new Wrapper instance, of the Java implementation class appropriate for this Context implementation.voiddecrementInProgressAsyncCount()protected voiddestroyInternal()Destroy needs to clean up the context completely.voiddynamicServletCreated(Servlet servlet)Hook to track which Servlets were created viaServletContext.createServlet(Class).booleanfilterStart()Configure and initialize the set of filters for this Context.booleanfilterStop()Finalize and release the set of filters for this Context.String[]findApplicationListeners()Return the set of application listener class names configured for this application.ApplicationParameter[]findApplicationParameters()Return the set of application parameters for this application.SecurityConstraint[]findConstraints()Return the security constraints for this web application.ErrorPagefindErrorPage(int errorCode)Return the error page entry for the specified HTTP error code, if any; otherwise returnnull.ErrorPagefindErrorPage(String exceptionType)Deprecated.ErrorPagefindErrorPage(Throwable exceptionType)Find and return the ErrorPage instance for the specified exception's class, or an ErrorPage instance for the closest superclass for which there is such a definition.ErrorPage[]findErrorPages()Return the set of defined error pages for all specified error codes and exception types.FilterConfigfindFilterConfig(String name)Find and return the initializedFilterConfigfor the specified filter name, if any; otherwise returnnull.FilterDeffindFilterDef(String filterName)Return the filter definition for the specified filter name, if any; otherwise returnnull.FilterDef[]findFilterDefs()FilterMap[]findFilterMaps()MessageDestinationfindMessageDestination(String name)MessageDestinationReffindMessageDestinationRef(String name)Deprecated.This will be removed in Tomcat 10.MessageDestinationRef[]findMessageDestinationRefs()Deprecated.This will be removed in Tomcat 10.MessageDestination[]findMessageDestinations()StringfindMimeMapping(String extension)String[]findMimeMappings()StringfindParameter(String name)String[]findParameters()StringfindPostConstructMethod(String clazz)Returns the method name that is specified as post construct method for the given class, if it exists; otherwiseNULLwill be returned.Map<String,String>findPostConstructMethods()Returns a map with keys - fully qualified class names of the classes that have post construct methods and the values are the corresponding method names.StringfindPreDestroyMethod(String clazz)Returns the method name that is specified as pre destroy method for the given class, if it exists; otherwiseNULLwill be returned.Map<String,String>findPreDestroyMethods()Returns a map with keys - fully qualified class names of the classes that have pre destroy methods and the values are the corresponding method names.StringfindRoleMapping(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[]findSecurityRoles()StringfindServletMapping(String pattern)String[]findServletMappings()StringfindStatusPage(int status)Deprecated.int[]findStatusPages()Deprecated.String[]findWatchedResources()booleanfindWelcomeFile(String name)String[]findWelcomeFiles()String[]findWrapperLifecycles()String[]findWrapperListeners()booleanfireRequestDestroyEvent(ServletRequest request)Notify allServletRequestListeners that a request has ended.booleanfireRequestInitEvent(ServletRequest request)Notify allServletRequestListeners that a request has started.booleangetAddWebinfClassesResources()booleangetAllowCasualMultipartParsing()Returnstrueif requests mapped to servlets without "multipart config" to parse multipart/form-data requests anyway.booleangetAllowMultipleLeadingForwardSlashInPath()When returning a context path fromHttpServletRequest.getContextPath(), is it allowed to contain multiple leading '/' characters?StringgetAltDDName()Return the alternate Deployment Descriptor name.booleangetAntiResourceLocking()Object[]getApplicationEventListeners()Obtain the registered application event listeners.Object[]getApplicationLifecycleListeners()Obtain the registered application lifecycle listeners.AuthenticatorgetAuthenticator()StringgetBaseName()StringgetCharset(Locale locale)Obtain the character set name to use with the given Locale.CharsetMappergetCharsetMapper()StringgetCharsetMapperClass()booleangetClearReferencesHttpClientKeepAliveThread()booleangetClearReferencesObjectStreamClassCaches()booleangetClearReferencesRmiTargets()booleangetClearReferencesStopThreads()booleangetClearReferencesStopTimerThreads()booleangetClearReferencesThreadLocals()protected booleangetComputedFailCtxIfServletStartFails()URLgetConfigFile()Return the URL of the XML descriptor for this context.booleangetConfigured()Return the "correctly configured" flag for this Context.StringgetContainerSciFilter()Obtains the regular expression that specifies which container provided SCIs should be filtered out and not used for this context.CookieProcessorgetCookieProcessor()booleangetCookies()Return the "use cookies for session ids" flag.booleangetCopyXML()Flag which indicates if bundled context.xml files should be copied to the config folder.booleangetCreateUploadTargets()Will Tomcat attempt to create an upload target used by this web application if it does not exist when the web application attempts to use it?booleangetCrossContext()Return the "allow crossing servlet contexts" flag.StringgetDefaultContextXml()StringgetDefaultWebXml()booleangetDelegate()Return the "follow standard delegation model" flag used to configure our ClassLoader.booleangetDenyUncoveredHttpMethods()Return the deny-uncovered-http-methods flag for this web application.booleangetDispatchersUseEncodedPaths()Are paths used in calls to obtain a request dispatcher expected to be encoded?StringgetDisplayName()Return the display name of this web application.booleangetDistributable()Get the distributable flag for this web application.StringgetDocBase()Obtain the document root for this Context.intgetEffectiveMajorVersion()intgetEffectiveMinorVersion()StringgetEncodedPath()Return the URL encoded context pathintgetErrorCount()Gets the cumulative error count of all servlets in this StandardContext.BooleangetFailCtxIfServletStartFails()booleangetFireRequestListenersOnForwards()booleangetIgnoreAnnotations()Determine if annotations parsing is currently disabledlonggetInProgressAsyncCount()InstanceManagergetInstanceManager()StringgetJ2EEApplication()StringgetJ2EEServer()JarScannergetJarScanner()Get the Jar Scanner to be used to scan for JAR resources for this context.String[]getJavaVMs()booleangetJndiExceptionOnFailedWrite()JspConfigDescriptorgetJspConfigDescriptor()LoadergetLoader()booleangetLogEffectiveWebXml()Should the effective web.xml for this context be logged on context start?LoginConfiggetLoginConfig()ManagergetManager()booleangetMapperContextRootRedirectEnabled()Determines if requests for a web application context root will be redirected (adding a trailing slash) by the Mapper.booleangetMapperDirectoryRedirectEnabled()Determines if requests for a directory will be redirected (adding a trailing slash) by the Mapper.longgetMaxTime()Gets the maximum processing time of all servlets in this StandardContext.longgetMinTime()Gets the minimum processing time of all servlets in this StandardContext.NamingContextListenergetNamingContextListener()Naming context listener accessor.NamingResourcesImplgetNamingResources()ObjectgetNamingToken()MBeanNotificationInfo[]getNotificationInfo()Get JMX Broadcaster Infoprotected StringgetObjectNameKeyProperties()Allow sub-classes to specify the key properties component of theObjectNamethat will be used to register this component.StringgetOriginalDocBase()booleangetOverride()booleangetParallelAnnotationScanning()ClassLoadergetParentClassLoader()Return the parent class loader (if any) for this web application.StringgetPath()booleangetPaused()Is this Context paused whilst it is reloaded?booleangetPreemptiveAuthentication()booleangetPrivileged()longgetProcessingTime()Gets the cumulative processing times of all servlets in this StandardContext.StringgetPublicId()StringgetRealPath(String path)Return the real path for a given virtual path, if possible; otherwise returnnull.booleangetReloadable()booleangetRenewThreadsWhenStoppingContext()StringgetRequestCharacterEncoding()Get the default request body encoding for this web application.intgetRequestCount()Gets the cumulative request count of all servlets in this StandardContext.StringgetResourceOnlyServlets()Obtains the list of Servlets that expect a resource to be present.WebResourceRootgetResources()StringgetResponseCharacterEncoding()Get the default response body encoding for this web application.booleangetSendRedirectBody()StringgetServer()ServletContextgetServletContext()StringgetSessionCookieDomain()Gets the domain to use for session cookies.StringgetSessionCookieName()Gets the name to use for session cookies.StringgetSessionCookiePath()Gets the path to use for session cookies.booleangetSessionCookiePathUsesTrailingSlash()Is a / added to the end of the session cookie path to ensure browsers, particularly IE, don't send a session cookie for context /foo with requests intended for context /foobar.intgetSessionTimeout()booleangetSkipMemoryLeakChecksOnJvmShutdown()longgetStartTime()Gets the time this context was started.longgetStartupTime()Gets the time (in milliseconds) it took to start this context.booleangetSwallowAbortedUploads()Returnstrueif remaining request data will be read (swallowed) even the request violates a data size constraint.booleangetSwallowOutput()ThreadBindingListenergetThreadBindingListener()longgetTldScanTime()booleangetTldValidation()Will the parsing of *.tld files for this Context be performed by a validating parser?longgetUnloadDelay()booleangetUnpackWAR()booleangetUseBloomFilterForArchives()booleangetUseHttpOnly()Gets the value of the use HttpOnly cookies for session cookies flag.booleangetUseRelativeRedirects()Will HTTP 1.1 and later location headers generated by a call toHttpServletResponse.sendRedirect(String)use relative or absolute redirects.booleangetValidateClientProvidedNewSessionId()Will client provided session IDs be validated (seeContext.setValidateClientProvidedNewSessionId(boolean)) before use?StringgetWebappVersion()String[]getWelcomeFiles()StringgetWorkDir()StringgetWorkPath()Get the absolute path to the work dir.StringgetWrapperClass()booleangetXmlBlockExternal()Will the parsing of web.xml, web-fragment.xml, *.tld, *.jspx, *.tagx and tagplugin.xml files for this Context block the use of external entities?booleangetXmlNamespaceAware()Will the parsing of web.xml and web-fragment.xml files for this Context be performed by a namespace aware parser?booleangetXmlValidation()Will the parsing of web.xml and web-fragment.xml files for this Context be performed by a validating parser?voidincrementInProgressAsyncCount()protected voidinitInternal()Sub-classes wishing to perform additional initialization should override this method, ensuring that super.initInternal() is the first call in the overriding method.booleanisResourceOnlyServlet(String servletName)Checks the named Servlet to see if it expects a resource to be present.booleanisServlet22()Are we processing a version 2.2 deployment descriptor?booleanisUseNaming()booleanlistenerStart()Configure the set of instantiated application event listeners for this Context.booleanlistenerStop()Send an application stop event to all interested listeners.booleanloadOnStartup(Container[] children)Load and initialize all servlets marked "load on startup" in the web application deployment descriptor.protected voidpostWorkDirectory()Set the appropriate context attribute for our work directory.voidreload()Reload this web application, if reloading is supported.voidremoveApplicationListener(String listener)Remove the specified application listener class from the set of listeners for this application.voidremoveApplicationParameter(String name)Remove the application parameter with the specified name from the set for this application.voidremoveChild(Container child)Add a child Container, only if the proposed child is an implementation of Wrapper.voidremoveConstraint(SecurityConstraint constraint)Remove the specified security constraint from this web application.voidremoveErrorPage(ErrorPage errorPage)Remove the error page for the specified error code or Java language exception, if it exists; otherwise, no action is taken.voidremoveFilterDef(FilterDef filterDef)Remove the specified filter definition from this Context, if it exists; otherwise, no action is taken.voidremoveFilterMap(FilterMap filterMap)Remove a filter mapping from this Context.voidremoveMessageDestination(String name)Remove any message destination with the specified name.voidremoveMessageDestinationRef(String name)Deprecated.This will be removed in Tomcat 10.voidremoveMimeMapping(String extension)Remove the MIME mapping for the specified extension, if it exists; otherwise, no action is taken.voidremoveNotificationListener(NotificationListener listener)Remove a JMX-NotificationListenervoidremoveNotificationListener(NotificationListener listener, NotificationFilter filter, Object object)Remove a JMX notificationListenervoidremoveParameter(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.voidresourcesStart()Allocate resources, including proxy.booleanresourcesStop()Deallocate resources and destroy proxy.voidsetAddWebinfClassesResources(boolean addWebinfClassesResources)Sets the flag that indicates if /WEB-INF/classes should be treated like an exploded JAR and JAR resources made available as if they were in a JAR.voidsetAllowCasualMultipartParsing(boolean allowCasualMultipartParsing)Set totrueto allow requests mapped to servlets that do not explicitly declare @MultipartConfig or have <multipart-config> specified in web.xml to parse multipart/form-data requests.voidsetAllowMultipleLeadingForwardSlashInPath(boolean allowMultipleLeadingForwardSlashInPath)Configure if, when returning a context path fromHttpServletRequest.getContextPath(), the return value is allowed to contain multiple leading '/' characters.voidsetAltDDName(String altDDName)Set an alternate Deployment Descriptor name.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.voidsetClearReferencesObjectStreamClassCaches(boolean clearReferencesObjectStreamClassCaches)voidsetClearReferencesRmiTargets(boolean clearReferencesRmiTargets)voidsetClearReferencesStopThreads(boolean clearReferencesStopThreads)Set the clearReferencesStopThreads feature for this Context.voidsetClearReferencesStopTimerThreads(boolean clearReferencesStopTimerThreads)Set the clearReferencesStopTimerThreads feature for this Context.voidsetClearReferencesThreadLocals(boolean clearReferencesThreadLocals)voidsetConfigFile(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.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?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.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.String[]setJavaVMs(String[] javaVMs)voidsetJndiExceptionOnFailedWrite(boolean jndiExceptionOnFailedWrite)Controls whether or not an attempt to modify the JNDI context will trigger an exception or if the request will be ignored.voidsetJspConfigDescriptor(JspConfigDescriptor descriptor)Set the JspConfigDescriptor for this context.voidsetLoader(Loader loader)Set the Loader with which this Context is associated.voidsetLogEffectiveWebXml(boolean logEffectiveWebXml)Set whether or not the effective web.xml for this context should be logged on context start.voidsetLoginConfig(LoginConfig config)Set the login configuration descriptor for this web application.voidsetManager(Manager manager)Set the Manager with which this Context is associated.voidsetMapperContextRootRedirectEnabled(boolean mapperContextRootRedirectEnabled)If enabled, requests for a web application context root will be redirected (adding a trailing slash) by the Mapper.voidsetMapperDirectoryRedirectEnabled(boolean mapperDirectoryRedirectEnabled)If enabled, requests for a directory will be redirected (adding a trailing slash) by the Mapper.voidsetNamingContextListener(NamingContextListener namingContextListener)Naming context listener setter.voidsetNamingResources(NamingResourcesImpl namingResources)Set the naming resources for this web application.voidsetOriginalDocBase(String docBase)Set the original document root for this Context.voidsetOverride(boolean override)Set the default context override flag for this web application.voidsetParallelAnnotationScanning(boolean parallelAnnotationScanning)Set the parallel annotation scanning value.voidsetPath(String path)Set the context path for this Context.voidsetPreemptiveAuthentication(boolean preemptiveAuthentication)Configures if a user presents authentication credentials, whether the context will process them when the request is for a non-protected resource.voidsetPrivileged(boolean privileged)Set the privileged flag for this web application.voidsetPublicId(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.StringsetServer(String server)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)voidsetSwallowAbortedUploads(boolean swallowAbortedUploads)Set tofalseto disable request data swallowing after an upload was aborted due to size constraints.voidsetSwallowOutput(boolean swallowOutput)Set the value of the swallowOutput flag.voidsetThreadBindingListener(ThreadBindingListener threadBindingListener)Get the associated ThreadBindingListener.voidsetTldScanTime(long tldScanTime)voidsetTldValidation(boolean tldValidation)Controls whether the parsing of *.tld files for this Context will be performed by a validating parser.voidsetUnloadDelay(long unloadDelay)Set the value of the unloadDelay flag, which represents the amount of ms that the container will wait when unloading servlets.voidsetUnpackWAR(boolean unpackWAR)Unpack WAR flag mutator.voidsetUseBloomFilterForArchives(boolean useBloomFilterForArchives)Set bloom filter flag value.voidsetUseHttpOnly(boolean useHttpOnly)Sets the use HttpOnly cookies for session cookies flag.voidsetUseNaming(boolean useNaming)Enables or disables naming.voidsetUseRelativeRedirects(boolean useRelativeRedirects)Controls whether HTTP 1.1 and later location headers generated by a call toHttpServletResponse.sendRedirect(String)will use relative or absolute redirects.voidsetValidateClientProvidedNewSessionId(boolean validateClientProvidedNewSessionId)When a client provides the ID for a new session, should that ID be validated?voidsetWebappVersion(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 voidstartInternal()Start this component and implement the requirements ofLifecycleBase.startInternal().protected voidstopInternal()Stop 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.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, toString
-
Methods inherited from class org.apache.catalina.util.LifecycleMBeanBase
getDomain, getObjectName, postDeregister, postRegister, preDeregister, preRegister, register, setDomain, unregister, unregister
-
Methods inherited from class org.apache.catalina.util.LifecycleBase
addLifecycleListener, destroy, findLifecycleListeners, fireLifecycleEvent, getState, getStateName, getThrowOnFailure, init, removeLifecycleListener, setState, setState, setThrowOnFailure, start, stop
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
Methods 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, setStartStopThreads
-
Methods inherited from interface org.apache.catalina.Context
addServletMappingDecoded, isParallelAnnotationScanning
-
Methods inherited from interface org.apache.catalina.Lifecycle
addLifecycleListener, destroy, findLifecycleListeners, getState, getStateName, init, removeLifecycleListener, start, stop
-
-
-
-
Field Detail
-
allowCasualMultipartParsing
protected boolean allowCasualMultipartParsing
Allow multipart/form-data requests to be parsed even when the target servlet doesn't specify @MultipartConfig or have a <multipart-config> element.
-
context
protected ApplicationContext context
The ServletContext implementation associated with this Context.
-
manager
protected Manager manager
The Manager implementation with which this Container is associated.
-
DEFAULT_NAMING_LISTENER
protected static final ThreadBindingListener DEFAULT_NAMING_LISTENER
-
threadBindingListener
protected ThreadBindingListener threadBindingListener
-
-
Method Detail
-
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
-
getRequestCharacterEncoding
public String 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
public void setRequestCharacterEncoding(String requestEncoding)
Description copied from interface:ContextSet the default request body encoding for this web application.- Specified by:
setRequestCharacterEncodingin interfaceContext- Parameters:
requestEncoding- The default encoding
-
getResponseCharacterEncoding
public String 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
public void setResponseCharacterEncoding(String responseEncoding)
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 applys 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:
Context.setUseRelativeRedirects(boolean)
-
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
public void setCookieProcessor(CookieProcessor cookieProcessor)
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
public CookieProcessor getCookieProcessor()
- Specified by:
getCookieProcessorin interfaceContext- Returns:
- the
CookieProcessorthat will be used to process cookies for this Context.
-
getNamingToken
public Object getNamingToken()
- Specified by:
getNamingTokenin interfaceContext- Returns:
- the token necessary for operations on the associated JNDI naming context.
-
setContainerSciFilter
public void setContainerSciFilter(String containerSciFilter)
Description copied from interface:ContextSets the regular expression that specifies which container provided SCIs should be filtered out and not used for this context. Matching usesMatcher.find()so the regular expression only has to match a sub-string of the fully qualified class name of the container provided SCI for it to be filtered out.- Specified by:
setContainerSciFilterin interfaceContext- Parameters:
containerSciFilter- The regular expression against which the fully qualified class name of each container provided SCI should be checked
-
getContainerSciFilter
public String getContainerSciFilter()
Description copied from interface:ContextObtains the regular expression that specifies which container provided SCIs should be filtered out and not used for this context. Matching usesMatcher.find()so the regular expression only has to match a sub-string of the fully qualified class name of the container provided SCI for it to be filtered out.- Specified by:
getContainerSciFilterin 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
public void setWebappVersion(String webappVersion)
Description copied from interface:ContextSet the version of this web application - used to differentiate different versions of the same web application when using parallel deployment.- Specified by:
setWebappVersionin interfaceContext- Parameters:
webappVersion- The webapp version associated with the context, which should be unique
-
getWebappVersion
public String 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
public String getBaseName()
- Specified by:
getBaseNamein interfaceContext- Returns:
- the base name to use for WARs, directories or context.xml files for this context.
-
getResourceOnlyServlets
public String 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
public void setResourceOnlyServlets(String resourceOnlyServlets)
Description copied from interface:ContextSets the (comma separated) list of Servlets that expect a resource to be present. Used to ensure that welcome files associated with Servlets that expect a resource to be present are not mapped when there is no resource.- Specified by:
setResourceOnlyServletsin interfaceContext- Parameters:
resourceOnlyServlets- The Servlet names comma separated list
-
isResourceOnlyServlet
public boolean isResourceOnlyServlet(String servletName)
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
public Authenticator getAuthenticator()
- Specified by:
getAuthenticatorin interfaceContext- Returns:
- the
Authenticatorthat is used by this context. This is always non-nullfor a started Context
-
getJarScanner
public JarScanner 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
public void setJarScanner(JarScanner jarScanner)
Description copied from interface:ContextSet the Jar Scanner to be used to scan for JAR resources for this context.- Specified by:
setJarScannerin interfaceContext- Parameters:
jarScanner- The Jar Scanner to be used for this context.
-
getInstanceManager
public InstanceManager getInstanceManager()
- Specified by:
getInstanceManagerin interfaceContext- Returns:
- the instance manager associated with this context.
-
setInstanceManager
public void setInstanceManager(InstanceManager instanceManager)
Description copied from interface:ContextSet the instance manager associated with this context.- Specified by:
setInstanceManagerin interfaceContext- Parameters:
instanceManager- the new instance manager instance
-
getEncodedPath
public String 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)
Set totrueto allow requests mapped to servlets that do not explicitly declare @MultipartConfig or have <multipart-config> specified in web.xml to parse multipart/form-data requests.- Specified by:
setAllowCasualMultipartParsingin 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.- 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)
Set 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.- Specified by:
getSwallowAbortedUploadsin interfaceContext- Returns:
trueif data will be swallowed (default),falseotherwise.
-
addServletContainerInitializer
public void addServletContainerInitializer(ServletContainerInitializer sci, Set<Class<?>> classes)
Add 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
public Object[] 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
public void setApplicationEventListeners(Object[] listeners)
Store the set of initialized application event listener objects, in the order they were specified in the web application deployment descriptor, for this application. Note that this implementation is not thread safe. If two threads call this method concurrently, the result may be either set of listeners or a the union of both.- Specified by:
setApplicationEventListenersin interfaceContext- Parameters:
listeners- The set of instantiated listener objects.
-
addApplicationEventListener
public void addApplicationEventListener(Object listener)
Add a listener to the end of the list of initialized application event listeners.- Parameters:
listener- The listener to add
-
getApplicationLifecycleListeners
public Object[] 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
public void setApplicationLifecycleListeners(Object[] listeners)
Store the set of initialized application lifecycle listener objects, in the order they were specified in the web application deployment descriptor, for this application.- Specified by:
setApplicationLifecycleListenersin interfaceContext- Parameters:
listeners- The set of instantiated listener objects.
-
addApplicationLifecycleListener
public void addApplicationLifecycleListener(Object listener)
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
-
getUseBloomFilterForArchives
public boolean getUseBloomFilterForArchives()
- Specified by:
getUseBloomFilterForArchivesin interfaceContext- Returns:
trueif the resources archive lookup will use a bloom filter.
-
setUseBloomFilterForArchives
public void setUseBloomFilterForArchives(boolean useBloomFilterForArchives)
Description copied from interface:ContextSet bloom filter flag value.- Specified by:
setUseBloomFilterForArchivesin interfaceContext- Parameters:
useBloomFilterForArchives- The new fast class path scan flag
-
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
public CharsetMapper getCharsetMapper()
- Returns:
- the Locale to character set mapper for this Context.
-
setCharsetMapper
public void setCharsetMapper(CharsetMapper mapper)
Set the Locale to character set mapper for this Context.- Parameters:
mapper- The new mapper
-
getCharset
public String getCharset(Locale locale)
Description copied from interface:ContextObtain the character set name to use with the given Locale. Note that different Contexts may have different mappings of Locale to character set.- Specified by:
getCharsetin 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
public URL 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
public void setConfigFile(URL configFile)
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)
Set the "correctly configured" flag for this Context. This can be set to false by startup listeners that detect a fatal configuration error to avoid the application from being made available.- Specified by:
setConfiguredin 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)
Set the "use cookies for session ids" flag.- Specified by:
setCookiesin interfaceContext- Parameters:
cookies- The new flag
-
getSessionCookieName
public String getSessionCookieName()
Gets 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
public void setSessionCookieName(String sessionCookieName)
Sets 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.- Specified by:
getUseHttpOnlyin interfaceContext- Returns:
trueif the HttpOnly flag should be set on session cookies
-
setUseHttpOnly
public void setUseHttpOnly(boolean useHttpOnly)
Sets the use HttpOnly cookies for session cookies flag.- Specified by:
setUseHttpOnlyin interfaceContext- Parameters:
useHttpOnly- Set totrueto use HttpOnly cookies for session cookies
-
getSessionCookieDomain
public String getSessionCookieDomain()
Gets 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
public void setSessionCookieDomain(String sessionCookieDomain)
Sets 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
public String getSessionCookiePath()
Gets 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
public void setSessionCookiePath(String sessionCookiePath)
Sets 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()
Description copied from interface:ContextReturn the "allow crossing servlet contexts" flag.- Specified by:
getCrossContextin interfaceContext- Returns:
trueif cross-contest requests are allowed from this web applications, otherwisefalse
-
setCrossContext
public void setCrossContext(boolean crossContext)
Set the "allow crossing servlet contexts" flag.- Specified by:
setCrossContextin interfaceContext- Parameters:
crossContext- The new cross contexts flag
-
getDefaultContextXml
public String getDefaultContextXml()
-
setDefaultContextXml
public void setDefaultContextXml(String defaultContextXml)
Set the location of the default context xml that will be used. If not absolute, it'll be made relative to the engine's base dir ( which defaults to catalina.base system property ).- Parameters:
defaultContextXml- The default web xml
-
getDefaultWebXml
public String getDefaultWebXml()
-
setDefaultWebXml
public void setDefaultWebXml(String defaultWebXml)
Set the location of the default web xml that will be used. If not absolute, it'll be made relative to the engine's base dir ( which defaults to catalina.base system property ).- Parameters:
defaultWebXml- The default web xml
-
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
public String getDisplayName()
Description copied from interface:ContextReturn the display name of this web application.- Specified by:
getDisplayNamein interfaceContext- Returns:
- the display name of this web application.
-
getAltDDName
public String getAltDDName()
Description copied from interface:ContextReturn the alternate Deployment Descriptor name.- Specified by:
getAltDDNamein interfaceContext- Returns:
- the alternate Deployment Descriptor name.
-
setAltDDName
public void setAltDDName(String altDDName)
Set an alternate Deployment Descriptor name.- Specified by:
setAltDDNamein interfaceContext- Parameters:
altDDName- The new name
-
setDisplayName
public void setDisplayName(String displayName)
Set the display name of this web application.- Specified by:
setDisplayNamein interfaceContext- Parameters:
displayName- The new display name
-
getDistributable
public boolean getDistributable()
Description copied from interface:ContextGet the distributable flag for this web application.- Specified by:
getDistributablein interfaceContext- Returns:
- the distributable flag for this web application.
-
setDistributable
public void setDistributable(boolean distributable)
Set the distributable flag for this web application.- Specified by:
setDistributablein interfaceContext- Parameters:
distributable- The new distributable flag
-
getDocBase
public String 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
public void setDocBase(String docBase)
Description copied from interface:ContextSet the document root for this Context. This can be either an absolute pathname or a relative pathname. Relative pathnames are relative to the containing Host's appBase.- Specified by:
setDocBasein interfaceContext- Parameters:
docBase- The new document root
-
getJ2EEApplication
public String getJ2EEApplication()
-
setJ2EEApplication
public void setJ2EEApplication(String j2EEApplication)
-
getJ2EEServer
public String getJ2EEServer()
-
setJ2EEServer
public void setJ2EEServer(String j2EEServer)
-
getLoader
public Loader getLoader()
-
setLoader
public void setLoader(Loader loader)
Description copied from interface:ContextSet the Loader with which this Context is associated.
-
getManager
public Manager getManager()
- Specified by:
getManagerin interfaceContext- Returns:
- the Manager with which this Context is associated. If there is
no associated Manager, return
null.
-
setManager
public void setManager(Manager manager)
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()
Description copied from interface:ContextDetermine if annotations parsing is currently disabled- Specified by:
getIgnoreAnnotationsin interfaceContext- Returns:
- the boolean on the annotations parsing.
-
setIgnoreAnnotations
public void setIgnoreAnnotations(boolean ignoreAnnotations)
Set the boolean on the annotations parsing for this web application.- Specified by:
setIgnoreAnnotationsin interfaceContext- Parameters:
ignoreAnnotations- The boolean on the annotations parsing
-
getLoginConfig
public LoginConfig getLoginConfig()
- Specified by:
getLoginConfigin interfaceContext- Returns:
- the login configuration descriptor for this web application.
-
setLoginConfig
public void setLoginConfig(LoginConfig config)
Set the login configuration descriptor for this web application.- Specified by:
setLoginConfigin interfaceContext- Parameters:
config- The new login configuration
-
getNamingResources
public NamingResourcesImpl getNamingResources()
- Specified by:
getNamingResourcesin interfaceContext- Returns:
- the naming resources associated with this web application.
-
setNamingResources
public void setNamingResources(NamingResourcesImpl namingResources)
Set the naming resources for this web application.- Specified by:
setNamingResourcesin interfaceContext- Parameters:
namingResources- The new naming resources
-
getPath
public String getPath()
-
setPath
public void setPath(String path)
Set the context path for this Context.
-
getPublicId
public String getPublicId()
- Specified by:
getPublicIdin interfaceContext- Returns:
- the public identifier of the deployment descriptor DTD that is currently being parsed.
-
setPublicId
public void setPublicId(String publicId)
Set 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()
- Specified by:
getReloadablein interfaceContext- Returns:
- the reloadable flag for this web application.
-
getOverride
public boolean getOverride()
- Specified by:
getOverridein interfaceContext- Returns:
- the default context override flag for this web application.
-
getOriginalDocBase
public String getOriginalDocBase()
- Returns:
- the original document root for this Context. This can be an absolute pathname, a relative pathname, or a URL. Is only set as deployment has change docRoot!
-
setOriginalDocBase
public void setOriginalDocBase(String docBase)
Set the original document root for this Context. This can be an absolute pathname, a relative pathname, or a URL.- Parameters:
docBase- The original document root
-
getParentClassLoader
public ClassLoader getParentClassLoader()
Description copied from class:ContainerBaseReturn the parent class loader (if any) for this web application. This call is meaningful only after a Loader has been configured.- Specified by:
getParentClassLoaderin interfaceContainer- Overrides:
getParentClassLoaderin classContainerBase- Returns:
- the parent class loader (if any) for this web application. This call is meaningful only after a Loader has been configured.
-
getPrivileged
public boolean getPrivileged()
- Specified by:
getPrivilegedin interfaceContext- Returns:
- the privileged flag for this web application.
-
setPrivileged
public void setPrivileged(boolean privileged)
Set the privileged flag for this web application.- Specified by:
setPrivilegedin interfaceContext- Parameters:
privileged- The new privileged flag
-
setReloadable
public void setReloadable(boolean reloadable)
Set the reloadable flag for this web application.- Specified by:
setReloadablein interfaceContext- Parameters:
reloadable- The new reloadable flag
-
setOverride
public void setOverride(boolean override)
Set the default context 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
public ServletContext getServletContext()
- Specified by:
getServletContextin interfaceContext- Returns:
- the servlet context for which this Context is a facade.
-
getSessionTimeout
public int getSessionTimeout()
- Specified by:
getSessionTimeoutin interfaceContext- Returns:
- the default session timeout (in minutes) for this web application.
-
setSessionTimeout
public void setSessionTimeout(int timeout)
Set 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()
- Specified by:
getSwallowOutputin interfaceContext- Returns:
- the value of the swallowOutput flag.
-
setSwallowOutput
public void setSwallowOutput(boolean swallowOutput)
Set the value of the swallowOutput flag. If set to true, the system.out and system.err will be redirected to the logger during a servlet execution.- Specified by:
setSwallowOutputin 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
public String getWrapperClass()
- Specified by:
getWrapperClassin interfaceContext- Returns:
- the Java class name of the Wrapper implementation used for servlets registered in this Context.
-
setWrapperClass
public void setWrapperClass(String wrapperClassName)
Set 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 name- Throws:
IllegalArgumentException- if the specified wrapper class cannot be found or is not a subclass of StandardWrapper
-
getResources
public WebResourceRoot getResources()
- Specified by:
getResourcesin interfaceContext- Returns:
- the Resources with which this Context is associated.
-
setResources
public void setResources(WebResourceRoot resources)
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
public JspConfigDescriptor getJspConfigDescriptor()
- Specified by:
getJspConfigDescriptorin interfaceContext- Returns:
- the JSP configuration for this context. Will be null if there is no JSP configuration.
-
setJspConfigDescriptor
public void setJspConfigDescriptor(JspConfigDescriptor descriptor)
Description copied from interface:ContextSet the JspConfigDescriptor for this context. A null value indicates there is not JSP configuration.- Specified by:
setJspConfigDescriptorin interfaceContext- Parameters:
descriptor- the new JSP configuration
-
getThreadBindingListener
public ThreadBindingListener getThreadBindingListener()
- Specified by:
getThreadBindingListenerin interfaceContext- Returns:
- the associated ThreadBindingListener.
-
setThreadBindingListener
public void setThreadBindingListener(ThreadBindingListener threadBindingListener)
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
public String getCharsetMapperClass()
- Returns:
- the Locale to character set mapper class for this Context.
-
setCharsetMapperClass
public void setCharsetMapperClass(String mapper)
Set the Locale to character set mapper class for this Context.- Parameters:
mapper- The new mapper class
-
getWorkPath
public String getWorkPath()
Get the absolute path to the work dir. To avoid duplication.- Returns:
- The work path
-
getWorkDir
public String getWorkDir()
- Returns:
- the work directory for this Context.
-
setWorkDir
public void setWorkDir(String workDir)
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)
-
getClearReferencesObjectStreamClassCaches
public boolean getClearReferencesObjectStreamClassCaches()
-
setClearReferencesObjectStreamClassCaches
public void setClearReferencesObjectStreamClassCaches(boolean clearReferencesObjectStreamClassCaches)
-
getClearReferencesThreadLocals
public boolean getClearReferencesThreadLocals()
-
setClearReferencesThreadLocals
public void setClearReferencesThreadLocals(boolean clearReferencesThreadLocals)
-
getSkipMemoryLeakChecksOnJvmShutdown
public boolean getSkipMemoryLeakChecksOnJvmShutdown()
-
setSkipMemoryLeakChecksOnJvmShutdown
public void setSkipMemoryLeakChecksOnJvmShutdown(boolean skipMemoryLeakChecksOnJvmShutdown)
-
getFailCtxIfServletStartFails
public Boolean getFailCtxIfServletStartFails()
-
setFailCtxIfServletStartFails
public void setFailCtxIfServletStartFails(Boolean failCtxIfServletStartFails)
-
getComputedFailCtxIfServletStartFails
protected boolean getComputedFailCtxIfServletStartFails()
-
addApplicationListener
public void addApplicationListener(String listener)
Add 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
public void addApplicationParameter(ApplicationParameter parameter)
Add a new application parameter for this application.- Specified by:
addApplicationParameterin interfaceContext- Parameters:
parameter- The new application parameter
-
addChild
public void addChild(Container child)
Add a child Container, only if the proposed child is an implementation of Wrapper.- Specified by:
addChildin interfaceContainer- Overrides:
addChildin classContainerBase- Parameters:
child- Child container to be added- Throws:
IllegalArgumentException- if the proposed container is not an implementation of Wrapper
-
addConstraint
public void addConstraint(SecurityConstraint constraint)
Add a security constraint to the set for this web application.- Specified by:
addConstraintin interfaceContext- Parameters:
constraint- the new security constraint
-
addErrorPage
public void addErrorPage(ErrorPage errorPage)
Add an error page for the specified error or Java exception.- Specified by:
addErrorPagein interfaceContext- Parameters:
errorPage- The error page definition to be added
-
addFilterDef
public void addFilterDef(FilterDef filterDef)
Add a filter definition to this Context.- Specified by:
addFilterDefin interfaceContext- Parameters:
filterDef- The filter definition to be added
-
addFilterMap
public void addFilterMap(FilterMap filterMap)
Add a filter mapping to this Context at the end of the current set of filter mappings.- Specified by:
addFilterMapin interfaceContext- Parameters:
filterMap- The filter mapping to be added- Throws:
IllegalArgumentException- if the specified filter name does not match an existing filter definition, or the filter mapping is malformed
-
addFilterMapBefore
public void addFilterMapBefore(FilterMap filterMap)
Add a filter mapping to this Context before the mappings defined in the deployment descriptor but after any other mappings added via this method.- Specified by:
addFilterMapBeforein interfaceContext- Parameters:
filterMap- The filter mapping to be added- Throws:
IllegalArgumentException- if the specified filter name does not match an existing filter definition, or the filter mapping is malformed
-
addLocaleEncodingMappingParameter
public void addLocaleEncodingMappingParameter(String locale, String encoding)
Add 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
public void addMessageDestination(MessageDestination md)
Add a message destination for this web application.- Parameters:
md- New message destination
-
addMessageDestinationRef
@Deprecated public void addMessageDestinationRef(MessageDestinationRef mdr)
Deprecated.This will be removed in Tomcat 10. UsegetNamingResources()insteadAdd a message destination reference for this web application.- Parameters:
mdr- New message destination reference
-
addMimeMapping
public void addMimeMapping(String extension, String mimeType)
Add 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
public void addParameter(String name, String value)
Add a new context initialization parameter.- Specified by:
addParameterin interfaceContext- Parameters:
name- Name of the new parametervalue- Value of the new parameter- Throws:
IllegalArgumentException- if the name or value is missing, or if this context initialization parameter has already been registered
-
addRoleMapping
public void addRoleMapping(String role, String link)
Add 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
public void addSecurityRole(String role)
Add a new security role for this web application.- Specified by:
addSecurityRolein interfaceContext- Parameters:
role- New security role
-
addServletMappingDecoded
public void addServletMappingDecoded(String pattern, String name, boolean jspWildCard)
Add 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- Throws:
IllegalArgumentException- if the specified servlet name is not known to this Context
-
addWatchedResource
public void addWatchedResource(String name)
Add a new watched resource to the set recognized by this Context.- Specified by:
addWatchedResourcein interfaceContext- Parameters:
name- New watched resource file name
-
addWelcomeFile
public void addWelcomeFile(String name)
Add a new welcome file to the set recognized by this Context.- Specified by:
addWelcomeFilein interfaceContext- Parameters:
name- New welcome file name
-
addWrapperLifecycle
public void addWrapperLifecycle(String listener)
Add 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
public void addWrapperListener(String listener)
Add 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
public Wrapper createWrapper()
Factory method to create and return a new Wrapper instance, of the Java implementation class appropriate for this Context implementation. The constructor of the instantiated Wrapper will have been called, but no properties will have been set.- Specified by:
createWrapperin interfaceContext- Returns:
- a newly created wrapper instance that is used to wrap a Servlet
-
findApplicationListeners
public String[] findApplicationListeners()
Return the set of application listener class names configured for this application.- Specified by:
findApplicationListenersin interfaceContext- Returns:
- the set of application listener class names configured for this application.
-
findApplicationParameters
public ApplicationParameter[] findApplicationParameters()
Return the set of application parameters for this application.- Specified by:
findApplicationParametersin interfaceContext- Returns:
- the set of application parameters for this application.
-
findConstraints
public SecurityConstraint[] findConstraints()
Return the security constraints for this web application. If there are none, a zero-length array is returned.- 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
public ErrorPage findErrorPage(int errorCode)
Return the error page entry for the specified HTTP error code, if any; otherwise returnnull.- 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
@Deprecated public ErrorPage findErrorPage(String exceptionType)
Deprecated.- Specified by:
findErrorPagein interfaceContext- Parameters:
exceptionType- Exception type to look up- Returns:
- the error page entry for the specified Java exception type,
if any; otherwise return
null.
-
findErrorPage
public ErrorPage findErrorPage(Throwable exceptionType)
Description copied from interface:ContextFind and return the ErrorPage instance for the specified exception's class, or an ErrorPage instance for the closest superclass for which there is such a definition. If no associated ErrorPage instance is found, returnnull.- Specified by:
findErrorPagein 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
public ErrorPage[] findErrorPages()
Return the set of defined error pages for all specified error codes and exception types.- Specified by:
findErrorPagesin interfaceContext- Returns:
- the set of defined error pages for all specified error codes and exception types.
-
findFilterDef
public FilterDef findFilterDef(String filterName)
Return the filter definition for the specified filter name, if any; otherwise returnnull.- 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
public FilterDef[] findFilterDefs()
- Specified by:
findFilterDefsin interfaceContext- Returns:
- the set of defined filters for this Context.
-
findFilterMaps
public FilterMap[] findFilterMaps()
- Specified by:
findFilterMapsin interfaceContext- Returns:
- the set of filter mappings for this Context.
-
findMessageDestination
public MessageDestination findMessageDestination(String name)
- Parameters:
name- Name of the desired message destination- Returns:
- the message destination with the specified name, if any;
otherwise, return
null.
-
findMessageDestinations
public MessageDestination[] findMessageDestinations()
- Returns:
- the set of defined message destinations for this web application. If none have been defined, a zero-length array is returned.
-
findMessageDestinationRef
@Deprecated public MessageDestinationRef findMessageDestinationRef(String name)
Deprecated.This will be removed in Tomcat 10. UsegetNamingResources()instead- Parameters:
name- Name of the desired message destination ref- Returns:
- the message destination ref with the specified name, if any;
otherwise, return
null.
-
findMessageDestinationRefs
@Deprecated public MessageDestinationRef[] findMessageDestinationRefs()
Deprecated.This will be removed in Tomcat 10. UsegetNamingResources()instead- Returns:
- the set of defined message destination refs for this web application. If none have been defined, a zero-length array is returned.
-
findMimeMapping
public String findMimeMapping(String extension)
- 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
public String[] 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
public String findParameter(String name)
- 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
public String[] 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
public String 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. Otherwise, return the specified role unchanged.- Specified by:
findRoleMappingin interfaceContext- Parameters:
role- Security role to map- Returns:
- the role name
-
findSecurityRole
public boolean findSecurityRole(String role)
- Specified by:
findSecurityRolein interfaceContext- Parameters:
role- Security role to verify- Returns:
trueif the specified security role is defined for this application; otherwise returnfalse.
-
findSecurityRoles
public String[] 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
public String findServletMapping(String pattern)
- 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
public String[] 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.
-
findStatusPage
@Deprecated public String findStatusPage(int status)
Deprecated.- Specified by:
findStatusPagein interfaceContext- Parameters:
status- HTTP status code to look up- Returns:
- the context-relative URI of the error page for the specified
HTTP status code, if any; otherwise return
null.
-
findStatusPages
@Deprecated public int[] findStatusPages()
Deprecated.- Specified by:
findStatusPagesin interfaceContext- Returns:
- the set of HTTP status codes for which error pages have been specified. If none are specified, a zero-length array is returned.
-
findWelcomeFile
public boolean findWelcomeFile(String name)
- Specified by:
findWelcomeFilein interfaceContext- Parameters:
name- Welcome file to verify- Returns:
trueif the specified welcome file is defined for this Context; otherwise returnfalse.
-
findWatchedResources
public String[] 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
public String[] 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
public String[] findWrapperLifecycles()
- Specified by:
findWrapperLifecyclesin interfaceContext- Returns:
- the set of LifecycleListener classes that will be added to newly created Wrappers automatically.
-
findWrapperListeners
public String[] 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.- Specified by:
reloadin interfaceContext- Throws:
IllegalStateException- if thereloadableproperty is set tofalse.
-
removeApplicationListener
public void removeApplicationListener(String listener)
Remove 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
public void removeApplicationParameter(String name)
Remove 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
public void removeChild(Container child)
Add a child Container, only if the proposed child is an implementation of Wrapper.- Specified by:
removeChildin interfaceContainer- Overrides:
removeChildin classContainerBase- Parameters:
child- Child container to be added- Throws:
IllegalArgumentException- if the proposed container is not an implementation of Wrapper
-
removeConstraint
public void removeConstraint(SecurityConstraint constraint)
Remove the specified security constraint from this web application.- Specified by:
removeConstraintin interfaceContext- Parameters:
constraint- Constraint to be removed
-
removeErrorPage
public void removeErrorPage(ErrorPage errorPage)
Remove the error page for the specified error code or Java language exception, if it exists; otherwise, no action is taken.- Specified by:
removeErrorPagein interfaceContext- Parameters:
errorPage- The error page definition to be removed
-
removeFilterDef
public void removeFilterDef(FilterDef filterDef)
Remove 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
public void removeFilterMap(FilterMap filterMap)
Remove a filter mapping from this Context.- Specified by:
removeFilterMapin interfaceContext- Parameters:
filterMap- The filter mapping to be removed
-
removeMessageDestination
public void removeMessageDestination(String name)
Remove any message destination with the specified name.- Parameters:
name- Name of the message destination to remove
-
removeMessageDestinationRef
@Deprecated public void removeMessageDestinationRef(String name)
Deprecated.This will be removed in Tomcat 10. UsegetNamingResources()insteadRemove any message destination ref with the specified name.- Parameters:
name- Name of the message destination ref to remove
-
removeMimeMapping
public void removeMimeMapping(String extension)
Remove 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
public void removeParameter(String name)
Remove 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
public void removeRoleMapping(String role)
Remove any security role reference for the specified name- Specified by:
removeRoleMappingin interfaceContext- Parameters:
role- Security role (as used in the application) to remove
-
removeSecurityRole
public void removeSecurityRole(String role)
Remove any security role with the specified name.- Specified by:
removeSecurityRolein interfaceContext- Parameters:
role- Security role to remove
-
removeServletMapping
public void removeServletMapping(String pattern)
Remove 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
public void removeWatchedResource(String name)
Remove 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
public void removeWelcomeFile(String name)
Remove 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
public void removeWrapperLifecycle(String listener)
Remove 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
public void removeWrapperListener(String listener)
Remove 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 int getRequestCount()
Gets the cumulative request count of all servlets in this StandardContext.- Returns:
- Cumulative request count of all servlets in this StandardContext
-
getErrorCount
public int getErrorCount()
Gets the cumulative error count of all servlets in this StandardContext.- Returns:
- Cumulative error count of all servlets in this StandardContext
-
getRealPath
public String getRealPath(String path)
Return the real path for a given virtual path, if possible; otherwise returnnull.- 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
public void dynamicServletCreated(Servlet servlet)
Hook to track which Servlets were created viaServletContext.createServlet(Class).- Parameters:
servlet- the created Servlet
-
wasCreatedDynamicServlet
public boolean wasCreatedDynamicServlet(Servlet servlet)
-
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
public FilterConfig findFilterConfig(String name)
Find and return the initializedFilterConfigfor the specified filter name, if any; otherwise returnnull.- Parameters:
name- Name of the desired filter- Returns:
- the filter config object
-
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
public void resourcesStart() throws LifecycleExceptionAllocate 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
public boolean loadOnStartup(Container[] children)
Load and initialize all servlets marked "load on startup" in the web application deployment descriptor.- Parameters:
children- Array of wrappers for all currently defined servlets (including those not declared load on startup)- Returns:
trueif load on startup was considered successful
-
startInternal
protected void startInternal() throws LifecycleExceptionStart 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
public InstanceManager createInstanceManager()
Description copied from interface:ContextFactory method to create and return a new InstanceManager instance. This can be used for framework integration or easier configuration with custom Context implementations.- Specified by:
createInstanceManagerin interfaceContext- Returns:
- the instance manager
-
stopInternal
protected void stopInternal() throws LifecycleExceptionStop 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
protected void destroyInternal() throws LifecycleExceptionDestroy needs to clean up the context completely. The problem is that undoing all the config in start() and restoring a 'fresh' state is impossible. After stop()/destroy()/init()/start() we should have the same state as if a fresh start was done - i.e read modified web.xml, etc. This can only be done by completely removing the context object and remapping a new one, or by cleaning up everything.- Overrides:
destroyInternalin classContainerBase- Throws:
LifecycleException- If the destruction fails
-
backgroundProcess
public void backgroundProcess()
Description copied from class:ContainerBaseExecute a periodic task, such as reloading, etc. This method will be invoked inside the classloading context of this container. Unexpected throwables will be caught and logged.- Specified by:
backgroundProcessin interfaceContainer- Overrides:
backgroundProcessin classContainerBase
-
adjustURLPattern
protected String adjustURLPattern(String urlPattern)
Adjust the URL pattern to begin with a leading slash, if appropriate (i.e. we are running a servlet 2.2 application). Otherwise, return the specified URL pattern unchanged.- Parameters:
urlPattern- The URL pattern to be adjusted (if needed) and returned- Returns:
- the URL pattern with a leading slash if needed
-
isServlet22
public boolean isServlet22()
Are we processing a version 2.2 deployment descriptor?- Specified by:
isServlet22in interfaceContext- Returns:
trueif running a legacy Servlet 2.2 application
-
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
protected ClassLoader bindThread()
Bind current thread, both for CL purposes and for JNDI ENC support during : startup, shutdown and reloading of the context.- Returns:
- the previous context class loader
-
unbindThread
protected void unbindThread(ClassLoader oldContextClassLoader)
Unbind thread and restore the specified context classloader.- Parameters:
oldContextClassLoader- the previous classloader
-
bind
public ClassLoader bind(boolean usePrivilegedAction, ClassLoader originalClassLoader)
Description copied from interface:ContextBindChange the current thread context class loader to the web application class loader. If no web application class loader is defined, or if the current thread is already using the web application class loader then no change will be made. If the class loader is changed and aThreadBindingListeneris configured thenThreadBindingListener.bind()will be called after the change has been made.- Specified by:
bindin interfaceContextBind- Parameters:
usePrivilegedAction- Should aPrivilegedActionbe used when obtaining the current thread context class loader and setting the new one?originalClassLoader- The current class loader if known to save this method having to look it up- Returns:
- If the class loader has been changed by the method it will return the thread context class loader in use when the method was called. If no change was made then this method returns null.
-
unbind
public void unbind(boolean usePrivilegedAction, ClassLoader originalClassLoader)Description copied from interface:ContextBindRestore the current thread context class loader to the original class loader in used beforeContextBind.bind(boolean, ClassLoader)was called. If no original class loader is passed to this method then no change will be made. If the class loader is changed and aThreadBindingListeneris configured thenThreadBindingListener.unbind()will be called before the change is made.- Specified by:
unbindin interfaceContextBind- Parameters:
usePrivilegedAction- Should aPrivilegedActionbe used when setting the current thread context class loader?originalClassLoader- The class loader to restore as the thread context class loader
-
getNamingContextListener
public NamingContextListener getNamingContextListener()
Naming context listener accessor.- Returns:
- the naming context listener associated with the webapp
-
setNamingContextListener
public void setNamingContextListener(NamingContextListener namingContextListener)
Naming context listener setter.- Parameters:
namingContextListener- the new naming context listener
-
getPaused
public boolean getPaused()
Description copied from interface:ContextIs this Context paused whilst it is reloaded?
-
fireRequestInitEvent
public boolean fireRequestInitEvent(ServletRequest request)
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
public boolean fireRequestDestroyEvent(ServletRequest request)
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
public void addPostConstructMethod(String clazz, String method)
Description copied from interface:ContextAdd a post construct method definition for the given class, if there is an existing definition for the specified class - IllegalArgumentException will be thrown.- Specified by:
addPostConstructMethodin interfaceContext- Parameters:
clazz- Fully qualified class namemethod- Post construct method name
-
removePostConstructMethod
public void removePostConstructMethod(String clazz)
Description copied from interface:ContextRemoves the post construct method definition for the given class, if it exists; otherwise, no action is taken.- Specified by:
removePostConstructMethodin interfaceContext- Parameters:
clazz- Fully qualified class name
-
addPreDestroyMethod
public void addPreDestroyMethod(String clazz, String method)
Description copied from interface:ContextAdd a pre destroy method definition for the given class, if there is an existing definition for the specified class - IllegalArgumentException will be thrown.- Specified by:
addPreDestroyMethodin interfaceContext- Parameters:
clazz- Fully qualified class namemethod- Post construct method name
-
removePreDestroyMethod
public void removePreDestroyMethod(String clazz)
Description copied from interface:ContextRemoves the pre destroy method definition for the given class, if it exists; otherwise, no action is taken.- Specified by:
removePreDestroyMethodin interfaceContext- Parameters:
clazz- Fully qualified class name
-
findPostConstructMethod
public String findPostConstructMethod(String clazz)
Description copied from interface:ContextReturns the method name that is specified as post construct method for the given class, if it exists; otherwiseNULLwill be returned.- Specified by:
findPostConstructMethodin 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
public String findPreDestroyMethod(String clazz)
Description copied from interface:ContextReturns the method name that is specified as pre destroy method for the given class, if it exists; otherwiseNULLwill be returned.- Specified by:
findPreDestroyMethodin 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
public Map<String,String> findPostConstructMethods()
Description copied from interface:ContextReturns a map with keys - fully qualified class names of the classes that have post construct methods and the values are the corresponding method names. If there are no such classes an empty map will be returned.- Specified by:
findPostConstructMethodsin 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
public Map<String,String> findPreDestroyMethods()
Description copied from interface:ContextReturns a map with keys - fully qualified class names of the classes that have pre destroy methods and the values are the corresponding method names. If there are no such classes an empty map will be returned.- Specified by:
findPreDestroyMethodsin 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
protected String getObjectNameKeyProperties()
Description copied from class:LifecycleMBeanBaseAllow sub-classes to specify the key properties component of theObjectNamethat will be used to register this component.- Specified by:
getObjectNameKeyPropertiesin classLifecycleMBeanBase- Returns:
- The string representation of the key properties component of the
desired
ObjectName
-
initInternal
protected void initInternal() throws LifecycleExceptionDescription copied from class:LifecycleMBeanBaseSub-classes wishing to perform additional initialization should override this method, ensuring that super.initInternal() is the first call in the overriding method.- Overrides:
initInternalin classContainerBase- Throws:
LifecycleException- If the initialisation fails
-
removeNotificationListener
public void removeNotificationListener(NotificationListener listener, NotificationFilter filter, Object object) throws ListenerNotFoundException
Remove a JMX notificationListener
-
getNotificationInfo
public MBeanNotificationInfo[] getNotificationInfo()
Get JMX Broadcaster Info- Specified by:
getNotificationInfoin interfaceNotificationBroadcaster- See Also:
NotificationBroadcaster.getNotificationInfo()
-
addNotificationListener
public void addNotificationListener(NotificationListener listener, NotificationFilter filter, Object object) throws IllegalArgumentException
Add a JMX NotificationListener
-
removeNotificationListener
public void removeNotificationListener(NotificationListener listener) throws ListenerNotFoundException
Remove a JMX-NotificationListener- Specified by:
removeNotificationListenerin interfaceNotificationBroadcaster- Throws:
ListenerNotFoundException- See Also:
NotificationBroadcaster.removeNotificationListener(javax.management.NotificationListener)
-
getWelcomeFiles
public String[] 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
public String getServer()
-
getJavaVMs
public String[] getJavaVMs()
-
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
-
-