org.apache.catalina.core

Class StandardContext

Implemented Interfaces:
Container, Context, Serializable, Lifecycle, MBeanRegistration, Pipeline, Serializable

public class StandardContext
extends ContainerBase
implements Context, Serializable

Standard implementation of the Context interface. Each child container must be a Wrapper implementation to process the requests directed to a particular servlet.

Version:
$Revision: 1.130.2.5 $ $Date: 2004/11/03 22:23:21 $

Authors:
Craig R. McClanahan
Remy Maucherat

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.catalina.core.ContainerBase

ContainerBase.ContainerBackgroundProcessor, ContainerBase.PrivilegedAddChild

Field Summary

protected boolean
allowLinking
Allow linking.
protected int
cacheMaxSize
Cache max size in KB.
protected int
cacheTTL
Cache TTL in ms.
protected boolean
caseSensitive
Case sensitivity.

Fields inherited from class org.apache.catalina.core.ContainerBase

backgroundProcessorDelay, children, cluster, controller, debug, domain, initialized, lifecycle, listeners, loader, logger, manager, mserver, name, oname, parent, parentClassLoader, pipeline, realm, resources, sm, started, suffix, support, type

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

Fields inherited from interface org.apache.catalina.Context

RELOAD_EVENT

Fields inherited from interface org.apache.catalina.Lifecycle

AFTER_START_EVENT, AFTER_STOP_EVENT, BEFORE_START_EVENT, BEFORE_STOP_EVENT, START_EVENT, STOP_EVENT

Constructor Summary

StandardContext()
Create a new StandardContext component with the default basic Valve.

Method Summary

