StandardContext (Apache Tomcat 6.0.43 API Documentation)

Overview

Package

Class

Tree

Deprecated

Index

Help

Apache Tomcat 6.0.43

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.apache.catalina.core
Class StandardContext

java.lang.Object
  org.apache.catalina.core.ContainerBase
      org.apache.catalina.core.StandardContext

All Implemented Interfaces:: java.io.Serializable, javax.management.MBeanRegistration, javax.management.NotificationBroadcaster, javax.management.NotificationEmitter, Container, Context, Lifecycle, Pipeline

Direct Known Subclasses:: ReplicatedContext

public class StandardContext
extends ContainerBase
implements Context, java.io.Serializable, javax.management.NotificationEmitter
extends ContainerBase
implements Context, java.io.Serializable, javax.management.NotificationEmitter

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

Author:: Craig R. McClanahan, Remy Maucherat
See Also:: Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.catalina.core.ContainerBase
`ContainerBase.ContainerBackgroundProcessor, ContainerBase.NoopAccessLog, ContainerBase.PrivilegedAddChild`

Field Summary
`protected boolean`	`allowLinking` Allow linking.
`protected int`	`cacheMaxSize` Cache max size in KB.
`protected int`	`cacheObjectMaxSize` Cache object max size in KB.
`protected int`	`cacheTTL` Cache TTL in ms.
`protected boolean`	`caseSensitive` Case sensitivity.
`protected ApplicationContext`	`context` The ServletContext implementation associated with this Context.
`protected static URLEncoder`	`urlEncoder` Array containing the safe characters set.

Fields inherited from class org.apache.catalina.core.ContainerBase
`accessLog, backgroundProcessorDelay, children, cluster, controller, domain, initialized, lifecycle, listeners, loader, logger, logName, manager, mserver, name, oname, parent, parentClassLoader, pipeline, realm, resources, sm, startChildren, started, suffix, support, type`

Fields inherited from interface org.apache.catalina.Context
`CHANGE_SESSION_ID_EVENT, RELOAD_EVENT`

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.Lifecycle
`AFTER_START_EVENT, AFTER_STOP_EVENT, BEFORE_START_EVENT, BEFORE_STOP_EVENT, DESTROY_EVENT, INIT_EVENT, PERIODIC_EVENT, START_EVENT, STOP_EVENT`

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

