public class StandardContext extends ContainerBase implements Context, NotificationEmitter
ContainerBase.ContainerBackgroundProcessor, ContainerBase.PrivilegedAddChildLifecycle.SingleUse| Modifier and Type | Field and Description |
|---|---|
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.
|
protected boolean |
allowLinking
Allow linking.
|
protected int |
cacheMaxSize
Cache max size in KB.
|
protected int |
cacheObjectMaxSize
Cache object max size in KB.
|
protected int |
cacheTTL
Cache TTL in ms.
|
protected ApplicationContext |
context
The ServletContext implementation associated with this Context.
|
protected static URLEncoder |
urlEncoder
Array containing the safe characters set.
|
accessLog, backgroundProcessorDelay, children, cluster, listeners, loader, logger, logName, manager, name, parent, parentClassLoader, pipeline, resources, sm, startChildren, startStopExecutor, supportmserverADD_WELCOME_FILE_EVENT, CHANGE_SESSION_ID_EVENT, CLEAR_WELCOME_FILES_EVENT, RELOAD_EVENT, REMOVE_WELCOME_FILE_EVENTADD_CHILD_EVENT, ADD_MAPPER_EVENT, ADD_VALVE_EVENT, REMOVE_CHILD_EVENT, REMOVE_MAPPER_EVENT, REMOVE_VALVE_EVENTAFTER_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 and Description |
|---|
StandardContext()
Create a new StandardContext component with the default basic Valve.
|
| Modifier and Type | Method and Description |
|---|---|
void |
addApplicationEventListener(Object listener)
Add a listener to the end of the list of initialized application event
listeners.
|
void |
addApplicationLifecycleListener(Object listener)
Add a listener to the end of the list of initialized application
lifecycle listeners.
|
void |
addApplicationListener(ApplicationListener listener)
Add a new Listener class name to the set of Listeners configured for this
application.
|
void |
addApplicationListener(String listener)
Add a new Listener class name to the set of Listeners
configured for this application.
|
void |
addApplicationParameter(ApplicationParameter parameter)
Add a new application parameter for this application.
|
void |
addChild(Container child)
Add a child Container, only if the proposed child is an implementation
of Wrapper.
|
void |
addConstraint(SecurityConstraint constraint)
Add a security constraint to the set for this web application.
|
void |
addErrorPage(ErrorPage errorPage)
Add an error page for the specified error or Java exception.
|
void |
addFilterDef(FilterDef filterDef)
Add a filter definition to this Context.
|
void |
addFilterMap(FilterMap filterMap)
Add a filter mapping to this Context at the end of the current set
of filter mappings.
|
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.
|
void |
addInstanceListener(String listener)
Add the classname of an InstanceListener to be added to each
Wrapper appended to this Context.
|
void |
addLocaleEncodingMappingParameter(String locale,
String encoding)
Add a Locale Encoding Mapping (see Sec 5.4 of Servlet spec 2.4)
|
void |
addMessageDestination(MessageDestination md)
Add a message destination for this web application.
|
void |
addMessageDestinationRef(MessageDestinationRef mdr)
Add a message destination reference for this web application.
|
void |
addMimeMapping(String extension,
String mimeType)
Add a new MIME mapping, replacing any existing mapping for
the specified extension.
|
void |
addNotificationListener(NotificationListener listener,
NotificationFilter filter,
Object object)
Add a JMX NotificationListener
|
void |
addParameter(String name,
String value)
Add a new context initialization parameter.
|
void |
addPostConstructMethod(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.
|
void |
addPreDestroyMethod(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.
|
void |
addResourceJarUrl(URL url)
Add a URL for a JAR that contains static resources in a
META-INF/resources directory that should be included in the static
resources for this context.
|
void |
addResourcesDirContext(DirContext altDirContext)
Add a DirContext for a JAR that contains static resources in a
META-INF/resources directory that should be included in the static
resources for this context.
|
void |
addRoleMapping(String role,
String link)
Add a security role reference for this web application.
|
void |
addSecurityRole(String role)
Add a new security role for this web application.
|
void |
addServletContainerInitializer(ServletContainerInitializer sci,
Set<Class<?>> classes)
Add a ServletContainerInitializer instance to this web application.
|
void |
addServletMapping(String pattern,
String name)
Add a new servlet mapping, replacing any existing mapping for
the specified pattern.
|
void |
addServletMapping(String pattern,
String name,
boolean jspWildCard)
Add a new servlet mapping, replacing any existing mapping for
the specified pattern.
|
Set<String> |
addServletSecurity(ApplicationServletRegistration registration,
ServletSecurityElement servletSecurityElement)
Notification that Servlet security has been dynamically set in a
ServletRegistration.Dynamic |
void |
addWatchedResource(String name)
Add a new watched resource to the set recognized by this Context.
|
void |
addWelcomeFile(String name)
Add a new welcome file to the set recognized by this Context.
|
void |
addWrapperLifecycle(String listener)
Add the classname of a LifecycleListener to be added to each
Wrapper appended to this Context.
|
void |
addWrapperListener(String listener)
Add the classname of a ContainerListener to be added to each
Wrapper appended to this Context.
|
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).
|
void |
backgroundProcess()
Execute a periodic task, such as reloading, etc.
|
protected ClassLoader |
bindThread()
Bind current thread, both for CL purposes and for JNDI ENC support
during : startup, shutdown and reloading of the context.
|
Wrapper |
createWrapper()
Factory method to create and return a new Wrapper instance, of
the Java implementation class appropriate for this Context
implementation.
|
void |
decrementInProgressAsyncCount() |
protected void |
destroyInternal()
Destroy needs to clean up the context completely.
|
ServletRegistration.Dynamic |
dynamicServletAdded(Wrapper wrapper)
Deprecated.
This will be removed in Tomcat 9. The registration should be
created directly.
|
void |
dynamicServletCreated(Servlet servlet)
Hook to track which Servlets were created via
ServletContext.createServlet(Class). |
protected File |
engineBase() |
boolean |
filterStart()
Configure and initialize the set of filters for this Context.
|
boolean |
filterStop()
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.
|
ErrorPage |
findErrorPage(int errorCode)
Return the error page entry for the specified HTTP error code,
if any; otherwise return
null. |
ErrorPage |
findErrorPage(String exceptionType)
Return the error page entry for the specified Java exception type,
if any; otherwise return
null. |
ErrorPage[] |
findErrorPages()
Return the set of defined error pages for all specified error codes
and exception types.
|
FilterConfig |
findFilterConfig(String name)
Find and return the initialized
FilterConfig for the
specified filter name, if any; otherwise return null. |
FilterDef |
findFilterDef(String filterName)
Return the filter definition for the specified filter name, if any;
otherwise return
null. |
FilterDef[] |
findFilterDefs()
Return the set of defined filters for this Context.
|
FilterMap[] |
findFilterMaps()
Return the set of filter mappings for this Context.
|
String[] |
findInstanceListeners()
Return the set of InstanceListener classes that will be added to
newly created Wrappers automatically.
|
Context |
findMappingObject()
Deprecated.
|
MessageDestination |
findMessageDestination(String name) |
MessageDestinationRef |
findMessageDestinationRef(String name) |
MessageDestinationRef[] |
findMessageDestinationRefs() |
MessageDestination[] |
findMessageDestinations() |
String |
findMimeMapping(String extension) |
String[] |
findMimeMappings() |
String |
findParameter(String name) |
String[] |
findParameters() |
String |
findPostConstructMethod(String clazz)
Returns the method name that is specified as post construct method for
the given class, if it exists; otherwise
NULL will 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.
|
String |
findPreDestroyMethod(String clazz)
Returns the method name that is specified as pre destroy method for the
given class, if it exists; otherwise
NULL will 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.
|
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.
|
boolean |
findSecurityRole(String role) |
String[] |
findSecurityRoles() |
String |
findServletMapping(String pattern) |
String[] |
findServletMappings() |
DirContext |
findStaticResources()
Deprecated.
|
String |
findStatusPage(int status)
Return the context-relative URI of the error page for the specified
HTTP status code, if any; otherwise return
null. |
int[] |
findStatusPages()
Return the set of HTTP status codes for which error pages have
been specified.
|
String[] |
findWatchedResources() |
boolean |
findWelcomeFile(String name) |
String[] |
findWelcomeFiles() |
String[] |
findWrapperLifecycles() |
String[] |
findWrapperListeners() |
boolean |
fireRequestDestroyEvent(ServletRequest request)
Notify all
ServletRequestListeners that a request
has ended. |
boolean |
fireRequestInitEvent(ServletRequest request)
Notify all
ServletRequestListeners that a request
has started. |
boolean |
getAddWebinfClassesResources() |
String |
getAliases() |
boolean |
getAllowCasualMultipartParsing()
Returns
true if requests mapped to servlets without
"multipart config" to parse multipart/form-data requests anyway. |
boolean |
getAllowMultipleLeadingForwardSlashInPath()
When returning a context path from
HttpServletRequest.getContextPath(), is it allowed to
contain multiple leading '/' characters? |
String |
getAltDDName()
Return the alternate Deployment Descriptor name.
|
boolean |
getAntiJARLocking() |
boolean |
getAntiResourceLocking() |
protected String |
getAppBase() |
Object[] |
getApplicationEventListeners()
Return the set of initialized application event listener objects,
in the order they were specified in the web application deployment
descriptor, for this application.
|
Object[] |
getApplicationLifecycleListeners()
Return the set of initialized application lifecycle listener objects,
in the order they were specified in the web application deployment
descriptor, for this application.
|
Authenticator |
getAuthenticator() |
boolean |
getAvailable() |
String |
getBaseName() |
protected String |
getBasePath() |
int |
getCacheMaxSize() |
int |
getCacheObjectMaxSize() |
int |
getCacheTTL() |
String |
getCharset(Locale locale)
Obtain the character set name to use with the given Locale.
|
CharsetMapper |
getCharsetMapper() |
String |
getCharsetMapperClass() |
boolean |
getClearReferencesHttpClientKeepAliveThread() |
boolean |
getClearReferencesObjectStreamClassCaches() |
boolean |
getClearReferencesRmiTargets() |
boolean |
getClearReferencesStatic()
Deprecated.
This option will be removed in Tomcat 8.5
|
boolean |
getClearReferencesStopThreads() |
boolean |
getClearReferencesStopTimerThreads() |
boolean |
getClearReferencesThreadLocals() |
String |
getCompilerClasspath()
Deprecated.
|
protected boolean |
getComputedFailCtxIfServletStartFails() |
URL |
getConfigFile()
Return the URL of the XML descriptor for this context.
|
boolean |
getConfigured()
Return the "correctly configured" flag for this Context.
|
String |
getContainerSciFilter()
Obtains the regular expression that specifies which container provided
SCIs should be filtered out and not used for this context.
|
boolean |
getCookies()
Return the "use cookies for session ids" flag.
|
boolean |
getCopyXML()
Flag which indicates if bundled context.xml files should be copied to the
config folder.
|
boolean |
getCreateUploadTargets()
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?
|
boolean |
getCrossContext()
Return the "allow crossing servlet contexts" flag.
|
String |
getDefaultContextXml() |
String |
getDefaultWebXml() |
boolean |
getDelegate()
Return the "follow standard delegation model" flag used to configure
our ClassLoader.
|
String |
getDeploymentDescriptor()
JSR77 deploymentDescriptor attribute
|
boolean |
getDispatchersUseEncodedPaths()
Are paths used in calls to obtain a request dispatcher expected to be
encoded?
|
String |
getDisplayName()
Return the display name of this web application.
|
boolean |
getDistributable()
Get the distributable flag for this web application.
|
String |
getDocBase()
Obtain the document root for this Context.
|
int |
getEffectiveMajorVersion() |
int |
getEffectiveMinorVersion() |
String |
getEncodedPath()
Return the URL encoded context path
|
int |
getErrorCount()
Gets the cumulative error count of all servlets in this
StandardContext.
|
Boolean |
getFailCtxIfServletStartFails() |
boolean |
getFireRequestListenersOnForwards() |
String |
getHostname()
Deprecated.
Unused. Will be removed in Tomcat 8.0.x.
|
boolean |
getIgnoreAnnotations()
Determine if annotations parsing is currently disabled
|
String |
getInfo()
Return descriptive information about this Container implementation and
the corresponding version number, in the format
<description>/<version>. |
long |
getInProgressAsyncCount() |
InstanceManager |
getInstanceManager() |
String |
getJ2EEApplication() |
String |
getJ2EEServer() |
JarScanner |
getJarScanner()
Get the Jar Scanner to be used to scan for JAR resources for this
context.
|
String[] |
getJavaVMs() |
boolean |
getJndiExceptionOnFailedWrite() |
JspConfigDescriptor |
getJspConfigDescriptor() |
boolean |
getLogEffectiveWebXml()
Should the effective web.xml for this context be logged on context start?
|
LoginConfig |
getLoginConfig() |
Mapper |
getMapper() |
boolean |
getMapperContextRootRedirectEnabled()
Determines if requests for a web application context root will be
redirected (adding a trailing slash) by the Mapper.
|
boolean |
getMapperDirectoryRedirectEnabled()
Determines if requests for a directory will be redirected (adding a
trailing slash) by the Mapper.
|
long |
getMaxTime()
Gets the maximum processing time of all servlets in this
StandardContext.
|
long |
getMinTime()
Gets the minimum processing time of all servlets in this
StandardContext.
|
NamingContextListener |
getNamingContextListener()
Naming context listener accessor.
|
NamingResources |
getNamingResources() |
MBeanNotificationInfo[] |
getNotificationInfo() |
protected String |
getObjectNameKeyProperties()
Allow sub-classes to specify the key properties component of the
ObjectName that will be used to register this component. |
String |
getOriginalDocBase() |
boolean |
getOverride() |
ClassLoader |
getParentClassLoader()
Return the parent class loader (if any) for this web application.
|
String |
getPath() |
boolean |
getPaused()
Is this Context paused whilst it is reloaded?
|
boolean |
getPreemptiveAuthentication() |
boolean |
getPrivileged() |
long |
getProcessingTime()
Gets the cumulative processing times of all servlets in this
StandardContext.
|
boolean |
getProcessTlds() |
String |
getPublicId() |
String |
getRealPath(String path)
Return the real path for a given virtual path, if possible; otherwise
return
null. |
boolean |
getReloadable() |
boolean |
getRenewThreadsWhenStoppingContext() |
int |
getRequestCount()
Gets the cumulative request count of all servlets in this
StandardContext.
|
String |
getResourceOnlyServlets()
Obtains the list of Servlets that expect a resource to be present.
|
boolean |
getSendRedirectBody() |
String |
getServer() |
ServletContext |
getServletContext() |
String[] |
getServlets()
JSR77 servlets attribute
|
String |
getSessionCookieDomain()
Gets the domain to use for session cookies.
|
String |
getSessionCookieName()
Gets the name to use for session cookies.
|
String |
getSessionCookiePath()
Gets the path to use for session cookies.
|
boolean |
getSessionCookiePathUsesTrailingSlash()
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.
|
int |
getSessionTimeout() |
long |
getStartTime()
Gets the time this context was started.
|
long |
getStartupTime()
Gets the time (in milliseconds) it took to start this context.
|
DirContext |
getStaticResources()
Deprecated.
|
boolean |
getSwallowAbortedUploads()
Returns
true if remaining request data will be read
(swallowed) even the request violates a data size constraint. |
boolean |
getSwallowOutput() |
boolean |
getTldNamespaceAware()
*.tld files are always parsed using a namespace aware parser.
|
long |
getTldScanTime() |
boolean |
getTldValidation()
Will the parsing of *.tld files for this Context be performed by a
validating parser?
|
long |
getUnloadDelay() |
boolean |
getUnpackWAR() |
boolean |
getUseHttpOnly()
Gets the value of the use HttpOnly cookies for session cookies flag.
|
boolean |
getUseRelativeRedirects()
Will HTTP 1.1 and later location headers generated by a call to
HttpServletResponse.sendRedirect(String) use
relative or absolute redirects. |
boolean |
getValidateClientProvidedNewSessionId()
Will client provided session IDs be validated (see
Context.setValidateClientProvidedNewSessionId(boolean)) before use? |
String |
getWebappVersion() |
String[] |
getWelcomeFiles() |
String |
getWorkDir() |
String |
getWorkPath()
Get the absolute path to the work dir.
|
String |
getWrapperClass() |
boolean |
getXmlBlockExternal()
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?
|
boolean |
getXmlNamespaceAware()
Will the parsing of web.xml and web-fragment.xml files for this Context
be performed by a namespace aware parser?
|
boolean |
getXmlValidation()
Will the parsing of web.xml and web-fragment.xml files for this Context
be performed by a validating parser?
|
void |
incrementInProgressAsyncCount() |
protected void |
initInternal()
Sub-classes wishing to perform additional initialization should override
this method, ensuring that super.initInternal() is the first call in the
overriding method.
|
boolean |
isAllowLinking() |
boolean |
isCachingAllowed() |
boolean |
isEventProvider()
Deprecated.
|
boolean |
isFilesystemBased()
Deprecated.
|
boolean |
isReplaceWelcomeFiles()
Deprecated.
|
boolean |
isResourceOnlyServlet(String servletName)
Checks the named Servlet to see if it expects a resource to be present.
|
boolean |
isSaveConfig()
Deprecated.
|
boolean |
isServlet22()
Are we processing a version 2.2 deployment descriptor?
|
boolean |
isStateManageable() |
boolean |
isStatisticsProvider()
Deprecated.
|
boolean |
isUseNaming() |
boolean |
listenerStart()
Configure the set of instantiated application event listeners
for this Context.
|
boolean |
listenerStop()
Send an application stop event to all interested listeners.
|
boolean |
loadOnStartup(Container[] children)
Load and initialize all servlets marked "load on startup" in the
web application deployment descriptor.
|
void |
reload()
Reload this web application, if reloading is supported.
|
void |
removeApplicationListener(String listener)
Remove the specified application listener class from the set of
listeners for this application.
|
void |
removeApplicationParameter(String name)
Remove the application parameter with the specified name from
the set for this application.
|
void |
removeChild(Container child)
Add a child Container, only if the proposed child is an implementation
of Wrapper.
|
void |
removeConstraint(SecurityConstraint constraint)
Remove the specified security constraint from this web application.
|
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.
|
void |
removeFilterDef(FilterDef filterDef)
Remove the specified filter definition from this Context, if it exists;
otherwise, no action is taken.
|
void |
removeFilterMap(FilterMap filterMap)
Remove a filter mapping from this Context.
|
void |
removeInstanceListener(String listener)
Remove a class name from the set of InstanceListener classes that
will be added to newly created Wrappers.
|
void |
removeMessageDestination(String name)
Remove any message destination with the specified name.
|
void |
removeMessageDestinationRef(String name)
Remove any message destination ref with the specified name.
|
void |
removeMimeMapping(String extension)
Remove the MIME mapping for the specified extension, if it exists;
otherwise, no action is taken.
|
void |
removeNotificationListener(NotificationListener listener)
Remove a JMX-NotificationListener
|
void |
removeNotificationListener(NotificationListener listener,
NotificationFilter filter,
Object object) |
void |
removeParameter(String name)
Remove the context initialization parameter with the specified
name, if it exists; otherwise, no action is taken.
|
void |
removePostConstructMethod(String clazz)
Removes the post construct method definition for the given class, if it
exists; otherwise, no action is taken.
|
void |
removePreDestroyMethod(String clazz)
Removes the pre destroy method definition for the given class, if it
exists; otherwise, no action is taken.
|
void |
removeRoleMapping(String role)
Remove any security role reference for the specified name
|
void |
removeSecurityRole(String role)
Remove any security role with the specified name.
|
void |
removeServletMapping(String pattern)
Remove any servlet mapping for the specified pattern, if it exists;
otherwise, no action is taken.
|
void |
removeWatchedResource(String name)
Remove the specified watched resource name from the list associated
with this Context.
|
void |
removeWelcomeFile(String name)
Remove the specified welcome file name from the list recognized
by this Context.
|
void |
removeWrapperLifecycle(String listener)
Remove a class name from the set of LifecycleListener classes that
will be added to newly created Wrappers.
|
void |
removeWrapperListener(String listener)
Remove a class name from the set of ContainerListener classes that
will be added to newly created Wrappers.
|
boolean |
resourcesStart()
Allocate resources, including proxy.
|
boolean |
resourcesStop()
Deallocate resources and destroy proxy.
|
void |
setAddWebinfClassesResources(boolean addWebinfClassesResources) |
void |
setAliases(String aliases)
Set the current alias configuration.
|
void |
setAllowCasualMultipartParsing(boolean allowCasualMultipartParsing)
Set to
true to 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. |
void |
setAllowLinking(boolean allowLinking)
Set allow linking.
|
void |
setAllowMultipleLeadingForwardSlashInPath(boolean allowMultipleLeadingForwardSlashInPath)
Configure if, when returning a context path from
HttpServletRequest.getContextPath(), the return value
is allowed to contain multiple leading '/' characters. |
void |
setAltDDName(String altDDName)
Set an alternate Deployment Descriptor name.
|
void |
setAntiJARLocking(boolean antiJARLocking)
Set the antiJARLocking feature for this Context.
|
void |
setAntiResourceLocking(boolean antiResourceLocking)
Set the antiResourceLocking feature for this Context.
|
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.
|
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.
|
void |
setCacheMaxSize(int cacheMaxSize)
Set the maximum size of the cache in KB.
|
void |
setCacheObjectMaxSize(int cacheObjectMaxSize)
Set the maximum size of objects to be placed the cache in KB.
|
void |
setCacheTTL(int cacheTTL)
Set cache TTL.
|
void |
setCachingAllowed(boolean cachingAllowed)
Set caching allowed flag.
|
void |
setCharsetMapper(CharsetMapper mapper)
Set the Locale to character set mapper for this Context.
|
void |
setCharsetMapperClass(String mapper)
Set the Locale to character set mapper class for this Context.
|
void |
setClearReferencesHttpClientKeepAliveThread(boolean clearReferencesHttpClientKeepAliveThread)
Set the clearReferencesHttpClientKeepAliveThread feature for this
Context.
|
void |
setClearReferencesObjectStreamClassCaches(boolean clearReferencesObjectStreamClassCaches) |
void |
setClearReferencesRmiTargets(boolean clearReferencesRmiTargets) |
void |
setClearReferencesStatic(boolean clearReferencesStatic)
Deprecated.
This option will be removed in Tomcat 8.5
|
void |
setClearReferencesStopThreads(boolean clearReferencesStopThreads)
Set the clearReferencesStopThreads feature for this Context.
|
void |
setClearReferencesStopTimerThreads(boolean clearReferencesStopTimerThreads)
Set the clearReferencesStopTimerThreads feature for this Context.
|
void |
setClearReferencesThreadLocals(boolean clearReferencesThreadLocals) |
void |
setCompilerClasspath(String compilerClasspath)
Deprecated.
|
void |
setConfigFile(URL configFile)
Set the URL of the XML descriptor for this context.
|
void |
setConfigured(boolean configured)
Set the "correctly configured" flag for this Context.
|
void |
setContainerSciFilter(String containerSciFilter)
Sets the regular expression that specifies which container provided SCIs
should be filtered out and not used for this context.
|
void |
setCookies(boolean cookies)
Set the "use cookies for session ids" flag.
|
void |
setCopyXML(boolean copyXML)
Allows copying a bundled context.xml file to the host configuration base
folder on deployment.
|
void |
setCreateUploadTargets(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.
|
void |
setCrossContext(boolean crossContext)
Set the "allow crossing servlet contexts" flag.
|
void |
setDefaultContextXml(String defaultContextXml)
Set the location of the default context xml that will be used.
|
void |
setDefaultWebXml(String defaultWebXml)
Set the location of the default web xml that will be used.
|
void |
setDelegate(boolean delegate)
Set the "follow standard delegation model" flag used to configure
our ClassLoader.
|
void |
setDispatchersUseEncodedPaths(boolean dispatchersUseEncodedPaths)
Are paths used in calls to obtain a request dispatcher expected to be
encoded?
|
void |
setDisplayName(String displayName)
Set the display name of this web application.
|
void |
setDistributable(boolean distributable)
Set the distributable flag for this web application.
|
void |
setDocBase(String docBase)
Set the document root for this Context.
|
void |
setEffectiveMajorVersion(int effectiveMajorVersion)
Set the effective major version of the Servlet spec used by this
context.
|
void |
setEffectiveMinorVersion(int effectiveMinorVersion)
Set the effective minor version of the Servlet spec used by this
context.
|
void |
setFailCtxIfServletStartFails(Boolean failCtxIfServletStartFails) |
void |
setFireRequestListenersOnForwards(boolean enable)
Configure whether or not requests listeners will be fired on forwards for
this Context.
|
void |
setIgnoreAnnotations(boolean ignoreAnnotations)
Set the boolean on the annotations parsing for this web
application.
|
void |
setInstanceManager(InstanceManager instanceManager)
Set the instance manager associated with this context.
|
void |
setJ2EEApplication(String j2EEApplication) |
void |
setJ2EEServer(String j2EEServer) |
void |
setJarScanner(JarScanner jarScanner)
Set the Jar Scanner to be used to scan for JAR resources for this
context.
|
String[] |
setJavaVMs(String[] javaVMs) |
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.
|
void |
setLogEffectiveWebXml(boolean logEffectiveWebXml)
Set whether or not the effective web.xml for this context should be
logged on context start.
|
void |
setLoginConfig(LoginConfig config)
Set the login configuration descriptor for this web application.
|
void |
setMapperContextRootRedirectEnabled(boolean mapperContextRootRedirectEnabled)
If enabled, requests for a web application context root will be
redirected (adding a trailing slash) by the Mapper.
|
void |
setMapperDirectoryRedirectEnabled(boolean mapperDirectoryRedirectEnabled)
If enabled, requests for a directory will be redirected (adding a
trailing slash) by the Mapper.
|
void |
setNamingContextListener(NamingContextListener namingContextListener)
Naming context listener setter.
|
void |
setNamingResources(NamingResources namingResources)
Set the naming resources for this web application.
|
void |
setOriginalDocBase(String docBase)
Set the original document root for this Context.
|
void |
setOverride(boolean override)
Set the default context override flag for this web application.
|
void |
setPath(String path)
Set the context path for this Context.
|
void |
setPreemptiveAuthentication(boolean preemptiveAuthentication)
Configures if a user presents authentication credentials, whether the
context will process them when the request is for a non-protected
resource.
|
void |
setPrivileged(boolean privileged)
Set the privileged flag for this web application.
|
void |
setProcessTlds(boolean newProcessTlds)
Sets the process TLDs attribute.
|
void |
setPublicId(String publicId)
Set the public identifier of the deployment descriptor DTD that is
currently being parsed.
|
void |
setReloadable(boolean reloadable)
Set the reloadable flag for this web application.
|
void |
setRenewThreadsWhenStoppingContext(boolean renewThreadsWhenStoppingContext) |
void |
setReplaceWelcomeFiles(boolean replaceWelcomeFiles)
Set the "replace welcome files" property.
|
void |
setResourceOnlyServlets(String resourceOnlyServlets)
Sets the (comma separated) list of Servlets that expect a resource to be
present.
|
void |
setResources(DirContext resources)
Set the resources DirContext object with which this Container is
associated.
|
void |
setSaveConfig(boolean saveConfig)
Deprecated.
|
void |
setSendRedirectBody(boolean sendRedirectBody)
Configures if a response body is included when a redirect response is
sent to the client.
|
String |
setServer(String server) |
void |
setSessionCookieDomain(String sessionCookieDomain)
Sets the domain to use for session cookies.
|
void |
setSessionCookieName(String sessionCookieName)
Sets the name to use for session cookies.
|
void |
setSessionCookiePath(String sessionCookiePath)
Sets the path to use for session cookies.
|
void |
setSessionCookiePathUsesTrailingSlash(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.
|
void |
setSessionTimeout(int timeout)
Set the default session timeout (in minutes) for this
web application.
|
void |
setStartupTime(long startupTime) |
void |
setSwallowAbortedUploads(boolean swallowAbortedUploads)
Set to
false to disable request data swallowing
after an upload was aborted due to size constraints. |
void |
setSwallowOutput(boolean swallowOutput)
Set the value of the swallowOutput flag.
|
void |
setTldNamespaceAware(boolean tldNamespaceAware)
*.tld files are always parsed using a namespace aware parser.
|
void |
setTldScanTime(long tldScanTime) |
void |
setTldValidation(boolean tldValidation)
Controls whether the parsing of *.tld files for this Context will be
performed by a validating parser.
|
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.
|
void |
setUnpackWAR(boolean unpackWAR)
Unpack WAR flag mutator.
|
void |
setUseHttpOnly(boolean useHttpOnly)
Sets the use HttpOnly cookies for session cookies flag.
|
void |
setUseNaming(boolean useNaming)
Enables or disables naming.
|
void |
setUseRelativeRedirects(boolean useRelativeRedirects)
Controls whether HTTP 1.1 and later location headers generated by a call
to
HttpServletResponse.sendRedirect(String)
will use relative or absolute redirects. |
void |
setValidateClientProvidedNewSessionId(boolean validateClientProvidedNewSessionId)
When a client provides the ID for a new session, should that ID be
validated?
|
void |
setWebappVersion(String webappVersion)
Set the version of this web application - used to differentiate
different versions of the same web application when using parallel
deployment.
|
void |
setWorkDir(String workDir)
Set the work directory for this Context.
|
void |
setWrapperClass(String wrapperClassName)
Set the Java class name of the Wrapper implementation used
for servlets registered in this Context.
|
void |
setXmlBlockExternal(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.
|
void |
setXmlNamespaceAware(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.
|
void |
setXmlValidation(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 void |
startInternal()
Start this component and implement the requirements
of
LifecycleBase.startInternal(). |
void |
startRecursive()
Deprecated.
|
protected void |
stopInternal()
Stop this component and implement the requirements
of
LifecycleBase.stopInternal(). |
String |
toString() |
protected void |
unbindThread(ClassLoader oldContextClassLoader)
Unbind thread and restore the specified context classloader.
|
boolean |
wasCreatedDynamicServlet(Servlet servlet) |
addContainerListener, addPropertyChangeListener, addValve, findChild, findChildren, findContainerListeners, fireContainerEvent, getAccessLog, getBackgroundProcessorDelay, getChildren, getCluster, getClusterInternal, getDomainInternal, getLoader, getLoaderInternal, getLogger, getManager, getManagerInternal, getMappingObject, getName, getParent, getPipeline, getRealm, getRealmInternal, getResources, getResourcesInternal, getStartChildren, getStartStopThreads, invoke, logAccess, logName, removeContainerListener, removePropertyChangeListener, setBackgroundProcessorDelay, setCluster, setLoader, setManager, setName, setParent, setParentClassLoader, setRealm, setStartChildren, setStartStopThreads, threadStart, threadStopgetDomain, getObjectName, postDeregister, postRegister, preDeregister, preRegister, register, setDomain, unregisteraddLifecycleListener, destroy, findLifecycleListeners, fireLifecycleEvent, getState, getStateName, getThrowOnFailure, init, removeLifecycleListener, setState, setState, setThrowOnFailure, start, stopclone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitaddContainerListener, addPropertyChangeListener, findChild, findChildren, findContainerListeners, fireContainerEvent, getAccessLog, getBackgroundProcessorDelay, getCluster, getLoader, getLogger, getManager, getMappingObject, getName, getObjectName, getParent, getPipeline, getRealm, getResources, getStartStopThreads, invoke, logAccess, removeContainerListener, removePropertyChangeListener, setBackgroundProcessorDelay, setCluster, setLoader, setManager, setName, setParent, setParentClassLoader, setRealm, setStartStopThreadsaddLifecycleListener, destroy, findLifecycleListeners, getState, getStateName, init, removeLifecycleListener, start, stopprotected static URLEncoder urlEncoder
protected boolean allowCasualMultipartParsing
protected ApplicationContext context
protected boolean allowLinking
protected int cacheMaxSize
protected int cacheObjectMaxSize
protected int cacheTTL
public StandardContext()
public void setCreateUploadTargets(boolean createUploadTargets)
ContextsetCreateUploadTargets in interface ContextcreateUploadTargets - true if Tomcat should attempt to
create the upload target, otherwise falsepublic boolean getCreateUploadTargets()
ContextgetCreateUploadTargets in interface Contexttrue if Tomcat will attempt to create an upload target
otherwise falsepublic void incrementInProgressAsyncCount()
incrementInProgressAsyncCount in interface Contextpublic void decrementInProgressAsyncCount()
decrementInProgressAsyncCount in interface Contextpublic long getInProgressAsyncCount()
public void setAllowMultipleLeadingForwardSlashInPath(boolean allowMultipleLeadingForwardSlashInPath)
ContextHttpServletRequest.getContextPath(), the return value
is allowed to contain multiple leading '/' characters.setAllowMultipleLeadingForwardSlashInPath in interface ContextallowMultipleLeadingForwardSlashInPath - The new value for the flagpublic boolean getAllowMultipleLeadingForwardSlashInPath()
ContextHttpServletRequest.getContextPath(), is it allowed to
contain multiple leading '/' characters?getAllowMultipleLeadingForwardSlashInPath in interface Contexttrue if multiple leading '/' characters are allowed,
otherwise falsepublic void setDispatchersUseEncodedPaths(boolean dispatchersUseEncodedPaths)
ContextsetDispatchersUseEncodedPaths in interface ContextdispatchersUseEncodedPaths - true to use encoded paths,
otherwise falsepublic boolean getDispatchersUseEncodedPaths()
The default value for this implementation is true.
getDispatchersUseEncodedPaths in interface Contexttrue if encoded paths will be used, otherwise
falsepublic void setUseRelativeRedirects(boolean useRelativeRedirects)
ContextHttpServletResponse.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
RemoteIpFilter if the filter is
changing the scheme and/or port.
setUseRelativeRedirects in interface ContextuseRelativeRedirects - true to use relative redirects and
false to use absolute redirectspublic boolean getUseRelativeRedirects()
HttpServletResponse.sendRedirect(String) use
relative or absolute redirects.
The default value for this implementation is true.
getUseRelativeRedirects in interface Contexttrue if relative redirects will be used false if
absolute redirects are used.Context.setUseRelativeRedirects(boolean)public void setMapperContextRootRedirectEnabled(boolean mapperContextRootRedirectEnabled)
ContextsetMapperContextRootRedirectEnabled in interface ContextmapperContextRootRedirectEnabled - Should the redirects be enabled?public boolean getMapperContextRootRedirectEnabled()
The default value for this implementation is false.
getMapperContextRootRedirectEnabled in interface Contexttrue if the Mapper level redirect is enabled for this
Context.public void setMapperDirectoryRedirectEnabled(boolean mapperDirectoryRedirectEnabled)
ContextsetMapperDirectoryRedirectEnabled in interface ContextmapperDirectoryRedirectEnabled - Should the redirects be enabled?public boolean getMapperDirectoryRedirectEnabled()
The default value for this implementation is false.
getMapperDirectoryRedirectEnabled in interface Contexttrue if the Mapper level redirect is enabled for this
Context.public void setValidateClientProvidedNewSessionId(boolean validateClientProvidedNewSessionId)
Context/setValidateClientProvidedNewSessionId in interface ContextvalidateClientProvidedNewSessionId - true if validation should be appliedpublic boolean getValidateClientProvidedNewSessionId()
Context.setValidateClientProvidedNewSessionId(boolean)) before use?
The default value for this implementation is true.
getValidateClientProvidedNewSessionId in interface Contexttrue if validation will be applied. Otherwise, falsepublic void setContainerSciFilter(String containerSciFilter)
ContextMatcher.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.setContainerSciFilter in interface ContextcontainerSciFilter - The regular expression against which the fully
qualified class name of each container provided
SCI should be checkedpublic String getContainerSciFilter()
ContextMatcher.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.getContainerSciFilter in interface Contextpublic boolean getSendRedirectBody()
getSendRedirectBody in interface Contextpublic void setSendRedirectBody(boolean sendRedirectBody)
ContextsetSendRedirectBody in interface ContextsendRedirectBody - true to send a response body for redirectspublic boolean getPreemptiveAuthentication()
getPreemptiveAuthentication in interface Contextpublic void setPreemptiveAuthentication(boolean preemptiveAuthentication)
ContextsetPreemptiveAuthentication in interface ContextpreemptiveAuthentication - true to perform authentication even outside
security constraintspublic void setFireRequestListenersOnForwards(boolean enable)
ContextsetFireRequestListenersOnForwards in interface Contextenable - true to fire request listeners when forwardingpublic boolean getFireRequestListenersOnForwards()
getFireRequestListenersOnForwards in interface Contextpublic void setAddWebinfClassesResources(boolean addWebinfClassesResources)
public boolean getAddWebinfClassesResources()
public void setWebappVersion(String webappVersion)
ContextsetWebappVersion in interface ContextwebappVersion - The webapp version associated with the context,
which should be uniquepublic String getWebappVersion()
getWebappVersion in interface Contextpublic String getBaseName()
getBaseName in interface Contextpublic String getResourceOnlyServlets()
ContextgetResourceOnlyServlets in interface Contextpublic void setResourceOnlyServlets(String resourceOnlyServlets)
ContextsetResourceOnlyServlets in interface ContextresourceOnlyServlets - The Servlet names comma separated listpublic boolean isResourceOnlyServlet(String servletName)
ContextisResourceOnlyServlet in interface ContextservletName - Name of the Servlet (as per web.xml) to checktrue if the Servlet expects a resource,
otherwise falsepublic int getEffectiveMajorVersion()
getEffectiveMajorVersion in interface Contextpublic void setEffectiveMajorVersion(int effectiveMajorVersion)
ContextsetEffectiveMajorVersion in interface ContexteffectiveMajorVersion - Set the version numberpublic int getEffectiveMinorVersion()
getEffectiveMinorVersion in interface Contextpublic void setEffectiveMinorVersion(int effectiveMinorVersion)
ContextsetEffectiveMinorVersion in interface ContexteffectiveMinorVersion - Set the version numberpublic void setLogEffectiveWebXml(boolean logEffectiveWebXml)
ContextsetLogEffectiveWebXml in interface ContextlogEffectiveWebXml - set to true to log the complete
web.xml that will be used for the webapppublic boolean getLogEffectiveWebXml()
ContextgetLogEffectiveWebXml in interface Contextpublic Authenticator getAuthenticator()
getAuthenticator in interface ContextAuthenticator that is used by this context. This is
always non-null for a started Contextpublic JarScanner getJarScanner()
ContextgetJarScanner in interface Contextpublic void setJarScanner(JarScanner jarScanner)
ContextsetJarScanner in interface ContextjarScanner - The Jar Scanner to be used for this context.public InstanceManager getInstanceManager()
getInstanceManager in interface Contextpublic void setInstanceManager(InstanceManager instanceManager)
ContextsetInstanceManager in interface ContextinstanceManager - the new instance manager instancepublic String getEncodedPath()
ContextgetEncodedPath in interface Contextpublic boolean isCachingAllowed()
public void setCachingAllowed(boolean cachingAllowed)
cachingAllowed - true to permit cachingpublic void setAllowLinking(boolean allowLinking)
allowLinking - true to permit linkingpublic boolean isAllowLinking()
public void setAllowCasualMultipartParsing(boolean allowCasualMultipartParsing)
true to 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.setAllowCasualMultipartParsing in interface ContextallowCasualMultipartParsing - true to allow such
casual parsing, false otherwise.public boolean getAllowCasualMultipartParsing()
true if requests mapped to servlets without
"multipart config" to parse multipart/form-data requests anyway.getAllowCasualMultipartParsing in interface Contexttrue if requests mapped to servlets without
"multipart config" to parse multipart/form-data requests,
false otherwise.public void setSwallowAbortedUploads(boolean swallowAbortedUploads)
false to disable request data swallowing
after an upload was aborted due to size constraints.setSwallowAbortedUploads in interface ContextswallowAbortedUploads - false to disable
swallowing, true otherwise (default).public boolean getSwallowAbortedUploads()
true if remaining request data will be read
(swallowed) even the request violates a data size constraint.getSwallowAbortedUploads in interface Contexttrue if data will be swallowed (default),
false otherwise.public void setCacheTTL(int cacheTTL)
cacheTTL - Time between cache entry revalidation in millisecondspublic int getCacheTTL()
public int getCacheMaxSize()
public void setCacheMaxSize(int cacheMaxSize)
cacheMaxSize - Maximum size of the cache in KBpublic int getCacheObjectMaxSize()
public void setCacheObjectMaxSize(int cacheObjectMaxSize)
cacheObjectMaxSize - Maximum size of the objects in the cache in KBpublic String getAliases()
public void addResourceJarUrl(URL url)
addResourceJarUrl in interface Contexturl - URL of resource JARpublic void addResourcesDirContext(DirContext altDirContext)
altDirContext - static resources to be added to this contextpublic void setAliases(String aliases)
aliases - List of aliases for this contextpublic void addServletContainerInitializer(ServletContainerInitializer sci, Set<Class<?>> classes)
addServletContainerInitializer in interface Contextsci - The instance to addclasses - The classes in which the initializer expressed an
interestpublic boolean getDelegate()
true if classloading delegates to the parent classloader firstpublic void setDelegate(boolean delegate)
delegate - The new flagpublic boolean isUseNaming()
public void setUseNaming(boolean useNaming)
useNaming - true to enable the naming environment@Deprecated public boolean isFilesystemBased()
true if the resources associated with this context are
filesystem based.public Object[] getApplicationEventListeners()
getApplicationEventListeners in interface ContextIllegalStateException - if this method is called before
this application has started, or after it has been stoppedpublic void setApplicationEventListeners(Object[] listeners)
setApplicationEventListeners in interface Contextlisteners - The set of instantiated listener objects.public void addApplicationEventListener(Object listener)
listener - The listener to addpublic Object[] getApplicationLifecycleListeners()
getApplicationLifecycleListeners in interface ContextIllegalStateException - if this method is called before
this application has started, or after it has been stoppedpublic void setApplicationLifecycleListeners(Object[] listeners)
setApplicationLifecycleListeners in interface Contextlisteners - The set of instantiated listener objects.public void addApplicationLifecycleListener(Object listener)
listener - The listener to addpublic boolean getAntiJARLocking()
public boolean getAntiResourceLocking()
public void setAntiJARLocking(boolean antiJARLocking)
antiJARLocking - The new flag valuepublic void setAntiResourceLocking(boolean antiResourceLocking)
antiResourceLocking - The new flag valuepublic boolean getAvailable()
getAvailable in interface Contextpublic CharsetMapper getCharsetMapper()
getCharsetMapper in interface Contextpublic void setCharsetMapper(CharsetMapper mapper)
setCharsetMapper in interface Contextmapper - The new mapperpublic String getCharset(Locale locale)
ContextgetCharset in interface Contextlocale - The locale for which the mapped character set should be
returnedpublic URL getConfigFile()
ContextgetConfigFile in interface Contextpublic void setConfigFile(URL configFile)
ContextsetConfigFile in interface ContextconfigFile - The URL of the XML descriptor for this context.public boolean getConfigured()
ContextgetConfigured in interface Contexttrue if the Context has been correctly configured,
otherwise falsepublic void setConfigured(boolean configured)
setConfigured in interface Contextconfigured - The new correctly configured flagpublic boolean getCookies()
ContextgetCookies in interface Contexttrue if it is permitted to use cookies to track
session IDs for this web application, otherwise
falsepublic void setCookies(boolean cookies)
setCookies in interface Contextcookies - The new flagpublic String getSessionCookieName()
getSessionCookieName in interface Contextpublic void setSessionCookieName(String sessionCookieName)
setSessionCookieName in interface ContextsessionCookieName - The name to usepublic boolean getUseHttpOnly()
getUseHttpOnly in interface Contexttrue if the HttpOnly flag should be set on session
cookiespublic void setUseHttpOnly(boolean useHttpOnly)
setUseHttpOnly in interface ContextuseHttpOnly - Set to true to use HttpOnly cookies
for session cookiespublic String getSessionCookieDomain()
getSessionCookieDomain in interface Contextpublic void setSessionCookieDomain(String sessionCookieDomain)
setSessionCookieDomain in interface ContextsessionCookieDomain - The domain to usepublic String getSessionCookiePath()
getSessionCookiePath in interface Contextpublic void setSessionCookiePath(String sessionCookiePath)
setSessionCookiePath in interface ContextsessionCookiePath - The path to usepublic boolean getSessionCookiePathUsesTrailingSlash()
ContextgetSessionCookiePathUsesTrailingSlash in interface Contexttrue if the slash is added, otherwise
falsepublic void setSessionCookiePathUsesTrailingSlash(boolean sessionCookiePathUsesTrailingSlash)
ContextsetSessionCookiePathUsesTrailingSlash in interface ContextsessionCookiePathUsesTrailingSlash - true if the
slash is should be added,
otherwise falsepublic boolean getCrossContext()
getCrossContext in interface Contexttrue if cross-contest requests are allowed from this
web applications, otherwise falsepublic void setCrossContext(boolean crossContext)
setCrossContext in interface ContextcrossContext - The new cross contexts flagpublic String getDefaultContextXml()
public void setDefaultContextXml(String defaultContextXml)
defaultContextXml - The default web xmlpublic String getDefaultWebXml()
public void setDefaultWebXml(String defaultWebXml)
defaultWebXml - The default web xmlpublic long getStartupTime()
public void setStartupTime(long startupTime)
public long getTldScanTime()
public void setTldScanTime(long tldScanTime)
public String getDisplayName()
ContextgetDisplayName in interface Contextpublic String getAltDDName()
ContextgetAltDDName in interface Contextpublic void setAltDDName(String altDDName)
setAltDDName in interface ContextaltDDName - The new name@Deprecated public String getCompilerClasspath()
@Deprecated public void setCompilerClasspath(String compilerClasspath)
compilerClasspath - The new compiler classpathpublic void setDisplayName(String displayName)
setDisplayName in interface ContextdisplayName - The new display namepublic boolean getDistributable()
ContextgetDistributable in interface Contextpublic void setDistributable(boolean distributable)
setDistributable in interface Contextdistributable - The new distributable flagpublic String getDocBase()
ContextgetDocBase in interface Contextpublic void setDocBase(String docBase)
ContextsetDocBase in interface ContextdocBase - The new document rootpublic String getInfo()
<description>/<version>.getInfo in interface ContainergetInfo in class ContainerBase<description>/<version>.public String getJ2EEApplication()
public void setJ2EEApplication(String j2EEApplication)
public String getJ2EEServer()
public void setJ2EEServer(String j2EEServer)
public boolean getIgnoreAnnotations()
ContextgetIgnoreAnnotations in interface Contextpublic void setIgnoreAnnotations(boolean ignoreAnnotations)
setIgnoreAnnotations in interface ContextignoreAnnotations - The boolean on the annotations parsingpublic LoginConfig getLoginConfig()
getLoginConfig in interface Contextpublic void setLoginConfig(LoginConfig config)
setLoginConfig in interface Contextconfig - The new login configurationpublic Mapper getMapper()
public NamingResources getNamingResources()
getNamingResources in interface Contextpublic void setNamingResources(NamingResources namingResources)
setNamingResources in interface ContextnamingResources - The new naming resourcespublic String getPath()
public void setPath(String path)
public String getPublicId()
getPublicId in interface Contextpublic void setPublicId(String publicId)
setPublicId in interface ContextpublicId - The public identifierpublic boolean getReloadable()
getReloadable in interface Contextpublic boolean getOverride()
getOverride in interface Contextpublic String getOriginalDocBase()
public void setOriginalDocBase(String docBase)
docBase - The original document rootpublic ClassLoader getParentClassLoader()
ContainerBasegetParentClassLoader in interface ContainergetParentClassLoader in class ContainerBasepublic boolean getPrivileged()
getPrivileged in interface Contextpublic void setPrivileged(boolean privileged)
setPrivileged in interface Contextprivileged - The new privileged flagpublic void setReloadable(boolean reloadable)
setReloadable in interface Contextreloadable - The new reloadable flagpublic void setOverride(boolean override)
setOverride in interface Contextoverride - The new override flag@Deprecated public boolean isReplaceWelcomeFiles()
public void setReplaceWelcomeFiles(boolean replaceWelcomeFiles)
replaceWelcomeFiles - The new property valuepublic ServletContext getServletContext()
getServletContext in interface Contextpublic int getSessionTimeout()
getSessionTimeout in interface Contextpublic void setSessionTimeout(int timeout)
setSessionTimeout in interface Contexttimeout - The new default session timeoutpublic boolean getSwallowOutput()
getSwallowOutput in interface Contextpublic void setSwallowOutput(boolean swallowOutput)
setSwallowOutput in interface ContextswallowOutput - The new valuepublic long getUnloadDelay()
public void setUnloadDelay(long unloadDelay)
unloadDelay - The new valuepublic boolean getUnpackWAR()
public void setUnpackWAR(boolean unpackWAR)
unpackWAR - true to unpack WARs on deploymentpublic boolean getCopyXML()
true if the META-INF/context.xml file included
in a WAR will be copied to the host configuration base folder on deploymentpublic void setCopyXML(boolean copyXML)
copyXML - the new flag valuepublic String getWrapperClass()
getWrapperClass in interface Contextpublic void setWrapperClass(String wrapperClassName)
setWrapperClass in interface ContextwrapperClassName - The new wrapper class nameIllegalArgumentException - if the specified wrapper class
cannot be found or is not a subclass of StandardWrapperpublic void setResources(DirContext resources)
setResources in interface ContainersetResources in class ContainerBaseresources - The newly associated DirContextpublic JspConfigDescriptor getJspConfigDescriptor()
getJspConfigDescriptor in interface Contextpublic boolean getJndiExceptionOnFailedWrite()
public void setJndiExceptionOnFailedWrite(boolean jndiExceptionOnFailedWrite)
jndiExceptionOnFailedWrite - false to avoid an exceptionpublic String getCharsetMapperClass()
public void setCharsetMapperClass(String mapper)
mapper - The new mapper classpublic String getWorkPath()
public String getWorkDir()
public void setWorkDir(String workDir)
workDir - The new work directorypublic boolean getClearReferencesRmiTargets()
public void setClearReferencesRmiTargets(boolean clearReferencesRmiTargets)
@Deprecated public boolean isSaveConfig()
@Deprecated public void setSaveConfig(boolean saveConfig)
saveConfig - New flag value@Deprecated public boolean getClearReferencesStatic()
@Deprecated public void setClearReferencesStatic(boolean clearReferencesStatic)
clearReferencesStatic - The new flag valuepublic boolean getClearReferencesStopThreads()
public void setClearReferencesStopThreads(boolean clearReferencesStopThreads)
clearReferencesStopThreads - The new flag valuepublic boolean getClearReferencesStopTimerThreads()
public void setClearReferencesStopTimerThreads(boolean clearReferencesStopTimerThreads)
clearReferencesStopTimerThreads - The new flag valuepublic boolean getClearReferencesHttpClientKeepAliveThread()
public void setClearReferencesHttpClientKeepAliveThread(boolean clearReferencesHttpClientKeepAliveThread)
clearReferencesHttpClientKeepAliveThread - The new flag valuepublic boolean getRenewThreadsWhenStoppingContext()
public void setRenewThreadsWhenStoppingContext(boolean renewThreadsWhenStoppingContext)
public boolean getClearReferencesObjectStreamClassCaches()
public void setClearReferencesObjectStreamClassCaches(boolean clearReferencesObjectStreamClassCaches)
public boolean getClearReferencesThreadLocals()
public void setClearReferencesThreadLocals(boolean clearReferencesThreadLocals)
public Boolean getFailCtxIfServletStartFails()
public void setFailCtxIfServletStartFails(Boolean failCtxIfServletStartFails)
protected boolean getComputedFailCtxIfServletStartFails()
public void addApplicationListener(String listener)
ContextaddApplicationListener in interface Contextlistener - Java class name of a listener classpublic void addApplicationListener(ApplicationListener listener)
Context
The ApplicationListener class is used to pass an additional
parameter that allows to differentiate listeners to Web Application added
via configuration (web.xml or annotations) vs. ones added by frameworks,
such as listeners declared in JSP tag libraries (TLD files) that are
added by Jasper JSP Engine.
The recommended method to call for the first use case is
Context.addApplicationListener(String). The recommended replacement for
the second use case is to use addListener(...) methods in
ServletContext.
addApplicationListener in interface Contextlistener - Definition of a listener, including its java class name.public void addApplicationParameter(ApplicationParameter parameter)
addApplicationParameter in interface Contextparameter - The new application parameterpublic void addChild(Container child)
addChild in interface ContaineraddChild in class ContainerBasechild - Child container to be addedIllegalArgumentException - if the proposed container is
not an implementation of Wrapperpublic void addConstraint(SecurityConstraint constraint)
addConstraint in interface Contextconstraint - The security constraint that should be addedpublic void addErrorPage(ErrorPage errorPage)
addErrorPage in interface ContexterrorPage - The error page definition to be addedpublic void addFilterDef(FilterDef filterDef)
addFilterDef in interface ContextfilterDef - The filter definition to be addedpublic void addFilterMap(FilterMap filterMap)
addFilterMap in interface ContextfilterMap - The filter mapping to be addedIllegalArgumentException - if the specified filter name
does not match an existing filter definition, or the filter mapping
is malformedpublic void addFilterMapBefore(FilterMap filterMap)
addFilterMapBefore in interface ContextfilterMap - The filter mapping to be addedIllegalArgumentException - if the specified filter name
does not match an existing filter definition, or the filter mapping
is malformedpublic void addInstanceListener(String listener)
addInstanceListener in interface Contextlistener - Java class name of an InstanceListener classpublic void addLocaleEncodingMappingParameter(String locale, String encoding)
addLocaleEncodingMappingParameter in interface Contextlocale - locale to map an encoding forencoding - encoding to be used for a give localepublic void addMessageDestination(MessageDestination md)
md - New message destinationpublic void addMessageDestinationRef(MessageDestinationRef mdr)
mdr - New message destination referencepublic void addMimeMapping(String extension, String mimeType)
addMimeMapping in interface Contextextension - Filename extension being mappedmimeType - Corresponding MIME typepublic void addParameter(String name, String value)
addParameter in interface Contextname - Name of the new parametervalue - Value of the new parameterIllegalArgumentException - if the name or value is missing,
or if this context initialization parameter has already been
registeredpublic void addRoleMapping(String role, String link)
addRoleMapping in interface Contextrole - Security role used in the applicationlink - Actual security role to check forpublic void addSecurityRole(String role)
addSecurityRole in interface Contextrole - New security rolepublic void addServletMapping(String pattern, String name)
addServletMapping in interface Contextpattern - URL pattern to be mappedname - Name of the corresponding servlet to executeIllegalArgumentException - if the specified servlet name
is not known to this Contextpublic void addServletMapping(String pattern, String name, boolean jspWildCard)
addServletMapping in interface Contextpattern - URL pattern to be mappedname - Name of the corresponding servlet to executejspWildCard - true if name identifies the JspServlet
and pattern contains a wildcard; false otherwiseIllegalArgumentException - if the specified servlet name
is not known to this Contextpublic void addWatchedResource(String name)
addWatchedResource in interface Contextname - New watched resource file namepublic void addWelcomeFile(String name)
addWelcomeFile in interface Contextname - New welcome file namepublic void addWrapperLifecycle(String listener)
addWrapperLifecycle in interface Contextlistener - Java class name of a LifecycleListener classpublic void addWrapperListener(String listener)
addWrapperListener in interface Contextlistener - Java class name of a ContainerListener classpublic Wrapper createWrapper()
createWrapper in interface Contextpublic String[] findApplicationListeners()
findApplicationListeners in interface Contextpublic ApplicationParameter[] findApplicationParameters()
findApplicationParameters in interface Contextpublic SecurityConstraint[] findConstraints()
findConstraints in interface Contextpublic ErrorPage findErrorPage(int errorCode)
null.findErrorPage in interface ContexterrorCode - Error code to look upnull.public ErrorPage findErrorPage(String exceptionType)
null.findErrorPage in interface ContextexceptionType - Exception type to look upnull.public ErrorPage[] findErrorPages()
findErrorPages in interface Contextpublic FilterDef findFilterDef(String filterName)
null.findFilterDef in interface ContextfilterName - Filter name to look upnull.public FilterDef[] findFilterDefs()
findFilterDefs in interface Contextpublic FilterMap[] findFilterMaps()
findFilterMaps in interface Contextpublic String[] findInstanceListeners()
findInstanceListeners in interface Context@Deprecated public Context findMappingObject()
public MessageDestination findMessageDestination(String name)
name - Name of the desired message destinationnull.public MessageDestination[] findMessageDestinations()
public MessageDestinationRef findMessageDestinationRef(String name)
name - Name of the desired message destination refnull.public MessageDestinationRef[] findMessageDestinationRefs()
public String findMimeMapping(String extension)
findMimeMapping in interface Contextextension - Extension to map to a MIME typenull.public String[] findMimeMappings()
findMimeMappings in interface Contextpublic String findParameter(String name)
findParameter in interface Contextname - Name of the parameter to returnnull.public String[] findParameters()
findParameters in interface Contextpublic String findRoleMapping(String role)
findRoleMapping in interface Contextrole - Security role to mappublic boolean findSecurityRole(String role)
findSecurityRole in interface Contextrole - Security role to verifytrue if the specified security role is defined
for this application; otherwise return false.public String[] findSecurityRoles()
findSecurityRoles in interface Contextpublic String findServletMapping(String pattern)
findServletMapping in interface Contextpattern - Pattern for which a mapping is requestednull.public String[] findServletMappings()
findServletMappings in interface Contextpublic String findStatusPage(int status)
null.findStatusPage in interface Contextstatus - HTTP status code to look upnull.public int[] findStatusPages()
findStatusPages in interface Contextpublic boolean findWelcomeFile(String name)
findWelcomeFile in interface Contextname - Welcome file to verifytrue if the specified welcome file is defined
for this Context; otherwise return false.public String[] findWatchedResources()
findWatchedResources in interface Contextpublic String[] findWelcomeFiles()
findWelcomeFiles in interface Contextpublic String[] findWrapperLifecycles()
findWrapperLifecycles in interface Contextpublic String[] findWrapperListeners()
findWrapperListeners in interface Contextpublic void reload()
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.
reload in interface ContextIllegalStateException - if the reloadable
property is set to false.public void removeApplicationListener(String listener)
removeApplicationListener in interface Contextlistener - Java class name of the listener to be removedpublic void removeApplicationParameter(String name)
removeApplicationParameter in interface Contextname - Name of the application parameter to removepublic void removeChild(Container child)
removeChild in interface ContainerremoveChild in class ContainerBasechild - Child container to be addedIllegalArgumentException - if the proposed container is
not an implementation of Wrapperpublic void removeConstraint(SecurityConstraint constraint)
removeConstraint in interface Contextconstraint - Constraint to be removedpublic void removeErrorPage(ErrorPage errorPage)
removeErrorPage in interface ContexterrorPage - The error page definition to be removedpublic void removeFilterDef(FilterDef filterDef)
removeFilterDef in interface ContextfilterDef - Filter definition to be removedpublic void removeFilterMap(FilterMap filterMap)
removeFilterMap in interface ContextfilterMap - The filter mapping to be removedpublic void removeInstanceListener(String listener)
removeInstanceListener in interface Contextlistener - Class name of an InstanceListener class to be removedpublic void removeMessageDestination(String name)
name - Name of the message destination to removepublic void removeMessageDestinationRef(String name)
name - Name of the message destination ref to removepublic void removeMimeMapping(String extension)
removeMimeMapping in interface Contextextension - Extension to remove the mapping forpublic void removeParameter(String name)
removeParameter in interface Contextname - Name of the parameter to removepublic void removeRoleMapping(String role)
removeRoleMapping in interface Contextrole - Security role (as used in the application) to removepublic void removeSecurityRole(String role)
removeSecurityRole in interface Contextrole - Security role to removepublic void removeServletMapping(String pattern)
removeServletMapping in interface Contextpattern - URL pattern of the mapping to removepublic void removeWatchedResource(String name)
removeWatchedResource in interface Contextname - Name of the watched resource to be removedpublic void removeWelcomeFile(String name)
removeWelcomeFile in interface Contextname - Name of the welcome file to be removedpublic void removeWrapperLifecycle(String listener)
removeWrapperLifecycle in interface Contextlistener - Class name of a LifecycleListener class to be removedpublic void removeWrapperListener(String listener)
removeWrapperListener in interface Contextlistener - Class name of a ContainerListener class to be removedpublic long getProcessingTime()
public long getMaxTime()
public long getMinTime()
public int getRequestCount()
public int getErrorCount()
public String getRealPath(String path)
null.getRealPath in interface Contextpath - The path to the desired resourcenull.@Deprecated public ServletRegistration.Dynamic dynamicServletAdded(Wrapper wrapper)
wrapper - The wrapper for which the registration should be created.public void dynamicServletCreated(Servlet servlet)
ServletContext.createServlet(Class).servlet - the created Servletpublic boolean wasCreatedDynamicServlet(Servlet servlet)
public boolean filterStart()
true if all filter initialization completed
successfully, or false otherwise.public boolean filterStop()
true if all filter finalization completed
successfully, or false otherwise.public FilterConfig findFilterConfig(String name)
FilterConfig for the
specified filter name, if any; otherwise return null.name - Name of the desired filterpublic boolean listenerStart()
true if all listeners wre
initialized successfully, or false otherwise.public boolean listenerStop()
true if all events were sent successfully,
or false otherwise.public boolean resourcesStart()
true if initialization was successfull,
or false otherwise.public boolean resourcesStop()
true if no error occurredpublic boolean loadOnStartup(Container[] children)
children - Array of wrappers for all currently defined
servlets (including those not declared load on startup)true if load on startup was considered successfulprotected void startInternal()
throws LifecycleException
LifecycleBase.startInternal().startInternal in class ContainerBaseLifecycleException - if this component detects a fatal error
that prevents this component from being usedprotected void stopInternal()
throws LifecycleException
LifecycleBase.stopInternal().stopInternal in class ContainerBaseLifecycleException - if this component detects a fatal error
that prevents this component from being usedprotected void destroyInternal()
throws LifecycleException
destroyInternal in class ContainerBaseLifecycleException - If the destruction failspublic void backgroundProcess()
ContainerBasebackgroundProcess in interface ContainerbackgroundProcess in class ContainerBaseprotected String adjustURLPattern(String urlPattern)
urlPattern - The URL pattern to be adjusted (if needed)
and returnedpublic boolean isServlet22()
isServlet22 in interface Contexttrue if running a legacy Servlet 2.2 applicationpublic Set<String> addServletSecurity(ApplicationServletRegistration registration, ServletSecurityElement servletSecurityElement)
ContextServletRegistration.DynamicaddServletSecurity in interface Contextregistration - Servlet security was modified forservletSecurityElement - new security constraints for this Servletprotected File engineBase()
protected ClassLoader bindThread()
protected void unbindThread(ClassLoader oldContextClassLoader)
oldContextClassLoader - the previous classloaderprotected String getBasePath()
protected String getAppBase()
public NamingContextListener getNamingContextListener()
public void setNamingContextListener(NamingContextListener namingContextListener)
namingContextListener - the new naming context listenerpublic boolean getPaused()
Context@Deprecated public String getHostname()
public boolean fireRequestInitEvent(ServletRequest request)
ContextServletRequestListeners that a request
has started.fireRequestInitEvent in interface Contextrequest - The request object that will be passed to the listenertrue if the listeners fire successfully, else
falsepublic boolean fireRequestDestroyEvent(ServletRequest request)
ContextServletRequestListeners that a request
has ended.fireRequestDestroyEvent in interface Contextrequest - The request object that will be passed to the listenertrue if the listeners fire successfully, else
falsepublic void addPostConstructMethod(String clazz, String method)
ContextaddPostConstructMethod in interface Contextclazz - Fully qualified class namemethod - Post construct method namepublic void removePostConstructMethod(String clazz)
ContextremovePostConstructMethod in interface Contextclazz - Fully qualified class namepublic void addPreDestroyMethod(String clazz, String method)
ContextaddPreDestroyMethod in interface Contextclazz - Fully qualified class namemethod - Post construct method namepublic void removePreDestroyMethod(String clazz)
ContextremovePreDestroyMethod in interface Contextclazz - Fully qualified class namepublic String findPostConstructMethod(String clazz)
ContextNULL will be
returned.findPostConstructMethod in interface Contextclazz - Fully qualified class nameNULL will
be returned.public String findPreDestroyMethod(String clazz)
ContextNULL will be returned.findPreDestroyMethod in interface Contextclazz - Fully qualified class nameNULL will be
returned.public Map<String,String> findPostConstructMethods()
ContextfindPostConstructMethods in interface Contextpublic Map<String,String> findPreDestroyMethods()
ContextfindPreDestroyMethods in interface Contextpublic String getDeploymentDescriptor()
public String[] getServlets()
protected String getObjectNameKeyProperties()
LifecycleMBeanBaseObjectName that will be used to register this component.getObjectNameKeyProperties in class LifecycleMBeanBaseObjectNameprotected void initInternal()
throws LifecycleException
LifecycleMBeanBaseinitInternal in class ContainerBaseLifecycleException - If the initialisation failspublic void removeNotificationListener(NotificationListener listener, NotificationFilter filter, Object object) throws ListenerNotFoundException
removeNotificationListener in interface NotificationEmitterListenerNotFoundExceptionpublic MBeanNotificationInfo[] getNotificationInfo()
getNotificationInfo in interface NotificationBroadcasterpublic void addNotificationListener(NotificationListener listener, NotificationFilter filter, Object object) throws IllegalArgumentException
public void removeNotificationListener(NotificationListener listener) throws ListenerNotFoundException
removeNotificationListener in interface NotificationBroadcasterListenerNotFoundExceptionNotificationBroadcaster.removeNotificationListener(javax.management.NotificationListener)@Deprecated public DirContext getStaticResources()
@Deprecated public DirContext findStaticResources()
public String[] getWelcomeFiles()
public boolean getXmlNamespaceAware()
ContextgetXmlNamespaceAware in interface Contextpublic void setXmlNamespaceAware(boolean webXmlNamespaceAware)
ContextsetXmlNamespaceAware in interface ContextwebXmlNamespaceAware - true to enable namespace awarenesspublic void setXmlValidation(boolean webXmlValidation)
ContextsetXmlValidation in interface ContextwebXmlValidation - true to enable xml validationpublic boolean getXmlValidation()
ContextgetXmlValidation in interface Contextpublic boolean getTldNamespaceAware()
ContextgetTldNamespaceAware in interface Contexttruepublic void setTldNamespaceAware(boolean tldNamespaceAware)
ContextsetTldNamespaceAware in interface ContexttldNamespaceAware - ignoredpublic void setXmlBlockExternal(boolean xmlBlockExternal)
ContextsetXmlBlockExternal in interface ContextxmlBlockExternal - true to block external entitiespublic boolean getXmlBlockExternal()
ContextgetXmlBlockExternal in interface Contextpublic void setTldValidation(boolean tldValidation)
ContextsetTldValidation in interface ContexttldValidation - true to enable xml validationpublic boolean getTldValidation()
ContextgetTldValidation in interface Contextpublic void setProcessTlds(boolean newProcessTlds)
newProcessTlds - The new valuepublic boolean getProcessTlds()
public boolean isStateManageable()
@Deprecated public void startRecursive() throws LifecycleException
LifecycleExceptionpublic String getServer()
public String[] getJavaVMs()
public long getStartTime()
@Deprecated public boolean isEventProvider()
@Deprecated public boolean isStatisticsProvider()
Copyright © 2000-2020 Apache Software Foundation. All Rights Reserved.