Home » apache-tomcat-6.0.26-src » org.apache » catalina » [javadoc | source]
org.apache.catalina
public interface: Context [javadoc | source]

All Implemented Interfaces:
    Container

All Known Implementing Classes:
    StandardContext, ReplicatedContext

A Context is a Container that represents a servlet context, and therefore an individual web application, in the Catalina servlet engine. It is therefore useful in almost every deployment of Catalina (even if a Connector attached to a web server (such as Apache) uses the web server's facilities to identify the appropriate Wrapper to handle this request. It also provides a convenient mechanism to use Interceptors that see every request processed by this particular web application.

The parent Container attached to a Context is generally a Host, but may be some other implementation, or may be omitted if it is not necessary.

The child containers attached to a Context are generally implementations of Wrapper (representing individual servlet definitions).

Field Summary
public static final  String RELOAD_EVENT    The LifecycleEvent type sent when a context is reloaded. 
Method from org.apache.catalina.Context Summary:
addApplicationListener,   addApplicationParameter,   addConstraint,   addErrorPage,   addFilterDef,   addFilterMap,   addInstanceListener,   addJspMapping,   addLocaleEncodingMappingParameter,   addMimeMapping,   addParameter,   addRoleMapping,   addSecurityRole,   addServletMapping,   addTaglib,   addWatchedResource,   addWelcomeFile,   addWrapperLifecycle,   addWrapperListener,   createWrapper,   findApplicationListeners,   findApplicationParameters,   findConstraints,   findErrorPage,   findErrorPage,   findErrorPages,   findFilterDef,   findFilterDefs,   findFilterMaps,   findInstanceListeners,   findMimeMapping,   findMimeMappings,   findParameter,   findParameters,   findRoleMapping,   findSecurityRole,   findSecurityRoles,   findServletMapping,   findServletMappings,   findStatusPage,   findStatusPages,   findTaglib,   findTaglibs,   findWatchedResources,   findWelcomeFile,   findWelcomeFiles,   findWrapperLifecycles,   findWrapperListeners,   getAltDDName,   getApplicationEventListeners,   getApplicationLifecycleListeners,   getAvailable,   getCharsetMapper,   getConfigFile,   getConfigured,   getCookies,   getCrossContext,   getDisplayName,   getDistributable,   getDocBase,   getEncodedPath,   getIgnoreAnnotations,   getLoginConfig,   getMapper,   getNamingResources,   getOverride,   getPath,   getPrivileged,   getPublicId,   getReloadable,   getServletContext,   getSessionTimeout,   getSwallowOutput,   getTldNamespaceAware,   getTldValidation,   getUseHttpOnly,   getWrapperClass,   getXmlNamespaceAware,   getXmlValidation,   reload,   removeApplicationListener,   removeApplicationParameter,   removeConstraint,   removeErrorPage,   removeFilterDef,   removeFilterMap,   removeInstanceListener,   removeMimeMapping,   removeParameter,   removeRoleMapping,   removeSecurityRole,   removeServletMapping,   removeTaglib,   removeWatchedResource,   removeWelcomeFile,   removeWrapperLifecycle,   removeWrapperListener,   setAltDDName,   setApplicationEventListeners,   setApplicationLifecycleListeners,   setAvailable,   setCharsetMapper,   setConfigFile,   setConfigured,   setCookies,   setCrossContext,   setDisplayName,   setDistributable,   setDocBase,   setIgnoreAnnotations,   setLoginConfig,   setNamingResources,   setOverride,   setPath,   setPrivileged,   setPublicId,   setReloadable,   setSessionTimeout,   setSwallowOutput,   setTldNamespaceAware,   setTldValidation,   setUseHttpOnly,   setWrapperClass,   setXmlNamespaceAware,   setXmlValidation
Method from org.apache.catalina.Context 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 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 addMimeMapping(String extension,
    String mimeType)
    Add a new MIME mapping, replacing any existing mapping for the specified extension.
 public  void addParameter(String name,
    String value)
    Add a new context initialization parameter, replacing any existing value for the specified name.
 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 addTaglib(String uri,
    String location)
    Add a JSP tag library for the specified URI.
 public  void addWatchedResource(String name)
    Add a resource which will be watched for reloading by the host auto deployer. Note: this will not be used in embedded mode.
 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.
 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 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 set of 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 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 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 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 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.
 public CharsetMapper getCharsetMapper()
    Return the Locale to character set mapper for this Context.
 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.
 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()
    Return the URL encoded context path, using UTF-8.
 public boolean getIgnoreAnnotations()
    Return the boolean on the annotations parsing.
 public LoginConfig getLoginConfig()
    Return the login configuration descriptor for this web application.
 public Mapper getMapper()
    Get the request dispatcher mapper.
 public NamingResources getNamingResources()
    Return the naming resources associated with this web application.
 public boolean getOverride()
    Return the override flag for this web application.
 public String getPath()
    Return the context path for this web application.
 public boolean getPrivileged()
    Return the privileged flag for this web application.
 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 ServletContext getServletContext()
    Return the servlet context for which this Context is a facade.
 public int getSessionTimeout()
    Return the default session timeout (in minutes) for this web application.
 public boolean getSwallowOutput()
    Return the value of the swallowOutput flag.
 public boolean getTldNamespaceAware()
    Get the server.xml <host> attribute's xmlNamespaceAware.
 public boolean getTldValidation()
    Get the server.xml attribute's webXmlValidation.
 public boolean getUseHttpOnly()
    Gets the value of the use HttpOnly cookies for session cookies flag.
 public String getWrapperClass()
    Return the Java class name of the Wrapper implementation used for servlets registered in this Context.
 public boolean getXmlNamespaceAware()
    Get the server.xml attribute's xmlNamespaceAware.
 public boolean getXmlValidation()
    Get the server.xml attribute's xmlValidation.
 public  void reload()
    Reload this web application, if reloading is supported.
 public  void removeApplicationListener(String listener)
    Remove the specified application listener class from the set of listeners for this application.
 public  void removeApplicationParameter(String name)
    Remove the application parameter with the specified name from the set for this application.
 public  void removeConstraint(SecurityConstraint constraint)
    Remove the specified security constraint from this web application.
 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.
 public  void removeFilterDef(FilterDef filterDef)
    Remove the specified filter definition from this Context, if it exists; otherwise, no action is taken.
 public  void removeFilterMap(FilterMap filterMap)
    Remove a filter mapping from this Context.
 public  void removeInstanceListener(String listener)
    Remove a class name from the set of InstanceListener classes that will be added to newly created Wrappers.
 public  void removeMimeMapping(String extension)
    Remove the MIME mapping for the specified extension, if it exists; otherwise, no action is taken.
 public  void removeParameter(String name)
    Remove the context initialization parameter with the specified name, if it exists; otherwise, no action is taken.
 public  void removeRoleMapping(String role)
    Remove any security role reference for the specified name
 public  void removeSecurityRole(String role)
    Remove any security role with the specified name.
 public  void removeServletMapping(String pattern)
    Remove any servlet mapping for the specified pattern, if it exists; otherwise, no action is taken.
 public  void removeTaglib(String uri)
    Remove the tag library location forthe specified tag library URI.
 public  void removeWatchedResource(String name)
    Remove the specified watched resource name from the list associated with this Context.
 public  void removeWelcomeFile(String name)
    Remove the specified welcome file name from the list recognized by this Context.
 public  void removeWrapperLifecycle(String listener)
    Remove a class name from the set of LifecycleListener classes that will be added to newly created Wrappers.
 public  void removeWrapperListener(String listener)
    Remove a class name from the set of ContainerListener classes that will be added to newly created Wrappers.
 public  void setAltDDName(String altDDName)
    Set an alternate Deployment Descriptor name.
 public  void setApplicationEventListeners(Object[] listeners)
    Store the set of initialized application event listener objects, in the order they were specified in the web application deployment descriptor, for this application.
 public  void setApplicationLifecycleListeners(Object[] listeners)
    Store the set of initialized application lifecycle listener objects, in the order they were specified in the web application deployment descriptor, for this application.
 public  void setAvailable(boolean available)
    Set the application available flag for this Context.
 public  void setCharsetMapper(CharsetMapper mapper)
    Set the Locale to character set mapper for this Context.
 public  void setConfigFile(String configFile)
    Set the path to a file to save this Context information.
 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.
 public  void setCookies(boolean cookies)
    Set the "use cookies for session ids" flag.
 public  void setCrossContext(boolean crossContext)
    Set the "allow crossing servlet contexts" flag.
 public  void setDisplayName(String displayName)
    Set the display name of this web application.
 public  void setDistributable(boolean distributable)
    Set the distributable flag for this web application.
 public  void setDocBase(String docBase)
    Set the document root for this Context. This can be an absolute pathname, a relative pathname, or a URL.
 public  void setIgnoreAnnotations(boolean ignoreAnnotations)
    Set the boolean on the annotations parsing for this web application.
 public  void setLoginConfig(LoginConfig config)
    Set the login configuration descriptor for this web application.
 public  void setNamingResources(NamingResources namingResources)
    Set the naming resources for this web application.
 public  void setOverride(boolean override)
    Set the override flag for this web application.
 public  void setPath(String path)
    Set the context path for this web application.
 public  void setPrivileged(boolean privileged)
    Set the privileged flag for this web application.
 public  void setPublicId(String publicId)
    Set the public identifier of the deployment descriptor DTD that is currently being parsed.
 public  void setReloadable(boolean reloadable)
    Set the reloadable flag for this web application.
 public  void setSessionTimeout(int timeout)
    Set the default session timeout (in minutes) for this web application.
 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.
 public  void setTldNamespaceAware(boolean tldNamespaceAware)
    Set the namespace aware feature of the XML parser used when parsing xml instances.
 public  void setTldValidation(boolean tldValidation)
    Set the validation feature of the XML parser used when parsing tlds files.
 public  void setUseHttpOnly(boolean useHttpOnly)
    Sets the use HttpOnly cookies for session cookies flag.
 public  void setWrapperClass(String wrapperClass)
    Set the Java class name of the Wrapper implementation used for servlets registered in this Context.
 public  void setXmlNamespaceAware(boolean xmlNamespaceAware)
    Set the namespace aware feature of the XML parser used when parsing xml instances.
 public  void setXmlValidation(boolean xmlValidation)
    Set the validation feature of the XML parser used when parsing xml instances.