Method Summary
`void`	`addApplicationListener(java.lang.String listener)` Add a new Listener class name to the set of Listeners configured for this application.
`void`	`addApplicationParameter(ApplicationParameter parameter)` Add a new application parameter for this application.
`void`	`addChild(Container child)` Add a child Container, only if the proposed child is an implementation of Wrapper.
`void`	`addConstraint(SecurityConstraint constraint)` Add a security constraint to the set for this web application.
`void`	`addErrorPage(ErrorPage errorPage)` Add an error page for the specified error or Java exception.
`void`	`addFilterDef(FilterDef filterDef)` Add a filter definition to this Context.
`void`	`addFilterMap(FilterMap filterMap)` Add a filter mapping to this Context.
`void`	`addInstanceListener(java.lang.String listener)` Add the classname of an InstanceListener to be added to each Wrapper appended to this Context.
`void`	`addJspMapping(java.lang.String pattern)` Add the given URL pattern as a jsp-property-group.
`void`	`addLocaleEncodingMappingParameter(java.lang.String locale, java.lang.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(java.lang.String extension, java.lang.String mimeType)` Add a new MIME mapping, replacing any existing mapping for the specified extension.
`void`	`addNotificationListener(javax.management.NotificationListener listener, javax.management.NotificationFilter filter, java.lang.Object object)`
`void`	`addParameter(java.lang.String name, java.lang.String value)` Add a new context initialization parameter.
`void`	`addRoleMapping(java.lang.String role, java.lang.String link)` Add a security role reference for this web application.
`void`	`addSecurityRole(java.lang.String role)` Add a new security role for this web application.
`void`	`addServletMapping(java.lang.String pattern, java.lang.String name)` Add a new servlet mapping, replacing any existing mapping for the specified pattern.
`void`	`addServletMapping(java.lang.String pattern, java.lang.String name, boolean jspWildCard)` Add a new servlet mapping, replacing any existing mapping for the specified pattern.
`void`	`addTaglib(java.lang.String uri, java.lang.String location)` Add a JSP tag library for the specified URI.
`void`	`addWatchedResource(java.lang.String name)` Add a new watched resource to the set recognized by this Context.
`void`	`addWelcomeFile(java.lang.String name)` Add a new welcome file to the set recognized by this Context.
`void`	`addWrapperLifecycle(java.lang.String listener)` Add the classname of a LifecycleListener to be added to each Wrapper appended to this Context.
`void`	`addWrapperListener(java.lang.String listener)` Add the classname of a ContainerListener to be added to each Wrapper appended to this Context.
`protected java.lang.String`	`adjustURLPattern(java.lang.String urlPattern)` Adjust the URL pattern to begin with a leading slash, if appropriate (i.e. we are running a servlet 2.2 application).
`void`	`create()`
`javax.management.ObjectName`	`createObjectName(java.lang.String hostDomain, javax.management.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 java.io.File`	`engineBase()` Return a File object representing the base directory for the entire servlet container (i.e. the Engine container if present).
`boolean`	`filterStart()` Configure and initialize the set of filters for this Context.
`boolean`	`filterStop()` Finalize and release the set of filters for this Context.
`java.lang.String[]`	`findApplicationListeners()` Return the set of application listener class names configured for this application.
`ApplicationParameter[]`	`findApplicationParameters()` Return the set of application parameters for this application.
`SecurityConstraint[]`	`findConstraints()` Return the security constraints for this web application.
`ErrorPage`	`findErrorPage(int errorCode)` Return the error page entry for the specified HTTP error code, if any; otherwise return `null`.
`ErrorPage`	`findErrorPage(java.lang.String exceptionType)` Return the error page entry for the specified Java exception type, if any; otherwise return `null`.
`ErrorPage[]`	`findErrorPages()` Return the set of defined error pages for all specified error codes and exception types.
`javax.servlet.FilterConfig`	`findFilterConfig(java.lang.String name)` Find and return the initialized `FilterConfig` for the specified filter name, if any; otherwise return `null`.
`FilterDef`	`findFilterDef(java.lang.String filterName)` Return the filter definition for the specified filter name, if any; otherwise return `null`.
`FilterDef[]`	`findFilterDefs()` Return the set of defined filters for this Context.
`FilterMap[]`	`findFilterMaps()` Return the set of filter mappings for this Context.
`java.lang.String[]`	`findInstanceListeners()` Return the set of InstanceListener classes that will be added to newly created Wrappers automatically.
`Context`	`findMappingObject()` FIXME: Fooling introspection ...
`MessageDestination`	`findMessageDestination(java.lang.String name)` Return the message destination with the specified name, if any; otherwise, return `null`.
`MessageDestinationRef`	`findMessageDestinationRef(java.lang.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.
`java.lang.String`	`findMimeMapping(java.lang.String extension)` Return the MIME type to which the specified extension is mapped, if any; otherwise return `null`.
`java.lang.String[]`	`findMimeMappings()` Return the extensions for which MIME mappings are defined.
`java.lang.String`	`findParameter(java.lang.String name)` Return the value for the specified context initialization parameter name, if any; otherwise return `null`.
`java.lang.String[]`	`findParameters()` Return the names of all defined context initialization parameters for this Context.
`java.lang.String`	`findRoleMapping(java.lang.String role)` For the given security role (as used by an application), return the corresponding role name (as defined by the underlying Realm) if there is one.
`boolean`	`findSecurityRole(java.lang.String role)` Return `true` if the specified security role is defined for this application; otherwise return `false`.
`java.lang.String[]`	`findSecurityRoles()` Return the security roles defined for this application.
`java.lang.String`	`findServletMapping(java.lang.String pattern)` Return the servlet name mapped by the specified pattern (if any); otherwise return `null`.
`java.lang.String[]`	`findServletMappings()` Return the patterns of all defined servlet mappings for this Context.
`javax.naming.directory.DirContext`	`findStaticResources()` Return the naming resources associated with this web application.
`java.lang.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.
`java.lang.String`	`findTaglib(java.lang.String uri)` Return the tag library descriptor location for the specified taglib URI, if any; otherwise, return `null`.
`java.lang.String[]`	`findTaglibs()` Return the URIs of all tag libraries for which a tag library descriptor location has been specified.
`java.lang.String[]`	`findWatchedResources()` Return the set of watched resources for this Context.
`boolean`	`findWelcomeFile(java.lang.String name)` Return `true` if the specified welcome file is defined for this Context; otherwise return `false`.
`java.lang.String[]`	`findWelcomeFiles()` Return the set of welcome files defined for this Context.
`java.lang.String[]`	`findWrapperLifecycles()` Return the set of LifecycleListener classes that will be added to newly created Wrappers automatically.
`java.lang.String[]`	`findWrapperListeners()` Return the set of ContainerListener classes that will be added to newly created Wrappers automatically.
`java.lang.String`	`getAltDDName()` Return the alternate Deployment Descriptor name.
`AnnotationProcessor`	`getAnnotationProcessor()`
`boolean`	`getAntiJARLocking()` Return the antiJARLocking flag for this Context.
`boolean`	`getAntiResourceLocking()` Return the antiResourceLocking flag for this Context.
`protected java.lang.String`	`getAppBase()` Get app base.
`java.lang.Object[]`	`getApplicationEventListeners()` Return the set of initialized application event listener objects, in the order they were specified in the web application deployment descriptor, for this application.
`java.lang.Object[]`	`getApplicationLifecycleListeners()` Return the set of initialized application lifecycle listener objects, in the order they were specified in the web application deployment descriptor, for this application.
`boolean`	`getAvailable()` Return the application available flag for this Context.
`protected java.lang.String`	`getBasePath()` Get base path.
`int`	`getCacheMaxSize()` Return the maximum size of the cache in KB.
`int`	`getCacheObjectMaxSize()` Return the maximum size of objects to be cached in KB.
`int`	`getCacheTTL()` Get cache TTL.
`CharsetMapper`	`getCharsetMapper()` Return the Locale to character set mapper for this Context.
`java.lang.String`	`getCharsetMapperClass()` Return the Locale to character set mapper class for this Context.
`boolean`	`getClearReferencesHttpClientKeepAliveThread()` Return the clearReferencesHttpClientKeepAliveThread flag for this Context.
`boolean`	`getClearReferencesStopThreads()` Return the clearReferencesStopThreads flag for this Context.
`boolean`	`getClearReferencesStopTimerThreads()` Return the clearReferencesStopTimerThreads flag for this Context.
`boolean`	`getClearReferencesThreadLocals()` Return the clearReferencesThreadLocals flag for this Context.
`java.lang.String`	`getCompilerClasspath()` Return the compiler classpath.
`java.io.File`	`getConfigBase()` Get config base.
`java.lang.String`	`getConfigFile()` Return the path to a file to save this Context information.
`boolean`	`getConfigured()` Return the "correctly configured" flag for this Context.
`boolean`	`getCookies()` Return the "use cookies for session ids" flag.
`boolean`	`getCrossContext()` Return the "allow crossing servlet contexts" flag.
`protected java.lang.String`	`getDefaultConfigFile()` Given a context path, get the config file name.
`java.lang.String`	`getDefaultContextXml()`
`java.lang.String`	`getDefaultWebXml()`
`boolean`	`getDelegate()` Return the "follow standard delegation model" flag used to configure our ClassLoader.
`java.lang.String`	`getDeploymentDescriptor()` JSR77 deploymentDescriptor attribute
`java.lang.String`	`getDisplayName()` Return the display name of this web application.
`boolean`	`getDistributable()` Return the distributable flag for this web application.
`java.lang.String`	`getDocBase()` Return the document root for this Context.
`java.lang.String`	`getEncodedPath()` Return the URL encoded context path, using UTF-8.
`java.lang.String`	`getEngineName()`
`java.lang.String`	`getHostname()`
`boolean`	`getIgnoreAnnotations()` Return the boolean on the annotations parsing.
`java.lang.String`	`getInfo()` Return descriptive information about this Container implementation and the corresponding version number, in the format `<description>/<version>`.
`java.lang.String`	`getJ2EEApplication()`
`java.lang.String`	`getJ2EEServer()`
`java.lang.String[]`	`getJavaVMs()`
`LoginConfig`	`getLoginConfig()` Return the login configuration descriptor for this web application.
`Mapper`	`getMapper()` Get the mapper associated with the context.
`NamingContextListener`	`getNamingContextListener()` Naming context listener accessor.
`NamingResources`	`getNamingResources()` Return the naming resources associated with this web application.
`javax.management.MBeanNotificationInfo[]`	`getNotificationInfo()`
`java.lang.String`	`getOriginalDocBase()` Return the original document root for this Context.
`boolean`	`getOverride()` Return the DefaultContext override flag for this web application.
`java.lang.ClassLoader`	`getParentClassLoader()` Return the parent class loader (if any) for this web application.
`javax.management.ObjectName`	`getParentName()`
`java.lang.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.
`long`	`getProcessingTime()` Gets the cumulative processing times of all servlets in this StandardContext.
`boolean`	`getProcessTlds()` Returns the processTlds attribute value.
`java.lang.String`	`getPublicId()` Return the public identifier of the deployment descriptor DTD that is currently being parsed.
`boolean`	`getReloadable()` Return the reloadable flag for this web application.
`java.lang.String`	`getServer()`
`javax.servlet.ServletContext`	`getServletContext()` Return the servlet context for which this Context is a facade.
`java.lang.String[]`	`getServlets()` JSR77 servlets attribute
`java.lang.String`	`getSessionCookieDomain()` Gets the domain to use for session cookies.
`java.lang.String`	`getSessionCookieName()` Gets the name to use for session cookies.
`java.lang.String`	`getSessionCookiePath()` Gets the path to use for session cookies.
`int`	`getSessionTimeout()` Return the default session timeout (in minutes) for this web application.
`long`	`getStartTime()` Gets the time this context was started.
`long`	`getStartupTime()` Gets the time (in milliseconds) it took to start this context.
`int`	`getState()`
`java.lang.String`	`getStateName()`
`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()` *.tld files are always parsed using a namespace aware parser.
`long`	`getTldScanTime()`
`boolean`	`getTldValidation()` Will the parsing of *.tld files for this Context be performed by a validating parser?
`long`	`getUnloadDelay()` Return the value of the unloadDelay flag.
`boolean`	`getUnpackWAR()` Unpack WAR flag accessor.
`boolean`	`getUseHttpOnly()` Gets the value of the use HttpOnly cookies for session cookies flag.
`java.lang.String[]`	`getWelcomeFiles()` Return the naming resources associated with this web application.
`java.lang.String`	`getWorkDir()` Return the work directory for this Context.
`java.lang.String`	`getWorkPath()` Get the absolute path to the work dir.
`java.lang.String`	`getWrapperClass()` Return the Java class name of the Wrapper implementation used for servlets registered in this Context.
`boolean`	`getXmlBlockExternal()` Will the parsing of web.xml, web-fragment.xml, .tld, .jspx, *.tagx and tagplugin.xml files for this Context block the use of external entities?
`boolean`	`getXmlNamespaceAware()` Will the parsing of the web.xml file for this Context be performed by a namespace aware parser?
`boolean`	`getXmlValidation()` Will the parsing of the web.xml file for this Context be performed by a validating parser?
`void`	`init()` Init method, part of the MBean lifecycle.
`boolean`	`isAllowLinking()` Is linking allowed.
`boolean`	`isCachingAllowed()` Is caching allowed ?
`boolean`	`isCaseSensitive()` Is case sensitive ?
`boolean`	`isDisableURLRewriting()` Is URL rewriting disabled?
`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(Container[] children)` Load and initialize all servlets marked "load on startup" in the web application deployment descriptor.
`void`	`preDeregister()`
`javax.management.ObjectName`	`preRegister(javax.management.MBeanServer server, javax.management.ObjectName name)` There are 2 cases: 1.The context is created and registered by internal APIS 2.
`void`	`reload()` Reload this web application, if reloading is supported.
`void`	`removeApplicationListener(java.lang.String listener)` Remove the specified application listener class from the set of listeners for this application.
`void`	`removeApplicationParameter(java.lang.String name)` Remove the application parameter with the specified name from the set for this application.
`void`	`removeChild(Container child)` Add a child Container, only if the proposed child is an implementation of Wrapper.
`void`	`removeConstraint(SecurityConstraint constraint)` Remove the specified security constraint from this web application.
`void`	`removeErrorPage(ErrorPage errorPage)` Remove the error page for the specified error code or Java language exception, if it exists; otherwise, no action is taken.
`void`	`removeFilterDef(FilterDef filterDef)` Remove the specified filter definition from this Context, if it exists; otherwise, no action is taken.
`void`	`removeFilterMap(FilterMap filterMap)` Remove a filter mapping from this Context.
`void`	`removeInstanceListener(java.lang.String listener)` Remove a class name from the set of InstanceListener classes that will be added to newly created Wrappers.
`void`	`removeMessageDestination(java.lang.String name)` Remove any message destination with the specified name.
`void`	`removeMessageDestinationRef(java.lang.String name)` Remove any message destination ref with the specified name.
`void`	`removeMimeMapping(java.lang.String extension)` Remove the MIME mapping for the specified extension, if it exists; otherwise, no action is taken.
`void`	`removeNotificationListener(javax.management.NotificationListener listener)` Remove a JMX-NotificationListener
`void`	`removeNotificationListener(javax.management.NotificationListener listener, javax.management.NotificationFilter filter, java.lang.Object object)`
`void`	`removeParameter(java.lang.String name)` Remove the context initialization parameter with the specified name, if it exists; otherwise, no action is taken.
`void`	`removeRoleMapping(java.lang.String role)` Remove any security role reference for the specified name
`void`	`removeSecurityRole(java.lang.String role)` Remove any security role with the specified name.
`void`	`removeServletMapping(java.lang.String pattern)` Remove any servlet mapping for the specified pattern, if it exists; otherwise, no action is taken.
`void`	`removeTaglib(java.lang.String uri)` Remove the tag library location forthe specified tag library URI.
`void`	`removeWatchedResource(java.lang.String name)` Remove the specified watched resource name from the list associated with this Context.
`void`	`removeWelcomeFile(java.lang.String name)` Remove the specified welcome file name from the list recognized by this Context.
`void`	`removeWrapperLifecycle(java.lang.String listener)` Remove a class name from the set of LifecycleListener classes that will be added to newly created Wrappers.
`void`	`removeWrapperListener(java.lang.String listener)` Remove a class name from the set of ContainerListener classes that will be added to newly created Wrappers.
`boolean`	`resourcesStart()` Allocate resources, including proxy.
`boolean`	`resourcesStop()` Deallocate resources and destroy proxy.
`void`	`setAllowLinking(boolean allowLinking)` Set allow linking.
`void`	`setAltDDName(java.lang.String altDDName)` Set an alternate Deployment Descriptor name.
`void`	`setAnnotationProcessor(AnnotationProcessor annotationProcessor)`
`void`	`setAntiJARLocking(boolean antiJARLocking)` Set the antiJARLocking feature for this Context.
`void`	`setAntiResourceLocking(boolean antiResourceLocking)` Set the antiResourceLocking feature for this Context.
`void`	`setApplicationEventListeners(java.lang.Object[] listeners)` Store the set of initialized application event listener objects, in the order they were specified in the web application deployment descriptor, for this application.
`void`	`setApplicationLifecycleListeners(java.lang.Object[] listeners)` Store the set of initialized application lifecycle listener objects, in the order they were specified in the web application deployment descriptor, for this application.
`void`	`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`	`setCacheObjectMaxSize(int cacheObjectMaxSize)` Set the maximum size of objects to be placed the cache in KB.
`void`	`setCacheTTL(int cacheTTL)` Set cache TTL.
`void`	`setCachingAllowed(boolean cachingAllowed)` Set caching allowed flag.
`void`	`setCaseSensitive(boolean caseSensitive)` Set case sensitivity.
`void`	`setCharsetMapper(CharsetMapper mapper)` Set the Locale to character set mapper for this Context.
`void`	`setCharsetMapperClass(java.lang.String mapper)` Set the Locale to character set mapper class for this Context.
`void`	`setClearReferencesHttpClientKeepAliveThread(boolean clearReferencesHttpClientKeepAliveThread)` Set the clearReferencesHttpClientKeepAliveThread feature for this Context.
`void`	`setClearReferencesStopThreads(boolean clearReferencesStopThreads)` Set the clearReferencesStopThreads feature for this Context.
`void`	`setClearReferencesStopTimerThreads(boolean clearReferencesStopTimerThreads)` Set the clearReferencesStopTimerThreads feature for this Context.
`void`	`setClearReferencesThreadLocals(boolean clearReferencesThreadLocals)` Set the clearReferencesThreadLocals feature for this Context.
`void`	`setCompilerClasspath(java.lang.String compilerClasspath)` Set the compiler classpath.
`void`	`setConfigFile(java.lang.String configFile)` Set the path to a file to save this Context information.
`void`	`setConfigured(boolean configured)` Set the "correctly configured" flag for this Context.
`void`	`setCookies(boolean cookies)` Set the "use cookies for session ids" flag.
`void`	`setCrossContext(boolean crossContext)` Set the "allow crossing servlet contexts" flag.
`void`	`setDefaultContextXml(java.lang.String defaultContextXml)` Set the location of the default context xml that will be used.
`void`	`setDefaultWebXml(java.lang.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`	`setDisableURLRewriting(boolean disable)` Sets the disabling of URL Rewriting.
`void`	`setDisplayName(java.lang.String displayName)` Set the display name of this web application.
`void`	`setDistributable(boolean distributable)` Set the distributable flag for this web application.
`void`	`setDocBase(java.lang.String docBase)` Set the document root for this Context.
`void`	`setEngineName(java.lang.String engineName)`
`void`	`setIgnoreAnnotations(boolean ignoreAnnotations)` Set the boolean on the annotations parsing for this web application.
`void`	`setJ2EEApplication(java.lang.String j2EEApplication)`
`void`	`setJ2EEServer(java.lang.String j2EEServer)`
`java.lang.String[]`	`setJavaVMs(java.lang.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`	`setName(java.lang.String name)` Set a name string (suitable for use by humans) that describes this Container.
`void`	`setNamingContextListener(NamingContextListener namingContextListener)` Naming context listener setter.
`void`	`setNamingResources(NamingResources namingResources)` Set the naming resources for this web application.
`void`	`setOriginalDocBase(java.lang.String docBase)` Set the original document root for this Context.
`void`	`setOverride(boolean override)` Set the DefaultContext override flag for this web application.
`void`	`setPath(java.lang.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 process TLDs attribute.
`void`	`setPublicId(java.lang.String publicId)` Set the public identifier of the deployment descriptor DTD that is currently being parsed.
`void`	`setReloadable(boolean reloadable)` Set the reloadable flag for this web application.
`void`	`setReplaceWelcomeFiles(boolean replaceWelcomeFiles)` Set the "replace welcome files" property.
`void`	`setResources(javax.naming.directory.DirContext resources)` Set the resources DirContext object with which this Container is associated.
`void`	`setSaveConfig(boolean saveConfig)` Set save config flag.
`java.lang.String`	`setServer(java.lang.String server)`
`void`	`setSessionCookieDomain(java.lang.String sessionCookieDomain)` Sets the domain to use for session cookies.
`void`	`setSessionCookieName(java.lang.String sessionCookieName)` Sets the name to use for session cookies.
`void`	`setSessionCookiePath(java.lang.String sessionCookiePath)` Sets the path to use for session cookies.
`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)` *.tld files are always parsed using a namespace aware parser.
`void`	`setTldScanTime(long tldScanTime)`
`void`	`setTldValidation(boolean tldValidation)` Controls whether the parsing of *.tld files for this Context will be performed by a validating parser.
`void`	`setUnloadDelay(long unloadDelay)` Set the value of the unloadDelay flag, which represents the amount of ms that the container will wait when unloading servlets.
`void`	`setUnpackWAR(boolean unpackWAR)` Unpack WAR flag mutator.
`void`	`setUseHttpOnly(boolean useHttpOnly)` Sets the use HttpOnly cookies for session cookies flag.
`void`	`setUseNaming(boolean useNaming)` Enables or disables naming.
`void`	`setWorkDir(java.lang.String workDir)` Set the work directory for this Context.
`void`	`setWrapperClass(java.lang.String wrapperClassName)` Set the Java class name of the Wrapper implementation used for servlets registered in this Context.
`void`	`setXmlBlockExternal(boolean xmlBlockExternal)` Controls whether the parsing of web.xml, web-fragment.xml, .tld, .jspx, *.tagx and tagplugin.xml files for this Context will block the use of external entities.
`void`	`setXmlNamespaceAware(boolean webXmlNamespaceAware)` Controls whether the parsing of the web.xml file for this Context will be performed by a namespace aware parser.
`void`	`setXmlValidation(boolean webXmlValidation)` Controls whether the parsing of the web.xml file for this Context will be performed by a validating parser.
`void`	`start()` Start this Context component.
`void`	`startRecursive()`
`void`	`stop()` Stop this Context component.
`java.lang.String`	`toString()` Return a String representation of this component.

Methods inherited from class org.apache.catalina.core.ContainerBase
addContainerListener, addLifecycleListener, addPropertyChangeListener, addValve, backgroundProcess, findChild, findChildren, findContainerListeners, findLifecycleListeners, fireContainerEvent, getAccessLog, getBackgroundProcessorDelay, getBasic, getChildren, getCluster, getContainerSuffix, getDomain, getFirst, getJmxName, getJSR77Suffix, getLoader, getLogger, getManager, getMappingObject, getName, getObjectName, getParent, getPipeline, getRealm, getResources, getStartChildren, getType, getValveObjectNames, getValves, invoke, logAccess, logName, postDeregister, postRegister, removeContainerListener, removeLifecycleListener, removePropertyChangeListener, removeValve, setBackgroundProcessorDelay, setBasic, setCluster, setDomain, setManager, setParent, setParentClassLoader, setRealm, setStartChildren, threadStart, threadStop

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

addContainerListener, addLifecycleListener, addPropertyChangeListener, addValve, backgroundProcess, findChild, findChildren, findContainerListeners, findLifecycleListeners, fireContainerEvent, getAccessLog, getBackgroundProcessorDelay, getBasic, getChildren, getCluster, getContainerSuffix, getDomain, getFirst, getJmxName, getJSR77Suffix, getLoader, getLogger, getManager, getMappingObject, getName, getObjectName, getParent, getPipeline, getRealm, getResources, getStartChildren, getType, getValveObjectNames, getValves, invoke, logAccess, logName, postDeregister, postRegister, removeContainerListener, removeLifecycleListener, removePropertyChangeListener, removeValve, setBackgroundProcessorDelay, setBasic, setCluster, setDomain, setManager, setParent, setParentClassLoader, setRealm, setStartChildren, threadStart, threadStop

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait`

Methods inherited from interface org.apache.catalina.Container
`addContainerListener, addPropertyChangeListener, backgroundProcess, findChild, findChildren, findContainerListeners, getAccessLog, getBackgroundProcessorDelay, getCluster, getLoader, getLogger, getManager, getMappingObject, getName, getObjectName, getParent, getPipeline, getRealm, getResources, invoke, logAccess, removeContainerListener, removePropertyChangeListener, setBackgroundProcessorDelay, setCluster, setManager, setParent, setParentClassLoader, setRealm`

Methods inherited from interface org.apache.catalina.Container

addContainerListener, addPropertyChangeListener, backgroundProcess, findChild, findChildren, findContainerListeners, getAccessLog, getBackgroundProcessorDelay, getCluster, getLoader, getLogger, getManager, getMappingObject, getName, getObjectName, getParent, getPipeline, getRealm, getResources, invoke, logAccess, removeContainerListener, removePropertyChangeListener, setBackgroundProcessorDelay, setCluster, setManager, setParent, setParentClassLoader, setRealm

Field Detail

urlEncoder

protected static URLEncoder urlEncoder

Array containing the safe characters set.

context

protected transient ApplicationContext context

The ServletContext implementation associated with this Context.

caseSensitive

protected boolean caseSensitive

Case sensitivity.

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.

Constructor Detail

StandardContext

public StandardContext()

Create a new StandardContext component with the default basic Valve.

Method Detail

getAnnotationProcessor

public AnnotationProcessor getAnnotationProcessor()

setAnnotationProcessor

public void setAnnotationProcessor(AnnotationProcessor annotationProcessor)

getEncodedPath

public java.lang.String getEncodedPath()

Description copied from interface: Context

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

Specified by:: getEncodedPath in interface Context

setName

public void setName(java.lang.String name)

Description copied from class: ContainerBase

Set a name string (suitable for use by humans) that describes this Container. Within the set of child containers belonging to a particular parent, Container names must be unique.

Specified by:: setName in interface Container
Overrides:: setName in class ContainerBase

Parameters:: name - New name of this container

isCachingAllowed

public boolean isCachingAllowed()

Is caching allowed ?

setCachingAllowed

public void setCachingAllowed(boolean cachingAllowed)

Set caching allowed flag.

setCaseSensitive

public void setCaseSensitive(boolean caseSensitive)

Set case sensitivity.

isCaseSensitive

public boolean isCaseSensitive()

Is case sensitive ?

setAllowLinking

public void setAllowLinking(boolean allowLinking)

Set allow linking.

isAllowLinking

public boolean isAllowLinking()

Is linking allowed.

setCacheTTL

public void setCacheTTL(int cacheTTL)

Set cache TTL.

getCacheTTL

public int getCacheTTL()

Get cache TTL.

getCacheMaxSize

public int getCacheMaxSize()

Return the maximum size of the cache in KB.

setCacheMaxSize

public void setCacheMaxSize(int cacheMaxSize)

Set the maximum size of the cache in KB.

getCacheObjectMaxSize

public int getCacheObjectMaxSize()

Return the maximum size of objects to be cached in KB.

setCacheObjectMaxSize

public void setCacheObjectMaxSize(int cacheObjectMaxSize)

Set the maximum size of objects to be placed the cache in KB.

getDelegate

public boolean getDelegate()

Return the "follow standard delegation model" flag used to configure our ClassLoader.

setDelegate

public void setDelegate(boolean delegate)

Set the "follow standard delegation model" flag used to configure our ClassLoader.

Parameters:: delegate - The new flag

isUseNaming

public boolean isUseNaming()

Returns true if the internal naming support is used.

setUseNaming

public void setUseNaming(boolean useNaming)

Enables or disables naming.

isFilesystemBased

public boolean isFilesystemBased()

Returns true if the resources associated with this context are filesystem based.

getApplicationEventListeners

public java.lang.Object[] getApplicationEventListeners()

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

Specified by:: getApplicationEventListeners in interface Context

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

setApplicationEventListeners

public void setApplicationEventListeners(java.lang.Object[] listeners)

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

Specified by:: setApplicationEventListeners in interface Context

Parameters:: listeners - The set of instantiated listener objects.

getApplicationLifecycleListeners

public java.lang.Object[] getApplicationLifecycleListeners()

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

Specified by:: getApplicationLifecycleListeners in interface Context

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

setApplicationLifecycleListeners

public void setApplicationLifecycleListeners(java.lang.Object[] listeners)

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

Specified by:: setApplicationLifecycleListeners in interface Context

Parameters:: listeners - The set of instantiated listener objects.

getAntiJARLocking

public boolean getAntiJARLocking()

Return the antiJARLocking flag for this Context.

getAntiResourceLocking

public boolean getAntiResourceLocking()

Return the antiResourceLocking flag for this Context.

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

getAvailable

public boolean getAvailable()

Return the application available flag for this Context.

Specified by:: getAvailable in interface Context

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

getCharsetMapper

public CharsetMapper getCharsetMapper()

Return the Locale to character set mapper for this Context.

Specified by:: getCharsetMapper in interface Context

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

getConfigFile

public java.lang.String getConfigFile()

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

Specified by:: getConfigFile in interface Context

setConfigFile

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

getConfigured

public boolean getConfigured()

Return the "correctly configured" flag for this Context.

Specified by:: getConfigured in interface Context

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

getCookies

public boolean getCookies()

Return the "use cookies for session ids" flag.

Specified by:: getCookies in interface Context

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

getUseHttpOnly

public boolean getUseHttpOnly()

Gets the value of the use HttpOnly cookies for session cookies flag.

Specified by:: getUseHttpOnly in interface Context

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

setUseHttpOnly

public void setUseHttpOnly(boolean useHttpOnly)

Sets the use HttpOnly cookies for session cookies flag.

Specified by:: setUseHttpOnly in interface Context

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

getSessionCookieDomain

public java.lang.String getSessionCookieDomain()

Gets the domain to use for session cookies.

Specified by:: getSessionCookieDomain in interface Context

Returns:: The value of the default session cookie domain or null if not specified

setSessionCookieDomain

public void setSessionCookieDomain(java.lang.String sessionCookieDomain)

Sets the domain to use for session cookies.

Specified by:: setSessionCookieDomain in interface Context

Parameters:: sessionCookieDomain - The domain to use

getSessionCookiePath

public java.lang.String getSessionCookiePath()

Gets the path to use for session cookies.

Specified by:: getSessionCookiePath in interface Context

Returns:: The value of the default session cookie path or null if not specified

setSessionCookiePath

public void setSessionCookiePath(java.lang.String sessionCookiePath)

Sets the path to use for session cookies.

Specified by:: setSessionCookiePath in interface Context

Parameters:: sessionCookiePath - The path to use

getSessionCookieName

public java.lang.String getSessionCookieName()

Gets the name to use for session cookies.

Specified by:: getSessionCookieName in interface Context

Returns:: The value of the default session cookie name or null if not specified

setSessionCookieName

public void setSessionCookieName(java.lang.String sessionCookieName)

Sets the name to use for session cookies. Overrides any setting that may be specified by the application.

Specified by:: setSessionCookieName in interface Context

Parameters:: sessionCookieName - The name to use

getCrossContext

public boolean getCrossContext()

Return the "allow crossing servlet contexts" flag.

Specified by:: getCrossContext in interface Context

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

getDefaultContextXml

public java.lang.String getDefaultContextXml()

setDefaultContextXml

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

getDefaultWebXml

public java.lang.String getDefaultWebXml()

setDefaultWebXml

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

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.

setStartupTime

public void setStartupTime(long startupTime)

getTldScanTime

public long getTldScanTime()

setTldScanTime

public void setTldScanTime(long tldScanTime)

getDisplayName

public java.lang.String getDisplayName()

Return the display name of this web application.

Specified by:: getDisplayName in interface Context

getAltDDName

public java.lang.String getAltDDName()

Return the alternate Deployment Descriptor name.

Specified by:: getAltDDName in interface Context

setAltDDName

public void setAltDDName(java.lang.String altDDName)

Set an alternate Deployment Descriptor name.

Specified by:: setAltDDName in interface Context

getCompilerClasspath

public java.lang.String getCompilerClasspath()

Return the compiler classpath.

setCompilerClasspath

public void setCompilerClasspath(java.lang.String compilerClasspath)

Set the compiler classpath.

setDisplayName

public void setDisplayName(java.lang.String displayName)

Set the display name of this web application.

Specified by:: setDisplayName in interface Context

Parameters:: displayName - The new display name

getDistributable

public boolean getDistributable()

Return the distributable flag for this web application.

Specified by:: getDistributable in interface Context

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

getDocBase

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

setDocBase

public void setDocBase(java.lang.String docBase)

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

Specified by:: setDocBase in interface Context

Parameters:: docBase - The new document root

isDisableURLRewriting

public boolean isDisableURLRewriting()

Is URL rewriting disabled? URL rewriting is an optional component of the servlet 2.5 specification. However if set to true this will be non-compliant with the specification as the specification requires that there must be a way to retain sessions if the client doesn't allow session cookies.

Specified by:: isDisableURLRewriting in interface Context

Returns:: true If URL rewriting is disabled.
See Also:: Servlet 2.5 Specification. Sections SRV.7.1.3 and SRV.7.1.4, encodeURL, encodeRedirectURL

setDisableURLRewriting

public void setDisableURLRewriting(boolean disable)

Sets the disabling of URL Rewriting.

Specified by:: setDisableURLRewriting in interface Context

Parameters:: disable - True to disable URL Rewriting. Default false.

isLazy

public boolean isLazy()

setLazy

public void setLazy(boolean lazy)

getInfo

public java.lang.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 class ContainerBase

getEngineName

public java.lang.String getEngineName()

setEngineName

public void setEngineName(java.lang.String engineName)

getJ2EEApplication

public java.lang.String getJ2EEApplication()

setJ2EEApplication

public void setJ2EEApplication(java.lang.String j2EEApplication)

getJ2EEServer

public java.lang.String getJ2EEServer()

setJ2EEServer

public void setJ2EEServer(java.lang.String j2EEServer)

setLoader

public void setLoader(Loader loader)

Set the Loader with which this Context is associated.

Specified by:: setLoader in interface Container
Overrides:: setLoader in class ContainerBase

Parameters:: loader - The newly associated loader

getIgnoreAnnotations

public boolean getIgnoreAnnotations()

Return the boolean on the annotations parsing.

Specified by:: getIgnoreAnnotations in interface Context

setIgnoreAnnotations

public void setIgnoreAnnotations(boolean ignoreAnnotations)

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

Specified by:: setIgnoreAnnotations in interface Context

Parameters:: ignoreAnnotations - The boolean on the annotations parsing

getLoginConfig

public LoginConfig getLoginConfig()

Return the login configuration descriptor for this web application.

Specified by:: getLoginConfig in interface Context

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

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

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

getPath

public java.lang.String getPath()

Return the context path for this Context.

Specified by:: getPath in interface Context

setPath

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

getPublicId

public java.lang.String getPublicId()

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

Specified by:: getPublicId in interface Context

setPublicId

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

getReloadable

public boolean getReloadable()

Return the reloadable flag for this web application.

Specified by:: getReloadable in interface Context

getOverride

public boolean getOverride()

Return the DefaultContext override flag for this web application.

Specified by:: getOverride in interface Context

getOriginalDocBase

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

setOriginalDocBase

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

getParentClassLoader

public java.lang.ClassLoader getParentClassLoader()

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

Specified by:: getParentClassLoader in interface Container
Overrides:: getParentClassLoader in class ContainerBase

getPrivileged

public boolean getPrivileged()

Return the privileged flag for this web application.

Specified by:: getPrivileged in interface Context

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

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

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

isReplaceWelcomeFiles

public boolean isReplaceWelcomeFiles()

Return the "replace welcome files" property.

setReplaceWelcomeFiles

public void setReplaceWelcomeFiles(boolean replaceWelcomeFiles)

Set the "replace welcome files" property.

Parameters:: replaceWelcomeFiles - The new property value

getServletContext

public javax.servlet.ServletContext getServletContext()

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

Specified by:: getServletContext in interface Context

getSessionTimeout

public int getSessionTimeout()

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

Specified by:: getSessionTimeout in interface Context

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

getSwallowOutput

public boolean getSwallowOutput()

Return the value of the swallowOutput flag.

Specified by:: getSwallowOutput in interface Context

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.

Specified by:: setSwallowOutput in interface Context

Parameters:: swallowOutput - The new value

getUnloadDelay

public long getUnloadDelay()

Return the value of the unloadDelay flag.

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

getUnpackWAR

public boolean getUnpackWAR()

Unpack WAR flag accessor.

setUnpackWAR

public void setUnpackWAR(boolean unpackWAR)

Unpack WAR flag mutator.

getWrapperClass

public java.lang.String getWrapperClass()

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

Specified by:: getWrapperClass in interface Context

setWrapperClass

public void setWrapperClass(java.lang.String wrapperClassName)

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

Specified by:: setWrapperClass in interface Context

Parameters:: wrapperClassName - The new wrapper class name
Throws:: java.lang.IllegalArgumentException - if the specified wrapper class cannot be found or is not a subclass of StandardWrapper

setResources

public void setResources(javax.naming.directory.DirContext resources)

Set the resources DirContext object with which this Container is associated.

Specified by:: setResources in interface Container
Overrides:: setResources in class ContainerBase

Parameters:: resources - The newly associated DirContext

getCharsetMapperClass

public java.lang.String getCharsetMapperClass()

Return the Locale to character set mapper class for this Context.

setCharsetMapperClass

public void setCharsetMapperClass(java.lang.String mapper)

Set the Locale to character set mapper class for this Context.

Parameters:: mapper - The new mapper class

getWorkPath

public java.lang.String getWorkPath()

Get the absolute path to the work dir. To avoid duplication.

Returns:: The work path

getWorkDir

public java.lang.String getWorkDir()

Return the work directory for this Context.

setWorkDir

public void setWorkDir(java.lang.String workDir)

Set the work directory for this Context.

Parameters:: workDir - The new work directory

isSaveConfig

public boolean isSaveConfig()

Save config ?

setSaveConfig

public void setSaveConfig(boolean saveConfig)

Set save config flag.

getClearReferencesStopThreads

public boolean getClearReferencesStopThreads()

Return the clearReferencesStopThreads flag for this Context.

setClearReferencesStopThreads

public void setClearReferencesStopThreads(boolean clearReferencesStopThreads)

Set the clearReferencesStopThreads feature for this Context.

Parameters:: clearReferencesStopThreads - The new flag value

getClearReferencesStopTimerThreads

public boolean getClearReferencesStopTimerThreads()

Return the clearReferencesStopTimerThreads flag for this Context.

setClearReferencesStopTimerThreads

public void setClearReferencesStopTimerThreads(boolean clearReferencesStopTimerThreads)

Set the clearReferencesStopTimerThreads feature for this Context.

Parameters:: clearReferencesStopTimerThreads - The new flag value

getClearReferencesThreadLocals

public boolean getClearReferencesThreadLocals()

Return the clearReferencesThreadLocals flag for this Context.

getClearReferencesHttpClientKeepAliveThread

public boolean getClearReferencesHttpClientKeepAliveThread()

Return the clearReferencesHttpClientKeepAliveThread flag for this Context.

setClearReferencesHttpClientKeepAliveThread

public void setClearReferencesHttpClientKeepAliveThread(boolean clearReferencesHttpClientKeepAliveThread)

Set the clearReferencesHttpClientKeepAliveThread feature for this Context.

Parameters:: clearReferencesHttpClientKeepAliveThread - The new flag value

setClearReferencesThreadLocals

public void setClearReferencesThreadLocals(boolean clearReferencesThreadLocals)

Set the clearReferencesThreadLocals feature for this Context.

Parameters:: clearReferencesThreadLocals - The new flag value

addApplicationListener

public void addApplicationListener(java.lang.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 class ContainerBase

Parameters:: child - Child container to be added
Throws:: java.lang.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.

Specified by:: addConstraint in interface Context

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
Throws:: java.lang.IllegalArgumentException - if the specified filter name does not match an existing filter definition, or the filter mapping is malformed

addInstanceListener

public void addInstanceListener(java.lang.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(java.lang.String pattern)

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

Specified by:: addJspMapping in interface Context

Parameters:: pattern - URL pattern to be mapped

addLocaleEncodingMappingParameter

public void addLocaleEncodingMappingParameter(java.lang.String locale,
                                              java.lang.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(java.lang.String extension,
                           java.lang.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(java.lang.String name,
                         java.lang.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
Throws:: java.lang.IllegalArgumentException - if the name or value is missing, or if this context initialization parameter has already been registered

addRoleMapping

public void addRoleMapping(java.lang.String role,
                           java.lang.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(java.lang.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(java.lang.String pattern,
                              java.lang.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
Throws:: java.lang.IllegalArgumentException - if the specified servlet name is not known to this Context

addServletMapping

public void addServletMapping(java.lang.String pattern,
                              java.lang.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:: java.lang.IllegalArgumentException - if the specified servlet name is not known to this Context

addTaglib

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

addWatchedResource

public void addWatchedResource(java.lang.String name)

Add a new watched resource to the set recognized by this Context.

Specified by:: addWatchedResource in interface Context

Parameters:: name - New watched resource file name

addWelcomeFile

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

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

findApplicationListeners

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

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

findErrorPage

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

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

findFilterDef

public FilterDef findFilterDef(java.lang.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 java.lang.String[] findInstanceListeners()

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

Specified by:: findInstanceListeners in interface Context

findMappingObject

public Context findMappingObject()

FIXME: Fooling introspection ...

findMessageDestination

public MessageDestination findMessageDestination(java.lang.String name)

Return the message destination with the specified name, if any; otherwise, return null.

Parameters:: name - Name of the desired message destination

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.

findMessageDestinationRef

public MessageDestinationRef findMessageDestinationRef(java.lang.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.

findMimeMapping

public java.lang.String findMimeMapping(java.lang.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 java.lang.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 java.lang.String findParameter(java.lang.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 java.lang.String[] findParameters()

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

Specified by:: findParameters in interface Context

findRoleMapping

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

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

Specified by:: findRoleMapping in interface Context

Parameters:: role - Security role to map

findSecurityRole

public boolean findSecurityRole(java.lang.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 java.lang.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 java.lang.String findServletMapping(java.lang.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 java.lang.String[] findServletMappings()

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

Specified by:: findServletMappings in interface Context

findStatusPage

public java.lang.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 java.lang.String findTaglib(java.lang.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 java.lang.String[] findTaglibs()

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

Specified by:: findTaglibs in interface Context

findWelcomeFile

public boolean findWelcomeFile(java.lang.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

findWatchedResources

public java.lang.String[] findWatchedResources()

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

Specified by:: findWatchedResources in interface Context

findWelcomeFiles

public java.lang.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 java.lang.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 java.lang.String[] findWrapperListeners()

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

Specified by:: findWrapperListeners in interface Context

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

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

removeApplicationListener

public void removeApplicationListener(java.lang.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(java.lang.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 class ContainerBase

Parameters:: child - Child container to be added
Throws:: java.lang.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.

Specified by:: removeConstraint in interface Context

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.

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

removeMessageDestination

public void removeMessageDestination(java.lang.String name)

Remove any message destination with the specified name.

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

removeMessageDestinationRef

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

removeRoleMapping

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

removeWatchedResource

public void removeWatchedResource(java.lang.String name)

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

Specified by:: removeWatchedResource in interface Context

Parameters:: name - Name of the watched resource to be removed

removeWelcomeFile

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

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

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.

findFilterConfig

public javax.servlet.FilterConfig findFilterConfig(java.lang.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

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.

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.

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)

start

public void start()
           throws LifecycleException

Start this Context component.

Specified by:: start in interface Lifecycle
Overrides:: start in class ContainerBase

Throws:: LifecycleException - if a startup error occurs

stop

public void stop()
          throws LifecycleException

Stop this Context component.

Specified by:: stop in interface Lifecycle
Overrides:: stop in class ContainerBase

Throws:: LifecycleException - if a shutdown error occurs

destroy

public void destroy()
             throws java.lang.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 class ContainerBase

Throws:: java.lang.Exception

toString

public java.lang.String toString()

Return a String representation of this component.

Overrides:: toString in class java.lang.Object

adjustURLPattern

protected java.lang.String adjustURLPattern(java.lang.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

isServlet22

protected boolean isServlet22()

Are we processing a version 2.2 deployment descriptor?

engineBase

protected java.io.File engineBase()

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

getBasePath

protected java.lang.String getBasePath()

Get base path.

getAppBase

protected java.lang.String getAppBase()

Get app base.

getConfigBase

public java.io.File getConfigBase()

Get config base.

getDefaultConfigFile

protected java.lang.String getDefaultConfigFile()

Given a context path, get the config file name.

getNamingContextListener

public NamingContextListener getNamingContextListener()

Naming context listener accessor.

setNamingContextListener

public void setNamingContextListener(NamingContextListener namingContextListener)

Naming context listener setter.

getPaused

public boolean getPaused()

Return the request processing paused flag for this Context.

getHostname

public java.lang.String getHostname()

getDeploymentDescriptor

public java.lang.String getDeploymentDescriptor()

JSR77 deploymentDescriptor attribute

Returns:: string deployment descriptor

getServlets

public java.lang.String[] getServlets()

JSR77 servlets attribute

Returns:: list of all servlets ( we know about )

createObjectName

public javax.management.ObjectName createObjectName(java.lang.String hostDomain,
                                                    javax.management.ObjectName parentName)
                                             throws javax.management.MalformedObjectNameException

Overrides:: createObjectName in class ContainerBase

Throws:: javax.management.MalformedObjectNameException

preRegister

public javax.management.ObjectName preRegister(javax.management.MBeanServer server,
                                               javax.management.ObjectName name)
                                        throws java.lang.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.

Specified by:: preRegister in interface javax.management.MBeanRegistration
Overrides:: preRegister in class ContainerBase

Parameters:: server - The server; name - The object name
Returns:: ObjectName The name of the object
Throws:: java.lang.Exception - If an error occurs

preDeregister

public void preDeregister()
                   throws java.lang.Exception

Specified by:: preDeregister in interface javax.management.MBeanRegistration
Overrides:: preDeregister in class ContainerBase

Throws:: java.lang.Exception

init

public void init()
          throws java.lang.Exception

Description copied from class: ContainerBase

Init method, part of the MBean lifecycle. If the container was added via JMX, it'll register itself with the parent, using the ObjectName conventions to locate the parent. If the container was added directly and it doesn't have an ObjectName, it'll create a name and register itself with the JMX console. On destroy(), the object will unregister.

Overrides:: init in class ContainerBase

Throws:: java.lang.Exception

getParentName

public javax.management.ObjectName getParentName()
                                          throws javax.management.MalformedObjectNameException

Overrides:: getParentName in class ContainerBase

Throws:: javax.management.MalformedObjectNameException

create

public void create()
            throws java.lang.Exception

Throws:: java.lang.Exception

removeNotificationListener

public void removeNotificationListener(javax.management.NotificationListener listener,
                                       javax.management.NotificationFilter filter,
                                       java.lang.Object object)
                                throws javax.management.ListenerNotFoundException

Specified by:: removeNotificationListener in interface javax.management.NotificationEmitter

Throws:: javax.management.ListenerNotFoundException

getNotificationInfo

public javax.management.MBeanNotificationInfo[] getNotificationInfo()

Specified by:: getNotificationInfo in interface javax.management.NotificationBroadcaster

addNotificationListener

public void addNotificationListener(javax.management.NotificationListener listener,
                                    javax.management.NotificationFilter filter,
                                    java.lang.Object object)
                             throws java.lang.IllegalArgumentException

Specified by:: addNotificationListener in interface javax.management.NotificationBroadcaster

Throws:: java.lang.IllegalArgumentException

removeNotificationListener

public void removeNotificationListener(javax.management.NotificationListener listener)
                                throws javax.management.ListenerNotFoundException

Remove a JMX-NotificationListener

Specified by:: removeNotificationListener in interface javax.management.NotificationBroadcaster

Throws:: javax.management.ListenerNotFoundException
See Also:: NotificationBroadcaster.removeNotificationListener(javax.management.NotificationListener)

getStaticResources

public javax.naming.directory.DirContext getStaticResources()

Return the naming resources associated with this web application.

findStaticResources

public javax.naming.directory.DirContext findStaticResources()

Return the naming resources associated with this web application. FIXME: Fooling introspection ...

getWelcomeFiles

public java.lang.String[] getWelcomeFiles()

Return the naming resources associated with this web application.

getXmlNamespaceAware

public boolean getXmlNamespaceAware()

Description copied from interface: Context

Will the parsing of the web.xml file for this Context be performed by a namespace aware parser?

Specified by:: getXmlNamespaceAware in interface Context

Returns:: true if namespace awareness is enabled.

setXmlNamespaceAware

public void setXmlNamespaceAware(boolean webXmlNamespaceAware)

Description copied from interface: Context

Controls whether the parsing of the web.xml file for this Context will be performed by a namespace aware parser.

Specified by:: setXmlNamespaceAware in interface Context

Parameters:: webXmlNamespaceAware - true to enable namespace awareness

setXmlValidation

public void setXmlValidation(boolean webXmlValidation)

Description copied from interface: Context

Controls whether the parsing of the web.xml file for this Context will be performed by a validating parser.

Specified by:: setXmlValidation in interface Context

Parameters:: webXmlValidation - true to enable xml validation

getXmlValidation

public boolean getXmlValidation()

Description copied from interface: Context

Will the parsing of the web.xml file for this Context be performed by a validating parser?

Specified by:: getXmlValidation in interface Context

Returns:: true if validation is enabled.

getTldNamespaceAware

public boolean getTldNamespaceAware()

Description copied from interface: Context

*.tld files are always parsed using a namespace aware parser.

Specified by:: getTldNamespaceAware in interface Context

Returns:: Always true

setTldNamespaceAware

public void setTldNamespaceAware(boolean tldNamespaceAware)

Description copied from interface: Context

*.tld files are always parsed using a namespace aware parser.

Specified by:: setTldNamespaceAware in interface Context

Parameters:: tldNamespaceAware - ignored

setXmlBlockExternal

public void setXmlBlockExternal(boolean xmlBlockExternal)

Description copied from interface: Context

Controls whether the parsing of web.xml, web-fragment.xml, *.tld, *.jspx, *.tagx and tagplugin.xml files for this Context will block the use of external entities.

Specified by:: setXmlBlockExternal in interface Context

Parameters:: xmlBlockExternal - true to block external entities

getXmlBlockExternal

public boolean getXmlBlockExternal()

Description copied from interface: Context

Will the parsing of web.xml, web-fragment.xml, *.tld, *.jspx, *.tagx and tagplugin.xml files for this Context block the use of external entities?

Specified by:: getXmlBlockExternal in interface Context

Returns:: true if access to external entities is blocked

setTldValidation

public void setTldValidation(boolean tldValidation)

Description copied from interface: Context

Controls whether the parsing of *.tld files for this Context will be performed by a validating parser.

Specified by:: setTldValidation in interface Context

Parameters:: tldValidation - true to enable xml validation

getTldValidation

public boolean getTldValidation()

Description copied from interface: Context

Will the parsing of *.tld files for this Context be performed by a validating parser?

Specified by:: getTldValidation in interface Context

Returns:: true if validation is enabled.

setProcessTlds

public void setProcessTlds(boolean newProcessTlds)

Sets the process TLDs attribute.

Parameters:: newProcessTlds - The new value

getProcessTlds

public boolean getProcessTlds()

Returns the processTlds attribute value.

isStateManageable

public boolean isStateManageable()

Support for "stateManageable" JSR77

startRecursive

public void startRecursive()
                    throws LifecycleException

Throws:: LifecycleException

getState

public int getState()

getStateName

public java.lang.String getStateName()

getServer

public java.lang.String getServer()

setServer

public java.lang.String setServer(java.lang.String server)

getJavaVMs

public java.lang.String[] getJavaVMs()

setJavaVMs

public java.lang.String[] setJavaVMs(java.lang.String[] javaVMs)

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

isEventProvider

public boolean isEventProvider()

isStatisticsProvider

public boolean isStatisticsProvider()

Overview

Package

Class

Tree

Deprecated

Index

Help

Apache Tomcat 6.0.43

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.apache.catalina.core Class StandardContext

urlEncoder

context

caseSensitive

allowLinking

cacheMaxSize

cacheObjectMaxSize

cacheTTL

StandardContext

getAnnotationProcessor

setAnnotationProcessor

getEncodedPath

setName

isCachingAllowed

setCachingAllowed

setCaseSensitive

isCaseSensitive

setAllowLinking

isAllowLinking

setCacheTTL

getCacheTTL

getCacheMaxSize

setCacheMaxSize

getCacheObjectMaxSize

setCacheObjectMaxSize

getDelegate

setDelegate

isUseNaming

setUseNaming

isFilesystemBased

getApplicationEventListeners

setApplicationEventListeners

getApplicationLifecycleListeners

setApplicationLifecycleListeners

getAntiJARLocking

getAntiResourceLocking

setAntiJARLocking

setAntiResourceLocking

getAvailable

setAvailable

getCharsetMapper

setCharsetMapper

getConfigFile

setConfigFile

getConfigured

setConfigured

getCookies

setCookies

getUseHttpOnly

setUseHttpOnly

getSessionCookieDomain

setSessionCookieDomain

getSessionCookiePath

setSessionCookiePath

getSessionCookieName

setSessionCookieName

getCrossContext

setCrossContext

getDefaultContextXml

setDefaultContextXml

getDefaultWebXml

setDefaultWebXml

getStartupTime

setStartupTime

getTldScanTime

setTldScanTime

getDisplayName

getAltDDName

setAltDDName

getCompilerClasspath

setCompilerClasspath

setDisplayName

getDistributable

setDistributable

getDocBase

setDocBase

isDisableURLRewriting

setDisableURLRewriting

isLazy

setLazy

org.apache.catalina.core
Class StandardContext