org.apache.catalina.core

Class StandardContext

public class StandardContext extends ContainerBase implements Context, Serializable, NotificationEmitter

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: 893564 $ $Date: 2009-12-23 17:31:31 +0100 (Wed, 23 Dec 2009) $

Author: Craig R. McClanahan Remy Maucherat

Field Summary
protected booleanallowLinking
Allow linking.
protected intcacheMaxSize
Cache max size in KB.
protected intcacheObjectMaxSize
Cache object max size in KB.
protected intcacheTTL
Cache TTL in ms.
protected booleancaseSensitive
Case sensitivity.
protected ApplicationContextcontext
The ServletContext implementation associated with this Context.
protected static URLEncoderurlEncoder
Array containing the safe characters set.
Constructor Summary
StandardContext()
Create a new StandardContext component with the default basic Valve.
Method Summary
voidaddApplicationListener(String listener)
Add a new Listener class name to the set of Listeners configured for this application.
voidaddApplicationParameter(ApplicationParameter parameter)
Add a new application parameter for this application.
voidaddChild(Container child)
Add a child Container, only if the proposed child is an implementation of Wrapper.
voidaddConstraint(SecurityConstraint constraint)
Add a security constraint to the set for this web application.
voidaddErrorPage(ErrorPage errorPage)
Add an error page for the specified error or Java exception.
voidaddFilterDef(FilterDef filterDef)
Add a filter definition to this Context.
voidaddFilterMap(FilterMap filterMap)
Add a filter mapping to this Context.
voidaddInstanceListener(String listener)
Add the classname of an InstanceListener to be added to each Wrapper appended to this Context.
voidaddJspMapping(String pattern)
Add the given URL pattern as a jsp-property-group.
voidaddLocaleEncodingMappingParameter(String locale, String encoding)
Add a Locale Encoding Mapping (see Sec 5.4 of Servlet spec 2.4)
voidaddMessageDestination(MessageDestination md)
Add a message destination for this web application.
voidaddMessageDestinationRef(MessageDestinationRef mdr)
Add a message destination reference for this web application.
voidaddMimeMapping(String extension, String mimeType)
Add a new MIME mapping, replacing any existing mapping for the specified extension.
voidaddNotificationListener(NotificationListener listener, NotificationFilter filter, Object object)
voidaddParameter(String name, String value)
Add a new context initialization parameter.
voidaddRoleMapping(String role, String link)
Add a security role reference for this web application.
voidaddSecurityRole(String role)
Add a new security role for this web application.
voidaddServletMapping(String pattern, String name)
Add a new servlet mapping, replacing any existing mapping for the specified pattern.
voidaddServletMapping(String pattern, String name, boolean jspWildCard)
Add a new servlet mapping, replacing any existing mapping for the specified pattern.
voidaddTaglib(String uri, String location)
Add a JSP tag library for the specified URI.
voidaddWatchedResource(String name)
Add a new watched resource to the set recognized by this Context.
voidaddWelcomeFile(String name)
Add a new welcome file to the set recognized by this Context.
voidaddWrapperLifecycle(String listener)
Add the classname of a LifecycleListener to be added to each Wrapper appended to this Context.
voidaddWrapperListener(String listener)
Add the classname of a ContainerListener to be added to each Wrapper appended to this Context.
protected StringadjustURLPattern(String urlPattern)
Adjust the URL pattern to begin with a leading slash, if appropriate (i.e. we are running a servlet 2.2 application).
voidcreate()
ObjectNamecreateObjectName(String hostDomain, ObjectName parentName)
WrappercreateWrapper()
Factory method to create and return a new Wrapper instance, of the Java implementation class appropriate for this Context implementation.
voiddestroy()
Destroy needs to clean up the context completely.
protected FileengineBase()
Return a File object representing the base directory for the entire servlet container (i.e. the Engine container if present).
booleanfilterStart()
Configure and initialize the set of filters for this Context.
booleanfilterStop()
Finalize and release the set of filters for this Context.
String[]findApplicationListeners()
Return the set of application listener class names configured for this application.
ApplicationParameter[]findApplicationParameters()
Return the set of application parameters for this application.
SecurityConstraint[]findConstraints()
Return the security constraints for this web application.
ErrorPagefindErrorPage(int errorCode)
Return the error page entry for the specified HTTP error code, if any; otherwise return null.
ErrorPagefindErrorPage(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.
FilterConfigfindFilterConfig(String name)
Find and return the initialized FilterConfig for the specified filter name, if any; otherwise return null.
FilterDeffindFilterDef(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.
ContextfindMappingObject()
FIXME: Fooling introspection ...
MessageDestinationfindMessageDestination(String name)
Return the message destination with the specified name, if any; otherwise, return null.
MessageDestinationReffindMessageDestinationRef(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.
StringfindMimeMapping(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.
StringfindParameter(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.
StringfindRoleMapping(String role)
For the given security role (as used by an application), return the corresponding role name (as defined by the underlying Realm) if there is one.
booleanfindSecurityRole(String role)
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.
StringfindServletMapping(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.
DirContextfindStaticResources()
Return the naming resources associated with this web application.
StringfindStatusPage(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.
StringfindTaglib(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.
String[]findWatchedResources()
Return the set of watched resources for this Context.
booleanfindWelcomeFile(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.
StringgetAltDDName()
Return the alternate Deployment Descriptor name.
AnnotationProcessorgetAnnotationProcessor()
booleangetAntiJARLocking()
Return the antiJARLocking flag for this Context.
booleangetAntiResourceLocking()
Return the antiResourceLocking flag for this Context.
protected StringgetAppBase()
Get app base.
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.
booleangetAvailable()
Return the application available flag for this Context.
protected StringgetBasePath()
Get base path.
intgetCacheMaxSize()
Return the maximum size of the cache in KB.
intgetCacheObjectMaxSize()
Return the maximum size of objects to be cached in KB.
intgetCacheTTL()
Get cache TTL.
CharsetMappergetCharsetMapper()
Return the Locale to character set mapper for this Context.
StringgetCharsetMapperClass()
Return the Locale to character set mapper class for this Context.
booleangetClearReferencesStopThreads()
Return the clearReferencesStopThreads flag for this Context.
StringgetCompilerClasspath()
Return the compiler classpath.
FilegetConfigBase()
Get config base.
StringgetConfigFile()
Return the path to a file to save this Context information.
booleangetConfigured()
Return the "correctly configured" flag for this Context.
booleangetCookies()
Return the "use cookies for session ids" flag.
booleangetCrossContext()
Return the "allow crossing servlet contexts" flag.
protected StringgetDefaultConfigFile()
Given a context path, get the config file name.
StringgetDefaultContextXml()
StringgetDefaultWebXml()
booleangetDelegate()
Return the "follow standard delegation model" flag used to configure our ClassLoader.
StringgetDeploymentDescriptor()
JSR77 deploymentDescriptor attribute
StringgetDisplayName()
Return the display name of this web application.
booleangetDistributable()
Return the distributable flag for this web application.
StringgetDocBase()
Return the document root for this Context.
StringgetEncodedPath()
StringgetEngineName()
StringgetHostname()
booleangetIgnoreAnnotations()
Return the boolean on the annotations parsing.
StringgetInfo()
Return descriptive information about this Container implementation and the corresponding version number, in the format <description>/<version>.
StringgetJ2EEApplication()
StringgetJ2EEServer()
String[]getJavaVMs()
LoginConfiggetLoginConfig()
Return the login configuration descriptor for this web application.
MappergetMapper()
Get the mapper associated with the context.
NamingContextListenergetNamingContextListener()
Naming context listener accessor.
NamingResourcesgetNamingResources()
Return the naming resources associated with this web application.
MBeanNotificationInfo[]getNotificationInfo()
StringgetOriginalDocBase()
Return the original document root for this Context.
booleangetOverride()
Return the DefaultContext override flag for this web application.
ClassLoadergetParentClassLoader()
Return the parent class loader (if any) for this web application.
ObjectNamegetParentName()
StringgetPath()
Return the context path for this Context.
booleangetPaused()
Return the request processing paused flag for this Context.
booleangetPrivileged()
Return the privileged flag for this web application.
longgetProcessingTime()
Gets the cumulative processing times of all servlets in this StandardContext.
booleangetProcessTlds()
Returns the processTlds attribute value.
StringgetPublicId()
Return the public identifier of the deployment descriptor DTD that is currently being parsed.
booleangetReloadable()
Return the reloadable flag for this web application.
StringgetServer()
ServletContextgetServletContext()
Return the servlet context for which this Context is a facade.
String[]getServlets()
JSR77 servlets attribute
intgetSessionTimeout()
Return the default session timeout (in minutes) for this web application.
longgetStartTime()
Gets the time this context was started.
longgetStartupTime()
Gets the time (in milliseconds) it took to start this context.
intgetState()
DirContextgetStaticResources()
Return the naming resources associated with this web application.
booleangetSwallowOutput()
Return the value of the swallowOutput flag.
booleangetTldNamespaceAware()
Get the server.xml <host> attribute's xmlNamespaceAware.
longgetTldScanTime()
booleangetTldValidation()
Get the server.xml attribute's webXmlValidation.
longgetUnloadDelay()
Return the value of the unloadDelay flag.
booleangetUnpackWAR()
Unpack WAR flag accessor.
booleangetUseHttpOnly()
Gets the value of the use HttpOnly cookies for session cookies flag.
String[]getWelcomeFiles()
Return the naming resources associated with this web application.
StringgetWorkDir()
Return the work directory for this Context.
StringgetWorkPath()
Get the absolute path to the work dir.
StringgetWrapperClass()
Return the Java class name of the Wrapper implementation used for servlets registered in this Context.
booleangetXmlNamespaceAware()
Get the server.xml attribute's xmlNamespaceAware.
booleangetXmlValidation()
Get the server.xml attribute's xmlValidation.
voidinit()
booleanisAllowLinking()
Is linking allowed.
booleanisCachingAllowed()
Is caching allowed ?
booleanisCaseSensitive()
Is case sensitive ?
booleanisEventProvider()
booleanisFilesystemBased()
Returns true if the resources associated with this context are filesystem based.
booleanisLazy()
booleanisReplaceWelcomeFiles()
Return the "replace welcome files" property.
booleanisSaveConfig()
Save config ?
protected booleanisServlet22()
Are we processing a version 2.2 deployment descriptor?
booleanisStateManageable()
Support for "stateManageable" JSR77
booleanisStatisticsProvider()
booleanisUseNaming()
Returns true if the internal naming support is used.
booleanlistenerStart()
Configure the set of instantiated application event listeners for this Context.
booleanlistenerStop()
Send an application stop event to all interested listeners.
voidloadOnStartup(Container[] children)
Load and initialize all servlets marked "load on startup" in the web application deployment descriptor.
voidpreDeregister()
ObjectNamepreRegister(MBeanServer server, ObjectName name)
There are 2 cases: 1.The context is created and registered by internal APIS 2.
voidreload()
Reload this web application, if reloading is supported.
voidremoveApplicationListener(String listener)
Remove the specified application listener class from the set of listeners for this application.
voidremoveApplicationParameter(String name)
Remove the application parameter with the specified name from the set for this application.
voidremoveChild(Container child)
Add a child Container, only if the proposed child is an implementation of Wrapper.
voidremoveConstraint(SecurityConstraint constraint)
Remove the specified security constraint from this web application.
voidremoveErrorPage(ErrorPage errorPage)
Remove the error page for the specified error code or Java language exception, if it exists; otherwise, no action is taken.
voidremoveFilterDef(FilterDef filterDef)
Remove the specified filter definition from this Context, if it exists; otherwise, no action is taken.
voidremoveFilterMap(FilterMap filterMap)
Remove a filter mapping from this Context.
voidremoveInstanceListener(String listener)
Remove a class name from the set of InstanceListener classes that will be added to newly created Wrappers.
voidremoveMessageDestination(String name)
Remove any message destination with the specified name.
voidremoveMessageDestinationRef(String name)
Remove any message destination ref with the specified name.
voidremoveMimeMapping(String extension)
Remove the MIME mapping for the specified extension, if it exists; otherwise, no action is taken.
voidremoveNotificationListener(NotificationListener listener, NotificationFilter filter, Object object)
voidremoveNotificationListener(NotificationListener listener)
Remove a JMX-NotificationListener
voidremoveParameter(String name)
Remove the context initialization parameter with the specified name, if it exists; otherwise, no action is taken.
voidremoveRoleMapping(String role)
Remove any security role reference for the specified name
voidremoveSecurityRole(String role)
Remove any security role with the specified name.
voidremoveServletMapping(String pattern)
Remove any servlet mapping for the specified pattern, if it exists; otherwise, no action is taken.
voidremoveTaglib(String uri)
Remove the tag library location forthe specified tag library URI.
voidremoveWatchedResource(String name)
Remove the specified watched resource name from the list associated with this Context.
voidremoveWelcomeFile(String name)
Remove the specified welcome file name from the list recognized by this Context.
voidremoveWrapperLifecycle(String listener)
Remove a class name from the set of LifecycleListener classes that will be added to newly created Wrappers.
voidremoveWrapperListener(String listener)
Remove a class name from the set of ContainerListener classes that will be added to newly created Wrappers.
booleanresourcesStart()
Allocate resources, including proxy.
booleanresourcesStop()
Deallocate resources and destroy proxy.
voidsetAllowLinking(boolean allowLinking)
Set allow linking.
voidsetAltDDName(String altDDName)
Set an alternate Deployment Descriptor name.
voidsetAnnotationProcessor(AnnotationProcessor annotationProcessor)
voidsetAntiJARLocking(boolean antiJARLocking)
Set the antiJARLocking feature for this Context.
voidsetAntiResourceLocking(boolean antiResourceLocking)
Set the antiResourceLocking feature for this Context.
voidsetApplicationEventListeners(Object[] listeners)
Store the set of initialized application event listener objects, in the order they were specified in the web application deployment descriptor, for this application.
voidsetApplicationLifecycleListeners(Object[] listeners)
Store the set of initialized application lifecycle listener objects, in the order they were specified in the web application deployment descriptor, for this application.
voidsetAvailable(boolean available)
Set the application available flag for this Context.
voidsetCacheMaxSize(int cacheMaxSize)
Set the maximum size of the cache in KB.
voidsetCacheObjectMaxSize(int cacheObjectMaxSize)
Set the maximum size of objects to be placed the cache in KB.
voidsetCacheTTL(int cacheTTL)
Set cache TTL.
voidsetCachingAllowed(boolean cachingAllowed)
Set caching allowed flag.
voidsetCaseSensitive(boolean caseSensitive)
Set case sensitivity.
voidsetCharsetMapper(CharsetMapper mapper)
Set the Locale to character set mapper for this Context.
voidsetCharsetMapperClass(String mapper)
Set the Locale to character set mapper class for this Context.
voidsetClearReferencesStopThreads(boolean clearReferencesStopThreads)
Set the clearReferencesStopThreads feature for this Context.
voidsetCompilerClasspath(String compilerClasspath)
Set the compiler classpath.
voidsetConfigFile(String configFile)
Set the path to a file to save this Context information.
voidsetConfigured(boolean configured)
Set the "correctly configured" flag for this Context.
voidsetCookies(boolean cookies)
Set the "use cookies for session ids" flag.
voidsetCrossContext(boolean crossContext)
Set the "allow crossing servlet contexts" flag.
voidsetDefaultContextXml(String defaultContextXml)
Set the location of the default context xml that will be used.
voidsetDefaultWebXml(String defaultWebXml)
Set the location of the default web xml that will be used.
voidsetDelegate(boolean delegate)
Set the "follow standard delegation model" flag used to configure our ClassLoader.
voidsetDisplayName(String displayName)
Set the display name of this web application.
voidsetDistributable(boolean distributable)
Set the distributable flag for this web application.
voidsetDocBase(String docBase)
Set the document root for this Context.
voidsetEngineName(String engineName)
voidsetIgnoreAnnotations(boolean ignoreAnnotations)
Set the boolean on the annotations parsing for this web application.
voidsetJ2EEApplication(String j2EEApplication)
voidsetJ2EEServer(String j2EEServer)
String[]setJavaVMs(String[] javaVMs)
voidsetLazy(boolean lazy)
voidsetLoader(Loader loader)
Set the Loader with which this Context is associated.
voidsetLoginConfig(LoginConfig config)
Set the login configuration descriptor for this web application.
voidsetName(String name)
voidsetNamingContextListener(NamingContextListener namingContextListener)
Naming context listener setter.
voidsetNamingResources(NamingResources namingResources)
Set the naming resources for this web application.
voidsetOriginalDocBase(String docBase)
Set the original document root for this Context.
voidsetOverride(boolean override)
Set the DefaultContext override flag for this web application.
voidsetPath(String path)
Set the context path for this Context.
voidsetPrivileged(boolean privileged)
Set the privileged flag for this web application.
voidsetProcessTlds(boolean newProcessTlds)
Sets the process TLDs attribute.
voidsetPublicId(String publicId)
Set the public identifier of the deployment descriptor DTD that is currently being parsed.
voidsetReloadable(boolean reloadable)
Set the reloadable flag for this web application.
voidsetReplaceWelcomeFiles(boolean replaceWelcomeFiles)
Set the "replace welcome files" property.
voidsetResources(DirContext resources)
Set the resources DirContext object with which this Container is associated.
voidsetSaveConfig(boolean saveConfig)
Set save config flag.
StringsetServer(String server)
voidsetSessionTimeout(int timeout)
Set the default session timeout (in minutes) for this web application.
voidsetStartupTime(long startupTime)
voidsetSwallowOutput(boolean swallowOutput)
Set the value of the swallowOutput flag.
voidsetTldNamespaceAware(boolean tldNamespaceAware)
Set the namespace aware feature of the XML parser used when parsing xml instances.
voidsetTldScanTime(long tldScanTime)
voidsetTldValidation(boolean tldValidation)
Set the validation feature of the XML parser used when parsing tlds files.
voidsetUnloadDelay(long unloadDelay)
Set the value of the unloadDelay flag, which represents the amount of ms that the container will wait when unloading servlets.
voidsetUnpackWAR(boolean unpackWAR)
Unpack WAR flag mutator.
voidsetUseHttpOnly(boolean useHttpOnly)
Sets the use HttpOnly cookies for session cookies flag.
voidsetUseNaming(boolean useNaming)
Enables or disables naming.
voidsetWorkDir(String workDir)
Set the work directory for this Context.
voidsetWrapperClass(String wrapperClassName)
Set the Java class name of the Wrapper implementation used for servlets registered in this Context.
voidsetXmlNamespaceAware(boolean webXmlNamespaceAware)
Set the namespace aware feature of the XML parser used when parsing xml instances.
voidsetXmlValidation(boolean webXmlValidation)
Set the validation feature of the XML parser used when parsing xml instances.
voidstart()
Start this Context component.
voidstartRecursive()
voidstop()
Stop this Context component.
StringtoString()
Return a String representation of this component.

Field Detail

allowLinking

protected boolean allowLinking
Allow linking.

cacheMaxSize

protected int cacheMaxSize
Cache max size in KB.

cacheObjectMaxSize

protected int cacheObjectMaxSize
Cache object max size in KB.

cacheTTL

protected int cacheTTL
Cache TTL in ms.

caseSensitive

protected boolean caseSensitive
Case sensitivity.

context

protected transient ApplicationContext context
The ServletContext implementation associated with this Context.

urlEncoder

protected static URLEncoder urlEncoder
Array containing the safe characters set.

Constructor Detail

StandardContext

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

Method Detail

addApplicationListener

public void addApplicationListener(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

addApplicationParameter

public void addApplicationParameter(ApplicationParameter parameter)
Add a new application parameter for this application.

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.

Parameters: child Child container to be added

Throws: IllegalArgumentException if the proposed container is not an implementation of Wrapper

addConstraint

public void addConstraint(SecurityConstraint constraint)
Add a security constraint to the set for this web application.

addErrorPage

public 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

public void addFilterDef(FilterDef filterDef)
Add a filter definition to this Context.

Parameters: filterDef The filter definition to be added

addFilterMap

public void addFilterMap(FilterMap filterMap)
Add a filter mapping to this Context.

Parameters: filterMap The filter mapping to be added

Throws: IllegalArgumentException if the specified filter name does not match an existing filter definition, or the filter mapping is malformed

addInstanceListener

public void addInstanceListener(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

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.

Parameters: pattern URL pattern to be mapped

addLocaleEncodingMappingParameter

public void addLocaleEncodingMappingParameter(String locale, 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

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.

Parameters: extension Filename extension being mapped mimeType Corresponding MIME type

addNotificationListener

public void addNotificationListener(NotificationListener listener, NotificationFilter filter, Object object)

addParameter

public void addParameter(String name, String value)
Add a new context initialization parameter.

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

Throws: IllegalArgumentException if the name or value is missing, or if this context initialization parameter has already been registered

addRoleMapping

public void addRoleMapping(String role, String link)
Add a security role reference for this web application.

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.

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.

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

Throws: IllegalArgumentException if the specified servlet name is not known to this Context

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

Throws: IllegalArgumentException if the specified servlet name is not known to this Context

addTaglib

public void addTaglib(String uri, 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

public void addWatchedResource(String name)
Add a new watched resource to the set recognized by this Context.

Parameters: name New watched resource file name

addWelcomeFile

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

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.

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.

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

create

public void create()

createObjectName

public ObjectName createObjectName(String hostDomain, ObjectName parentName)

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.

destroy

public void destroy()
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() ?

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.

findApplicationParameters

public ApplicationParameter[] findApplicationParameters()
Return the set of application parameters for this application.

findConstraints

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

findErrorPage

public 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

public ErrorPage findErrorPage(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

public ErrorPage[] findErrorPages()
Return the set of defined error pages for all specified error codes and exception types.

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.

Parameters: filterName Filter name to look up

findFilterDefs

public FilterDef[] findFilterDefs()
Return the set of defined filters for this Context.

findFilterMaps

public FilterMap[] findFilterMaps()
Return the set of filter mappings for this Context.

findInstanceListeners

public String[] findInstanceListeners()
Return the set of InstanceListener classes that will be added to newly created Wrappers automatically.

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.

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.

findParameter

public String findParameter(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

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.

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.

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.

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.

findServletMapping

public String findServletMapping(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

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.

findStaticResources

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

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.

findTaglib

public String findTaglib(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

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.

findWatchedResources

public String[] findWatchedResources()
Return the set of watched resources for this Context. If none are defined, a zero length array will be returned.

findWelcomeFile

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

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.

findWrapperLifecycles

public String[] findWrapperLifecycles()
Return the set of LifecycleListener classes that will be added to newly created Wrappers automatically.

findWrapperListeners

public String[] findWrapperListeners()
Return the set of ContainerListener classes that will be added to newly created Wrappers automatically.

getAltDDName

public String getAltDDName()
Return the alternate Deployment Descriptor name.

getAnnotationProcessor

public AnnotationProcessor getAnnotationProcessor()

getAntiJARLocking

public boolean getAntiJARLocking()
Return the antiJARLocking flag for this Context.

getAntiResourceLocking

public boolean getAntiResourceLocking()
Return the antiResourceLocking flag for this Context.

getAppBase

protected String getAppBase()
Get app base.

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.

Throws: IllegalStateException if this method is called before this application has started, or after it has been stopped

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.

Throws: IllegalStateException if this method is called before this application has started, or after it has been stopped

getAvailable

public boolean getAvailable()
Return the application available flag for this Context.

getBasePath

protected String getBasePath()
Get base path.

getCacheMaxSize

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

getCacheObjectMaxSize

public int getCacheObjectMaxSize()
Return the maximum size of objects to be cached in KB.

getCacheTTL

public int getCacheTTL()
Get cache TTL.

getCharsetMapper

public CharsetMapper getCharsetMapper()
Return the Locale to character set mapper for this Context.

getCharsetMapperClass

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

getClearReferencesStopThreads

public boolean getClearReferencesStopThreads()
Return the clearReferencesStopThreads flag for this Context.

getCompilerClasspath

public String getCompilerClasspath()
Return the compiler classpath.

getConfigBase

public File getConfigBase()
Get config base.

getConfigFile

public String getConfigFile()
Return the path to a file to save this Context information.

getConfigured

public boolean getConfigured()
Return the "correctly configured" flag for this Context.

getCookies

public boolean getCookies()
Return the "use cookies for session ids" flag.

getCrossContext

public boolean getCrossContext()
Return the "allow crossing servlet contexts" flag.

getDefaultConfigFile

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

getDefaultContextXml

public String getDefaultContextXml()

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.

getDistributable

public boolean getDistributable()
Return the distributable flag for this web application.

getDocBase

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

getEncodedPath

public String getEncodedPath()

getEngineName

public String getEngineName()

getHostname

public String getHostname()

getIgnoreAnnotations

public boolean getIgnoreAnnotations()
Return the boolean on the annotations parsing.

getInfo

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

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.

getMapper

public Mapper getMapper()
Get the mapper associated with the context.

getNamingContextListener

public NamingContextListener getNamingContextListener()
Naming context listener accessor.

getNamingResources

public NamingResources getNamingResources()
Return the naming resources associated with this web application.

getNotificationInfo

public MBeanNotificationInfo[] getNotificationInfo()

getOriginalDocBase

public String getOriginalDocBase()
Return the original document root for this Context. This can be an absolute pathname, a relative pathname, or a URL. Is only set as deployment has change docRoot!

getOverride

public boolean getOverride()
Return the DefaultContext override flag for this web application.

getParentClassLoader

public ClassLoader getParentClassLoader()
Return the parent class loader (if any) for this web application. This call is meaningful only after a Loader has been configured.

getParentName

public ObjectName getParentName()

getPath

public String getPath()
Return the context path for this 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.

getProcessingTime

public long getProcessingTime()
Gets the cumulative processing times of all servlets in this StandardContext.

Returns: Cumulative processing times of all servlets in this StandardContext

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.

getReloadable

public boolean getReloadable()
Return the reloadable flag for this web application.

getServer

public String getServer()

getServletContext

public ServletContext getServletContext()
Return the servlet context for which this Context is a facade.

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.

getStartTime

public long getStartTime()
Gets the time this context was started.

Returns: Time (in milliseconds since January 1, 1970, 00:00:00) when this context was started

getStartupTime

public long getStartupTime()
Gets the time (in milliseconds) it took to start this context.

Returns: Time (in milliseconds) it took to start this context.

getState

public int getState()

getStaticResources

public 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 <host> attribute's xmlNamespaceAware.

Returns: true if namespace awarenes is enabled.

getTldScanTime

public long getTldScanTime()

getTldValidation

public boolean getTldValidation()
Get the server.xml attribute's webXmlValidation.

Returns: true if validation is enabled.

getUnloadDelay

public long getUnloadDelay()
Return the value of the unloadDelay flag.

getUnpackWAR

public boolean getUnpackWAR()
Unpack WAR flag accessor.

getUseHttpOnly

public boolean getUseHttpOnly()
Gets the value of the use HttpOnly cookies for session cookies flag.

Returns: true if the HttpOnly flag should be set on session cookies

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.

getXmlNamespaceAware

public boolean getXmlNamespaceAware()
Get the server.xml attribute's xmlNamespaceAware.

Returns: true if namespace awarenes is enabled.

getXmlValidation

public boolean getXmlValidation()
Get the server.xml attribute's xmlValidation.

Returns: true if validation is enabled.

init

public void init()

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(Container[] children)
Load and initialize all servlets marked "load on startup" in the web application deployment descriptor.

Parameters: children Array of wrappers for all currently defined servlets (including those not declared load on startup)

preDeregister

public void preDeregister()

preRegister

public ObjectName preRegister(MBeanServer server, ObjectName name)
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.

Parameters: server The server name The object name

Returns: ObjectName The name of the object

Throws: Exception 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.

Throws: IllegalStateException if the reloadable property is set to false.

removeApplicationListener

public void removeApplicationListener(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

public void removeApplicationParameter(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

removeChild

public void removeChild(Container child)
Add a child Container, only if the proposed child is an implementation of Wrapper.

Parameters: child Child container to be added

Throws: IllegalArgumentException if the proposed container is not an implementation of Wrapper

removeConstraint

public void removeConstraint(SecurityConstraint constraint)
Remove the specified security constraint from this web application.

Parameters: constraint Constraint to be removed

removeErrorPage

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

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.

Parameters: filterDef Filter definition to be removed

removeFilterMap

public void removeFilterMap(FilterMap filterMap)
Remove a filter mapping from this 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.

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

removeMessageDestination

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

Parameters: name Name of the message destination to remove

removeMessageDestinationRef

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.

Parameters: extension Extension to remove the mapping for

removeNotificationListener

public void removeNotificationListener(NotificationListener listener, NotificationFilter filter, Object object)

removeNotificationListener

public void removeNotificationListener(NotificationListener listener)
Remove a JMX-NotificationListener

See Also: javax.management.NotificationBroadcaster#removeNotificationListener(javax.management.NotificationListener)

removeParameter

public void removeParameter(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

public void removeRoleMapping(String role)
Remove any security role reference for the specified name

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.

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.

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.

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

removeWatchedResource

public void removeWatchedResource(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

public void removeWelcomeFile(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

public void removeWrapperLifecycle(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

public void removeWrapperListener(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

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.

setAnnotationProcessor

public void setAnnotationProcessor(AnnotationProcessor annotationProcessor)

setAntiJARLocking

public void setAntiJARLocking(boolean antiJARLocking)
Set the antiJARLocking feature for this Context.

Parameters: antiJARLocking The new flag value

setAntiResourceLocking

public void setAntiResourceLocking(boolean antiResourceLocking)
Set the antiResourceLocking feature for this Context.

Parameters: antiResourceLocking The new flag value

setApplicationEventListeners

public void setApplicationEventListeners(Object[] listeners)
Store the set of initialized application event listener objects, in the order they were specified in the web application deployment descriptor, for this application.

Parameters: listeners The set of instantiated listener objects.

setApplicationLifecycleListeners

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

Parameters: listeners The set of instantiated listener objects.

setAvailable

public void setAvailable(boolean available)
Set the application available flag for this Context.

Parameters: available The new application available flag

setCacheMaxSize

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

setCacheObjectMaxSize

public void setCacheObjectMaxSize(int cacheObjectMaxSize)
Set the maximum size of objects to be placed 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.

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

setClearReferencesStopThreads

public void setClearReferencesStopThreads(boolean clearReferencesStopThreads)
Set the clearReferencesStopThreads feature for this Context.

Parameters: clearReferencesStopThreads The new flag value

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.

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.

Parameters: configured The new correctly configured flag

setCookies

public void setCookies(boolean cookies)
Set the "use cookies for session ids" flag.

Parameters: cookies The new flag

setCrossContext

public void setCrossContext(boolean crossContext)
Set the "allow crossing servlet contexts" flag.

Parameters: crossContext The new cross contexts flag

setDefaultContextXml

public void setDefaultContextXml(String defaultContextXml)
Set the location of the default context xml that will be used. If not absolute, it'll be made relative to the engine's base dir ( which defaults to catalina.base system property ).

Parameters: defaultContextXml The default web xml

setDefaultWebXml

public void setDefaultWebXml(String defaultWebXml)
Set the location of the default web xml that will be used. If not absolute, it'll be made relative to the engine's base dir ( which defaults to catalina.base system property ).

Parameters: defaultWebXml The default web xml

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.

Parameters: displayName The new display name

setDistributable

public void setDistributable(boolean distributable)
Set the distributable flag for this web application.

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.

Parameters: docBase The new document root

setEngineName

public void setEngineName(String engineName)

setIgnoreAnnotations

public void setIgnoreAnnotations(boolean ignoreAnnotations)
Set the boolean on the annotations parsing for this web application.

Parameters: ignoreAnnotations The boolean on the annotations parsing

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.

Parameters: loader The newly associated loader

setLoginConfig

public void setLoginConfig(LoginConfig config)
Set the login configuration descriptor for this web application.

Parameters: config The new login configuration

setName

public void setName(String name)

setNamingContextListener

public void setNamingContextListener(NamingContextListener namingContextListener)
Naming context listener setter.

setNamingResources

public void setNamingResources(NamingResources namingResources)
Set the naming resources for this web application.

Parameters: namingResources The new naming resources

setOriginalDocBase

public void setOriginalDocBase(String docBase)
Set the original document root for this Context. This can be an absolute pathname, a relative pathname, or a URL.

Parameters: docBase The orginal document root

setOverride

public void setOverride(boolean override)
Set the DefaultContext override flag for this web application.

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.

Parameters: path The new context path

setPrivileged

public void setPrivileged(boolean privileged)
Set the privileged flag for this web application.

Parameters: privileged The new privileged flag

setProcessTlds

public void setProcessTlds(boolean newProcessTlds)
Sets the process TLDs attribute.

Parameters: newProcessTlds The new value

setPublicId

public void setPublicId(String publicId)
Set the public identifier of the deployment descriptor DTD that is currently being parsed.

Parameters: publicId The public identifier

setReloadable

public void setReloadable(boolean reloadable)
Set the reloadable flag for this web application.

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.

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.

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.

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.

Parameters: tldValidation true to enable xml instance validation

setUnloadDelay

public void setUnloadDelay(long unloadDelay)
Set the value of the unloadDelay flag, which represents the amount of ms that the container will wait when unloading servlets. Setting this to a small value may cause more requests to fail to complete when stopping a web application.

Parameters: unloadDelay The new value

setUnpackWAR

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

setUseHttpOnly

public void setUseHttpOnly(boolean useHttpOnly)
Sets the use HttpOnly cookies for session cookies flag.

Parameters: useHttpOnly Set to true to use HttpOnly cookies for session cookies

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 wrapperClassName)
Set the Java class name of the Wrapper implementation used for servlets registered in this Context.

Parameters: wrapperClassName The new wrapper class name

Throws: IllegalArgumentException if the specified wrapper class cannot be found or is not a subclass of StandardWrapper

setXmlNamespaceAware

public void setXmlNamespaceAware(boolean webXmlNamespaceAware)
Set the namespace aware feature of the XML parser used when parsing xml instances.

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.

Parameters: webXmlValidation true to enable xml instance validation

start

public void start()
Start this Context component.

Throws: LifecycleException if a startup error occurs

startRecursive

public void startRecursive()

stop

public void stop()
Stop this Context component.

Throws: LifecycleException if a shutdown error occurs

toString

public String toString()
Return a String representation of this component.
Copyright © 2000-2011 Apache Software Foundation. All Rights Reserved.