/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.catalina;
import java.net.URL;
import java.util.Locale;
import java.util.Map;
import java.util.Set;
import jakarta.servlet.ServletContainerInitializer;
import jakarta.servlet.ServletContext;
import jakarta.servlet.ServletRegistration;
import jakarta.servlet.ServletRequest;
import jakarta.servlet.ServletSecurityElement;
import jakarta.servlet.descriptor.JspConfigDescriptor;
import org.apache.catalina.deploy.NamingResourcesImpl;
import org.apache.tomcat.ContextBind;
import org.apache.tomcat.InstanceManager;
import org.apache.tomcat.JarScanner;
import org.apache.tomcat.util.descriptor.web.ApplicationParameter;
import org.apache.tomcat.util.descriptor.web.ErrorPage;
import org.apache.tomcat.util.descriptor.web.FilterDef;
import org.apache.tomcat.util.descriptor.web.FilterMap;
import org.apache.tomcat.util.descriptor.web.LoginConfig;
import org.apache.tomcat.util.descriptor.web.SecurityConstraint;
import org.apache.tomcat.util.http.CookieProcessor;
A Context is a Container that represents a servlet context, and
therefore an individual web application, in the Catalina servlet engine.
It is therefore useful in almost every deployment of Catalina (even if a
Connector attached to a web server (such as Apache) uses the web server's
facilities to identify the appropriate Wrapper to handle this request.
It also provides a convenient mechanism to use Interceptors that see
every request processed by this particular web application.
The parent Container attached to a Context is generally a Host, but may
be some other implementation, or may be omitted if it is not necessary.
The child containers attached to a Context are generally implementations
of Wrapper (representing individual servlet definitions).
Author: Craig R. McClanahan
/**
* A <b>Context</b> is a Container that represents a servlet context, and
* therefore an individual web application, in the Catalina servlet engine.
* It is therefore useful in almost every deployment of Catalina (even if a
* Connector attached to a web server (such as Apache) uses the web server's
* facilities to identify the appropriate Wrapper to handle this request.
* It also provides a convenient mechanism to use Interceptors that see
* every request processed by this particular web application.
* <p>
* The parent Container attached to a Context is generally a Host, but may
* be some other implementation, or may be omitted if it is not necessary.
* <p>
* The child containers attached to a Context are generally implementations
* of Wrapper (representing individual servlet definitions).
* <p>
*
* @author Craig R. McClanahan
*/
public interface Context extends Container, ContextBind {
// ----------------------------------------------------- Manifest Constants
Container event for adding a welcome file.
/**
* Container event for adding a welcome file.
*/
public static final String ADD_WELCOME_FILE_EVENT = "addWelcomeFile";
Container event for removing a wrapper.
/**
* Container event for removing a wrapper.
*/
public static final String REMOVE_WELCOME_FILE_EVENT = "removeWelcomeFile";
Container event for clearing welcome files.
/**
* Container event for clearing welcome files.
*/
public static final String CLEAR_WELCOME_FILES_EVENT = "clearWelcomeFiles";
Container event for changing the ID of a session.
/**
* Container event for changing the ID of a session.
*/
public static final String CHANGE_SESSION_ID_EVENT = "changeSessionId";
// ------------------------------------------------------------- Properties
Returns true
if requests mapped to servlets without
"multipart config" to parse multipart/form-data requests anyway.
Returns: true
if requests mapped to servlets without
"multipart config" to parse multipart/form-data requests,
false
otherwise.
/**
* Returns <code>true</code> if requests mapped to servlets without
* "multipart config" to parse multipart/form-data requests anyway.
*
* @return <code>true</code> if requests mapped to servlets without
* "multipart config" to parse multipart/form-data requests,
* <code>false</code> otherwise.
*/
public boolean getAllowCasualMultipartParsing();
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.
Params: - allowCasualMultipartParsing –
true
to allow such
casual parsing, false
otherwise.
/**
* Set to <code>true</code> 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.
*
* @param allowCasualMultipartParsing <code>true</code> to allow such
* casual parsing, <code>false</code> otherwise.
*/
public void setAllowCasualMultipartParsing(boolean allowCasualMultipartParsing);
Obtain the registered application event listeners.
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
/**
* Obtain the registered application event listeners.
*
* @return An array containing the application event listener instances for
* this web application in the order they were specified in the web
* application deployment descriptor
*/
public Object[] getApplicationEventListeners();
Store the set of initialized application event listener objects,
in the order they were specified in the web application deployment
descriptor, for this application.
Params: - listeners – The set of instantiated listener objects.
/**
* Store the set of initialized application event listener objects,
* in the order they were specified in the web application deployment
* descriptor, for this application.
*
* @param listeners The set of instantiated listener objects.
*/
public void setApplicationEventListeners(Object listeners[]);
Obtain the registered application lifecycle listeners.
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
/**
* Obtain the registered application lifecycle listeners.
*
* @return An array containing the application lifecycle listener instances
* for this web application in the order they were specified in the
* web application deployment descriptor
*/
public Object[] getApplicationLifecycleListeners();
Store the set of initialized application lifecycle listener objects,
in the order they were specified in the web application deployment
descriptor, for this application.
Params: - listeners – The set of instantiated listener objects.
/**
* Store the set of initialized application lifecycle listener objects,
* in the order they were specified in the web application deployment
* descriptor, for this application.
*
* @param listeners The set of instantiated listener objects.
*/
public void setApplicationLifecycleListeners(Object listeners[]);
Obtain the character set name to use with the given Locale. Note that
different Contexts may have different mappings of Locale to character
set.
Params: - 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
/**
* Obtain the character set name to use with the given Locale. Note that
* different Contexts may have different mappings of Locale to character
* set.
*
* @param locale The locale for which the mapped character set should be
* returned
*
* @return The name of the character set to use with the given Locale
*/
public String getCharset(Locale locale);
Return the URL of the XML descriptor for this context.
Returns: The URL of the XML descriptor for this context
/**
* Return the URL of the XML descriptor for this context.
*
* @return The URL of the XML descriptor for this context
*/
public URL getConfigFile();
Set the URL of the XML descriptor for this context.
Params: - configFile – The URL of the XML descriptor for this context.
/**
* Set the URL of the XML descriptor for this context.
*
* @param configFile The URL of the XML descriptor for this context.
*/
public void setConfigFile(URL configFile);
Return the "correctly configured" flag for this Context.
Returns: true
if the Context has been correctly configured,
otherwise false
/**
* Return the "correctly configured" flag for this Context.
*
* @return <code>true</code> if the Context has been correctly configured,
* otherwise <code>false</code>
*/
public boolean getConfigured();
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.
Params: - configured – The new correctly configured flag
/**
* 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.
*
* @param configured The new correctly configured flag
*/
public void setConfigured(boolean configured);
Return the "use cookies for session ids" flag.
Returns: true
if it is permitted to use cookies to track
session IDs for this web application, otherwise
false
/**
* Return the "use cookies for session ids" flag.
*
* @return <code>true</code> if it is permitted to use cookies to track
* session IDs for this web application, otherwise
* <code>false</code>
*/
public boolean getCookies();
Set the "use cookies for session ids" flag.
Params: - cookies – The new flag
/**
* Set the "use cookies for session ids" flag.
*
* @param cookies The new flag
*/
public void setCookies(boolean cookies);
Gets the name to use for session cookies. Overrides any setting that
may be specified by the application.
Returns: The value of the default session cookie name or null if not
specified
/**
* Gets the name to use for session cookies. Overrides any setting that
* may be specified by the application.
*
* @return The value of the default session cookie name or null if not
* specified
*/
public String getSessionCookieName();
Sets the name to use for session cookies. Overrides any setting that
may be specified by the application.
Params: - sessionCookieName – The name to use
/**
* Sets the name to use for session cookies. Overrides any setting that
* may be specified by the application.
*
* @param sessionCookieName The name to use
*/
public void setSessionCookieName(String sessionCookieName);
Gets the value of the use HttpOnly cookies for session cookies flag.
Returns: true
if the HttpOnly flag should be set on session
cookies
/**
* Gets the value of the use HttpOnly cookies for session cookies flag.
*
* @return <code>true</code> if the HttpOnly flag should be set on session
* cookies
*/
public boolean getUseHttpOnly();
Sets the use HttpOnly cookies for session cookies flag.
Params: - useHttpOnly – Set to
true
to use HttpOnly cookies
for session cookies
/**
* Sets the use HttpOnly cookies for session cookies flag.
*
* @param useHttpOnly Set to <code>true</code> to use HttpOnly cookies
* for session cookies
*/
public void setUseHttpOnly(boolean useHttpOnly);
Gets the domain to use for session cookies. Overrides any setting that
may be specified by the application.
Returns: The value of the default session cookie domain or null if not
specified
/**
* Gets the domain to use for session cookies. Overrides any setting that
* may be specified by the application.
*
* @return The value of the default session cookie domain or null if not
* specified
*/
public String getSessionCookieDomain();
Sets the domain to use for session cookies. Overrides any setting that
may be specified by the application.
Params: - sessionCookieDomain – The domain to use
/**
* Sets the domain to use for session cookies. Overrides any setting that
* may be specified by the application.
*
* @param sessionCookieDomain The domain to use
*/
public void setSessionCookieDomain(String sessionCookieDomain);
Gets the path to use for session cookies. Overrides any setting that
may be specified by the application.
Returns: The value of the default session cookie path or null if not
specified
/**
* Gets the path to use for session cookies. Overrides any setting that
* may be specified by the application.
*
* @return The value of the default session cookie path or null if not
* specified
*/
public String getSessionCookiePath();
Sets the path to use for session cookies. Overrides any setting that
may be specified by the application.
Params: - sessionCookiePath – The path to use
/**
* Sets the path to use for session cookies. Overrides any setting that
* may be specified by the application.
*
* @param sessionCookiePath The path to use
*/
public void setSessionCookiePath(String sessionCookiePath);
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.
Returns: true
if the slash is added, otherwise
false
/**
* 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.
*
* @return <code>true</code> if the slash is added, otherwise
* <code>false</code>
*/
public boolean getSessionCookiePathUsesTrailingSlash();
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.
Params: - sessionCookiePathUsesTrailingSlash –
true
if the
slash is should be added,
otherwise false
/**
* 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.
*
* @param sessionCookiePathUsesTrailingSlash <code>true</code> if the
* slash is should be added,
* otherwise <code>false</code>
*/
public void setSessionCookiePathUsesTrailingSlash(
boolean sessionCookiePathUsesTrailingSlash);
Return the "allow crossing servlet contexts" flag.
Returns: true
if cross-contest requests are allowed from this
web applications, otherwise false
/**
* Return the "allow crossing servlet contexts" flag.
*
* @return <code>true</code> if cross-contest requests are allowed from this
* web applications, otherwise <code>false</code>
*/
public boolean getCrossContext();
Return the alternate Deployment Descriptor name.
Returns: the name
/**
* Return the alternate Deployment Descriptor name.
*
* @return the name
*/
public String getAltDDName();
Set an alternate Deployment Descriptor name.
Params: - altDDName – The new name
/**
* Set an alternate Deployment Descriptor name.
*
* @param altDDName The new name
*/
public void setAltDDName(String altDDName) ;
Set the "allow crossing servlet contexts" flag.
Params: - crossContext – The new cross contexts flag
/**
* Set the "allow crossing servlet contexts" flag.
*
* @param crossContext The new cross contexts flag
*/
public void setCrossContext(boolean crossContext);
Return the deny-uncovered-http-methods flag for this web application.
Returns: The current value of the flag
/**
* Return the deny-uncovered-http-methods flag for this web application.
*
* @return The current value of the flag
*/
public boolean getDenyUncoveredHttpMethods();
Set the deny-uncovered-http-methods flag for this web application.
Params: - denyUncoveredHttpMethods – The new deny-uncovered-http-methods flag
/**
* Set the deny-uncovered-http-methods flag for this web application.
*
* @param denyUncoveredHttpMethods The new deny-uncovered-http-methods flag
*/
public void setDenyUncoveredHttpMethods(boolean denyUncoveredHttpMethods);
Return the display name of this web application.
Returns: The display name
/**
* Return the display name of this web application.
*
* @return The display name
*/
public String getDisplayName();
Set the display name of this web application.
Params: - displayName – The new display name
/**
* Set the display name of this web application.
*
* @param displayName The new display name
*/
public void setDisplayName(String displayName);
Get the distributable flag for this web application.
Returns: The value of the distributable flag for this web application.
/**
* Get the distributable flag for this web application.
*
* @return The value of the distributable flag for this web application.
*/
public boolean getDistributable();
Set the distributable flag for this web application.
Params: - distributable – The new distributable flag
/**
* Set the distributable flag for this web application.
*
* @param distributable The new distributable flag
*/
public void setDistributable(boolean distributable);
Obtain the document root for this Context.
Returns: An absolute pathname or a relative (to the Host's appBase)
pathname.
/**
* Obtain the document root for this Context.
*
* @return An absolute pathname or a relative (to the Host's appBase)
* pathname.
*/
public String getDocBase();
Set 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.
Params: - docBase – The new document root
/**
* Set 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.
*
* @param docBase The new document root
*/
public void setDocBase(String docBase);
Return the URL encoded context path
Returns: The URL encoded (with UTF-8) context path
/**
* Return the URL encoded context path
*
* @return The URL encoded (with UTF-8) context path
*/
public String getEncodedPath();
Determine if annotations parsing is currently disabled
Returns: true
if annotation parsing is disabled for this web application
/**
* Determine if annotations parsing is currently disabled
*
* @return {@code true} if annotation parsing is disabled for this web
* application
*/
public boolean getIgnoreAnnotations();
Set the boolean on the annotations parsing for this web
application.
Params: - ignoreAnnotations – The boolean on the annotations parsing
/**
* Set the boolean on the annotations parsing for this web
* application.
*
* @param ignoreAnnotations The boolean on the annotations parsing
*/
public void setIgnoreAnnotations(boolean ignoreAnnotations);
Returns: the login configuration descriptor for this web application.
/**
* @return the login configuration descriptor for this web application.
*/
public LoginConfig getLoginConfig();
Set the login configuration descriptor for this web application.
Params: - config – The new login configuration
/**
* Set the login configuration descriptor for this web application.
*
* @param config The new login configuration
*/
public void setLoginConfig(LoginConfig config);
Returns: the naming resources associated with this web application.
/**
* @return the naming resources associated with this web application.
*/
public NamingResourcesImpl getNamingResources();
Set the naming resources for this web application.
Params: - namingResources – The new naming resources
/**
* Set the naming resources for this web application.
*
* @param namingResources The new naming resources
*/
public void setNamingResources(NamingResourcesImpl namingResources);
Returns: the context path for this web application.
/**
* @return the context path for this web application.
*/
public String getPath();
Set the context path for this web application.
Params: - path – The new context path
/**
* Set the context path for this web application.
*
* @param path The new context path
*/
public void setPath(String path);
Returns: the public identifier of the deployment descriptor DTD that is
currently being parsed.
/**
* @return the public identifier of the deployment descriptor DTD that is
* currently being parsed.
*/
public String getPublicId();
Set the public identifier of the deployment descriptor DTD that is
currently being parsed.
Params: - publicId – The public identifier
/**
* Set the public identifier of the deployment descriptor DTD that is
* currently being parsed.
*
* @param publicId The public identifier
*/
public void setPublicId(String publicId);
Returns: the reloadable flag for this web application.
/**
* @return the reloadable flag for this web application.
*/
public boolean getReloadable();
Set the reloadable flag for this web application.
Params: - reloadable – The new reloadable flag
/**
* Set the reloadable flag for this web application.
*
* @param reloadable The new reloadable flag
*/
public void setReloadable(boolean reloadable);
Returns: the override flag for this web application.
/**
* @return the override flag for this web application.
*/
public boolean getOverride();
Set the override flag for this web application.
Params: - override – The new override flag
/**
* Set the override flag for this web application.
*
* @param override The new override flag
*/
public void setOverride(boolean override);
Returns: the privileged flag for this web application.
/**
* @return the privileged flag for this web application.
*/
public boolean getPrivileged();
Set the privileged flag for this web application.
Params: - privileged – The new privileged flag
/**
* Set the privileged flag for this web application.
*
* @param privileged The new privileged flag
*/
public void setPrivileged(boolean privileged);
Returns: the Servlet context for which this Context is a facade.
/**
* @return the Servlet context for which this Context is a facade.
*/
public ServletContext getServletContext();
Returns: the default session timeout (in minutes) for this
web application.
/**
* @return the default session timeout (in minutes) for this
* web application.
*/
public int getSessionTimeout();
Set the default session timeout (in minutes) for this
web application.
Params: - timeout – The new default session timeout
/**
* Set the default session timeout (in minutes) for this
* web application.
*
* @param timeout The new default session timeout
*/
public void setSessionTimeout(int timeout);
Returns true
if remaining request data will be read
(swallowed) even the request violates a data size constraint.
Returns: true
if data will be swallowed (default),
false
otherwise.
/**
* Returns <code>true</code> if remaining request data will be read
* (swallowed) even the request violates a data size constraint.
*
* @return <code>true</code> if data will be swallowed (default),
* <code>false</code> otherwise.
*/
public boolean getSwallowAbortedUploads();
Set to false
to disable request data swallowing
after an upload was aborted due to size constraints.
Params: - swallowAbortedUploads –
false
to disable
swallowing, true
otherwise (default).
/**
* Set to <code>false</code> to disable request data swallowing
* after an upload was aborted due to size constraints.
*
* @param swallowAbortedUploads <code>false</code> to disable
* swallowing, <code>true</code> otherwise (default).
*/
public void setSwallowAbortedUploads(boolean swallowAbortedUploads);
Returns: the value of the swallowOutput flag.
/**
* @return the value of the swallowOutput flag.
*/
public boolean getSwallowOutput();
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.
Params: - swallowOutput – The new value
/**
* 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.
*
* @param swallowOutput The new value
*/
public void setSwallowOutput(boolean swallowOutput);
Returns: the Java class name of the Wrapper implementation used
for servlets registered in this Context.
/**
* @return the Java class name of the Wrapper implementation used
* for servlets registered in this Context.
*/
public String getWrapperClass();
Set the Java class name of the Wrapper implementation used
for servlets registered in this Context.
Params: - wrapperClass – The new wrapper class
/**
* Set the Java class name of the Wrapper implementation used
* for servlets registered in this Context.
*
* @param wrapperClass The new wrapper class
*/
public void setWrapperClass(String wrapperClass);
Will the parsing of web.xml and web-fragment.xml files for this Context
be performed by a namespace aware parser?
Returns: true if namespace awareness is enabled.
/**
* Will the parsing of web.xml and web-fragment.xml files for this Context
* be performed by a namespace aware parser?
*
* @return true if namespace awareness is enabled.
*/
public boolean getXmlNamespaceAware();
Controls whether the parsing of web.xml and web-fragment.xml files for
this Context will be performed by a namespace aware parser.
Params: - xmlNamespaceAware – true to enable namespace awareness
/**
* Controls whether the parsing of web.xml and web-fragment.xml files for
* this Context will be performed by a namespace aware parser.
*
* @param xmlNamespaceAware true to enable namespace awareness
*/
public void setXmlNamespaceAware(boolean xmlNamespaceAware);
Will the parsing of web.xml and web-fragment.xml files for this Context
be performed by a validating parser?
Returns: true if validation is enabled.
/**
* Will the parsing of web.xml and web-fragment.xml files for this Context
* be performed by a validating parser?
*
* @return true if validation is enabled.
*/
public boolean getXmlValidation();
Controls whether the parsing of web.xml and web-fragment.xml files
for this Context will be performed by a validating parser.
Params: - xmlValidation – true to enable xml validation
/**
* Controls whether the parsing of web.xml and web-fragment.xml files
* for this Context will be performed by a validating parser.
*
* @param xmlValidation true to enable xml validation
*/
public void setXmlValidation(boolean xmlValidation);
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?
Returns: true if access to external entities is blocked
/**
* 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?
*
* @return true if access to external entities is blocked
*/
public boolean getXmlBlockExternal();
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.
Params: - xmlBlockExternal – true to block external entities
/**
* 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.
*
* @param xmlBlockExternal true to block external entities
*/
public void setXmlBlockExternal(boolean xmlBlockExternal);
Will the parsing of *.tld files for this Context be performed by a
validating parser?
Returns: true if validation is enabled.
/**
* Will the parsing of *.tld files for this Context be performed by a
* validating parser?
*
* @return true if validation is enabled.
*/
public boolean getTldValidation();
Controls whether the parsing of *.tld files for this Context will be
performed by a validating parser.
Params: - tldValidation – true to enable xml validation
/**
* Controls whether the parsing of *.tld files for this Context will be
* performed by a validating parser.
*
* @param tldValidation true to enable xml validation
*/
public void setTldValidation(boolean tldValidation);
Get the Jar Scanner to be used to scan for JAR resources for this
context.
Returns: The Jar Scanner configured for this context.
/**
* Get the Jar Scanner to be used to scan for JAR resources for this
* context.
* @return The Jar Scanner configured for this context.
*/
public JarScanner getJarScanner();
Set the Jar Scanner to be used to scan for JAR resources for this
context.
Params: - jarScanner – The Jar Scanner to be used for this context.
/**
* Set the Jar Scanner to be used to scan for JAR resources for this
* context.
* @param jarScanner The Jar Scanner to be used for this context.
*/
public void setJarScanner(JarScanner jarScanner);
Returns: the Authenticator
that is used by this context. This is always non-null
for a started Context
/**
* @return the {@link Authenticator} that is used by this context. This is
* always non-{@code null} for a started Context
*/
public Authenticator getAuthenticator();
Set whether or not the effective web.xml for this context should be
logged on context start.
Params: - logEffectiveWebXml – set to
true
to log the complete
web.xml that will be used for the webapp
/**
* Set whether or not the effective web.xml for this context should be
* logged on context start.
*
* @param logEffectiveWebXml set to <code>true</code> to log the complete
* web.xml that will be used for the webapp
*/
public void setLogEffectiveWebXml(boolean logEffectiveWebXml);
Should the effective web.xml for this context be logged on context start?
Returns: true if the reconstructed web.xml that will be used for the
webapp should be logged
/**
* Should the effective web.xml for this context be logged on context start?
*
* @return true if the reconstructed web.xml that will be used for the
* webapp should be logged
*/
public boolean getLogEffectiveWebXml();
Returns: the instance manager associated with this context.
/**
* @return the instance manager associated with this context.
*/
public InstanceManager getInstanceManager();
Set the instance manager associated with this context.
Params: - instanceManager – the new instance manager instance
/**
* Set the instance manager associated with this context.
*
* @param instanceManager the new instance manager instance
*/
public void setInstanceManager(InstanceManager instanceManager);
Sets the regular expression that specifies which container provided SCIs should be filtered out and not used for this context. Matching uses Matcher.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. Params: - containerSciFilter – The regular expression against which the fully
qualified class name of each container provided
SCI should be checked
/**
* Sets the regular expression that specifies which container provided SCIs
* should be filtered out and not used for this context. Matching uses
* {@link java.util.regex.Matcher#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.
*
* @param containerSciFilter The regular expression against which the fully
* qualified class name of each container provided
* SCI should be checked
*/
public void setContainerSciFilter(String containerSciFilter);
Obtains the regular expression that specifies which container provided SCIs should be filtered out and not used for this context. Matching uses Matcher.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. Returns: The regular expression against which the fully qualified class
name of each container provided SCI will be checked
/**
* Obtains the regular expression that specifies which container provided
* SCIs should be filtered out and not used for this context. Matching uses
* {@link java.util.regex.Matcher#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.
*
* @return The regular expression against which the fully qualified class
* name of each container provided SCI will be checked
*/
public String getContainerSciFilter();
Returns: the value of the parallel annotation scanning flag. If true,
it will dispatch scanning to the utility executor.
/**
* @return the value of the parallel annotation scanning flag. If true,
* it will dispatch scanning to the utility executor.
*/
public boolean isParallelAnnotationScanning();
Set the parallel annotation scanning value.
Params: - parallelAnnotationScanning – new parallel annotation scanning flag
/**
* Set the parallel annotation scanning value.
*
* @param parallelAnnotationScanning new parallel annotation scanning flag
*/
public void setParallelAnnotationScanning(boolean parallelAnnotationScanning);
// --------------------------------------------------------- Public Methods
Add a new Listener class name to the set of Listeners
configured for this application.
Params: - listener – Java class name of a listener class
/**
* Add a new Listener class name to the set of Listeners
* configured for this application.
*
* @param listener Java class name of a listener class
*/
public void addApplicationListener(String listener);
Add a new application parameter for this application.
Params: - parameter – The new application parameter
/**
* Add a new application parameter for this application.
*
* @param parameter The new application parameter
*/
public void addApplicationParameter(ApplicationParameter parameter);
Add a security constraint to the set for this web application.
Params: - constraint – The security constraint that should be added
/**
* Add a security constraint to the set for this web application.
*
* @param constraint The security constraint that should be added
*/
public void addConstraint(SecurityConstraint constraint);
Add an error page for the specified error or Java exception.
Params: - errorPage – The error page definition to be added
/**
* Add an error page for the specified error or Java exception.
*
* @param errorPage The error page definition to be added
*/
public void addErrorPage(ErrorPage errorPage);
Add a filter definition to this Context.
Params: - filterDef – The filter definition to be added
/**
* Add a filter definition to this Context.
*
* @param filterDef The filter definition to be added
*/
public void addFilterDef(FilterDef filterDef);
Add a filter mapping to this Context.
Params: - filterMap – The filter mapping to be added
/**
* Add a filter mapping to this Context.
*
* @param filterMap The filter mapping to be added
*/
public void addFilterMap(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.
Params: - 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
/**
* Add a filter mapping to this Context before the mappings defined in the
* deployment descriptor but after any other mappings added via this method.
*
* @param filterMap The filter mapping to be added
*
* @exception IllegalArgumentException if the specified filter name
* does not match an existing filter definition, or the filter mapping
* is malformed
*/
public void addFilterMapBefore(FilterMap filterMap);
Add a Locale Encoding Mapping (see Sec 5.4 of Servlet spec 2.4)
Params: - locale – locale to map an encoding for
- encoding – encoding to be used for a give locale
/**
* Add a Locale Encoding Mapping (see Sec 5.4 of Servlet spec 2.4)
*
* @param locale locale to map an encoding for
* @param encoding encoding to be used for a give locale
*/
public void addLocaleEncodingMappingParameter(String locale, String encoding);
Add a new MIME mapping, replacing any existing mapping for
the specified extension.
Params: - extension – Filename extension being mapped
- mimeType – Corresponding MIME type
/**
* Add a new MIME mapping, replacing any existing mapping for
* the specified extension.
*
* @param extension Filename extension being mapped
* @param mimeType Corresponding MIME type
*/
public void addMimeMapping(String extension, String mimeType);
Add a new context initialization parameter, replacing any existing
value for the specified name.
Params: - name – Name of the new parameter
- value – Value of the new parameter
/**
* Add a new context initialization parameter, replacing any existing
* value for the specified name.
*
* @param name Name of the new parameter
* @param value Value of the new parameter
*/
public void addParameter(String name, String value);
Add a security role reference for this web application.
Params: - role – Security role used in the application
- link – Actual security role to check for
/**
* Add a security role reference for this web application.
*
* @param role Security role used in the application
* @param link Actual security role to check for
*/
public void addRoleMapping(String role, String link);
Add a new security role for this web application.
Params: - role – New security role
/**
* Add a new security role for this web application.
*
* @param role New security role
*/
public void addSecurityRole(String role);
Add a new servlet mapping, replacing any existing mapping for
the specified pattern.
Params: - pattern – URL pattern to be mapped
- name – Name of the corresponding servlet to execute
/**
* Add a new servlet mapping, replacing any existing mapping for
* the specified pattern.
*
* @param pattern URL pattern to be mapped
* @param name Name of the corresponding servlet to execute
*/
public default void addServletMappingDecoded(String pattern, String name) {
addServletMappingDecoded(pattern, name, false);
}
Add a new servlet mapping, replacing any existing mapping for
the specified pattern.
Params: - pattern – URL pattern to be mapped
- name – Name of the corresponding servlet to execute
- jspWildcard – true if name identifies the JspServlet
and pattern contains a wildcard; false otherwise
/**
* Add a new servlet mapping, replacing any existing mapping for
* the specified pattern.
*
* @param pattern URL pattern to be mapped
* @param name Name of the corresponding servlet to execute
* @param jspWildcard true if name identifies the JspServlet
* and pattern contains a wildcard; false otherwise
*/
public void addServletMappingDecoded(String pattern, String name,
boolean jspWildcard);
Add a resource which will be watched for reloading by the host auto
deployer. Note: this will not be used in embedded mode.
Params: - name – Path to the resource, relative to docBase
/**
* Add a resource which will be watched for reloading by the host auto
* deployer. Note: this will not be used in embedded mode.
*
* @param name Path to the resource, relative to docBase
*/
public void addWatchedResource(String name);
Add a new welcome file to the set recognized by this Context.
Params: - name – New welcome file name
/**
* Add a new welcome file to the set recognized by this Context.
*
* @param name New welcome file name
*/
public void addWelcomeFile(String name);
Add the classname of a LifecycleListener to be added to each
Wrapper appended to this Context.
Params: - listener – Java class name of a LifecycleListener class
/**
* Add the classname of a LifecycleListener to be added to each
* Wrapper appended to this Context.
*
* @param listener Java class name of a LifecycleListener class
*/
public void addWrapperLifecycle(String listener);
Add the classname of a ContainerListener to be added to each
Wrapper appended to this Context.
Params: - listener – Java class name of a ContainerListener class
/**
* Add the classname of a ContainerListener to be added to each
* Wrapper appended to this Context.
*
* @param listener Java class name of a ContainerListener class
*/
public void addWrapperListener(String listener);
Factory method to create and return a new InstanceManager
instance. This can be used for framework integration or easier
configuration with custom Context implementations.
Returns: the instance manager
/**
* Factory method to create and return a new InstanceManager
* instance. This can be used for framework integration or easier
* configuration with custom Context implementations.
* @return the instance manager
*/
public InstanceManager createInstanceManager();
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.
Returns: a newly created wrapper instance that is used to wrap a Servlet
/**
* 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.
*
* @return a newly created wrapper instance that is used to wrap a Servlet
*/
public Wrapper createWrapper();
Returns: the set of application listener class names configured
for this application.
/**
* @return the set of application listener class names configured
* for this application.
*/
public String[] findApplicationListeners();
Returns: the set of application parameters for this application.
/**
* @return the set of application parameters for this application.
*/
public ApplicationParameter[] findApplicationParameters();
Returns: the set of security constraints for this web application.
If there are none, a zero-length array is returned.
/**
* @return the set of security constraints for this web application.
* If there are none, a zero-length array is returned.
*/
public SecurityConstraint[] findConstraints();
Params: - errorCode – Error code to look up
Returns: the error page entry for the specified HTTP error code,
if any; otherwise return null
.
/**
* @return the error page entry for the specified HTTP error code,
* if any; otherwise return <code>null</code>.
*
* @param errorCode Error code to look up
*/
public ErrorPage findErrorPage(int errorCode);
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. If no associated ErrorPage instance is
found, return null
.
Params: - throwable – The exception type for which to find an ErrorPage
Returns: the error page entry for the specified Java exception type, if any; otherwise return null
.
/**
* 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. If no associated ErrorPage instance is
* found, return <code>null</code>.
*
* @param throwable The exception type for which to find an ErrorPage
*
* @return the error page entry for the specified Java exception type,
* if any; otherwise return {@code null}.
*/
public ErrorPage findErrorPage(Throwable throwable);
Returns: the set of defined error pages for all specified error codes
and exception types.
/**
* @return the set of defined error pages for all specified error codes
* and exception types.
*/
public ErrorPage[] findErrorPages();
Params: - filterName – Filter name to look up
Returns: the filter definition for the specified filter name, if any;
otherwise return null
.
/**
* @return the filter definition for the specified filter name, if any;
* otherwise return <code>null</code>.
*
* @param filterName Filter name to look up
*/
public FilterDef findFilterDef(String filterName);
Returns: the set of defined filters for this Context.
/**
* @return the set of defined filters for this Context.
*/
public FilterDef[] findFilterDefs();
Returns: the set of filter mappings for this Context.
/**
* @return the set of filter mappings for this Context.
*/
public FilterMap[] findFilterMaps();
Params: - extension – Extension to map to a MIME type
Returns: the MIME type to which the specified extension is mapped,
if any; otherwise return null
.
/**
* @return the MIME type to which the specified extension is mapped,
* if any; otherwise return <code>null</code>.
*
* @param extension Extension to map to a MIME type
*/
public String findMimeMapping(String extension);
Returns: the extensions for which MIME mappings are defined. If there
are none, a zero-length array is returned.
/**
* @return the extensions for which MIME mappings are defined. If there
* are none, a zero-length array is returned.
*/
public String[] findMimeMappings();
Params: - name – Name of the parameter to return
Returns: the value for the specified context initialization
parameter name, if any; otherwise return null
.
/**
* @return the value for the specified context initialization
* parameter name, if any; otherwise return <code>null</code>.
*
* @param name Name of the parameter to return
*/
public String findParameter(String name);
Returns: the names of all defined context initialization parameters
for this Context. If no parameters are defined, a zero-length
array is returned.
/**
* @return the names of all defined context initialization parameters
* for this Context. If no parameters are defined, a zero-length
* array is returned.
*/
public String[] findParameters();
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.
Params: - role – Security role to map
Returns: The role name that was mapped to the specified 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.
*
* @param role Security role to map
* @return The role name that was mapped to the specified role
*/
public String findRoleMapping(String role);
Params: - role – Security role to verify
Returns: true
if the specified security role is defined
for this application; otherwise return false
.
/**
* @return <code>true</code> if the specified security role is defined
* for this application; otherwise return <code>false</code>.
*
* @param role Security role to verify
*/
public boolean findSecurityRole(String role);
Returns: the security roles defined for this application. If none
have been defined, a zero-length array is returned.
/**
* @return the security roles defined for this application. If none
* have been defined, a zero-length array is returned.
*/
public String[] findSecurityRoles();
Params: - pattern – Pattern for which a mapping is requested
Returns: the servlet name mapped by the specified pattern (if any);
otherwise return null
.
/**
* @return the servlet name mapped by the specified pattern (if any);
* otherwise return <code>null</code>.
*
* @param pattern Pattern for which a mapping is requested
*/
public String findServletMapping(String pattern);
Returns: the patterns of all defined servlet mappings for this
Context. If no mappings are defined, a zero-length array is returned.
/**
* @return the patterns of all defined servlet mappings for this
* Context. If no mappings are defined, a zero-length array is returned.
*/
public String[] findServletMappings();
Returns: the associated ThreadBindingListener.
/**
* @return the associated ThreadBindingListener.
*/
public ThreadBindingListener getThreadBindingListener();
Get the associated ThreadBindingListener.
Params: - threadBindingListener – Set the listener that will receive
notifications when entering and exiting the application scope
/**
* Get the associated ThreadBindingListener.
*
* @param threadBindingListener Set the listener that will receive
* notifications when entering and exiting the application scope
*/
public void setThreadBindingListener(ThreadBindingListener threadBindingListener);
Returns: the set of watched resources for this Context. If none are
defined, a zero length array will be returned.
/**
* @return the set of watched resources for this Context. If none are
* defined, a zero length array will be returned.
*/
public String[] findWatchedResources();
Params: - name – Welcome file to verify
Returns: true
if the specified welcome file is defined
for this Context; otherwise return false
.
/**
* @return <code>true</code> if the specified welcome file is defined
* for this Context; otherwise return <code>false</code>.
*
* @param name Welcome file to verify
*/
public boolean findWelcomeFile(String name);
Returns: the set of welcome files defined for this Context. If none are
defined, a zero-length array is returned.
/**
* @return the set of welcome files defined for this Context. If none are
* defined, a zero-length array is returned.
*/
public String[] findWelcomeFiles();
Returns: the set of LifecycleListener classes that will be added to
newly created Wrappers automatically.
/**
* @return the set of LifecycleListener classes that will be added to
* newly created Wrappers automatically.
*/
public String[] findWrapperLifecycles();
Returns: the set of ContainerListener classes that will be added to
newly created Wrappers automatically.
/**
* @return the set of ContainerListener classes that will be added to
* newly created Wrappers automatically.
*/
public String[] findWrapperListeners();
Notify all ServletRequestListener
s that a request has started. Params: - request – The request object that will be passed to the listener
Returns: true
if the listeners fire successfully, else
false
/**
* Notify all {@link jakarta.servlet.ServletRequestListener}s that a request
* has started.
*
* @param request The request object that will be passed to the listener
* @return <code>true</code> if the listeners fire successfully, else
* <code>false</code>
*/
public boolean fireRequestInitEvent(ServletRequest request);
Notify all ServletRequestListener
s that a request has ended. Params: - request – The request object that will be passed to the listener
Returns: true
if the listeners fire successfully, else
false
/**
* Notify all {@link jakarta.servlet.ServletRequestListener}s that a request
* has ended.
*
* @param request The request object that will be passed to the listener
* @return <code>true</code> if the listeners fire successfully, else
* <code>false</code>
*/
public boolean fireRequestDestroyEvent(ServletRequest request);
Reload this web application, if reloading is supported.
Throws: - IllegalStateException – if the
reloadable
property is set to false
.
/**
* Reload this web application, if reloading is supported.
*
* @exception IllegalStateException if the <code>reloadable</code>
* property is set to <code>false</code>.
*/
public void reload();
Remove the specified application listener class from the set of
listeners for this application.
Params: - listener – Java class name of the listener to be removed
/**
* Remove the specified application listener class from the set of
* listeners for this application.
*
* @param listener Java class name of the listener to be removed
*/
public void removeApplicationListener(String listener);
Remove the application parameter with the specified name from
the set for this application.
Params: - name – Name of the application parameter to remove
/**
* Remove the application parameter with the specified name from
* the set for this application.
*
* @param name Name of the application parameter to remove
*/
public void removeApplicationParameter(String name);
Remove the specified security constraint from this web application.
Params: - constraint – Constraint to be removed
/**
* Remove the specified security constraint from this web application.
*
* @param constraint Constraint to be removed
*/
public void removeConstraint(SecurityConstraint constraint);
Remove the error page for the specified error code or
Java language exception, if it exists; otherwise, no action is taken.
Params: - errorPage – The error page definition to be removed
/**
* Remove the error page for the specified error code or
* Java language exception, if it exists; otherwise, no action is taken.
*
* @param errorPage The error page definition to be removed
*/
public void removeErrorPage(ErrorPage errorPage);
Remove the specified filter definition from this Context, if it exists;
otherwise, no action is taken.
Params: - filterDef – Filter definition to be removed
/**
* Remove the specified filter definition from this Context, if it exists;
* otherwise, no action is taken.
*
* @param filterDef Filter definition to be removed
*/
public void removeFilterDef(FilterDef filterDef);
Remove a filter mapping from this Context.
Params: - filterMap – The filter mapping to be removed
/**
* Remove a filter mapping from this Context.
*
* @param filterMap The filter mapping to be removed
*/
public void removeFilterMap(FilterMap filterMap);
Remove the MIME mapping for the specified extension, if it exists;
otherwise, no action is taken.
Params: - extension – Extension to remove the mapping for
/**
* Remove the MIME mapping for the specified extension, if it exists;
* otherwise, no action is taken.
*
* @param extension Extension to remove the mapping for
*/
public void removeMimeMapping(String extension);
Remove the context initialization parameter with the specified
name, if it exists; otherwise, no action is taken.
Params: - name – Name of the parameter to remove
/**
* Remove the context initialization parameter with the specified
* name, if it exists; otherwise, no action is taken.
*
* @param name Name of the parameter to remove
*/
public void removeParameter(String name);
Remove any security role reference for the specified name
Params: - role – Security role (as used in the application) to remove
/**
* Remove any security role reference for the specified name
*
* @param role Security role (as used in the application) to remove
*/
public void removeRoleMapping(String role);
Remove any security role with the specified name.
Params: - role – Security role to remove
/**
* Remove any security role with the specified name.
*
* @param role Security role to remove
*/
public void removeSecurityRole(String role);
Remove any servlet mapping for the specified pattern, if it exists;
otherwise, no action is taken.
Params: - pattern – URL pattern of the mapping to remove
/**
* Remove any servlet mapping for the specified pattern, if it exists;
* otherwise, no action is taken.
*
* @param pattern URL pattern of the mapping to remove
*/
public void removeServletMapping(String pattern);
Remove the specified watched resource name from the list associated
with this Context.
Params: - name – Name of the watched resource to be removed
/**
* Remove the specified watched resource name from the list associated
* with this Context.
*
* @param name Name of the watched resource to be removed
*/
public void removeWatchedResource(String name);
Remove the specified welcome file name from the list recognized
by this Context.
Params: - name – Name of the welcome file to be removed
/**
* Remove the specified welcome file name from the list recognized
* by this Context.
*
* @param name Name of the welcome file to be removed
*/
public void removeWelcomeFile(String name);
Remove a class name from the set of LifecycleListener classes that
will be added to newly created Wrappers.
Params: - listener – Class name of a LifecycleListener class to be removed
/**
* Remove a class name from the set of LifecycleListener classes that
* will be added to newly created Wrappers.
*
* @param listener Class name of a LifecycleListener class to be removed
*/
public void removeWrapperLifecycle(String listener);
Remove a class name from the set of ContainerListener classes that
will be added to newly created Wrappers.
Params: - listener – Class name of a ContainerListener class to be removed
/**
* Remove a class name from the set of ContainerListener classes that
* will be added to newly created Wrappers.
*
* @param listener Class name of a ContainerListener class to be removed
*/
public void removeWrapperListener(String listener);
Params: - path – The path to the desired resource
Returns: the real path for a given virtual path, if possible; otherwise
return null
.
/**
* @return the real path for a given virtual path, if possible; otherwise
* return <code>null</code>.
*
* @param path The path to the desired resource
*/
public String getRealPath(String path);
Returns: the effective major version of the Servlet spec used by this
context.
/**
* @return the effective major version of the Servlet spec used by this
* context.
*/
public int getEffectiveMajorVersion();
Set the effective major version of the Servlet spec used by this
context.
Params: - major – Set the version number
/**
* Set the effective major version of the Servlet spec used by this
* context.
*
* @param major Set the version number
*/
public void setEffectiveMajorVersion(int major);
Returns: the effective minor version of the Servlet spec used by this
context.
/**
* @return the effective minor version of the Servlet spec used by this
* context.
*/
public int getEffectiveMinorVersion();
Set the effective minor version of the Servlet spec used by this
context.
Params: - minor – Set the version number
/**
* Set the effective minor version of the Servlet spec used by this
* context.
*
* @param minor Set the version number
*/
public void setEffectiveMinorVersion(int minor);
Returns: the JSP configuration for this context.
Will be null if there is no JSP configuration.
/**
* @return the JSP configuration for this context.
* Will be null if there is no JSP configuration.
*/
public JspConfigDescriptor getJspConfigDescriptor();
Set the JspConfigDescriptor for this context.
A null value indicates there is not JSP configuration.
Params: - descriptor – the new JSP configuration
/**
* Set the JspConfigDescriptor for this context.
* A null value indicates there is not JSP configuration.
*
* @param descriptor the new JSP configuration
*/
public void setJspConfigDescriptor(JspConfigDescriptor descriptor);
Add a ServletContainerInitializer instance to this web application.
Params: - sci – The instance to add
- classes – The classes in which the initializer expressed an
interest
/**
* Add a ServletContainerInitializer instance to this web application.
*
* @param sci The instance to add
* @param classes The classes in which the initializer expressed an
* interest
*/
public void addServletContainerInitializer(
ServletContainerInitializer sci, Set<Class<?>> classes);
Is this Context paused whilst it is reloaded?
Returns: true
if the context has been paused
/**
* Is this Context paused whilst it is reloaded?
*
* @return <code>true</code> if the context has been paused
*/
public boolean getPaused();
Is this context using version 2.2 of the Servlet spec?
Returns: true
for a legacy Servlet 2.2 webapp
/**
* Is this context using version 2.2 of the Servlet spec?
*
* @return <code>true</code> for a legacy Servlet 2.2 webapp
*/
boolean isServlet22();
Notification that Servlet security has been dynamically set in a Dynamic
Params: - registration – Servlet security was modified for
- servletSecurityElement – new security constraints for this Servlet
Returns: urls currently mapped to this registration that are already
present in web.xml
/**
* Notification that Servlet security has been dynamically set in a
* {@link jakarta.servlet.ServletRegistration.Dynamic}
* @param registration Servlet security was modified for
* @param servletSecurityElement new security constraints for this Servlet
* @return urls currently mapped to this registration that are already
* present in web.xml
*/
Set<String> addServletSecurity(ServletRegistration.Dynamic registration,
ServletSecurityElement servletSecurityElement);
Sets 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.
Params: - resourceOnlyServlets – The Servlet names comma separated list
/**
* Sets 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.
*
* @param resourceOnlyServlets The Servlet names comma separated list
*/
public void setResourceOnlyServlets(String resourceOnlyServlets);
Obtains the list of Servlets that expect a resource to be present.
Returns: A comma separated list of Servlet names as used in web.xml
/**
* Obtains the list of Servlets that expect a resource to be present.
*
* @return A comma separated list of Servlet names as used in web.xml
*/
public String getResourceOnlyServlets();
Checks the named Servlet to see if it expects a resource to be present.
Params: - servletName – Name of the Servlet (as per web.xml) to check
Returns: true
if the Servlet expects a resource,
otherwise false
/**
* Checks the named Servlet to see if it expects a resource to be present.
*
* @param servletName Name of the Servlet (as per web.xml) to check
* @return <code>true</code> if the Servlet expects a resource,
* otherwise <code>false</code>
*/
public boolean isResourceOnlyServlet(String servletName);
Returns: the base name to use for WARs, directories or context.xml files
for this context.
/**
* @return the base name to use for WARs, directories or context.xml files
* for this context.
*/
public String getBaseName();
Set the version of this web application - used to differentiate
different versions of the same web application when using parallel
deployment.
Params: - webappVersion – The webapp version associated with the context,
which should be unique
/**
* Set the version of this web application - used to differentiate
* different versions of the same web application when using parallel
* deployment.
*
* @param webappVersion The webapp version associated with the context,
* which should be unique
*/
public void setWebappVersion(String webappVersion);
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.
/**
* @return 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.
*/
public String getWebappVersion();
Configure whether or not requests listeners will be fired on forwards for
this Context.
Params: - enable –
true
to fire request listeners when forwarding
/**
* Configure whether or not requests listeners will be fired on forwards for
* this Context.
*
* @param enable <code>true</code> to fire request listeners when forwarding
*/
public void setFireRequestListenersOnForwards(boolean enable);
Returns: whether or not requests listeners will be fired on forwards for
this Context.
/**
* @return whether or not requests listeners will be fired on forwards for
* this Context.
*/
public boolean getFireRequestListenersOnForwards();
Configures if a user presents authentication credentials, whether the
context will process them when the request is for a non-protected
resource.
Params: - enable –
true
to perform authentication even outside
security constraints
/**
* Configures if a user presents authentication credentials, whether the
* context will process them when the request is for a non-protected
* resource.
*
* @param enable <code>true</code> to perform authentication even outside
* security constraints
*/
public void setPreemptiveAuthentication(boolean enable);
Returns: if a user presents authentication credentials, will the
context will process them when the request is for a non-protected
resource.
/**
* @return if a user presents authentication credentials, will the
* context will process them when the request is for a non-protected
* resource.
*/
public boolean getPreemptiveAuthentication();
Configures if a response body is included when a redirect response is
sent to the client.
Params: - enable –
true
to send a response body for redirects
/**
* Configures if a response body is included when a redirect response is
* sent to the client.
*
* @param enable <code>true</code> to send a response body for redirects
*/
public void setSendRedirectBody(boolean enable);
Returns: if the context is configured to include a response body as
part of a redirect response.
/**
* @return if the context is configured to include a response body as
* part of a redirect response.
*/
public boolean getSendRedirectBody();
Returns: the Loader with which this Context is associated.
/**
* @return the Loader with which this Context is associated.
*/
public Loader getLoader();
Set the Loader with which this Context is associated.
Params: - loader – The newly associated loader
/**
* Set the Loader with which this Context is associated.
*
* @param loader The newly associated loader
*/
public void setLoader(Loader loader);
Returns: the Resources with which this Context is associated.
/**
* @return the Resources with which this Context is associated.
*/
public WebResourceRoot getResources();
Set the Resources object with which this Context is associated.
Params: - resources – The newly associated Resources
/**
* Set the Resources object with which this Context is associated.
*
* @param resources The newly associated Resources
*/
public void setResources(WebResourceRoot resources);
Returns: the Manager with which this Context is associated. If there is
no associated Manager, return null
.
/**
* @return the Manager with which this Context is associated. If there is
* no associated Manager, return <code>null</code>.
*/
public Manager getManager();
Set the Manager with which this Context is associated.
Params: - manager – The newly associated Manager
/**
* Set the Manager with which this Context is associated.
*
* @param manager The newly associated Manager
*/
public void setManager(Manager manager);
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.
Params: - addWebinfClassesResources – The new value for the flag
/**
* 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.
*
* @param addWebinfClassesResources The new value for the flag
*/
public void setAddWebinfClassesResources(boolean addWebinfClassesResources);
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.
/**
* @return 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.
*/
public boolean getAddWebinfClassesResources();
Add a post construct method definition for the given class, if there is
an existing definition for the specified class - IllegalArgumentException
will be thrown.
Params: - clazz – Fully qualified class name
- method –
Post construct method name
Throws: - IllegalArgumentException –
if the fully qualified class name or method name are
NULL
; if there is already post construct method
definition for the given class
/**
* Add a post construct method definition for the given class, if there is
* an existing definition for the specified class - IllegalArgumentException
* will be thrown.
*
* @param clazz Fully qualified class name
* @param method
* Post construct method name
* @throws IllegalArgumentException
* if the fully qualified class name or method name are
* <code>NULL</code>; if there is already post construct method
* definition for the given class
*/
public void addPostConstructMethod(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.
Params: - clazz – Fully qualified class name
- method –
Post construct method name
Throws: - IllegalArgumentException –
if the fully qualified class name or method name are
NULL
; if there is already pre destroy method
definition for the given class
/**
* Add a pre destroy method definition for the given class, if there is an
* existing definition for the specified class - IllegalArgumentException
* will be thrown.
*
* @param clazz Fully qualified class name
* @param method
* Post construct method name
* @throws IllegalArgumentException
* if the fully qualified class name or method name are
* <code>NULL</code>; if there is already pre destroy method
* definition for the given class
*/
public void addPreDestroyMethod(String clazz, String method);
Removes the post construct method definition for the given class, if it
exists; otherwise, no action is taken.
Params: - clazz –
Fully qualified class name
/**
* Removes the post construct method definition for the given class, if it
* exists; otherwise, no action is taken.
*
* @param clazz
* Fully qualified class name
*/
public void removePostConstructMethod(String clazz);
Removes the pre destroy method definition for the given class, if it
exists; otherwise, no action is taken.
Params: - clazz –
Fully qualified class name
/**
* Removes the pre destroy method definition for the given class, if it
* exists; otherwise, no action is taken.
*
* @param clazz
* Fully qualified class name
*/
public void removePreDestroyMethod(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.
Params: - clazz –
Fully qualified class name
Returns: the method name that is specified as post construct method for
the given class, if it exists; otherwise NULL
will
be returned.
/**
* Returns the method name that is specified as post construct method for
* the given class, if it exists; otherwise <code>NULL</code> will be
* returned.
*
* @param clazz
* Fully qualified class name
*
* @return the method name that is specified as post construct method for
* the given class, if it exists; otherwise <code>NULL</code> will
* be returned.
*/
public String findPostConstructMethod(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.
Params: - clazz –
Fully qualified class name
Returns: the method name that is specified as pre destroy method for the
given class, if it exists; otherwise NULL
will be
returned.
/**
* Returns the method name that is specified as pre destroy method for the
* given class, if it exists; otherwise <code>NULL</code> will be returned.
*
* @param clazz
* Fully qualified class name
*
* @return the method name that is specified as pre destroy method for the
* given class, if it exists; otherwise <code>NULL</code> will be
* returned.
*/
public String findPreDestroyMethod(String clazz);
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. If there are no such classes an empty map will be returned.
Returns: a map with keys - fully qualified class names of the classes that
have post construct methods and the values are the corresponding
method names.
/**
* 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. If there are no such classes an empty map will be returned.
*
* @return a map with keys - fully qualified class names of the classes that
* have post construct methods and the values are the corresponding
* method names.
*/
public Map<String, String> findPostConstructMethods();
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. If there are no such classes an empty map will be returned.
Returns: a map with keys - fully qualified class names of the classes that
have pre destroy methods and the values are the corresponding
method names.
/**
* 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. If there are no such classes an empty map will be returned.
*
* @return a map with keys - fully qualified class names of the classes that
* have pre destroy methods and the values are the corresponding
* method names.
*/
public Map<String, String> findPreDestroyMethods();
Returns: the token necessary for operations on the associated JNDI naming
context.
/**
* @return the token necessary for operations on the associated JNDI naming
* context.
*/
public Object getNamingToken();
Sets the CookieProcessor
that will be used to process cookies for this Context. Params: - cookieProcessor – The new cookie processor
Throws: - IllegalArgumentException – If a
null
CookieProcessor is specified
/**
* Sets the {@link CookieProcessor} that will be used to process cookies
* for this Context.
*
* @param cookieProcessor The new cookie processor
*
* @throws IllegalArgumentException If a {@code null} CookieProcessor is
* specified
*/
public void setCookieProcessor(CookieProcessor cookieProcessor);
Returns: the CookieProcessor
that will be used to process cookies for this Context.
/**
* @return the {@link CookieProcessor} that will be used to process cookies
* for this Context.
*/
public CookieProcessor getCookieProcessor();
When 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
/
Params: - validateClientProvidedNewSessionId –
true
if validation should be applied
/**
* When 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:
* <ul>
* <li>The session ID is provided by a cookie</li>
* <li>The session cookie has a path of {@code /}</li>
* </ul>
*
* @param validateClientProvidedNewSessionId
* {@code true} if validation should be applied
*/
public void setValidateClientProvidedNewSessionId(boolean validateClientProvidedNewSessionId);
Will client provided session IDs be validated (see setValidateClientProvidedNewSessionId(boolean)
) before use? Returns: true
if validation will be applied. Otherwise,
false
/**
* Will client provided session IDs be validated (see {@link
* #setValidateClientProvidedNewSessionId(boolean)}) before use?
*
* @return {@code true} if validation will be applied. Otherwise, {@code
* false}
*/
public boolean getValidateClientProvidedNewSessionId();
If 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.
Params: - mapperContextRootRedirectEnabled – Should the redirects be enabled?
/**
* If 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.
*
* @param mapperContextRootRedirectEnabled Should the redirects be enabled?
*/
public void setMapperContextRootRedirectEnabled(boolean mapperContextRootRedirectEnabled);
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.
Returns: true
if the Mapper level redirect is enabled for this Context.
/**
* 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.
*
* @return {@code true} if the Mapper level redirect is enabled for this
* Context.
*/
public boolean getMapperContextRootRedirectEnabled();
If 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.
Params: - mapperDirectoryRedirectEnabled – Should the redirects be enabled?
/**
* If 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.
*
* @param mapperDirectoryRedirectEnabled Should the redirects be enabled?
*/
public void setMapperDirectoryRedirectEnabled(boolean mapperDirectoryRedirectEnabled);
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.
Returns: true
if the Mapper level redirect is enabled for this Context.
/**
* 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.
*
* @return {@code true} if the Mapper level redirect is enabled for this
* Context.
*/
public boolean getMapperDirectoryRedirectEnabled();
Controls whether HTTP 1.1 and later location headers generated by a call to HttpServletResponse.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.
Params: - useRelativeRedirects –
true
to use relative redirects and false
to use absolute redirects
/**
* Controls whether HTTP 1.1 and later location headers generated by a call
* to {@link jakarta.servlet.http.HttpServletResponse#sendRedirect(String)}
* will use relative or absolute redirects.
* <p>
* 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.
* <p>
* Absolute redirects should work with reverse proxies that change the
* context path but may cause issues with the
* {@link org.apache.catalina.filters.RemoteIpFilter} if the filter is
* changing the scheme and/or port.
*
* @param useRelativeRedirects {@code true} to use relative redirects and
* {@code false} to use absolute redirects
*/
public void setUseRelativeRedirects(boolean useRelativeRedirects);
Will HTTP 1.1 and later location headers generated by a call to HttpServletResponse.sendRedirect(String)
use relative or absolute redirects. See Also: Returns: true
if relative redirects will be used false
if absolute redirects are used.
/**
* Will HTTP 1.1 and later location headers generated by a call to
* {@link jakarta.servlet.http.HttpServletResponse#sendRedirect(String)} use
* relative or absolute redirects.
*
* @return {@code true} if relative redirects will be used {@code false} if
* absolute redirects are used.
*
* @see #setUseRelativeRedirects(boolean)
*/
public boolean getUseRelativeRedirects();
Are 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.
Params: - dispatchersUseEncodedPaths –
true
to use encoded paths, otherwise false
/**
* Are 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.
*
* @param dispatchersUseEncodedPaths {@code true} to use encoded paths,
* otherwise {@code false}
*/
public void setDispatchersUseEncodedPaths(boolean dispatchersUseEncodedPaths);
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.
Returns: true
if encoded paths will be used, otherwise false
/**
* 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.
*
* @return {@code true} if encoded paths will be used, otherwise
* {@code false}
*/
public boolean getDispatchersUseEncodedPaths();
Set the default request body encoding for this web application.
Params: - encoding – The default encoding
/**
* Set the default request body encoding for this web application.
*
* @param encoding The default encoding
*/
public void setRequestCharacterEncoding(String encoding);
Get the default request body encoding for this web application.
Returns: The default request body encoding
/**
* Get the default request body encoding for this web application.
*
* @return The default request body encoding
*/
public String getRequestCharacterEncoding();
Set the default response body encoding for this web application.
Params: - encoding – The default encoding
/**
* Set the default response body encoding for this web application.
*
* @param encoding The default encoding
*/
public void setResponseCharacterEncoding(String encoding);
Get the default response body encoding for this web application.
Returns: The default response body encoding
/**
* Get the default response body encoding for this web application.
*
* @return The default response body encoding
*/
public String getResponseCharacterEncoding();
Configure if, when returning a context path from HttpServletRequest.getContextPath()
, the return value is allowed to contain multiple leading '/' characters. Params: - allowMultipleLeadingForwardSlashInPath – The new value for the flag
/**
* Configure if, when returning a context path from {@link
* jakarta.servlet.http.HttpServletRequest#getContextPath()}, the return value
* is allowed to contain multiple leading '/' characters.
*
* @param allowMultipleLeadingForwardSlashInPath The new value for the flag
*/
public void setAllowMultipleLeadingForwardSlashInPath(
boolean allowMultipleLeadingForwardSlashInPath);
When returning a context path from HttpServletRequest.getContextPath()
, is it allowed to contain multiple leading '/' characters? Returns: true
if multiple leading '/' characters are allowed,
otherwise false
/**
* When returning a context path from {@link
* jakarta.servlet.http.HttpServletRequest#getContextPath()}, is it allowed to
* contain multiple leading '/' characters?
*
* @return <code>true</code> if multiple leading '/' characters are allowed,
* otherwise <code>false</code>
*/
public boolean getAllowMultipleLeadingForwardSlashInPath();
public void incrementInProgressAsyncCount();
public void decrementInProgressAsyncCount();
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.
Params: - createUploadTargets –
true
if Tomcat should attempt to create the upload target, otherwise false
/**
* 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.
*
* @param createUploadTargets {@code true} if Tomcat should attempt to
* create the upload target, otherwise {@code false}
*/
public void setCreateUploadTargets(boolean createUploadTargets);
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?
Returns: true
if Tomcat will attempt to create an upload target otherwise false
/**
* 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?
*
* @return {@code true} if Tomcat will attempt to create an upload target
* otherwise {@code false}
*/
public boolean getCreateUploadTargets();
If this is true
, every request that is associated with a
session will cause the session's last accessed time to be updated
regardless of whether or not the request explicitly accesses the session.
If org.apache.catalina.STRICT_SERVLET_COMPLIANCE
is set to
true
, the default of this setting will be true
,
else the default value will be false
.
Returns: the flag value
/**
* If this is <code>true</code>, every request that is associated with a
* session will cause the session's last accessed time to be updated
* regardless of whether or not the request explicitly accesses the session.
* If <code>org.apache.catalina.STRICT_SERVLET_COMPLIANCE</code> is set to
* <code>true</code>, the default of this setting will be <code>true</code>,
* else the default value will be <code>false</code>.
* @return the flag value
*/
public boolean getAlwaysAccessSession();
Set the session access behavior.
Params: - alwaysAccessSession – the new flag value
/**
* Set the session access behavior.
* @param alwaysAccessSession the new flag value
*/
public void setAlwaysAccessSession(boolean alwaysAccessSession);
If this is true
then the path passed to
ServletContext.getResource()
or
ServletContext.getResourceAsStream()
must start with
"/". If false
, code like
getResource("myfolder/myresource.txt")
will work as Tomcat
will prepend "/" to the provided path.
If org.apache.catalina.STRICT_SERVLET_COMPLIANCE
is set to
true
, the default of this setting will be true
,
else the default value will be false
.
Returns: the flag value
/**
* If this is <code>true</code> then the path passed to
* <code>ServletContext.getResource()</code> or
* <code>ServletContext.getResourceAsStream()</code> must start with
* "/". If <code>false</code>, code like
* <code>getResource("myfolder/myresource.txt")</code> will work as Tomcat
* will prepend "/" to the provided path.
* If <code>org.apache.catalina.STRICT_SERVLET_COMPLIANCE</code> is set to
* <code>true</code>, the default of this setting will be <code>true</code>,
* else the default value will be <code>false</code>.
* @return the flag value
*/
public boolean getContextGetResourceRequiresSlash();
Allow using ServletContext.getResource()
or
ServletContext.getResourceAsStream()
without
a leading "/".
Params: - contextGetResourceRequiresSlash – the new flag value
/**
* Allow using <code>ServletContext.getResource()</code> or
* <code>ServletContext.getResourceAsStream()</code> without
* a leading "/".
* @param contextGetResourceRequiresSlash the new flag value
*/
public void setContextGetResourceRequiresSlash(boolean contextGetResourceRequiresSlash);
If this is true
then any wrapped request or response
object passed to an application dispatcher will be checked to ensure that
it has wrapped the original request or response.
If org.apache.catalina.STRICT_SERVLET_COMPLIANCE
is set to
true
, the default of this setting will be true
,
else the default value will be false
.
Returns: the flag value
/**
* If this is <code>true</code> then any wrapped request or response
* object passed to an application dispatcher will be checked to ensure that
* it has wrapped the original request or response.
* If <code>org.apache.catalina.STRICT_SERVLET_COMPLIANCE</code> is set to
* <code>true</code>, the default of this setting will be <code>true</code>,
* else the default value will be <code>false</code>.
* @return the flag value
*/
public boolean getDispatcherWrapsSameObject();
Allow disabling the object wrap check in the request dispatcher.
Params: - dispatcherWrapsSameObject – the new flag value
/**
* Allow disabling the object wrap check in the request dispatcher.
* @param dispatcherWrapsSameObject the new flag value
*/
public void setDispatcherWrapsSameObject(boolean dispatcherWrapsSameObject);
Returns: true
if the resources archive lookup will
use a bloom filter.
/**
* @return <code>true</code> if the resources archive lookup will
* use a bloom filter.
*/
public boolean getUseBloomFilterForArchives();
Set bloom filter flag value.
Params: - useBloomFilterForArchives – The new fast class path scan flag
/**
* Set bloom filter flag value.
*
* @param useBloomFilterForArchives The new fast class path scan flag
*/
public void setUseBloomFilterForArchives(boolean useBloomFilterForArchives);
}