Save This Page
Home » apache-tomcat-6.0.16-src » org.apache » catalina » core » [javadoc | source]
org.apache.catalina.core
public class: StandardContext [javadoc | source]
java.lang.Object
   org.apache.catalina.core.ContainerBase
      org.apache.catalina.core.StandardContext

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

Direct Known Subclasses:
    ReplicatedContext

Standard implementation of the Context interface. Each child container must be a Wrapper implementation to process the requests directed to a particular servlet.
Field Summary
protected static  URLEncoder urlEncoder    Array containing the safe characters set. 
protected transient  ApplicationContext context    The ServletContext implementation associated with this Context. 
protected  boolean caseSensitive    Case sensitivity. 
protected  boolean allowLinking    Allow linking. 
protected  int cacheMaxSize    Cache max size in KB. 
protected  int cacheTTL    Cache TTL in ms. 
Fields inherited from org.apache.catalina.core.ContainerBase:
children,  backgroundProcessorDelay,  lifecycle,  listeners,  loader,  logger,  logName,  manager,  cluster,  name,  parent,  parentClassLoader,  pipeline,  realm,  resources,  sm,  started,  initialized,  startChildren,  support,  type,  domain,  suffix,  oname,  controller,  mserver
Constructor:
 public StandardContext() 
Method from org.apache.catalina.core.StandardContext Summary:
addApplicationListener,   addApplicationParameter,   addChild,   addConstraint,   addErrorPage,   addFilterDef,   addFilterMap,   addInstanceListener,   addJspMapping,   addLocaleEncodingMappingParameter,   addMessageDestination,   addMessageDestinationRef,   addMimeMapping,   addNotificationListener,   addParameter,   addRoleMapping,   addSecurityRole,   addServletMapping,   addServletMapping,   addTaglib,   addWatchedResource,   addWelcomeFile,   addWrapperLifecycle,   addWrapperListener,   adjustURLPattern,   create,   createObjectName,   createWrapper,   destroy,   engineBase,   filterStart,   filterStop,   findApplicationListeners,   findApplicationParameters,   findConstraints,   findErrorPage,   findErrorPage,   findErrorPages,   findFilterConfig,   findFilterDef,   findFilterDefs,   findFilterMaps,   findInstanceListeners,   findMappingObject,   findMessageDestination,   findMessageDestinationRef,   findMessageDestinationRefs,   findMessageDestinations,   findMimeMapping,   findMimeMappings,   findParameter,   findParameters,   findRoleMapping,   findSecurityRole,   findSecurityRoles,   findServletMapping,   findServletMappings,   findStaticResources,   findStatusPage,   findStatusPages,   findTaglib,   findTaglibs,   findWatchedResources,   findWelcomeFile,   findWelcomeFiles,   findWrapperLifecycles,   findWrapperListeners,   getAltDDName,   getAnnotationProcessor,   getAntiJARLocking,   getAntiResourceLocking,   getAppBase,   getApplicationEventListeners,   getApplicationLifecycleListeners,   getAvailable,   getBasePath,   getCacheMaxSize,   getCacheTTL,   getCharsetMapper,   getCharsetMapperClass,   getCompilerClasspath,   getConfigBase,   getConfigFile,   getConfigured,   getCookies,   getCrossContext,   getDefaultConfigFile,   getDefaultContextXml,   getDefaultWebXml,   getDelegate,   getDeploymentDescriptor,   getDisplayName,   getDistributable,   getDocBase,   getEncodedPath,   getEngineName,   getHostname,   getIgnoreAnnotations,   getInfo,   getJ2EEApplication,   getJ2EEServer,   getJavaVMs,   getLoginConfig,   getMapper,   getNamingContextListener,   getNamingResources,   getNotificationInfo,   getOriginalDocBase,   getOverride,   getParentClassLoader,   getParentName,   getPath,   getPaused,   getPrivileged,   getProcessTlds,   getProcessingTime,   getPublicId,   getReloadable,   getServer,   getServletContext,   getServlets,   getSessionTimeout,   getStartTime,   getStartupTime,   getState,   getStaticResources,   getSwallowOutput,   getTldNamespaceAware,   getTldScanTime,   getTldValidation,   getUnloadDelay,   getUnpackWAR,   getWelcomeFiles,   getWorkDir,   getWorkPath,   getWrapperClass,   getXmlNamespaceAware,   getXmlValidation,   init,   isAllowLinking,   isCachingAllowed,   isCaseSensitive,   isEventProvider,   isFilesystemBased,   isLazy,   isReplaceWelcomeFiles,   isSaveConfig,   isServlet22,   isStateManageable,   isStatisticsProvider,   isUseNaming,   listenerStart,   listenerStop,   loadOnStartup,   preDeregister,   preRegister,   processTlds,   reload,   removeApplicationListener,   removeApplicationParameter,   removeChild,   removeConstraint,   removeErrorPage,   removeFilterDef,   removeFilterMap,   removeInstanceListener,   removeMessageDestination,   removeMessageDestinationRef,   removeMimeMapping,   removeNotificationListener,   removeNotificationListener,   removeParameter,   removeRoleMapping,   removeSecurityRole,   removeServletMapping,   removeTaglib,   removeWatchedResource,   removeWelcomeFile,   removeWrapperLifecycle,   removeWrapperListener,   resourcesStart,   resourcesStop,   setAllowLinking,   setAltDDName,   setAnnotationProcessor,   setAntiJARLocking,   setAntiResourceLocking,   setApplicationEventListeners,   setApplicationLifecycleListeners,   setAvailable,   setCacheMaxSize,   setCacheTTL,   setCachingAllowed,   setCaseSensitive,   setCharsetMapper,   setCharsetMapperClass,   setCompilerClasspath,   setConfigFile,   setConfigured,   setCookies,   setCrossContext,   setDefaultContextXml,   setDefaultWebXml,   setDelegate,   setDisplayName,   setDistributable,   setDocBase,   setEngineName,   setIgnoreAnnotations,   setJ2EEApplication,   setJ2EEServer,   setJavaVMs,   setLazy,   setLoader,   setLoginConfig,   setName,   setNamingContextListener,   setNamingResources,   setOriginalDocBase,   setOverride,   setPath,   setPrivileged,   setProcessTlds,   setPublicId,   setReloadable,   setReplaceWelcomeFiles,   setResources,   setSaveConfig,   setServer,   setSessionTimeout,   setStartupTime,   setSwallowOutput,   setTldNamespaceAware,   setTldScanTime,   setTldValidation,   setUnloadDelay,   setUnpackWAR,   setUseNaming,   setWorkDir,   setWrapperClass,   setXmlNamespaceAware,   setXmlValidation,   start,   startRecursive,   stop,   toString
Methods from org.apache.catalina.core.ContainerBase:
addChild,   addContainerListener,   addLifecycleListener,   addPropertyChangeListener,   addValve,   backgroundProcess,   createObjectName,   destroy,   findChild,   findChildren,   findContainerListeners,   findLifecycleListeners,   fireContainerEvent,   getBackgroundProcessorDelay,   getBasic,   getChildren,   getCluster,   getContainerSuffix,   getDomain,   getFirst,   getInfo,   getJSR77Suffix,   getJmxName,   getLoader,   getLogger,   getManager,   getMappingObject,   getName,   getObjectName,   getParent,   getParentClassLoader,   getParentName,   getPipeline,   getRealm,   getResources,   getStartChildren,   getType,   getValveObjectNames,   getValves,   init,   invoke,   logName,   postDeregister,   postRegister,   preDeregister,   preRegister,   removeChild,   removeContainerListener,   removeLifecycleListener,   removePropertyChangeListener,   removeValve,   setBackgroundProcessorDelay,   setBasic,   setCluster,   setDomain,   setLoader,   setManager,   setName,   setParent,   setParentClassLoader,   setRealm,   setResources,   setStartChildren,   start,   stop,   threadStart,   threadStop
Methods from java.lang.Object:
equals,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from org.apache.catalina.core.StandardContext Detail:
 public  void addApplicationListener(String listener) 
    Add a new Listener class name to the set of Listeners configured for this application.
 public  void addApplicationParameter(ApplicationParameter parameter) 
    Add a new application parameter for this application.
 public  void addChild(Container child) 
    Add a child Container, only if the proposed child is an implementation of Wrapper.
 public  void addConstraint(SecurityConstraint constraint) 
    Add a security constraint to the set for this web application.
 public  void addErrorPage(ErrorPage errorPage) 
    Add an error page for the specified error or Java exception.
 public  void addFilterDef(FilterDef filterDef) 
    Add a filter definition to this Context.
 public  void addFilterMap(FilterMap filterMap) 
    Add a filter mapping to this Context.
 public  void addInstanceListener(String listener) 
    Add the classname of an InstanceListener to be added to each Wrapper appended to this Context.
 public  void addJspMapping(String pattern) 
    Add the given URL pattern as a jsp-property-group. This maps resources that match the given pattern so they will be passed to the JSP container. Though there are other elements in the property group, we only care about the URL pattern here. The JSP container will parse the rest.
 public  void addLocaleEncodingMappingParameter(String locale,
    String encoding) 
    Add a Locale Encoding Mapping (see Sec 5.4 of Servlet spec 2.4)
 public  void addMessageDestination(MessageDestination md) 
    Add a message destination for this web application.
 public  void addMessageDestinationRef(MessageDestinationRef mdr) 
    Add a message destination reference for this web application.
 public  void addMimeMapping(String extension,
    String mimeType) 
    Add a new MIME mapping, replacing any existing mapping for the specified extension.
 public  void addNotificationListener(NotificationListener listener,
    NotificationFilter filter,
    Object object) throws IllegalArgumentException 
 public  void addParameter(String name,
    String value) 
    Add a new context initialization parameter.
 public  void addRoleMapping(String role,
    String link) 
    Add a security role reference for this web application.
 public  void addSecurityRole(String role) 
    Add a new security role for this web application.
 public  void addServletMapping(String pattern,
    String name) 
    Add a new servlet mapping, replacing any existing mapping for the specified pattern.
 public  void addServletMapping(String pattern,
    String name,
    boolean jspWildCard) 
    Add a new servlet mapping, replacing any existing mapping for the specified pattern.
 public  void addTaglib(String uri,
    String location) 
    Add a JSP tag library for the specified URI.
 public  void addWatchedResource(String name) 
    Add a new watched resource to the set recognized by this Context.
 public  void addWelcomeFile(String name) 
    Add a new welcome file to the set recognized by this Context.
 public  void addWrapperLifecycle(String listener) 
    Add the classname of a LifecycleListener to be added to each Wrapper appended to this Context.
 public  void addWrapperListener(String listener) 
    Add the classname of a ContainerListener to be added to each Wrapper appended to this Context.
 protected String adjustURLPattern(String urlPattern) 
    Adjust the URL pattern to begin with a leading slash, if appropriate (i.e. we are running a servlet 2.2 application). Otherwise, return the specified URL pattern unchanged.
 public  void create() throws Exception 
 public ObjectName createObjectName(String hostDomain,
    ObjectName parentName) throws MalformedObjectNameException 
 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.
 public  void destroy() throws Exception 
    Destroy needs to clean up the context completely. The problem is that undoing all the config in start() and restoring a 'fresh' state is impossible. After stop()/destroy()/init()/start() we should have the same state as if a fresh start was done - i.e read modified web.xml, etc. This can only be done by completely removing the context object and remapping a new one, or by cleaning up everything. XXX Should this be done in stop() ?
 protected File engineBase() 
    Return a File object representing the base directory for the entire servlet container (i.e. the Engine container if present).
 public boolean filterStart() 
    Configure and initialize the set of filters for this Context. Return true if all filter initialization completed successfully, or false otherwise.
 public boolean filterStop() 
    Finalize and release the set of filters for this Context. Return true if all filter finalization completed successfully, or false otherwise.
 public String[] findApplicationListeners() 
    Return the set of application listener class names configured for this application.
 public ApplicationParameter[] findApplicationParameters() 
    Return the set of application parameters for this application.
 public SecurityConstraint[] findConstraints() 
    Return the security constraints for this web application. If there are none, a zero-length array is returned.
 public ErrorPage findErrorPage(int errorCode) 
    Return the error page entry for the specified HTTP error code, if any; otherwise return null.
 public ErrorPage findErrorPage(String exceptionType) 
    Return the error page entry for the specified Java exception type, if any; otherwise return null.
 public ErrorPage[] findErrorPages() 
    Return the set of defined error pages for all specified error codes and exception types.
 public FilterConfig findFilterConfig(String name) 
    Find and return the initialized FilterConfig for the specified filter name, if any; otherwise return null.
 public FilterDef findFilterDef(String filterName) 
    Return the filter definition for the specified filter name, if any; otherwise return null.
 public FilterDef[] findFilterDefs() 
    Return the set of defined filters for this Context.
 public FilterMap[] findFilterMaps() 
    Return the set of filter mappings for this Context.
 public String[] findInstanceListeners() 
    Return the set of InstanceListener classes that will be added to newly created Wrappers automatically.
 public Context findMappingObject() 
    FIXME: Fooling introspection ...
 public MessageDestination findMessageDestination(String name) 
    Return the message destination with the specified name, if any; otherwise, return null.
 public MessageDestinationRef findMessageDestinationRef(String name) 
    Return the message destination ref with the specified name, if any; otherwise, return null.
 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.
 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.
 public String findMimeMapping(String extension) 
    Return the MIME type to which the specified extension is mapped, if any; otherwise return null.
 public String[] findMimeMappings() 
    Return the extensions for which MIME mappings are defined. If there are none, a zero-length array is returned.
 public String findParameter(String name) 
    Return the value for the specified context initialization parameter name, if any; otherwise return null.
 public String[] findParameters() 
    Return the names of all defined context initialization parameters for this Context. If no parameters are defined, a zero-length array is returned.
 public String findRoleMapping(String role) 
    For the given security role (as used by an application), return the corresponding role name (as defined by the underlying Realm) if there is one. Otherwise, return the specified role unchanged.
 public boolean findSecurityRole(String role) 
    Return true if the specified security role is defined for this application; otherwise return false.
 public String[] findSecurityRoles() 
    Return the security roles defined for this application. If none have been defined, a zero-length array is returned.
 public String findServletMapping(String pattern) 
    Return the servlet name mapped by the specified pattern (if any); otherwise return null.
 public String[] findServletMappings() 
    Return the patterns of all defined servlet mappings for this Context. If no mappings are defined, a zero-length array is returned.
 public DirContext findStaticResources() 
    Return the naming resources associated with this web application. FIXME: Fooling introspection ...
 public String findStatusPage(int status) 
    Return the context-relative URI of the error page for the specified HTTP status code, if any; otherwise return null.
 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.
 public String findTaglib(String uri) 
    Return the tag library descriptor location for the specified taglib URI, if any; otherwise, return null.
 public String[] findTaglibs() 
    Return the URIs of all tag libraries for which a tag library descriptor location has been specified. If none are specified, a zero-length array is returned.
 public String[] findWatchedResources() 
    Return the set of watched resources for this Context. If none are defined, a zero length array will be returned.
 public boolean findWelcomeFile(String name) 
    Return true if the specified welcome file is defined for this Context; otherwise return false.
 public String[] findWelcomeFiles() 
    Return the set of welcome files defined for this Context. If none are defined, a zero-length array is returned.
 public String[] findWrapperLifecycles() 
    Return the set of LifecycleListener classes that will be added to newly created Wrappers automatically.
 public String[] findWrapperListeners() 
    Return the set of ContainerListener classes that will be added to newly created Wrappers automatically.
 public String getAltDDName() 
    Return the alternate Deployment Descriptor name.
 public AnnotationProcessor getAnnotationProcessor() 
 public boolean getAntiJARLocking() 
    Return the antiJARLocking flag for this Context.
 public boolean getAntiResourceLocking() 
    Return the antiResourceLocking flag for this Context.
 protected String getAppBase() 
    Get app base.
 public Object[] getApplicationEventListeners() 
    Return the set of initialized application event listener objects, in the order they were specified in the web application deployment descriptor, for this application.
 public Object[] getApplicationLifecycleListeners() 
    Return the set of initialized application lifecycle listener objects, in the order they were specified in the web application deployment descriptor, for this application.
 public boolean getAvailable() 
    Return the application available flag for this Context.
 protected String getBasePath() 
    Get base path.
 public int getCacheMaxSize() 
    Return the maximum size of the cache in KB.
 public int getCacheTTL() 
    Get cache TTL.
 public CharsetMapper getCharsetMapper() 
    Return the Locale to character set mapper for this Context.
 public String getCharsetMapperClass() 
    Return the Locale to character set mapper class for this Context.
 public String getCompilerClasspath() 
    Return the compiler classpath.
 public File getConfigBase() 
    Get config base.
 public String getConfigFile() 
    Return the path to a file to save this Context information.
 public boolean getConfigured() 
    Return the "correctly configured" flag for this Context.
 public boolean getCookies() 
    Return the "use cookies for session ids" flag.
 public boolean getCrossContext() 
    Return the "allow crossing servlet contexts" flag.
 protected String getDefaultConfigFile() 
    Given a context path, get the config file name.
 public String getDefaultContextXml() 
 public String getDefaultWebXml() 
 public boolean getDelegate() 
    Return the "follow standard delegation model" flag used to configure our ClassLoader.
 public String getDeploymentDescriptor() 
    JSR77 deploymentDescriptor attribute
 public String getDisplayName() 
    Return the display name of this web application.
 public boolean getDistributable() 
    Return the distributable flag for this web application.
 public String getDocBase() 
    Return the document root for this Context. This can be an absolute pathname, a relative pathname, or a URL.
 public String getEncodedPath() 
 public String getEngineName() 
 public String getHostname() 
 public boolean getIgnoreAnnotations() 
    Return the boolean on the annotations parsing.
 public String getInfo() 
    Return descriptive information about this Container implementation and the corresponding version number, in the format <description>/<version>.
 public String getJ2EEApplication() 
 public String getJ2EEServer() 
 public String[] getJavaVMs() 
 public LoginConfig getLoginConfig() 
    Return the login configuration descriptor for this web application.
 public Mapper getMapper() 
    Get the mapper associated with the context.
 public NamingContextListener getNamingContextListener() 
    Naming context listener accessor.
 public NamingResources getNamingResources() 
    Return the naming resources associated with this web application.
 public MBeanNotificationInfo[] getNotificationInfo() 
 public String getOriginalDocBase() 
    Return the original document root for this Context. This can be an absolute pathname, a relative pathname, or a URL. Is only set as deployment has change docRoot!
 public boolean getOverride() 
    Return the DefaultContext override flag for this web application.
 public ClassLoader getParentClassLoader() 
    Return the parent class loader (if any) for this web application. This call is meaningful only after a Loader has been configured.
 public ObjectName getParentName() throws MalformedObjectNameException 
 public String getPath() 
    Return the context path for this Context.
 public boolean getPaused() 
    Return the request processing paused flag for this Context.
 public boolean getPrivileged() 
    Return the privileged flag for this web application.
 public boolean getProcessTlds() 
    Returns the processTlds attribute value.
 public long getProcessingTime() 
    Gets the cumulative processing times of all servlets in this StandardContext.
 public String getPublicId() 
    Return the public identifier of the deployment descriptor DTD that is currently being parsed.
 public boolean getReloadable() 
    Return the reloadable flag for this web application.
 public String getServer() 
 public ServletContext getServletContext() 
    Return the servlet context for which this Context is a facade.
 public String[] getServlets() 
    JSR77 servlets attribute
 public int getSessionTimeout() 
    Return the default session timeout (in minutes) for this web application.
 public long getStartTime() 
    Gets the time this context was started.
 public l