void
addApplicationListener(String listener)
Add a new Listener class name to the set of Listeners configured for this application.
void
addApplicationParameter(ApplicationParameter parameter)
Add a new application parameter for this application.
void
addChild(Container child)
Add a child Container, only if the proposed child is an implementation of Wrapper.
void
addConstraint(SecurityConstraint constraint)
Add a security constraint to the set for this web application.
void
addEjb(ContextEjb ejb)
Add an EJB resource reference for this web application.
String
addEnvironment(String envName, String type)
Add an environment entry for this web application.
void
addEnvironment(ContextEnvironment environment)
Add an environment entry 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
addInstanceListener(String listener)
Add the classname of an InstanceListener to be added to each Wrapper appended to this Context.
void
addJspMapping(String pattern)
Add the given URL pattern as a jsp-property-group.
void
addLocalEjb(ContextLocalEjb ejb)
Add a local EJB resource reference for this web application.
void
addLocaleEncodingMappingParameter(String locale, String encoding)
Add a Locale Encoding Mapping (see Sec 5.4 of Servlet spec 2.4)
void
addMessageDestination(MessageDestination md)
Add a message destination for this web application.
void
addMessageDestinationRef(MessageDestinationRef mdr)
Add a message destination reference for this web application.
void
addMimeMapping(String extension, String mimeType)
Add a new MIME mapping, replacing any existing mapping for the specified extension.
void
addParameter(String name, String value)
Add a new context initialization parameter.
String
addResource(String resourceName, String type)
Add a resource reference for this web application.
void
addResource(ContextResource resource)
Add a resource reference for this web application.
void
addResourceEnvRef(String name, String type)
Add a resource environment reference for this web application.
String
addResourceLink(String resourceLinkName, String global, String name, String type)
Add a resource link for this web application.
void
addResourceLink(ContextResourceLink resourceLink)
Add a resource link for this web application.
void
addResourceParams(ResourceParams resourceParameters)
Add resource parameters for this web application.
void
addRoleMapping(String role, String link)
Add a security role reference for this web application.
void
addSecurityRole(String role)
Add a new security role for this web application.
void
addServletMapping(String pattern, String name)
Add a new servlet mapping, replacing any existing mapping for the specified pattern.
void
addServletMapping(String pattern, String name, boolean jspWildCard)
Add a new servlet mapping, replacing any existing mapping for the specified pattern.
void
addTaglib(String uri, String location)
Add a JSP tag library for the specified URI.
void
addWelcomeFile(String name)
Add a new welcome file to the set recognized by this Context.
void
addWrapperLifecycle(String listener)
Add the classname of a LifecycleListener to be added to each Wrapper appended to this Context.
void
addWrapperListener(String listener)
Add the classname of a ContainerListener to be added to each Wrapper appended to this Context.
protected String
adjustURLPattern(String urlPattern)
Adjust the URL pattern to begin with a leading slash, if appropriate (i.e.
void
backgroundProcess()
Execute a periodic task, such as reloading, etc.
void
create()
ObjectName
createObjectName(String hostDomain, ObjectName parentName)
Wrapper
createWrapper()
Factory method to create and return a new Wrapper instance, of the Java implementation class appropriate for this Context implementation.
void
destroy()
Destroy needs to clean up the context completely.
protected File
engineBase()
Return a File object representing the base directory for the entire servlet container (i.e.
boolean
filterStart()
Configure and initialize the set of filters for this Context.
boolean
filterStop()
Finalize and release the set of filters for this Context.
String[]
findApplicationListeners()
Return the set of application listener class names configured for this application.
ApplicationParameter[]
findApplicationParameters()
Return the set of application parameters for this application.
SecurityConstraint[]
findConstraints()
Return the security constraints for this web application.
ContextEjb
findEjb(String name)
Return the EJB resource reference with the specified name, if any; otherwise, return null.
ContextEjb[]
findEjbs()
Return the defined EJB resource references for this application.
ContextEnvironment
findEnvironment(String name)
Return the environment entry with the specified name, if any; otherwise, return null.
ContextEnvironment[]
findEnvironments()
Return the set of defined environment entries for this web application.
ErrorPage
findErrorPage(String exceptionType)
Return the error page entry for the specified Java exception type, if any; otherwise return null.
ErrorPage
findErrorPage(int errorCode)
Return the error page entry for the specified HTTP error code, if any; otherwise return null.
ErrorPage[]
findErrorPages()
Return the set of defined error pages for all specified error codes and exception types.
FilterConfig
findFilterConfig(String name)
Find and return the initialized FilterConfig for the specified filter name, if any; otherwise return null.
FilterDef
findFilterDef(String filterName)
Return the filter definition for the specified filter name, if any; otherwise return null.
FilterDef[]
findFilterDefs()
Return the set of defined filters for this Context.
FilterMap[]
findFilterMaps()
Return the set of filter mappings for this Context.
String[]
findInstanceListeners()
Return the set of InstanceListener classes that will be added to newly created Wrappers automatically.
ContextLocalEjb
findLocalEjb(String name)
Return the local EJB resource reference with the specified name, if any; otherwise, return null.
ContextLocalEjb[]
findLocalEjbs()
Return the defined local EJB resource references for this application.
Context
findMappingObject()
FIXME: Fooling introspection ...
MessageDestination
findMessageDestination(String name)
Return the message destination with the specified name, if any; otherwise, return null.
MessageDestinationRef
findMessageDestinationRef(String name)
Return the message destination ref with the specified name, if any; otherwise, return null.
MessageDestinationRef[]
findMessageDestinationRefs()
Return the set of defined message destination refs for this web application.
MessageDestination[]
findMessageDestinations()
Return the set of defined message destinations for this web application.
String
findMimeMapping(String extension)
Return the MIME type to which the specified extension is mapped, if any; otherwise return null.
String[]
findMimeMappings()
Return the extensions for which MIME mappings are defined.
String
findParameter(String name)
Return the value for the specified context initialization parameter name, if any; otherwise return null.
String[]
findParameters()
Return the names of all defined context initialization parameters for this Context.
ContextResource
findResource(String name)
Return the resource reference with the specified name, if any; otherwise return null.
String
findResourceEnvRef(String name)
Return the resource environment reference type for the specified name, if any; otherwise return null.
String[]
findResourceEnvRefs()
Return the set of resource environment reference names for this web application.
ContextResourceLink
findResourceLink(String name)
Return the resource link with the specified name, if any; otherwise return null.
ContextResourceLink[]
findResourceLinks()
Return the defined resource links for this application.
ContextResource[]
findResources()
Return the defined resource references for this application.
String
findRoleMapping(String role)
For the given security role (as used by an application), return the corresponding role name (as defined by the underlying Realm) if there is one.
boolean
findSecurityRole(String role)
Return true if the specified security role is defined for this application; otherwise return false.
String[]
findSecurityRoles()
Return the security roles defined for this application.
String
findServletMapping(String pattern)
Return the servlet name mapped by the specified pattern (if any); otherwise return null.
String[]
findServletMappings()
Return the patterns of all defined servlet mappings for this Context.
javax.naming.directory.DirContext
findStaticResources()
Return the naming resources associated with this web application.
String
findStatusPage(int status)
Return the context-relative URI of the error page for the specified HTTP status code, if any; otherwise return null.
int[]
findStatusPages()
Return the set of HTTP status codes for which error pages have been specified.
String
findTaglib(String uri)
Return the tag library descriptor location for the specified taglib URI, if any; otherwise, return null.
String[]
findTaglibs()
Return the URIs of all tag libraries for which a tag library descriptor location has been specified.
boolean
findWelcomeFile(String name)
Return true if the specified welcome file is defined for this Context; otherwise return false.
String[]
findWelcomeFiles()
Return the set of welcome files defined for this Context.
String[]
findWrapperLifecycles()
Return the set of LifecycleListener classes that will be added to newly created Wrappers automatically.
String[]
findWrapperListeners()
Return the set of ContainerListener classes that will be added to newly created Wrappers automatically.
String
getAltDDName()
Return the alternate Deployment Descriptor name.
Object[]
getApplicationEventListeners()
Return the set of initialized application event listener objects, in the order they were specified in the web application deployment descriptor, for this application.
Object[]
getApplicationLifecycleListeners()
Return the set of initialized application lifecycle listener objects, in the order they were specified in the web application deployment descriptor, for this application.
boolean
getAvailable()
Return the application available flag for this Context.
int
getCacheMaxSize()
Return the maximum size of the cache in KB.
int
getCacheTTL()
Get cache TTL.
CharsetMapper
getCharsetMapper()
Return the Locale to character set mapper for this Context.
String
getCharsetMapperClass()
Return the Locale to character set mapper class for this Context.
String
getCompilerClasspath()
Return the compiler classpath.
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.
protected String
getDefaultConfigFile()
Given a context path, get the config file name.
String
getDefaultWebXml()
boolean
getDelegate()
Return the "follow standard delegation model" flag used to configure our ClassLoader.
String
getDeploymentDescriptor()
JSR77 deploymentDescriptor attribute
String
getDisplayName()
Return the display name of this web application.
boolean
getDistributable()
Return the distributable flag for this web application.
String
getDocBase()
Return the document root for this Context.
String
getEngineName()
String[]
getEnvironments()
Return the MBean Names of the set of defined environment entries for this web application
String
getHostname()
String
getInfo()
Return descriptive information about this Container implementation and the corresponding version number, in the format <description>/<version>.
String
getJ2EEApplication()
String
getJ2EEServer()
String[]
getJavaVMs()
LoginConfig
getLoginConfig()
Return the login configuration descriptor for this web application.
int
getManagerChecksFrequency()
Return the frequency of manager checks.
Mapper
getMapper()
Get the mapper associated with the context.
NamingResources
getNamingResources()
Return the naming resources associated with this web application.
boolean
getOverride()
Return the DefaultContext override flag for this web application.
ObjectName
getParentName()
String
getPath()
Return the context path for this Context.
boolean
getPaused()
Return the request processing paused flag for this Context.
boolean
getPrivileged()
Return the privileged flag for this web application.
boolean
getProcessTlds()
Returns the processTlds attribute value.
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.
String[]
getResourceLinks()
Return the MBean Names of all the defined resource links for this application
String[]
getResourceNames()
Return the MBean Names of all the defined resource references for this application.
String
getServer()
ServletContext
getServletContext()
Return the servlet context for which this Context is a facade.
String[]
getServlets()
JSR77 servlets attribute
int
getSessionTimeout()
Return the default session timeout (in minutes) for this web application.
long
getStartTime()
long
getStartupTime()
int
getState()
javax.naming.directory.DirContext
getStaticResources()
Return the naming resources associated with this web application.
boolean
getSwallowOutput()
Return the value of the swallowOutput flag.
boolean
getTldNamespaceAware()
Get the server.xml attribute's xmlNamespaceAware.
long
getTldScanTime()
boolean
getTldValidation()
Get the server.xml attribute's webXmlValidation.
boolean
getUnpackWAR()
Unpack WAR flag accessor.
String[]
getWelcomeFiles()
Return the naming resources associated with this web application.
String
getWorkDir()
Return the work directory for this Context.
String
getWorkPath()
Get the absolute path to the work dir.
String
getWrapperClass()
Return the Java class name of the Wrapper implementation used for servlets registered in this Context.
boolean
getXmlNamespaceAware()
Get the server.xml attribute's xmlNamespaceAware.
boolean
getXmlValidation()
Get the server.xml attribute's xmlValidation.
void
init()
boolean
isAllowLinking()
Is linking allowed.
boolean
isCachingAllowed()
Is caching allowed ?
boolean
isCaseSensitive()
Is case sensitive ?
boolean
isEventProvider()
boolean
isFilesystemBased()
Returns true if the resources associated with this context are filesystem based.
boolean
isLazy()
boolean
isReplaceWelcomeFiles()
Return the "replace welcome files" property.
boolean
isSaveConfig()
Save config ?
protected boolean
isServlet22()
Are we processing a version 2.2 deployment descriptor?
boolean
isStateManageable()
Support for "stateManageable" JSR77
boolean
isStatisticsProvider()
boolean
isUseNaming()
Returns true if the internal naming support is used.
boolean
listenerStart()
Configure the set of instantiated application event listeners for this Context.
boolean
listenerStop()
Send an application stop event to all interested listeners.
void
loadOnStartup(children[] )
Load and initialize all servlets marked "load on startup" in the web application deployment descriptor.
void
preDeregister()
ObjectName
preRegister(MBeanServer server, ObjectName name)
There are 2 cases: 1.The context is created and registered by internal APIS 2.
protected void
processTlds()
Processes the TLDs.
void
reload()
Reload this web application, if reloading is supported.
void
removeApplicationListener(String listener)
Remove the specified application listener class from the set of listeners for this application.
void
removeApplicationParameter(String name)
Remove the application parameter with the specified name from the set for this application.
void
removeChild(Container child)
Add a child Container, only if the proposed child is an implementation of Wrapper.
void
removeConstraint(SecurityConstraint constraint)
Remove the specified security constraint from this web application.
void
removeEjb(String name)
Remove any EJB resource reference with the specified name.
void
removeEnvironment(String name)
Remove any environment entry with the specified name.
void
removeErrorPage(ErrorPage errorPage)
Remove the error page for the specified error code or Java language exception, if it exists; otherwise, no action is taken.
void
removeFilterDef(FilterDef filterDef)
Remove the specified filter definition from this Context, if it exists; otherwise, no action is taken.
void
removeFilterMap(FilterMap filterMap)
Remove a filter mapping from this Context.
void
removeInstanceListener(String listener)
Remove a class name from the set of InstanceListener classes that will be added to newly created Wrappers.
void
removeLocalEjb(String name)
Remove any local EJB resource reference with the specified name.
void
removeMessageDestination(String name)
Remove any message destination with the specified name.
void
removeMessageDestinationRef(String name)
Remove any message destination ref with the specified name.
void
removeMimeMapping(String extension)
Remove the MIME mapping for the specified extension, if it exists; otherwise, no action is taken.
void
removeParameter(String name)
Remove the context initialization parameter with the specified name, if it exists; otherwise, no action is taken.
void
removeResource(String name)
Remove any resource reference with the specified name.
void
removeResourceEnvRef(String name)
Remove any resource environment reference with the specified name.
void
removeResourceLink(String name)
Remove any resource link with the specified name.
void
removeRoleMapping(String role)
Remove any security role reference for the specified name
void
removeSecurityRole(String role)
Remove any security role with the specified name.
void
removeServletMapping(String pattern)
Remove any servlet mapping for the specified pattern, if it exists; otherwise, no action is taken.
void
removeTaglib(String uri)
Remove the tag library location forthe specified tag library URI.
void
removeWelcomeFile(String name)
Remove the specified welcome file name from the list recognized by this Context.
void
removeWrapperLifecycle(String listener)
Remove a class name from the set of LifecycleListener classes that will be added to newly created Wrappers.
void
removeWrapperListener(String listener)
Remove a class name from the set of ContainerListener classes that will be added to newly created Wrappers.
boolean
resourcesStart()
Allocate resources, including proxy.
boolean
resourcesStop()
Deallocate resources and destroy proxy.
void
setAllowLinking(boolean allowLinking)
Set allow linking.
void
setAltDDName(String altDDName)
Set an alternate Deployment Descriptor name.
void
setApplicationEventListeners(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(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
setAvailable(boolean available)
Set the application available flag for this Context.
void
setCacheMaxSize(int cacheMaxSize)
Set the maximum size of the cache in KB.
void
setCacheTTL(int cacheTTL)
Set cache TTL.
void
setCachingAllowed(boolean cachingAllowed)
Set caching allowed flag.
void
setCaseSensitive(boolean caseSensitive)
Set case sensitivity.
void
setCharsetMapper(CharsetMapper mapper)
Set the Locale to character set mapper for this Context.
void
setCharsetMapperClass(String mapper)
Set the Locale to character set mapper class for this Context.
void
setCompilerClasspath(String compilerClasspath)
Set the compiler classpath.
void
setConfigFile(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
setDefaultWebXml(String defaultWebXml)
Set the location of the default web xml that will be used.
void
setDelegate(boolean delegate)
Set the "follow standard delegation model" flag used to configure our ClassLoader.
void
setDisplayName(String displayName)
Set the display name of this web application.
void
setDistributable(boolean distributable)
Set the distributable flag for this web application.
void
setDocBase(String docBase)
Set the document root for this Context.
void
setEngineName(String engineName)
void
setJ2EEApplication(String j2EEApplication)
void
setJ2EEServer(String j2EEServer)
String[]
setJavaVMs(String[] javaVMs)
void
setLazy(boolean lazy)
void
setLoader(Loader loader)
Set the Loader with which this Context is associated.
void
setLoginConfig(LoginConfig config)
Set the login configuration descriptor for this web application.
void
setManagerChecksFrequency(int managerChecksFrequency)
Set the manager checks frequency.
void
setName(String name)
void
setNamingResources(NamingResources namingResources)
Set the naming resources for this web application.
void
setOverride(boolean override)
Set the DefaultContext override flag for this web application.
void
setPath(String path)
Set the context path for this Context.
void
setPrivileged(boolean privileged)
Set the privileged flag for this web application.
void
setProcessTlds(boolean newProcessTlds)
Sets the processTlds attribute value.
void
setPublicId(String publicId)
Set the public identifier of the deployment descriptor DTD that is currently being parsed.
void
setReloadable(boolean reloadable)
Set the reloadable flag for this web application.
void
setReplaceWelcomeFiles(boolean replaceWelcomeFiles)
Set the "replace welcome files" property.
void
setResources(DirContext resources)
Set the resources DirContext object with which this Container is associated.
void
setSaveConfig(boolean saveConfig)
Set save config flag.
String
setServer(String server)
void
setSessionTimeout(int timeout)
Set the default session timeout (in minutes) for this web application.
void
setStartupTime(long startupTime)
void
setSwallowOutput(boolean swallowOutput)
Set the value of the swallowOutput flag.
void
setTldNamespaceAware(boolean tldNamespaceAware)
Set the namespace aware feature of the XML parser used when parsing xml instances.
void
setTldScanTime(long tldScanTime)
void
setTldValidation(boolean tldValidation)
Set the validation feature of the XML parser used when parsing tlds files.
void
setUnpackWAR(boolean unpackWAR)
Unpack WAR flag mutator.
void
setUseNaming(boolean useNaming)
Enables or disables naming.
void
setWorkDir(String workDir)
Set the work directory for this Context.
void
setWrapperClass(String wrapperClass)
Set the Java class name of the Wrapper implementation used for servlets registered in this Context.
void
setXmlNamespaceAware(boolean webXmlNamespaceAware)
Set the namespace aware feature of the XML parser used when parsing xml instances.
void
setXmlValidation(boolean webXmlValidation)
Set the validation feature of the XML parser used when parsing xml instances.
void
start()
Start this Context component.
void
startRecursive()
void
stop()
Stop this Context component.
void
stopNew()
Stop this Context component.
String
toString()
Return a String representation of this component.

Methods inherited from class org.apache.catalina.core.ContainerBase

addChild, addContainerListener, addLifecycleListener, addPropertyChangeListener, addValve, backgroundProcess, createObjectName, destroy, findChild, findChildren, findContainerListeners, findLifecycleListeners, fireContainerEvent, getBackgroundProcessorDelay, getBasic, getChildren, getCluster, getContainerSuffix, getDebug, getDomain, getInfo, getJSR77Suffix, getJmxName, getLoader, getLogger, getManager, getMappingObject, getName, getObjectName, getParent, getParentClassLoader, getParentName, getPipeline, getRealm, getResources, getType, getValveObjectNames, getValves, init, invoke, log, log, logName, postDeregister, postRegister, preDeregister, preRegister, removeChild, removeContainerListener, removeLifecycleListener, removePropertyChangeListener, removeValve, setBackgroundProcessorDelay, setBasic, setCluster, setDebug, setDomain, setLoader, setLogger, setManager, setName, setParent, setParentClassLoader, setRealm, setResources, start, stop, threadStart, threadStop

Field Details

allowLinking

protected boolean allowLinking
Allow linking.


cacheMaxSize

protected int cacheMaxSize
Cache max size in KB.


cacheTTL

protected int cacheTTL
Cache TTL in ms.


caseSensitive

protected boolean caseSensitive
Case sensitivity.

Constructor Details

StandardContext

public StandardContext()
Create a new StandardContext component with the default basic Valve.

Method Details

addApplicationListener

public void addApplicationListener(String listener)
Add a new Listener class name to the set of Listeners configured for this application.
Specified by:
addApplicationListener in interface Context

Parameters:
listener - Java class name of a listener class


addApplicationParameter

public void addApplicationParameter(ApplicationParameter parameter)
Add a new application parameter for this application.
Specified by:
addApplicationParameter in interface Context

Parameters:
parameter - The new application parameter


addChild

public void addChild(Container child)
Add a child Container, only if the proposed child is an implementation of Wrapper.
Specified by:
addChild in interface Container
Overrides:
addChild in interface ContainerBase

Parameters:
child - Child container to be added


addConstraint

public void addConstraint(SecurityConstraint constraint)
Add a security constraint to the set for this web application.
Specified by:
addConstraint in interface Context


addEjb

public void addEjb(ContextEjb ejb)
Add an EJB resource reference for this web application.
Specified by:
addEjb in interface Context

Parameters:
ejb - New EJB resource reference


addEnvironment

public String addEnvironment(String envName,
                             String type)
            throws MalformedObjectNameException
Add an environment entry for this web application.

Parameters:
envName - New environment entry name


addEnvironment

public void addEnvironment(ContextEnvironment environment)
Add an environment entry for this web application.
Specified by:
addEnvironment in interface Context

Parameters:
environment - New environment entry


addErrorPage

public void addErrorPage(ErrorPage errorPage)
Add an error page for the specified error or Java exception.
Specified by:
addErrorPage in interface Context

Parameters:
errorPage - The error page definition to be added


addFilterDef

public void addFilterDef(FilterDef filterDef)
Add a filter definition to this Context.
Specified by:
addFilterDef in interface Context

Parameters:
filterDef - The filter definition to be added


addFilterMap

public void addFilterMap(FilterMap filterMap)
Add a filter mapping to this Context.
Specified by:
addFilterMap in interface Context

Parameters:
filterMap - The filter mapping to be added


addInstanceListener

public void addInstanceListener(String listener)
Add the classname of an InstanceListener to be added to each Wrapper appended to this Context.
Specified by:
addInstanceListener in interface Context

Parameters:
listener - Java class name of an InstanceListener class


addJspMapping

public void addJspMapping(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.
Specified by:
addJspMapping in interface Context

Parameters:
pattern - URL pattern to be mapped


addLocalEjb

public void addLocalEjb(ContextLocalEjb ejb)
Add a local EJB resource reference for this web application.
Specified by:
addLocalEjb in interface Context

Parameters:
ejb - New EJB resource reference


addLocaleEncodingMappingParameter

public void addLocaleEncodingMappingParameter(String locale,
                                              String encoding)
Add a Locale Encoding Mapping (see Sec 5.4 of Servlet spec 2.4)
Specified by:
addLocaleEncodingMappingParameter in interface Context

Parameters:
locale - locale to map an encoding for
encoding - encoding to be used for a give locale


addMessageDestination

public void addMessageDestination(MessageDestination md)
Add a message destination for this web application.

Parameters:
md - New message destination


addMessageDestinationRef

public void addMessageDestinationRef(MessageDestinationRef mdr)
Add a message destination reference for this web application.

Parameters:
mdr - New message destination reference


addMimeMapping

public void addMimeMapping(String extension,
                           String mimeType)
Add a new MIME mapping, replacing any existing mapping for the specified extension.
Specified by:
addMimeMapping in interface Context

Parameters:
extension - Filename extension being mapped
mimeType - Corresponding MIME type


addParameter

public void addParameter(String name,
                         String value)
Add a new context initialization parameter.
Specified by:
addParameter in interface Context

Parameters:
name - Name of the new parameter
value - Value of the new parameter


addResource

public String addResource(String resourceName,
                          String type)
            throws MalformedObjectNameException
Add a resource reference for this web application.

Parameters:
resourceName - New resource reference name


addResource

public void addResource(ContextResource resource)
Add a resource reference for this web application.
Specified by:
addResource in interface Context

Parameters:
resource - New resource reference


addResourceEnvRef

public void addResourceEnvRef(String name,
                              String type)
Add a resource environment reference for this web application.
Specified by:
addResourceEnvRef in interface Context

Parameters:
name - The resource environment reference name
type - The resource environment reference type


addResourceLink

public String addResourceLink(String resourceLinkName,
                              String global,
                              String name,
                              String type)
            throws MalformedObjectNameException
Add a resource link for this web application.

Parameters:
resourceLinkName - New resource link name


addResourceLink

public void addResourceLink(ContextResourceLink resourceLink)
Add a resource link for this web application.
Specified by:
addResourceLink in interface Context

Parameters:
resourceLink - New resource link


addResourceParams

public void addResourceParams(ResourceParams resourceParameters)
Add resource parameters for this web application.

Parameters:
resourceParameters - New resource parameters


addRoleMapping

public void addRoleMapping(String role,
                           String link)
Add a security role reference for this web application.
Specified by:
addRoleMapping in interface Context

Parameters:
role - Security role used in the application
link - Actual security role to check for


addSecurityRole

public void addSecurityRole(String role)
Add a new security role for this web application.
Specified by:
addSecurityRole in interface Context

Parameters:
role - New security role


addServletMapping

public void addServletMapping(String pattern,
                              String name)
Add a new servlet mapping, replacing any existing mapping for the specified pattern.
Specified by:
addServletMapping in interface Context

Parameters:
pattern - URL pattern to be mapped
name - Name of the corresponding servlet to execute


addServletMapping

public void addServletMapping(String pattern,
                              String name,
                              boolean jspWildCard)
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
jspWildCard - true if name identifies the JspServlet and pattern contains a wildcard; false otherwise


addTaglib

public void addTaglib(String uri,
                      String location)
Add a JSP tag library for the specified URI.
Specified by:
addTaglib in interface Context

Parameters:
uri - URI, relative to the web.xml file, of this tag library
location - Location of the tag library descriptor


addWelcomeFile

public void addWelcomeFile(String name)
Add a new welcome file to the set recognized by this Context.
Specified by:
addWelcomeFile in interface Context

Parameters:
name - New welcome file name


addWrapperLifecycle

public void addWrapperLifecycle(String listener)
Add the classname of a LifecycleListener to be added to each Wrapper appended to this Context.
Specified by:
addWrapperLifecycle in interface Context

Parameters:
listener - Java class name of a LifecycleListener class


addWrapperListener

public void addWrapperListener(String listener)
Add the classname of a ContainerListener to be added to each Wrapper appended to this Context.
Specified by:
addWrapperListener in interface Context

Parameters:
listener - Java class name of a ContainerListener class


adjustURLPattern

protected String adjustURLPattern(String urlPattern)
Adjust the URL pattern to begin with a leading slash, if appropriate (i.e. we are running a servlet 2.2 application). Otherwise, return the specified URL pattern unchanged.

Parameters:
urlPattern - The URL pattern to be adjusted (if needed) and returned


backgroundProcess

public void backgroundProcess()
Execute a periodic task, such as reloading, etc. This method will be invoked inside the classloading context of this container. Unexpected throwables will be caught and logged.
Specified by:
backgroundProcess in interface Container
Overrides:
backgroundProcess in interface ContainerBase


create

public void create()
            throws Exception


createObjectName

public ObjectName createObjectName(String hostDomain,
                                   ObjectName parentName)
            throws MalformedObjectNameException
Overrides:
createObjectName in interface ContainerBase


createWrapper

public Wrapper createWrapper()
Factory method to create and return a new Wrapper instance, of the Java implementation class appropriate for this Context implementation. The constructor of the instantiated Wrapper will have been called, but no properties will have been set.
Specified by:
createWrapper in interface Context


destroy

public void destroy()
            throws Exception
Destroy needs to clean up the context completely. The problem is that undoing all the config in start() and restoring a 'fresh' state is impossible. After stop()/destroy()/init()/start() we should have the same state as if a fresh start was done - i.e read modified web.xml, etc. This can only be done by completely removing the context object and remapping a new one, or by cleaning up everything. XXX Should this be done in stop() ?
Overrides:
destroy in interface ContainerBase


engineBase

protected File engineBase()
Return a File object representing the base directory for the entire servlet container (i.e. the Engine container if present).


filterStart

public boolean filterStart()
Configure and initialize the set of filters for this Context. Return true if all filter initialization completed successfully, or false otherwise.


filterStop

public boolean filterStop()
Finalize and release the set of filters for this Context. Return true if all filter finalization completed successfully, or false otherwise.


findApplicationListeners

public String[] findApplicationListeners()
Return the set of application listener class names configured for this application.
Specified by:
findApplicationListeners in interface Context


findApplicationParameters

public ApplicationParameter[] findApplicationParameters()
Return the set of application parameters for this application.
Specified by:
findApplicationParameters in interface Context


findConstraints

public SecurityConstraint[] findConstraints()
Return the security constraints for this web application. If there are none, a zero-length array is returned.
Specified by:
findConstraints in interface Context


findEjb

public ContextEjb findEjb(String name)
Return the EJB resource reference with the specified name, if any; otherwise, return null.
Specified by:
findEjb in interface Context

Parameters:
name - Name of the desired EJB resource reference


findEjbs

public ContextEjb[] findEjbs()
Return the defined EJB resource references for this application. If there are none, a zero-length array is returned.
Specified by:
findEjbs in interface Context


findEnvironment

public ContextEnvironment findEnvironment(String name)
Return the environment entry with the specified name, if any; otherwise, return null.
Specified by:
findEnvironment in interface Context

Parameters:
name - Name of the desired environment entry


findEnvironments

public ContextEnvironment[] findEnvironments()
Return the set of defined environment entries for this web application. If none have been defined, a zero-length array is returned.
Specified by:
findEnvironments in interface Context


findErrorPage

public ErrorPage findErrorPage(String exceptionType)
Return the error page entry for the specified Java exception type, if any; otherwise return null.
Specified by:
findErrorPage in interface Context

Parameters:
exceptionType - Exception type to look up


findErrorPage

public ErrorPage findErrorPage(int errorCode)
Return the error page entry for the specified HTTP error code, if any; otherwise return null.
Specified by:
findErrorPage in interface Context

Parameters:
errorCode - Error code to look up


findErrorPages

public ErrorPage[] findErrorPages()
Return the set of defined error pages for all specified error codes and exception types.
Specified by:
findErrorPages in interface Context


findFilterConfig

public FilterConfig findFilterConfig(String name)
Find and return the initialized FilterConfig for the specified filter name, if any; otherwise return null.

Parameters:
name - Name of the desired filter


findFilterDef

public FilterDef findFilterDef(String filterName)
Return the filter definition for the specified filter name, if any; otherwise return null.
Specified by:
findFilterDef in interface Context

Parameters:
filterName - Filter name to look up


findFilterDefs

public FilterDef[] findFilterDefs()
Return the set of defined filters for this Context.
Specified by:
findFilterDefs in interface Context


findFilterMaps

public FilterMap[] findFilterMaps()
Return the set of filter mappings for this Context.
Specified by:
findFilterMaps in interface Context


findInstanceListeners

public String[] findInstanceListeners()
Return the set of InstanceListener classes that will be added to newly created Wrappers automatically.
Specified by:
findInstanceListeners in interface Context


findLocalEjb

public ContextLocalEjb findLocalEjb(String name)
Return the local EJB resource reference with the specified name, if any; otherwise, return null.
Specified by:
findLocalEjb in interface Context

Parameters:
name - Name of the desired EJB resource reference


findLocalEjbs

public ContextLocalEjb[] findLocalEjbs()
Return the defined local EJB resource references for this application. If there are none, a zero-length array is returned.
Specified by:
findLocalEjbs in interface Context


findMappingObject

public Context findMappingObject()
FIXME: Fooling introspection ...


findMessageDestination

public MessageDestination findMessageDestination(String name)
Return the message destination with the specified name, if any; otherwise, return null.

Parameters:
name - Name of the desired message destination


findMessageDestinationRef

public MessageDestinationRef findMessageDestinationRef(String name)
Return the message destination ref with the specified name, if any; otherwise, return null.

Parameters:
name - Name of the desired message destination ref


findMessageDestinationRefs

public MessageDestinationRef[] findMessageDestinationRefs()
Return the set of defined message destination refs for this web application. If none have been defined, a zero-length array is returned.


findMessageDestinations

public MessageDestination[] findMessageDestinations()
Return the set of defined message destinations for this web application. If none have been defined, a zero-length array is returned.


findMimeMapping

public String findMimeMapping(String extension)
Return the MIME type to which the specified extension is mapped, if any; otherwise return null.
Specified by:
findMimeMapping in interface Context

Parameters:
extension - Extension to map to a MIME type


findMimeMappings

public String[] findMimeMappings()
Return the extensions for which MIME mappings are defined. If there are none, a zero-length array is returned.
Specified by:
findMimeMappings in interface Context


findParameter

public String findParameter(String name)
Return the value for the specified context initialization parameter name, if any; otherwise return null.
Specified by:
findParameter in interface Context

Parameters:
name - Name of the parameter to return


findParameters

public 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.
Specified by:
findParameters in interface Context


findResource

public ContextResource findResource(String name)
Return the resource reference with the specified name, if any; otherwise return null.
Specified by:
findResource in interface Context

Parameters:
name - Name of the desired resource reference


findResourceEnvRef

public String findResourceEnvRef(String name)
Return the resource environment reference type for the specified name, if any; otherwise return null.
Specified by:
findResourceEnvRef in interface Context

Parameters:
name - Name of the desired resource environment reference


findResourceEnvRefs

public String[] findResourceEnvRefs()
Return the set of resource environment reference names for this web application. If none have been specified, a zero-length array is returned.
Specified by:
findResourceEnvRefs in interface Context


findResourceLink

public ContextResourceLink findResourceLink(String name)
Return the resource link with the specified name, if any; otherwise return null.
Specified by:
findResourceLink in interface Context

Parameters:
name - Name of the desired resource link


findResourceLinks

public ContextResourceLink[] findResourceLinks()
Return the defined resource links for this application. If none have been defined, a zero-length array is returned.
Specified by:
findResourceLinks in interface Context


findResources

public ContextResource[] findResources()
Return the defined resource references for this application. If none have been defined, a zero-length array is returned.
Specified by:
findResources in interface Context


findRoleMapping

public String findRoleMapping(String role)
For the given security role (as used by an application), return the corresponding role name (as defined by the underlying Realm) if there is one. Otherwise, return the specified role unchanged.
Specified by:
findRoleMapping in interface Context

Parameters:
role - Security role to map


findSecurityRole

public boolean findSecurityRole(String role)
Return true if the specified security role is defined for this application; otherwise return false.
Specified by:
findSecurityRole in interface Context

Parameters:
role - Security role to verify


findSecurityRoles

public String[] findSecurityRoles()
Return the security roles defined for this application. If none have been defined, a zero-length array is returned.
Specified by:
findSecurityRoles in interface Context


findServletMapping

public String findServletMapping(String pattern)
Return the servlet name mapped by the specified pattern (if any); otherwise return null.
Specified by:
findServletMapping in interface Context

Parameters:
pattern - Pattern for which a mapping is requested


findServletMappings

public String[] findServletMappings()
Return the patterns of all defined servlet mappings for this Context. If no mappings are defined, a zero-length array is returned.
Specified by:
findServletMappings in interface Context


findStaticResources

public javax.naming.directory.DirContext findStaticResources()
Return the naming resources associated with this web application. FIXME: Fooling introspection ...


findStatusPage

public String findStatusPage(int status)
Return the context-relative URI of the error page for the specified HTTP status code, if any; otherwise return null.
Specified by:
findStatusPage in interface Context

Parameters:
status - HTTP status code to look up


findStatusPages

public 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.
Specified by:
findStatusPages in interface Context


findTaglib

public String findTaglib(String uri)
Return the tag library descriptor location for the specified taglib URI, if any; otherwise, return null.
Specified by:
findTaglib in interface Context

Parameters:
uri - URI, relative to the web.xml file


findTaglibs

public 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.
Specified by:
findTaglibs in interface Context


findWelcomeFile

public boolean findWelcomeFile(String name)
Return true if the specified welcome file is defined for this Context; otherwise return false.
Specified by:
findWelcomeFile in interface Context

Parameters:
name - Welcome file to verify


findWelcomeFiles

public String[] findWelcomeFiles()
Return the set of welcome files defined for this Context. If none are defined, a zero-length array is returned.
Specified by:
findWelcomeFiles in interface Context


findWrapperLifecycles

public String[] findWrapperLifecycles()
Return the set of LifecycleListener classes that will be added to newly created Wrappers automatically.
Specified by:
findWrapperLifecycles in interface Context


findWrapperListeners

public String[] findWrapperListeners()
Return the set of ContainerListener classes that will be added to newly created Wrappers automatically.
Specified by:
findWrapperListeners in interface Context


getAltDDName

public String getAltDDName()
Return the alternate Deployment Descriptor name.
Specified by:
getAltDDName in interface Context


getApplicationEventListeners

public 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.
Specified by:
getApplicationEventListeners in interface Context


getApplicationLifecycleListeners

public 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.
Specified by:
getApplicationLifecycleListeners in interface Context


getAvailable

public boolean getAvailable()
Return the application available flag for this Context.
Specified by:
getAvailable in interface Context


getCacheMaxSize

public int getCacheMaxSize()
Return the maximum size of the cache in KB.


getCacheTTL

public int getCacheTTL()
Get cache TTL.


getCharsetMapper

public CharsetMapper getCharsetMapper()
Return the Locale to character set mapper for this Context.
Specified by:
getCharsetMapper in interface Context


getCharsetMapperClass

public String getCharsetMapperClass()
Return the Locale to character set mapper class for this Context.


getCompilerClasspath

public String getCompilerClasspath()
Return the compiler classpath.


getConfigFile

public String getConfigFile()
Return the path to a file to save this Context information.
Specified by:
getConfigFile in interface Context


getConfigured

public boolean getConfigured()
Return the "correctly configured" flag for this Context.
Specified by:
getConfigured in interface Context


getCookies

public boolean getCookies()
Return the "use cookies for session ids" flag.
Specified by:
getCookies in interface Context


getCrossContext

public boolean getCrossContext()
Return the "allow crossing servlet contexts" flag.
Specified by:
getCrossContext in interface Context


getDefaultConfigFile

protected String getDefaultConfigFile()
Given a context path, get the config file name.


getDefaultWebXml

public String getDefaultWebXml()


getDelegate

public boolean getDelegate()
Return the "follow standard delegation model" flag used to configure our ClassLoader.


getDeploymentDescriptor

public String getDeploymentDescriptor()
JSR77 deploymentDescriptor attribute

Returns:
string deployment descriptor


getDisplayName

public String getDisplayName()
Return the display name of this web application.
Specified by:
getDisplayName in interface Context


getDistributable

public boolean getDistributable()
Return the distributable flag for this web application.
Specified by:
getDistributable in interface Context


getDocBase

public String getDocBase()
Return the document root for this Context. This can be an absolute pathname, a relative pathname, or a URL.
Specified by:
getDocBase in interface Context


getEngineName

public String getEngineName()


getEnvironments

public String[] getEnvironments()
Return the MBean Names of the set of defined environment entries for this web application


getHostname

public String getHostname()


getInfo

public String getInfo()
Return descriptive information about this Container implementation and the corresponding version number, in the format <description>/<version>.
Specified by:
getInfo in interface Container
Overrides:
getInfo in interface ContainerBase


getJ2EEApplication

public String getJ2EEApplication()


getJ2EEServer

public String getJ2EEServer()


getJavaVMs

public String[] getJavaVMs()


getLoginConfig

public LoginConfig getLoginConfig()
Return the login configuration descriptor for this web application.
Specified by:
getLoginConfig in interface Context


getManagerChecksFrequency

public int getManagerChecksFrequency()
Return the frequency of manager checks.


getMapper

public Mapper getMapper()
Get the mapper associated with the context.
Specified by:
getMapper in interface Context


getNamingResources

public NamingResources getNamingResources()
Return the naming resources associated with this web application.
Specified by:
getNamingResources in interface Context


getOverride

public boolean getOverride()
Return the DefaultContext override flag for this web application.
Specified by:
getOverride in interface Context


getParentName

public ObjectName getParentName()
            throws MalformedObjectNameException
Overrides:
getParentName in interface ContainerBase


getPath

public String getPath()
Return the context path for this Context.
Specified by:
getPath in interface Context


getPaused

public boolean getPaused()
Return the request processing paused flag for this Context.


getPrivileged

public boolean getPrivileged()
Return the privileged flag for this web application.
Specified by:
getPrivileged in interface Context


getProcessTlds

public boolean getProcessTlds()
Returns the processTlds attribute value.


getPublicId

public String getPublicId()
Return the public identifier of the deployment descriptor DTD that is currently being parsed.
Specified by:
getPublicId in interface Context


getReloadable

public boolean getReloadable()
Return the reloadable flag for this web application.
Specified by:
getReloadable in interface Context


getResourceLinks

public String[] getResourceLinks()
Return the MBean Names of all the defined resource links for this application


getResourceNames

public String[] getResourceNames()
Return the MBean Names of all the defined resource references for this application.


getServer

public String getServer()


getServletContext

public ServletContext getServletContext()
Return the servlet context for which this Context is a facade.
Specified by:
getServletContext in interface Context


getServlets

public String[] getServlets()
JSR77 servlets attribute

Returns:
list of all servlets ( we know about )


getSessionTimeout

public int getSessionTimeout()
Return the default session timeout (in minutes) for this web application.
Specified by:
getSessionTimeout in interface Context


getStartTime

public long getStartTime()


getStartupTime

public long getStartupTime()


getState

public int getState()


getStaticResources

public javax.naming.directory.DirContext getStaticResources()
Return the naming resources associated with this web application.


getSwallowOutput

public boolean getSwallowOutput()
Return the value of the swallowOutput flag.


getTldNamespaceAware

public boolean getTldNamespaceAware()
Get the server.xml attribute's xmlNamespaceAware.
Specified by:
getTldNamespaceAware in interface Context

Returns:
true if namespace awarenes is enabled.


getTldScanTime

public long getTldScanTime()


getTldValidation

public boolean getTldValidation()
Get the server.xml attribute's webXmlValidation.
Specified by:
getTldValidation in interface Context

Returns:
true if validation is enabled.


getUnpackWAR

public boolean getUnpackWAR()
Unpack WAR flag accessor.


getWelcomeFiles

public String[] getWelcomeFiles()
Return the naming resources associated with this web application.


getWorkDir

public String getWorkDir()
Return the work directory for this Context.


getWorkPath

public String getWorkPath()
Get the absolute path to the work dir. To avoid duplication.

Returns:
The work path


getWrapperClass

public String getWrapperClass()
Return the Java class name of the Wrapper implementation used for servlets registered in this Context.
Specified by:
getWrapperClass in interface Context


getXmlNamespaceAware

public boolean getXmlNamespaceAware()
Get the server.xml attribute's xmlNamespaceAware.
Specified by:
getXmlNamespaceAware in interface Context

Returns:
true if namespace awarenes is enabled.


getXmlValidation

public boolean getXmlValidation()
Get the server.xml attribute's xmlValidation.
Specified by:
getXmlValidation in interface Context

Returns:
true if validation is enabled.


init

public void init()
            throws Exception
Overrides:
init in interface ContainerBase


isAllowLinking

public boolean isAllowLinking()
Is linking allowed.


isCachingAllowed

public boolean isCachingAllowed()
Is caching allowed ?


isCaseSensitive

public boolean isCaseSensitive()
Is case sensitive ?


isEventProvider

public boolean isEventProvider()


isFilesystemBased

public boolean isFilesystemBased()
Returns true if the resources associated with this context are filesystem based.


isLazy

public boolean isLazy()


isReplaceWelcomeFiles

public boolean isReplaceWelcomeFiles()
Return the "replace welcome files" property.


isSaveConfig

public boolean isSaveConfig()
Save config ?


isServlet22

protected boolean isServlet22()
Are we processing a version 2.2 deployment descriptor?


isStateManageable

public boolean isStateManageable()
Support for "stateManageable" JSR77


isStatisticsProvider

public boolean isStatisticsProvider()


isUseNaming

public boolean isUseNaming()
Returns true if the internal naming support is used.


listenerStart

public boolean listenerStart()
Configure the set of instantiated application event listeners for this Context. Return true if all listeners wre initialized successfully, or false otherwise.


listenerStop

public boolean listenerStop()
Send an application stop event to all interested listeners. Return true if all events were sent successfully, or false otherwise.


loadOnStartup

public void loadOnStartup(children[] )
Load and initialize all servlets marked "load on startup" in the web application deployment descriptor.

Parameters:


preDeregister

public void preDeregister()
            throws Exception
Overrides:
preDeregister in interface ContainerBase


preRegister

public ObjectName preRegister(MBeanServer server,
                              ObjectName name)
            throws Exception
There are 2 cases: 1.The context is created and registered by internal APIS 2. The context is created by JMX, and it'll self-register.
Overrides:
preRegister in interface ContainerBase

Parameters:
server - The server
name - The object name

Returns:
ObjectName The name of the object


processTlds

protected void processTlds()
            throws LifecycleException
Processes the TLDs.

Throws:
LifecycleException - If an error occurs


reload

public void reload()
Reload this web application, if reloading is supported.

IMPLEMENTATION NOTE: This method is designed to deal with reloads required by changes to classes in the underlying repositories of our class loader. It does not handle changes to the web application deployment descriptor. If that has occurred, you should stop this Context and create (and start) a new Context instance instead.

Specified by:
reload in interface Context


removeApplicationListener

public void removeApplicationListener(String listener)
Remove the specified application listener class from the set of listeners for this application.
Specified by:
removeApplicationListener in interface Context

Parameters:
listener - Java class name of the listener to be removed


removeApplicationParameter

public void removeApplicationParameter(String name)
Remove the application parameter with the specified name from the set for this application.
Specified by:
removeApplicationParameter in interface Context

Parameters:
name - Name of the application parameter to remove


removeChild

public void removeChild(Container child)
Add a child Container, only if the proposed child is an implementation of Wrapper.
Specified by:
removeChild in interface Container
Overrides:
removeChild in interface ContainerBase

Parameters:
child - Child container to be added


removeConstraint

public void removeConstraint(SecurityConstraint constraint)
Remove the specified security constraint from this web application.
Specified by:
removeConstraint in interface Context

Parameters:
constraint - Constraint to be removed


removeEjb

public void removeEjb(String name)
Remove any EJB resource reference with the specified name.
Specified by:
removeEjb in interface Context

Parameters:
name - Name of the EJB resource reference to remove


removeEnvironment

public void removeEnvironment(String name)
Remove any environment entry with the specified name.
Specified by:
removeEnvironment in interface Context

Parameters:
name - Name of the environment entry to remove


removeErrorPage

public void removeErrorPage(ErrorPage errorPage)
Remove the error page for the specified error code or Java language exception, if it exists; otherwise, no action is taken.
Specified by:
removeErrorPage in interface Context

Parameters:
errorPage - The error page definition to be removed


removeFilterDef

public void removeFilterDef(FilterDef filterDef)
Remove the specified filter definition from this Context, if it exists; otherwise, no action is taken.
Specified by:
removeFilterDef in interface Context

Parameters:
filterDef - Filter definition to be removed


removeFilterMap

public void removeFilterMap(FilterMap filterMap)
Remove a filter mapping from this Context.
Specified by:
removeFilterMap in interface Context

Parameters:
filterMap - The filter mapping to be removed


removeInstanceListener

public void removeInstanceListener(String listener)
Remove a class name from the set of InstanceListener classes that will be added to newly created Wrappers.
Specified by:
removeInstanceListener in interface Context

Parameters:
listener - Class name of an InstanceListener class to be removed


removeLocalEjb

public void removeLocalEjb(String name)
Remove any local EJB resource reference with the specified name.
Specified by:
removeLocalEjb in interface Context

Parameters:
name - Name of the EJB resource reference to remove


removeMessageDestination

public void removeMessageDestination(String name)
Remove any message destination with the specified name.

Parameters:
name - Name of the message destination to remove


removeMessageDestinationRef

public void removeMessageDestinationRef(String name)
Remove any message destination ref with the specified name.

Parameters:
name - Name of the message destination ref to remove


removeMimeMapping

public void removeMimeMapping(String extension)
Remove the MIME mapping for the specified extension, if it exists; otherwise, no action is taken.
Specified by:
removeMimeMapping in interface Context

Parameters:
extension - Extension to remove the mapping for


removeParameter

public void removeParameter(String name)
Remove the context initialization parameter with the specified name, if it exists; otherwise, no action is taken.
Specified by:
removeParameter in interface Context

Parameters:
name - Name of the parameter to remove


removeResource

public void removeResource(String name)
Remove any resource reference with the specified name.
Specified by:
removeResource in interface Context

Parameters:
name - Name of the resource reference to remove


removeResourceEnvRef

public void removeResourceEnvRef(String name)
Remove any resource environment reference with the specified name.
Specified by:
removeResourceEnvRef in interface Context

Parameters:
name - Name of the resource environment reference to remove


removeResourceLink

public void removeResourceLink(String name)
Remove any resource link with the specified name.
Specified by:
removeResourceLink in interface Context

Parameters:
name - Name of the resource link to remove


removeRoleMapping

public void removeRoleMapping(String role)
Remove any security role reference for the specified name
Specified by:
removeRoleMapping in interface Context

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


removeSecurityRole

public void removeSecurityRole(String role)
Remove any security role with the specified name.
Specified by:
removeSecurityRole in interface Context

Parameters:
role - Security role to remove


removeServletMapping

public void removeServletMapping(String pattern)
Remove any servlet mapping for the specified pattern, if it exists; otherwise, no action is taken.
Specified by:
removeServletMapping in interface Context

Parameters:
pattern - URL pattern of the mapping to remove


removeTaglib

public void removeTaglib(String uri)
Remove the tag library location forthe specified tag library URI.
Specified by:
removeTaglib in interface Context

Parameters:
uri - URI, relative to the web.xml file


removeWelcomeFile

public void removeWelcomeFile(String name)
Remove the specified welcome file name from the list recognized by this Context.
Specified by:
removeWelcomeFile in interface Context

Parameters:
name - Name of the welcome file to be removed


removeWrapperLifecycle

public void removeWrapperLifecycle(String listener)
Remove a class name from the set of LifecycleListener classes that will be added to newly created Wrappers.
Specified by:
removeWrapperLifecycle in interface Context

Parameters:
listener - Class name of a LifecycleListener class to be removed


removeWrapperListener

public void removeWrapperListener(String listener)
Remove a class name from the set of ContainerListener classes that will be added to newly created Wrappers.
Specified by:
removeWrapperListener in interface Context

Parameters:
listener - Class name of a ContainerListener class to be removed


resourcesStart

public boolean resourcesStart()
Allocate resources, including proxy. Return true if initialization was successfull, or false otherwise.


resourcesStop

public boolean resourcesStop()
Deallocate resources and destroy proxy.


setAllowLinking

public void setAllowLinking(boolean allowLinking)
Set allow linking.


setAltDDName

public void setAltDDName(String altDDName)
Set an alternate Deployment Descriptor name.
Specified by:
setAltDDName in interface Context


setApplicationEventListeners

public void setApplicationEventListeners(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.
Specified by:
setApplicationEventListeners in interface Context

Parameters:


setApplicationLifecycleListeners

public void setApplicationLifecycleListeners(listeners[] )
Store the set of initialized application lifecycle listener objects, in the order they were specified in the web application deployment descriptor, for this application.
Specified by:
setApplicationLifecycleListeners in interface Context

Parameters:


setAvailable

public void setAvailable(boolean available)
Set the application available flag for this Context.
Specified by:
setAvailable in interface Context

Parameters:
available - The new application available flag


setCacheMaxSize

public void setCacheMaxSize(int cacheMaxSize)
Set the maximum size of the cache in KB.


setCacheTTL

public void setCacheTTL(int cacheTTL)
Set cache TTL.


setCachingAllowed

public void setCachingAllowed(boolean cachingAllowed)
Set caching allowed flag.


setCaseSensitive

public void setCaseSensitive(boolean caseSensitive)
Set case sensitivity.


setCharsetMapper

public void setCharsetMapper(CharsetMapper mapper)
Set the Locale to character set mapper for this Context.
Specified by:
setCharsetMapper in interface Context

Parameters:
mapper - The new mapper


setCharsetMapperClass

public void setCharsetMapperClass(String mapper)
Set the Locale to character set mapper class for this Context.

Parameters:
mapper - The new mapper class


setCompilerClasspath

public void setCompilerClasspath(String compilerClasspath)
Set the compiler classpath.


setConfigFile

public void setConfigFile(String configFile)
Set the path to a file to save this Context information.
Specified by:
setConfigFile in interface Context

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


setConfigured

public void setConfigured(boolean configured)
Set the "correctly configured" flag for this Context. This can be set to false by startup listeners that detect a fatal configuration error to avoid the application from being made available.
Specified by:
setConfigured in interface Context

Parameters:
configured - The new correctly configured flag


setCookies

public void setCookies(boolean cookies)
Set the "use cookies for session ids" flag.
Specified by:
setCookies in interface Context

Parameters:
cookies - The new flag


setCrossContext

public void setCrossContext(boolean crossContext)
Set the "allow crossing servlet contexts" flag.
Specified by:
setCrossContext in interface Context

Parameters:
crossContext - The new cross contexts flag


setDefaultWebXml

public void setDefaultWebXml(String defaultWebXml)
Set the location of the default web xml that will be used. If not absolute, it'll be made relative to the engine's base dir ( which defaults to catalina.base system property ). XXX If a file is not found - we can attempt a getResource()

Parameters:
defaultWebXml - The default web xml


setDelegate

public void setDelegate(boolean delegate)
Set the "follow standard delegation model" flag used to configure our ClassLoader.

Parameters:
delegate - The new flag


setDisplayName

public void setDisplayName(String displayName)
Set the display name of this web application.
Specified by:
setDisplayName in interface Context

Parameters:
displayName - The new display name


setDistributable

public void setDistributable(boolean distributable)
Set the distributable flag for this web application.
Specified by:
setDistributable in interface Context

Parameters:
distributable - The new distributable flag


setDocBase

public void setDocBase(String docBase)
Set the document root for this Context. This can be an absolute pathname, a relative pathname, or a URL.
Specified by:
setDocBase in interface Context

Parameters:
docBase - The new document root


setEngineName

public void setEngineName(String engineName)


setJ2EEApplication

public void setJ2EEApplication(String j2EEApplication)


setJ2EEServer

public void setJ2EEServer(String j2EEServer)


setJavaVMs

public String[] setJavaVMs(String[] javaVMs)


setLazy

public void setLazy(boolean lazy)


setLoader

public void setLoader(Loader loader)
Set the Loader with which this Context is associated.
Specified by:
setLoader in interface Container
Overrides:
setLoader in interface ContainerBase

Parameters:
loader - The newly associated loader


setLoginConfig

public void setLoginConfig(LoginConfig config)
Set the login configuration descriptor for this web application.
Specified by:
setLoginConfig in interface Context

Parameters:
config - The new login configuration


setManagerChecksFrequency

public void setManagerChecksFrequency(int managerChecksFrequency)
Set the manager checks frequency.

Parameters:
managerChecksFrequency - the new manager checks frequency


setName

public void setName(String name)
Specified by:
setName in interface Container
Overrides:
setName in interface ContainerBase


setNamingResources

public void setNamingResources(NamingResources namingResources)
Set the naming resources for this web application.
Specified by:
setNamingResources in interface Context

Parameters:
namingResources - The new naming resources


setOverride

public void setOverride(boolean override)
Set the DefaultContext override flag for this web application.
Specified by:
setOverride in interface Context

Parameters:
override - The new override flag


setPath

public void setPath(String path)
Set the context path for this Context.

IMPLEMENTATION NOTE: The context path is used as the "name" of a Context, because it must be unique.

Specified by:
setPath in interface Context

Parameters:
path - The new context path


setPrivileged

public void setPrivileged(boolean privileged)
Set the privileged flag for this web application.
Specified by:
setPrivileged in interface Context

Parameters:
privileged - The new privileged flag


setProcessTlds

public void setProcessTlds(boolean newProcessTlds)
Sets the processTlds attribute value.

Parameters:
newProcessTlds - The new attribute value


setPublicId

public void setPublicId(String publicId)
Set the public identifier of the deployment descriptor DTD that is currently being parsed.
Specified by:
setPublicId in interface Context

Parameters:
publicId - The public identifier


setReloadable

public void setReloadable(boolean reloadable)
Set the reloadable flag for this web application.
Specified by:
setReloadable in interface Context

Parameters:
reloadable - The new reloadable flag


setReplaceWelcomeFiles

public void setReplaceWelcomeFiles(boolean replaceWelcomeFiles)
Set the "replace welcome files" property.

Parameters:
replaceWelcomeFiles - The new property value


setResources

public void setResources(DirContext resources)
Set the resources DirContext object with which this Container is associated.
Specified by:
setResources in interface Container
Overrides:
setResources in interface ContainerBase

Parameters:
resources - The newly associated DirContext


setSaveConfig

public void setSaveConfig(boolean saveConfig)
Set save config flag.


setServer

public String setServer(String server)


setSessionTimeout

public void setSessionTimeout(int timeout)
Set the default session timeout (in minutes) for this web application.
Specified by:
setSessionTimeout in interface Context

Parameters:
timeout - The new default session timeout


setStartupTime

public void setStartupTime(long startupTime)


setSwallowOutput

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

Parameters:
swallowOutput - The new value


setTldNamespaceAware

public void setTldNamespaceAware(boolean tldNamespaceAware)
Set the namespace aware feature of the XML parser used when parsing xml instances.
Specified by:
setTldNamespaceAware in interface Context

Parameters:
tldNamespaceAware - true to enable namespace awareness


setTldScanTime

public void setTldScanTime(long tldScanTime)


setTldValidation

public void setTldValidation(boolean tldValidation)
Set the validation feature of the XML parser used when parsing tlds files.
Specified by:
setTldValidation in interface Context

Parameters:
tldValidation - true to enable xml instance validation


setUnpackWAR

public void setUnpackWAR(boolean unpackWAR)
Unpack WAR flag mutator.


setUseNaming

public void setUseNaming(boolean useNaming)
Enables or disables naming.


setWorkDir

public void setWorkDir(String workDir)
Set the work directory for this Context.

Parameters:
workDir - The new work directory


setWrapperClass

public void setWrapperClass(String wrapperClass)
Set the Java class name of the Wrapper implementation used for servlets registered in this Context.
Specified by:
setWrapperClass in interface Context

Parameters:
wrapperClass - The new wrapper class


setXmlNamespaceAware

public void setXmlNamespaceAware(boolean webXmlNamespaceAware)
Set the namespace aware feature of the XML parser used when parsing xml instances.
Specified by:
setXmlNamespaceAware in interface Context

Parameters:
webXmlNamespaceAware - true to enable namespace awareness


setXmlValidation

public void setXmlValidation(boolean webXmlValidation)
Set the validation feature of the XML parser used when parsing xml instances.
Specified by:
setXmlValidation in interface Context

Parameters:
webXmlValidation - true to enable xml instance validation


start

public void start()
            throws LifecycleException
Start this Context component.
Specified by:
start in interface Lifecycle
Overrides:
start in interface ContainerBase

Throws:
LifecycleException - if a startup error occurs


startRecursive

public void startRecursive()
            throws LifecycleException


stop

public void stop()
            throws LifecycleException
Stop this Context component.
Specified by:
stop in interface Lifecycle
Overrides:
stop in interface ContainerBase

Throws:
LifecycleException - if a shutdown error occurs


stopNew

public void stopNew()
            throws LifecycleException
Stop this Context component. Experimental, please ignore.

Throws:
LifecycleException - if a shutdown error occurs


toString

public String toString()
Return a String representation of this component.


Copyright B) 2000-2003 Apache Software Foundation. All Rights Reserved.