org.apache.catalina
Interface Context

All Superinterfaces:

Container

All Known Implementing Classes:

StandardContext

public interface Context
extends Container

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).

Version:

$Revision: 1209 $ $Date: 2009-10-19 13:28:13 +0200 (Mon, 19 Oct 2009) $

Author:

Craig R. McClanahan

Field Summary

static java.lang.String	COMPLETE_CONFIG_EVENT The LifecycleEvent type sent to complete the configuration (called after running all listeners and other init callbacks).
static java.lang.String	RELOAD_EVENT The LifecycleEvent type sent when a context is reloaded.

Fields inherited from interface org.apache.catalina.Container

ADD_CHILD_EVENT, ADD_MAPPER_EVENT, ADD_VALVE_EVENT, REMOVE_CHILD_EVENT, REMOVE_MAPPER_EVENT, REMOVE_VALVE_EVENT

Method Summary

void	addApplicationListener(java.lang.String listener) Add a new Listener class name to the set of Listeners configured for this application.
<T extends java.util.EventListener> void	addApplicationListenerInstance(T listener) Add a new Listener instance to the set of Listeners configured for this application.
void	addApplicationParameter(ApplicationParameter parameter) Add a new application parameter for this application.
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.
void	addFilterMapBefore(FilterMap filterMap) Add a filter mapping to this Context before current mappings.
void	addInstanceListener(java.lang.String listener) Add the classname of an InstanceListener to be added to each Wrapper appended to this Context.
void	addJspMapping(java.lang.String pattern) Add the given URL pattern as a jsp-property-group.
void	addJspPropertyGroup(JspPropertyGroup propertyGroup) Add the given jsp-property-group.
void	addJspTagLibrary(java.lang.String uri, TagLibraryInfo tagLibraryInfo) Add the given JSP tag library metadata.
void	addJspTagLibrary(TagLibraryInfo tagLibraryInfo) Add the given JSP tag library metadata.
void	addLocaleEncodingMappingParameter(java.lang.String locale, java.lang.String encoding) Add a Locale Encoding Mapping (see Sec 5.4 of Servlet spec 2.4)
void	addMimeMapping(java.lang.String extension, java.lang.String mimeType) Add a new MIME mapping, replacing any existing mapping for the specified extension.
void	addParameter(java.lang.String name, java.lang.String value) Add a new context initialization parameter, replacing any existing value for the specified name.
void	addRoleMapping(java.lang.String role, java.lang.String link) Add a security role reference for this web application.
void	addSecurityRole(java.lang.String role) Add a new security role for this web application.
void	addServletMapping(java.lang.String pattern, java.lang.String name) Add a new servlet mapping, replacing any existing mapping for the specified pattern.
void	addSessionTrackingMode(java.lang.String trackingMode) Add the given session tracking mode.
void	addTaglib(java.lang.String uri, java.lang.String location) Add a JSP tag library for the specified URI.
void	addWatchedResource(java.lang.String name) Add a resource which will be watched for reloading by the host auto deployer.
void	addWelcomeFile(java.lang.String name) Add a new welcome file to the set recognized by this Context.
void	addWrapperLifecycle(java.lang.String listener) Add the classname of a LifecycleListener to be added to each Wrapper appended to this Context.
void	addWrapperListener(java.lang.String listener) Add the classname of a ContainerListener to be added to each Wrapper appended to this Context.
Wrapper	createWrapper() Factory method to create and return a new Wrapper instance, of the Java implementation class appropriate for this Context implementation.
java.lang.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 set of 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(java.lang.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.
FilterDef	findFilterDef(java.lang.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.
java.lang.String[]	findInstanceListeners() Return the set of InstanceListener classes that will be added to newly created Wrappers automatically.
JspPropertyGroup[]	findJspPropertyGroups() Return the set of JSP property groups.
java.lang.String	findMimeMapping(java.lang.String extension) Return the MIME type to which the specified extension is mapped, if any; otherwise return null.
java.lang.String[]	findMimeMappings() Return the extensions for which MIME mappings are defined.
java.lang.String	findParameter(java.lang.String name) Return the value for the specified context initialization parameter name, if any; otherwise return null.
java.lang.String[]	findParameters() Return the names of all defined context initialization parameters for this Context.
java.lang.String	findRoleMapping(java.lang.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(java.lang.String role) Return true if the specified security role is defined for this application; otherwise return false.
java.lang.String[]	findSecurityRoles() Return the security roles defined for this application.
java.lang.String	findServletMapping(java.lang.String pattern) Return the servlet name mapped by the specified pattern (if any); otherwise return null.
java.lang.String[]	findServletMappings() Return the patterns of all defined servlet mappings for this Context.
int[]	findStatusPages() Return the set of HTTP status codes for which error pages have been specified.
java.lang.String	findTaglib(java.lang.String uri) Return the tag library descriptor location for the specified taglib URI, if any; otherwise, return null.
java.lang.String[]	findTaglibs() Return the URIs of all tag libraries for which a tag library descriptor location has been specified.
java.lang.String[]	findWatchedResources() Return the set of watched resources for this Context.
boolean	findWelcomeFile(java.lang.String name) Return true if the specified welcome file is defined for this Context; otherwise return false.
java.lang.String[]	findWelcomeFiles() Return the set of welcome files defined for this Context.
java.lang.String[]	findWrapperLifecycles() Return the set of LifecycleListener classes that will be added to newly created Wrappers automatically.
java.lang.String[]	findWrapperListeners() Return the set of ContainerListener classes that will be added to newly created Wrappers automatically.
java.lang.String	getAltDDName() Return the alternate Deployment Descriptor name.
java.lang.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.
java.lang.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.
java.lang.Object[]	getApplicationSessionLifecycleListeners() 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() Return the authenticator that is configured for this context, or null if no authenticator has been configured.
boolean	getAvailable() Return the application available flag for this Context.
CharsetMapper	getCharsetMapper() Return the Locale to character set mapper for this Context.
java.lang.String	getConfigFile() Return the path to a file to save this Context information.
boolean	getConfigured() Return the "correctly configured" flag for this Context.
boolean	getCookies() Return the "use cookies for session ids" flag.
boolean	getCrossContext() Return the "allow crossing servlet contexts" flag.
java.lang.String	getDisplayName() Return the display name of this web application.
boolean	getDistributable() Return the distributable flag for this web application.
java.lang.String	getDocBase() Return the document root for this Context.
java.lang.String	getEncodedPath() Return the URL encoded context path, using UTF-8.
boolean	getIgnoreAnnotations() Return the boolean on the annotations parsing.
InstanceManager	getInstanceManager() Used to create application instances.
java.lang.String	getLogicalName() Return the logical name for this web application.
LoginConfig	getLoginConfig() Return the login configuration descriptor for this web application.
Mapper	getMapper() Get the request dispatcher mapper.
NamingResources	getNamingResources() Return the naming resources associated with this web application.
boolean	getOverride() Return the override flag for this web application.
java.lang.String	getPath() Return the context path for this web application.
boolean	getPrivileged() Return the privileged flag for this web application.
java.lang.String	getPublicId() Return the public identifier of the deployment descriptor DTD that is currently being parsed.
boolean	getReloadable() Return the reloadable flag for this web application.
javax.servlet.ServletContext	getServletContext() Return the servlet context for which this Context is a facade.
SessionCookie	getSessionCookie() Return the session cookie configuration.
int	getSessionTimeout() Return the default session timeout (in minutes) for this web application.
boolean	getSwallowOutput() Return the value of the swallowOutput flag.
java.lang.String	getVersion() Return the Servlet API version defined for the webapp.
int	getVersionMajor() Return the Servlet API version defined for the webapp.
int	getVersionMinor() Return the Servlet API version defined for the webapp.
WebAbsoluteOrdering	getWebAbsoluteOrdering() Return the absolute ordering that is configured for this context, or null if no absolute ordering has been defined.
java.lang.String	getWrapperClass() Return the Java class name of the Wrapper implementation used for servlets registered in this Context.
boolean	isInitialized() Return true if the Context has been initialized.
boolean	isStarting() Return the application starting flag for this Context.
void	reload() Reload this web application, if reloading is supported.
void	removeApplicationListener(java.lang.String listener) Remove the specified application listener class from the set of listeners for this application.
void	removeApplicationParameter(java.lang.String name) Remove the application parameter with the specified name from the set for this application.
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(java.lang.String listener) Remove a class name from the set of InstanceListener classes that will be added to newly created Wrappers.
void	removeMimeMapping(java.lang.String extension) Remove the MIME mapping for the specified extension, if it exists; otherwise, no action is taken.
void	removeParameter(java.lang.String name) Remove the context initialization parameter with the specified name, if it exists; otherwise, no action is taken.
void	removeRoleMapping(java.lang.String role) Remove any security role reference for the specified name
void	removeSecurityRole(java.lang.String role) Remove any security role with the specified name.
void	removeServletMapping(java.lang.String pattern) Remove any servlet mapping for the specified pattern, if it exists; otherwise, no action is taken.
void	removeTaglib(java.lang.String uri) Remove the tag library location forthe specified tag library URI.
void	removeWatchedResource(java.lang.String name) Remove the specified watched resource name from the list associated with this Context.
void	removeWelcomeFile(java.lang.String name) Remove the specified welcome file name from the list recognized by this Context.
void	removeWrapperLifecycle(java.lang.String listener) Remove a class name from the set of LifecycleListener classes that will be added to newly created Wrappers.
void	removeWrapperListener(java.lang.String listener) Remove a class name from the set of ContainerListener classes that will be added to newly created Wrappers.
void	setAltDDName(java.lang.String altDDName) Set an alternate Deployment Descriptor name.
void	setApplicationEventListeners(java.lang.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(java.lang.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	setApplicationSessionLifecycleListeners(java.lang.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	setAuthenticator(Authenticator authenticator) Set the authenticator for this context.
void	setAvailable(boolean available) Set the application available flag for this Context.
void	setCharsetMapper(CharsetMapper mapper) Set the Locale to character set mapper for this Context.
void	setConfigFile(java.lang.String configFile) Set the path to a file to save this Context information.
void	setConfigured(boolean configured) Set the "correctly configured" flag for this Context.
void	setCookies(boolean cookies) Set the "use cookies for session ids" flag.
void	setCrossContext(boolean crossContext) Set the "allow crossing servlet contexts" flag.
void	setDisplayName(java.lang.String displayName) Set the display name of this web application.
void	setDistributable(boolean distributable) Set the distributable flag for this web application.
void	setDocBase(java.lang.String docBase) Set the document root 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	setLogicalName(java.lang.String logicalName) Set the logical name for this web application.
void	setLoginConfig(LoginConfig config) Set the login configuration descriptor for this web application.
void	setNamingResources(NamingResources namingResources) Set the naming resources for this web application.
void	setOverride(boolean override) Set the override flag for this web application.
void	setPath(java.lang.String path) Set the context path for this web application.
void	setPrivileged(boolean privileged) Set the privileged flag for this web application.
void	setPublicId(java.lang.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	setSessionCookie(SessionCookie sessionCookie) Set the session cookie configuration.
void	setSessionTimeout(int timeout) Set the default session timeout (in minutes) for this web application.
void	setStarting(boolean starting) Set the application starting flag for this Context.
void	setSwallowOutput(boolean swallowOutput) Set the value of the swallowOutput flag.
void	setVersion(java.lang.String version) Set the Servlet API version defined for the webapp.
void	setWebAbsoluteOrdering(WebAbsoluteOrdering webAbsoluteOrdering) Set the absolute ordering for this context.
void	setWrapperClass(java.lang.String wrapperClass) Set the Java class name of the Wrapper implementation used for servlets registered in this Context.

Methods inherited from interface org.apache.catalina.Container

addChild, addContainerListener, addPropertyChangeListener, backgroundProcess, findChild, findChildren, findContainerListeners, fireContainerEvent, getBackgroundProcessorDelay, getCluster, getInfo, getJarRepository, getLoader, getLogger, getManager, getMappingObject, getName, getObjectName, getParent, getParentClassLoader, getPipeline, getRealm, getResources, invoke, isStarted, removeChild, removeContainerListener, removePropertyChangeListener, setBackgroundProcessorDelay, setCluster, setJarRepository, setLoader, setManager, setName, setParent, setParentClassLoader, setRealm, setResources

Field Detail

RELOAD_EVENT

static final java.lang.String RELOAD_EVENT

The LifecycleEvent type sent when a context is reloaded.

See Also:

Constant Field Values

COMPLETE_CONFIG_EVENT

static final java.lang.String COMPLETE_CONFIG_EVENT

The LifecycleEvent type sent to complete the configuration (called after running all listeners and other init callbacks).

See Also:

Constant Field Values

Method Detail

addSessionTrackingMode

void addSessionTrackingMode(java.lang.String trackingMode)

Add the given session tracking mode.

getWebAbsoluteOrdering

WebAbsoluteOrdering getWebAbsoluteOrdering()

Return the absolute ordering that is configured for this context, or null if no absolute ordering has been defined.

setWebAbsoluteOrdering

void setWebAbsoluteOrdering(WebAbsoluteOrdering webAbsoluteOrdering)

Set the absolute ordering for this context.

Parameters:

webAbsoluteOrdering - the new absolute ordering for this context

getAuthenticator

Authenticator getAuthenticator()

Return the authenticator that is configured for this context, or null if no authenticator has been configured.

setAuthenticator

void setAuthenticator(Authenticator authenticator)

Set the authenticator for this context.

Parameters:

authenticator - the new Authenticator for this context

getApplicationEventListeners

java.lang.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.

Throws:

java.lang.IllegalStateException - if this method is called before this application has started, or after it has been stopped

setApplicationEventListeners

void setApplicationEventListeners(java.lang.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.

Parameters:

listeners - The set of instantiated listener objects.

getApplicationLifecycleListeners

java.lang.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.

Throws:

java.lang.IllegalStateException - if this method is called before this application has started, or after it has been stopped

setApplicationLifecycleListeners

void setApplicationLifecycleListeners(java.lang.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.

Parameters:

listeners - The set of instantiated listener objects.

getApplicationSessionLifecycleListeners

java.lang.Object[] getApplicationSessionLifecycleListeners()

Return the set of initialized application lifecycle listener objects, in the order they were specified in the web application deployment descriptor, for this application.

Throws:

java.lang.IllegalStateException - if this method is called before this application has started, or after it has been stopped

setApplicationSessionLifecycleListeners

void setApplicationSessionLifecycleListeners(java.lang.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.

Parameters:

listeners - The set of instantiated listener objects.

getAvailable

boolean getAvailable()

Return the application available flag for this Context.

setAvailable

void setAvailable(boolean available)

Set the application available flag for this Context.

Parameters:

available - The new application available flag

isStarting

boolean isStarting()

Return the application starting flag for this Context.

setStarting

void setStarting(boolean starting)

Set the application starting flag for this Context.

Parameters:

starting - The new application starting flag

getCharsetMapper

CharsetMapper getCharsetMapper()

Return the Locale to character set mapper for this Context.

setCharsetMapper

void setCharsetMapper(CharsetMapper mapper)

Set the Locale to character set mapper for this Context.

Parameters:

mapper - The new mapper

getConfigFile

java.lang.String getConfigFile()

Return the path to a file to save this Context information.

setConfigFile

void setConfigFile(java.lang.String configFile)

Set the path to a file to save this Context information.

Parameters:

configFile - The path to a file to save this Context information.

getConfigured

boolean getConfigured()

Return the "correctly configured" flag for this Context.

setConfigured

void setConfigured(boolean configured)

Set the "correctly configured" flag for this Context. This can be set to false by startup listeners that detect a fatal configuration error to avoid the application from being made available.

Parameters:

configured - The new correctly configured flag

getCookies

boolean getCookies()

Return the "use cookies for session ids" flag.

setSessionCookie

void setSessionCookie(SessionCookie sessionCookie)

Set the session cookie configuration.

Parameters:

sessionCookie - The new value

getSessionCookie

SessionCookie getSessionCookie()

Return the session cookie configuration.

setCookies

void setCookies(boolean cookies)

Set the "use cookies for session ids" flag.

Parameters:

cookies - The new flag

getCrossContext

boolean getCrossContext()

Return the "allow crossing servlet contexts" flag.

getAltDDName

java.lang.String getAltDDName()

Return the alternate Deployment Descriptor name.

setAltDDName

void setAltDDName(java.lang.String altDDName)

Set an alternate Deployment Descriptor name.

setCrossContext

void setCrossContext(boolean crossContext)

Set the "allow crossing servlet contexts" flag.

Parameters:

crossContext - The new cross contexts flag

getDisplayName

java.lang.String getDisplayName()

Return the display name of this web application.

setDisplayName

void setDisplayName(java.lang.String displayName)

Set the display name of this web application.

Parameters:

displayName - The new display name

getDistributable

boolean getDistributable()

Return the distributable flag for this web application.

setDistributable

void setDistributable(boolean distributable)

Set the distributable flag for this web application.

Parameters:

distributable - The new distributable flag

getDocBase

java.lang.String getDocBase()

Return the document root for this Context. This can be an absolute pathname, a relative pathname, or a URL.

setDocBase

void setDocBase(java.lang.String docBase)

Set the document root for this Context. This can be an absolute pathname, a relative pathname, or a URL.

Parameters:

docBase - The new document root

getEncodedPath

java.lang.String getEncodedPath()

Return the URL encoded context path, using UTF-8.

getIgnoreAnnotations

boolean getIgnoreAnnotations()

Return the boolean on the annotations parsing.

setIgnoreAnnotations

void setIgnoreAnnotations(boolean ignoreAnnotations)

Set the boolean on the annotations parsing for this web application.

Parameters:

ignoreAnnotations - The boolean on the annotations parsing

getInstanceManager

InstanceManager getInstanceManager()

Used to create application instances.

setInstanceManager

void setInstanceManager(InstanceManager instanceManager)

Set the instance manager associated with this Context.

Parameters:

instanceManager - The instance manager

getLogicalName

java.lang.String getLogicalName()

Return the logical name for this web application.

setLogicalName

void setLogicalName(java.lang.String logicalName)

Set the logical name for this web application.

Parameters:

logicalName - The new logical name

getLoginConfig

LoginConfig getLoginConfig()

Return the login configuration descriptor for this web application.

setLoginConfig

void setLoginConfig(LoginConfig config)

Set the login configuration descriptor for this web application.

Parameters:

config - The new login configuration

getMapper

Mapper getMapper()

Get the request dispatcher mapper.

getNamingResources

NamingResources getNamingResources()

Return the naming resources associated with this web application.

setNamingResources

void setNamingResources(NamingResources namingResources)

Set the naming resources for this web application.

Parameters:

namingResources - The new naming resources

getPath

java.lang.String getPath()

Return the context path for this web application.

setPath

void setPath(java.lang.String path)

Set the context path for this web application.

Parameters:

path - The new context path

getPublicId

java.lang.String getPublicId()

Return the public identifier of the deployment descriptor DTD that is currently being parsed.

setPublicId

void setPublicId(java.lang.String publicId)

Set the public identifier of the deployment descriptor DTD that is currently being parsed.

Parameters:

publicId - The public identifier

getVersion

java.lang.String getVersion()

Return the Servlet API version defined for the webapp.

getVersionMajor

int getVersionMajor()

Return the Servlet API version defined for the webapp.

getVersionMinor

int getVersionMinor()

Return the Servlet API version defined for the webapp.

setVersion

void setVersion(java.lang.String version)

Set the Servlet API version defined for the webapp.

Parameters:

version - The version

getReloadable

boolean getReloadable()

Return the reloadable flag for this web application.

setReloadable

void setReloadable(boolean reloadable)

Set the reloadable flag for this web application.

Parameters:

reloadable - The new reloadable flag

getOverride

boolean getOverride()

Return the override flag for this web application.

setOverride

void setOverride(boolean override)

Set the override flag for this web application.

Parameters:

override - The new override flag

getPrivileged

boolean getPrivileged()

Return the privileged flag for this web application.

setPrivileged

void setPrivileged(boolean privileged)

Set the privileged flag for this web application.

Parameters:

privileged - The new privileged flag

getServletContext

javax.servlet.ServletContext getServletContext()

Return the servlet context for which this Context is a facade.

getSessionTimeout

int getSessionTimeout()

Return the default session timeout (in minutes) for this web application.

setSessionTimeout

void setSessionTimeout(int timeout)

Set the default session timeout (in minutes) for this web application.

Parameters:

timeout - The new default session timeout

getSwallowOutput

boolean getSwallowOutput()

Return the value of the swallowOutput flag.

setSwallowOutput

void setSwallowOutput(boolean swallowOutput)

Set the value of the swallowOutput flag. If set to true, the system.out and system.err will be redirected to the logger during a servlet execution.

Parameters:

swallowOutput - The new value

getWrapperClass

java.lang.String getWrapperClass()

Return the Java class name of the Wrapper implementation used for servlets registered in this Context.

setWrapperClass

void setWrapperClass(java.lang.String wrapperClass)

Set the Java class name of the Wrapper implementation used for servlets registered in this Context.

Parameters:

wrapperClass - The new wrapper class

addApplicationListener

void addApplicationListener(java.lang.String listener)

Add a new Listener class name to the set of Listeners configured for this application.

Parameters:

listener - Java class name of a listener class

addApplicationListenerInstance

<T extends java.util.EventListener> void addApplicationListenerInstance(T listener)

Add a new Listener instance to the set of Listeners configured for this application.

Parameters:

listener - Java instance of a listener

addApplicationParameter

void addApplicationParameter(ApplicationParameter parameter)

Add a new application parameter for this application.

Parameters:

parameter - The new application parameter

addConstraint

void addConstraint(SecurityConstraint constraint)

Add a security constraint to the set for this web application.

addErrorPage

void addErrorPage(ErrorPage errorPage)

Add an error page for the specified error or Java exception.

Parameters:

errorPage - The error page definition to be added

addFilterDef

void addFilterDef(FilterDef filterDef)

Add a filter definition to this Context.

Parameters:

filterDef - The filter definition to be added

addFilterMap

void addFilterMap(FilterMap filterMap)

Add a filter mapping to this Context.

Parameters:

filterMap - The filter mapping to be added

addFilterMapBefore

void addFilterMapBefore(FilterMap filterMap)

Add a filter mapping to this Context before current mappings.

Parameters:

filterMap - The filter mapping to be added

addInstanceListener

void addInstanceListener(java.lang.String listener)

Add the classname of an InstanceListener to be added to each Wrapper appended to this Context.

Parameters:

listener - Java class name of an InstanceListener class

addJspMapping

void addJspMapping(java.lang.String pattern)

Add the given URL pattern as a jsp-property-group. This maps resources that match the given pattern so they will be passed to the JSP container. Though there are other elements in the property group, we only care about the URL pattern here. The JSP container will parse the rest.

Parameters:

pattern - URL pattern to be mapped

addJspPropertyGroup

void addJspPropertyGroup(JspPropertyGroup propertyGroup)

Add the given jsp-property-group.

Parameters:

propertyGroup - the property group which will be added

addJspTagLibrary

void addJspTagLibrary(TagLibraryInfo tagLibraryInfo)

Add the given JSP tag library metadata.

Parameters:

tagLibraryInfo - the tag library info that will be added

addJspTagLibrary

void addJspTagLibrary(java.lang.String uri,
                      TagLibraryInfo tagLibraryInfo)

Add the given JSP tag library metadata.

Parameters:

tagLibraryInfo - the tag library info that will be added

addLocaleEncodingMappingParameter

void addLocaleEncodingMappingParameter(java.lang.String locale,
                                       java.lang.String encoding)

Add a Locale Encoding Mapping (see Sec 5.4 of Servlet spec 2.4)

Parameters:

locale - locale to map an encoding for

encoding - encoding to be used for a give locale

addMimeMapping

void addMimeMapping(java.lang.String extension,
                    java.lang.String mimeType)

Add a new MIME mapping, replacing any existing mapping for the specified extension.

Parameters:

extension - Filename extension being mapped

mimeType - Corresponding MIME type

addParameter

void addParameter(java.lang.String name,
                  java.lang.String value)

Add a new context initialization parameter, replacing any existing value for the specified name.

Parameters:

name - Name of the new parameter

value - Value of the new parameter

addRoleMapping

void addRoleMapping(java.lang.String role,
                    java.lang.String link)

Add a security role reference for this web application.

Parameters:

role - Security role used in the application

link - Actual security role to check for

addSecurityRole

void addSecurityRole(java.lang.String role)

Add a new security role for this web application.

Parameters:

role - New security role

addServletMapping

void addServletMapping(java.lang.String pattern,
                       java.lang.String name)

Add a new servlet mapping, replacing any existing mapping for the specified pattern.

Parameters:

pattern - URL pattern to be mapped

name - Name of the corresponding servlet to execute

addTaglib

void addTaglib(java.lang.String uri,
               java.lang.String location)

Add a JSP tag library for the specified URI.

Parameters:

uri - URI, relative to the web.xml file, of this tag library

location - Location of the tag library descriptor

addWatchedResource

void addWatchedResource(java.lang.String name)

Add a resource which will be watched for reloading by the host auto deployer. Note: this will not be used in embedded mode.

Parameters:

name - Path to the resource, relative to docBase

addWelcomeFile

void addWelcomeFile(java.lang.String name)

Add a new welcome file to the set recognized by this Context.

Parameters:

name - New welcome file name

addWrapperLifecycle

void addWrapperLifecycle(java.lang.String listener)

Add the classname of a LifecycleListener to be added to each Wrapper appended to this Context.

Parameters:

listener - Java class name of a LifecycleListener class

addWrapperListener

void addWrapperListener(java.lang.String listener)

Add the classname of a ContainerListener to be added to each Wrapper appended to this Context.

Parameters:

listener - Java class name of a ContainerListener class

createWrapper

Wrapper createWrapper()

Factory method to create and return a new Wrapper instance, of the Java implementation class appropriate for this Context implementation. The constructor of the instantiated Wrapper will have been called, but no properties will have been set.

findApplicationListeners

java.lang.String[] findApplicationListeners()

Return the set of application listener class names configured for this application.

findApplicationParameters

ApplicationParameter[] findApplicationParameters()

Return the set of application parameters for this application.

findConstraints

SecurityConstraint[] findConstraints()

Return the set of security constraints for this web application. If there are none, a zero-length array is returned.

findErrorPage

ErrorPage findErrorPage(int errorCode)

Return the error page entry for the specified HTTP error code, if any; otherwise return null.

Parameters:

errorCode - Error code to look up

findErrorPage

ErrorPage findErrorPage(java.lang.String exceptionType)

Return the error page entry for the specified Java exception type, if any; otherwise return null.

Parameters:

exceptionType - Exception type to look up

findErrorPages

ErrorPage[] findErrorPages()

Return the set of defined error pages for all specified error codes and exception types.

findFilterDef

FilterDef findFilterDef(java.lang.String filterName)

Return the filter definition for the specified filter name, if any; otherwise return null.

Parameters:

filterName - Filter name to look up

findFilterDefs

FilterDef[] findFilterDefs()

Return the set of defined filters for this Context.

findFilterMaps

FilterMap[] findFilterMaps()

Return the set of filter mappings for this Context.

findInstanceListeners

java.lang.String[] findInstanceListeners()

Return the set of InstanceListener classes that will be added to newly created Wrappers automatically.

findJspPropertyGroups

JspPropertyGroup[] findJspPropertyGroups()

Return the set of JSP property groups.

findMimeMapping

java.lang.String findMimeMapping(java.lang.String extension)

Return the MIME type to which the specified extension is mapped, if any; otherwise return null.

Parameters:

extension - Extension to map to a MIME type

findMimeMappings

java.lang.String[] findMimeMappings()

Return the extensions for which MIME mappings are defined. If there are none, a zero-length array is returned.

findParameter

java.lang.String findParameter(java.lang.String name)

Return the value for the specified context initialization parameter name, if any; otherwise return null.

Parameters:

name - Name of the parameter to return

findParameters

java.lang.String[] findParameters()

Return the names of all defined context initialization parameters for this Context. If no parameters are defined, a zero-length array is returned.

findRoleMapping

java.lang.String findRoleMapping(java.lang.String role)

For the given security role (as used by an application), return the corresponding role name (as defined by the underlying Realm) if there is one. Otherwise, return the specified role unchanged.

Parameters:

role - Security role to map

findSecurityRole

boolean findSecurityRole(java.lang.String role)

Return true if the specified security role is defined for this application; otherwise return false.

Parameters:

role - Security role to verify

findSecurityRoles

java.lang.String[] findSecurityRoles()

Return the security roles defined for this application. If none have been defined, a zero-length array is returned.

findServletMapping

java.lang.String findServletMapping(java.lang.String pattern)

Return the servlet name mapped by the specified pattern (if any); otherwise return null.

Parameters:

pattern - Pattern for which a mapping is requested

findServletMappings

java.lang.String[] findServletMappings()

Return the patterns of all defined servlet mappings for this Context. If no mappings are defined, a zero-length array is returned.

findStatusPages

int[] findStatusPages()

Return the set of HTTP status codes for which error pages have been specified. If none are specified, a zero-length array is returned.

findTaglib

java.lang.String findTaglib(java.lang.String uri)

Return the tag library descriptor location for the specified taglib URI, if any; otherwise, return null.

Parameters:

uri - URI, relative to the web.xml file

findTaglibs

java.lang.String[] findTaglibs()

Return the URIs of all tag libraries for which a tag library descriptor location has been specified. If none are specified, a zero-length array is returned.

findWatchedResources

java.lang.String[] findWatchedResources()

Return the set of watched resources for this Context. If none are defined, a zero length array will be returned.

findWelcomeFile

boolean findWelcomeFile(java.lang.String name)

Return true if the specified welcome file is defined for this Context; otherwise return false.

Parameters:

name - Welcome file to verify

findWelcomeFiles

java.lang.String[] findWelcomeFiles()

Return the set of welcome files defined for this Context. If none are defined, a zero-length array is returned.

findWrapperLifecycles

java.lang.String[] findWrapperLifecycles()

Return the set of LifecycleListener classes that will be added to newly created Wrappers automatically.

findWrapperListeners

java.lang.String[] findWrapperListeners()

Return the set of ContainerListener classes that will be added to newly created Wrappers automatically.

reload

void reload()

Reload this web application, if reloading is supported.

Throws:

java.lang.IllegalStateException - if the reloadable property is set to false.

removeApplicationListener

void removeApplicationListener(java.lang.String listener)

Remove the specified application listener class from the set of listeners for this application.

Parameters:

listener - Java class name of the listener to be removed

removeApplicationParameter

void removeApplicationParameter(java.lang.String name)

Remove the application parameter with the specified name from the set for this application.

Parameters:

name - Name of the application parameter to remove

removeConstraint

void removeConstraint(SecurityConstraint constraint)

Remove the specified security constraint from this web application.

Parameters:

constraint - Constraint to be removed

removeErrorPage

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.

Parameters:

errorPage - The error page definition to be removed

removeFilterDef

void removeFilterDef(FilterDef filterDef)

Remove the specified filter definition from this Context, if it exists; otherwise, no action is taken.

Parameters:

filterDef - Filter definition to be removed

removeFilterMap

void removeFilterMap(FilterMap filterMap)

Remove a filter mapping from this Context.

Parameters:

filterMap - The filter mapping to be removed

removeInstanceListener

void removeInstanceListener(java.lang.String listener)

Remove a class name from the set of InstanceListener classes that will be added to newly created Wrappers.

Parameters:

listener - Class name of an InstanceListener class to be removed

removeMimeMapping

void removeMimeMapping(java.lang.String extension)

Remove the MIME mapping for the specified extension, if it exists; otherwise, no action is taken.

Parameters:

extension - Extension to remove the mapping for

removeParameter

void removeParameter(java.lang.String name)

Remove the context initialization parameter with the specified name, if it exists; otherwise, no action is taken.

Parameters:

name - Name of the parameter to remove

removeRoleMapping

void removeRoleMapping(java.lang.String role)

Remove any security role reference for the specified name

Parameters:

role - Security role (as used in the application) to remove

removeSecurityRole

void removeSecurityRole(java.lang.String role)

Remove any security role with the specified name.

Parameters:

role - Security role to remove

removeServletMapping

void removeServletMapping(java.lang.String pattern)

Remove any servlet mapping for the specified pattern, if it exists; otherwise, no action is taken.

Parameters:

pattern - URL pattern of the mapping to remove

removeTaglib

void removeTaglib(java.lang.String uri)

Remove the tag library location forthe specified tag library URI.

Parameters:

uri - URI, relative to the web.xml file

removeWatchedResource

void removeWatchedResource(java.lang.String name)

Remove the specified watched resource name from the list associated with this Context.

Parameters:

name - Name of the watched resource to be removed

removeWelcomeFile

void removeWelcomeFile(java.lang.String name)

Remove the specified welcome file name from the list recognized by this Context.

Parameters:

name - Name of the welcome file to be removed

removeWrapperLifecycle

void removeWrapperLifecycle(java.lang.String listener)

Remove a class name from the set of LifecycleListener classes that will be added to newly created Wrappers.

Parameters:

listener - Class name of a LifecycleListener class to be removed

removeWrapperListener

void removeWrapperListener(java.lang.String listener)

Remove a class name from the set of ContainerListener classes that will be added to newly created Wrappers.

Parameters:

listener - Class name of a ContainerListener class to be removed

isInitialized

boolean isInitialized()

Return true if the Context has been initialized. This is lifecycle-ish, but needed by more and more Servlet API operations which are only permitted until the Context is initialized.

Returns:

true if the context is initialized.