Context (Apache Tomcat 6.0.53 API Documentation)
Keywords: org.apache.catalina.Context interface

Overview | Package | Class | Tree | Deprecated | Index | Help
| Apache Tomcat 6.0.53
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## org.apache.catalina
Interface Context

All Superinterfaces:
  Container

All Known Implementing Classes:
  ReplicatedContext, StandardContext

    public interface Context

extends Container

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

Author:
  Craig R. McClanahan

Field Summary
`static java.lang.String` | `CHANGE_SESSION_ID_EVENT` Container event for changing the ID of a session.
`static java.lang.String` | `RELOAD_EVENT` The LifecycleEvent type sent when a context is reloaded.

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`

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` | `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` | `addMimeMapping(java.lang.String extension, java.lang.String mimeType)` Add a new MIME mapping, replacing any existing mapping for the specified extension.
`void` | `addParameter(java.lang.String name, java.lang.String value)` Add a new context initialization parameter, replacing any existing value for the specified name.
`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` | `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 resource which will be watched for reloading by the host auto deployer.
`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.
`Wrapper` | `createWrapper()` Factory method to create and return a new Wrapper instance, of the Java implementation class appropriate for this Context implementation.
`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 set of 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.
`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.
`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.
`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.
`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.
`CharsetMapper` | `getCharsetMapper()` Return the Locale to character set mapper for this Context.
`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.
`boolean` | `getDispatchersUseEncodedPaths()` Are paths used in calls to obtain a request dispatcher expected to be encoded?
`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.
`boolean` | `getIgnoreAnnotations()` Return the boolean on the annotations parsing.
`LoginConfig` | `getLoginConfig()` Return the login configuration descriptor for this web application.
`Mapper` | `getMapper()` Get the request dispatcher mapper.
`boolean` | `getMapperContextRootRedirectEnabled()` Determines if requests for a web application context root will be redirected (adding a trailing slash) by the Mapper.
`boolean` | `getMapperDirectoryRedirectEnabled()` Determines if requests for a directory will be redirected (adding a trailing slash) by the Mapper.
`NamingResources` | `getNamingResources()` Return the naming resources associated with this web application.
`boolean` | `getOverride()` Return the override flag for this web application.
`java.lang.String` | `getPath()` Return the context path for this web application.
`boolean` | `getPrivileged()` Return the privileged flag for this web application.
`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.
`javax.servlet.ServletContext` | `getServletContext()` Return the servlet context for which this Context is a facade.
`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.
`boolean` | `getSwallowOutput()` Return the value of the swallowOutput flag.
`boolean` | `getTldNamespaceAware()` Deprecated. This option will be removed in 8.0.x.
`boolean` | `getTldValidation()` Will the parsing of *.tld files for this Context be performed by a validating parser?
`boolean` | `getUseHttpOnly()` Gets the value of the use HttpOnly cookies for session cookies flag.
`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?
`boolean` | `isDisableURLRewriting()` Is URL rewriting disabled?
`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` | `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` | `removeMimeMapping(java.lang.String extension)` Remove the MIME mapping for the specified extension, if it exists; otherwise, no action is taken.
`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.
`void` | `setAltDDName(java.lang.String altDDName)` Set an alternate Deployment Descriptor name.
`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` | `setCharsetMapper(CharsetMapper mapper)` Set the Locale to character set mapper for this Context.
`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` | `setDisableURLRewriting(boolean disable)` Is URL rewriting disabled?
`void` | `setDispatchersUseEncodedPaths(boolean dispatchersUseEncodedPaths)` Are paths used in calls to obtain a request dispatcher expected to be encoded?
`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` | `setIgnoreAnnotations(boolean ignoreAnnotations)` Set the boolean on the annotations parsing for this web application.
`void` | `setLoginConfig(LoginConfig config)` Set the login configuration descriptor for this web application.
`void` | `setMapperContextRootRedirectEnabled(boolean mapperContextRootRedirectEnabled)` If enabled, requests for a web application context root will be redirected (adding a trailing slash) by the Mapper.
`void` | `setMapperDirectoryRedirectEnabled(boolean mapperDirectoryRedirectEnabled)` If enabled, requests for a directory will be redirected (adding a trailing slash) by the Mapper.
`void` | `setNamingResources(NamingResources namingResources)` Set the naming resources for this web application.
`void` | `setOverride(boolean override)` Set the override flag for this web application.
`void` | `setPath(java.lang.String path)` Set the context path for this web application.
`void` | `setPrivileged(boolean privileged)` Set the privileged flag for this web application.
`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` | `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` | `setSwallowOutput(boolean swallowOutput)` Set the value of the swallowOutput flag.
`void` | `setTldNamespaceAware(boolean tldNamespaceAware)` Deprecated. This option will be removed in 8.0.x.
`void` | `setTldValidation(boolean tldValidation)` Controls whether the parsing of *.tld files for this Context will be performed by a validating parser.
`void` | `setUseHttpOnly(boolean useHttpOnly)` Sets the use HttpOnly cookies for session cookies flag.
`void` | `setWrapperClass(java.lang.String wrapperClass)` 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 xmlNamespaceAware)` Controls whether the parsing of the web.xml file for this Context will be performed by a namespace aware parser.
`void` | `setXmlValidation(boolean xmlValidation)` Controls whether the parsing of the web.xml file for this Context will be performed by a validating parser.

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

Field Detail

### RELOAD_EVENT

    static final java.lang.String RELOAD_EVENT

  The LifecycleEvent type sent when a context is reloaded.

  See Also:
    Constant Field Values

### CHANGE_SESSION_ID_EVENT

    static final java.lang.String CHANGE_SESSION_ID_EVENT

  Container event for changing the ID of a session.

  See Also:
    Constant Field Values

Method Detail

### getApplicationEventListeners

    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.

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

### setApplicationEventListeners

    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.

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

### getApplicationLifecycleListeners

    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.

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

### setApplicationLifecycleListeners

    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.

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

### getAvailable

    boolean getAvailable()

  Return the application available flag for this Context.

### setAvailable

    void setAvailable(boolean available)

  Set the application available flag for this Context.

  Parameters:
    `available` - The new application available flag

### getCharsetMapper

    CharsetMapper getCharsetMapper()

  Return the Locale to character set mapper for this Context.

### setCharsetMapper

    void setCharsetMapper(CharsetMapper mapper)

  Set the Locale to character set mapper for this Context.

  Parameters:
    `mapper` - The new mapper

### getConfigFile

    java.lang.String getConfigFile()

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

### setConfigFile

    void setConfigFile(java.lang.String configFile)

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

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

### getConfigured

    boolean getConfigured()

  Return the "correctly configured" flag for this Context.

### setConfigured

    void setConfigured(boolean configured)

  Set the "correctly configured" flag for this Context. This can be set to false by startup listeners that detect a fatal configuration error to avoid the application from being made available.

  Parameters:
    `configured` - The new correctly configured flag

### getCookies

    boolean getCookies()

  Return the "use cookies for session ids" flag.

### setCookies

    void setCookies(boolean cookies)

  Set the "use cookies for session ids" flag.

  Parameters:
    `cookies` - The new flag

### getSessionCookieName

    java.lang.String getSessionCookieName()

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

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

### setSessionCookieName

    void setSessionCookieName(java.lang.String sessionCookieName)

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

  Parameters:
    `sessionCookieName` - The name to use

### getUseHttpOnly

    boolean getUseHttpOnly()

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

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

### setUseHttpOnly

    void setUseHttpOnly(boolean useHttpOnly)

  Sets the use HttpOnly cookies for session cookies flag.

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

### getSessionCookieDomain

    java.lang.String getSessionCookieDomain()

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

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

### setSessionCookieDomain

    void setSessionCookieDomain(java.lang.String sessionCookieDomain)

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

  Parameters:
    `sessionCookieDomain` - The domain to use

### getSessionCookiePath

    java.lang.String getSessionCookiePath()

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

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

### setSessionCookiePath

    void setSessionCookiePath(java.lang.String sessionCookiePath)

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

  Parameters:
    `sessionCookiePath` - The path to use

### getCrossContext

    boolean getCrossContext()

  Return the "allow crossing servlet contexts" flag.

### getAltDDName

    java.lang.String getAltDDName()

  Return the alternate Deployment Descriptor name.

### setAltDDName

    void setAltDDName(java.lang.String altDDName)

  Set an alternate Deployment Descriptor name.

### setCrossContext

    void setCrossContext(boolean crossContext)

  Set the "allow crossing servlet contexts" flag.

  Parameters:
    `crossContext` - The new cross contexts flag

### getDisplayName

    java.lang.String getDisplayName()

  Return the display name of this web application.

### setDisplayName

    void setDisplayName(java.lang.String displayName)

  Set the display name of this web application.

  Parameters:
    `displayName` - The new display name

### getDistributable

    boolean getDistributable()

  Return the distributable flag for this web application.

### setDistributable

    void setDistributable(boolean distributable)

  Set the distributable flag for this web application.

  Parameters:
    `distributable` - The new distributable flag

### getDocBase

    java.lang.String getDocBase()

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

### setDocBase

    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.

  Parameters:
    `docBase` - The new document root

### isDisableURLRewriting

    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.

  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

    void setDisableURLRewriting(boolean disable)

  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.

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

### getEncodedPath

    java.lang.String getEncodedPath()

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

### getIgnoreAnnotations

    boolean getIgnoreAnnotations()

  Return the boolean on the annotations parsing.

### setIgnoreAnnotations

    void setIgnoreAnnotations(boolean ignoreAnnotations)

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

  Parameters:
    `ignoreAnnotations` - The boolean on the annotations parsing

### getLoginConfig

    LoginConfig getLoginConfig()

  Return the login configuration descriptor for this web application.

### setLoginConfig

    void setLoginConfig(LoginConfig config)

  Set the login configuration descriptor for this web application.

  Parameters:
    `config` - The new login configuration

### getMapper

    Mapper getMapper()

  Get the request dispatcher mapper.

### getNamingResources

    NamingResources getNamingResources()

  Return the naming resources associated with this web application.

### setNamingResources

    void setNamingResources(NamingResources namingResources)

  Set the naming resources for this web application.

  Parameters:
    `namingResources` - The new naming resources

### getPath

    java.lang.String getPath()

  Return the context path for this web application.

### setPath

    void setPath(java.lang.String path)

  Set the context path for this web application.

  Parameters:
    `path` - The new context path

### getPublicId

    java.lang.String getPublicId()

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

### setPublicId

    void setPublicId(java.lang.String publicId)

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

  Parameters:
    `publicId` - The public identifier

### getReloadable

    boolean getReloadable()

  Return the reloadable flag for this web application.

### setReloadable

    void setReloadable(boolean reloadable)

  Set the reloadable flag for this web application.

  Parameters:
    `reloadable` - The new reloadable flag

### getOverride

    boolean getOverride()

  Return the override flag for this web application.

### setOverride

    void setOverride(boolean override)

  Set the override flag for this web application.

  Parameters:
    `override` - The new override flag

### getPrivileged

    boolean getPrivileged()

  Return the privileged flag for this web application.

### setPrivileged

    void setPrivileged(boolean privileged)

  Set the privileged flag for this web application.

  Parameters:
    `privileged` - The new privileged flag

### getServletContext

    javax.servlet.ServletContext getServletContext()

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

### getSessionTimeout

    int getSessionTimeout()

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

### setSessionTimeout

    void setSessionTimeout(int timeout)

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

  Parameters:
    `timeout` - The new default session timeout

### getSwallowOutput

    boolean getSwallowOutput()

  Return the value of the swallowOutput flag.

### setSwallowOutput

    void setSwallowOutput(boolean swallowOutput)

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

  Parameters:
    `swallowOutput` - The new value

### getWrapperClass

    java.lang.String getWrapperClass()

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

### setWrapperClass

    void setWrapperClass(java.lang.String wrapperClass)

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

  Parameters:
    `wrapperClass` - The new wrapper class

### getXmlNamespaceAware

    boolean getXmlNamespaceAware()

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

  Returns:
    true if namespace awareness is enabled.

### setXmlNamespaceAware

    void setXmlNamespaceAware(boolean xmlNamespaceAware)

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

  Parameters:
    `xmlNamespaceAware` - true to enable namespace awareness

### getXmlValidation

    boolean getXmlValidation()

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

  Returns:
    true if validation is enabled.

### setXmlValidation

    void setXmlValidation(boolean xmlValidation)

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

  Parameters:
    `xmlValidation` - true to enable xml validation

### getTldNamespaceAware

    @Deprecated
    boolean getTldNamespaceAware()

  Deprecated. This option will be removed in 8.0.x.

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

  Returns:
    Always `true`

### setTldNamespaceAware

    @Deprecated
    void setTldNamespaceAware(boolean tldNamespaceAware)

  Deprecated. This option will be removed in 8.0.x.

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

  Parameters:
    `tldNamespaceAware` - ignored

### getXmlBlockExternal

    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?

  Returns:
    true if access to external entities is blocked

### setXmlBlockExternal

    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.

  Parameters:
    `xmlBlockExternal` - true to block external entities

### getTldValidation

    boolean getTldValidation()

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

  Returns:
    true if validation is enabled.

### setTldValidation

    void setTldValidation(boolean tldValidation)

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

  Parameters:
    `tldValidation` - true to enable xml validation

### addApplicationListener

    void addApplicationListener(java.lang.String listener)

  Add a new Listener class name to the set of Listeners configured for this application.

  Parameters:
    `listener` - Java class name of a listener class

### addApplicationParameter

    void addApplicationParameter(ApplicationParameter parameter)

  Add a new application parameter for this application.

  Parameters:
    `parameter` - The new application parameter

### addConstraint

    void addConstraint(SecurityConstraint constraint)

  Add a security constraint to the set for this web application.

### addErrorPage

    void addErrorPage(ErrorPage errorPage)

  Add an error page for the specified error or Java exception.

  Parameters:
    `errorPage` - The error page definition to be added

### addFilterDef

    void addFilterDef(FilterDef filterDef)

  Add a filter definition to this Context.

  Parameters:
    `filterDef` - The filter definition to be added

### addFilterMap

    void addFilterMap(FilterMap filterMap)

  Add a filter mapping to this Context.

  Parameters:
    `filterMap` - The filter mapping to be added

### addInstanceListener

    void addInstanceListener(java.lang.String listener)

  Add the classname of an InstanceListener to be added to each Wrapper appended to this Context.

  Parameters:
    `listener` - Java class name of an InstanceListener class

### addJspMapping

    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.

  Parameters:
    `pattern` - URL pattern to be mapped

### addLocaleEncodingMappingParameter

    void addLocaleEncodingMappingParameter(java.lang.String locale,
                                           java.lang.String encoding)

  Add a Locale Encoding Mapping (see Sec 5.4 of Servlet spec 2.4)

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

### addMimeMapping

    void addMimeMapping(java.lang.String extension,
                        java.lang.String mimeType)

  Add a new MIME mapping, replacing any existing mapping for the specified extension.

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

### addParameter

    void addParameter(java.lang.String name,
                      java.lang.String value)

  Add a new context initialization parameter, replacing any existing value for the specified name.

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

### addRoleMapping

    void addRoleMapping(java.lang.String role,
                        java.lang.String link)

  Add a security role reference for this web application.

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

### addSecurityRole

    void addSecurityRole(java.lang.String role)

  Add a new security role for this web application.

  Parameters:
    `role` - New security role

### addServletMapping

    void addServletMapping(java.lang.String pattern,
                           java.lang.String name)

  Add a new servlet mapping, replacing any existing mapping for the specified pattern.

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

### addTaglib

    void addTaglib(java.lang.String uri,
                   java.lang.String location)

  Add a JSP tag library for the specified URI.

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

### addWatchedResource

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

  Parameters:
    `name` - Path to the resource, relative to docBase

### addWelcomeFile

    void addWelcomeFile(java.lang.String name)

  Add a new welcome file to the set recognized by this Context.

  Parameters:
    `name` - New welcome file name

### addWrapperLifecycle

    void addWrapperLifecycle(java.lang.String listener)

  Add the classname of a LifecycleListener to be added to each Wrapper appended to this Context.

  Parameters:
    `listener` - Java class name of a LifecycleListener class

### addWrapperListener

    void addWrapperListener(java.lang.String listener)

  Add the classname of a ContainerListener to be added to each Wrapper appended to this Context.

  Parameters:
    `listener` - Java class name of a ContainerListener class

### createWrapper

    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.

### findApplicationListeners

    java.lang.String[] findApplicationListeners()

  Return the set of application listener class names configured for this application.

### findApplicationParameters

    ApplicationParameter[] findApplicationParameters()

  Return the set of application parameters for this application.

### findConstraints

    SecurityConstraint[] findConstraints()

  Return the set of security constraints for this web application. If there are none, a zero-length array is returned.

### findErrorPage

    ErrorPage findErrorPage(int errorCode)

  Return the error page entry for the specified HTTP error code, if any; otherwise return `null`.

  Parameters:
    `errorCode` - Error code to look up

### findErrorPage

    ErrorPage findErrorPage(java.lang.String exceptionType)

  Return the error page entry for the specified Java exception type, if any; otherwise return `null`.

  Parameters:
    `exceptionType` - Exception type to look up

### findErrorPages

    ErrorPage[] findErrorPages()

  Return the set of defined error pages for all specified error codes and exception types.

### findFilterDef

    FilterDef findFilterDef(java.lang.String filterName)

  Return the filter definition for the specified filter name, if any; otherwise return `null`.

  Parameters:
    `filterName` - Filter name to look up

### findFilterDefs

    FilterDef[] findFilterDefs()

  Return the set of defined filters for this Context.

### findFilterMaps

    FilterMap[] findFilterMaps()

  Return the set of filter mappings for this Context.

### findInstanceListeners

    java.lang.String[] findInstanceListeners()

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

### findMimeMapping

    java.lang.String findMimeMapping(java.lang.String extension)

  Return the MIME type to which the specified extension is mapped, if any; otherwise return `null`.

  Parameters:
    `extension` - Extension to map to a MIME type

### findMimeMappings

    java.lang.String[] findMimeMappings()

  Return the extensions for which MIME mappings are defined. If there are none, a zero-length array is returned.

### findParameter

    java.lang.String findParameter(java.lang.String name)

  Return the value for the specified context initialization parameter name, if any; otherwise return `null`.

  Parameters:
    `name` - Name of the parameter to return

### findParameters

    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.

### findRoleMapping

    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.

  Parameters:
    `role` - Security role to map

### findSecurityRole

    boolean findSecurityRole(java.lang.String role)

  Return `true` if the specified security role is defined for this application; otherwise return `false`.

  Parameters:
    `role` - Security role to verify

### findSecurityRoles

    java.lang.String[] findSecurityRoles()

  Return the security roles defined for this application. If none have been defined, a zero-length array is returned.

### findServletMapping

    java.lang.String findServletMapping(java.lang.String pattern)

  Return the servlet name mapped by the specified pattern (if any); otherwise return `null`.

  Parameters:
    `pattern` - Pattern for which a mapping is requested

### findServletMappings

    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.

### findStatusPage

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

  Parameters:
    `status` - HTTP status code to look up

### findStatusPages

    int[] findStatusPages()

  Return the set of HTTP status codes for which error pages have been specified. If none are specified, a zero-length array is returned.

### findTaglib

    java.lang.String findTaglib(java.lang.String uri)

  Return the tag library descriptor location for the specified taglib URI, if any; otherwise, return `null`.

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

### findTaglibs

    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.

### findWatchedResources

    java.lang.String[] findWatchedResources()

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

### findWelcomeFile

    boolean findWelcomeFile(java.lang.String name)

  Return `true` if the specified welcome file is defined for this Context; otherwise return `false`.

  Parameters:
    `name` - Welcome file to verify

### findWelcomeFiles

    java.lang.String[] findWelcomeFiles()

  Return the set of welcome files defined for this Context. If none are defined, a zero-length array is returned.

### findWrapperLifecycles

    java.lang.String[] findWrapperLifecycles()

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

### findWrapperListeners

    java.lang.String[] findWrapperListeners()

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

### reload

    void reload()

  Reload this web application, if reloading is supported.

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

### removeApplicationListener

    void removeApplicationListener(java.lang.String listener)

  Remove the specified application listener class from the set of listeners for this application.

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

### removeApplicationParameter

    void removeApplicationParameter(java.lang.String name)

  Remove the application parameter with the specified name from the set for this application.

  Parameters:
    `name` - Name of the application parameter to remove

### removeConstraint

    void removeConstraint(SecurityConstraint constraint)

  Remove the specified security constraint from this web application.

  Parameters:
    `constraint` - Constraint to be removed

### removeErrorPage

    void removeErrorPage(ErrorPage errorPage)

  Remove the error page for the specified error code or Java language exception, if it exists; otherwise, no action is taken.

  Parameters:
    `errorPage` - The error page definition to be removed

### removeFilterDef

    void removeFilterDef(FilterDef filterDef)

  Remove the specified filter definition from this Context, if it exists; otherwise, no action is taken.

  Parameters:
    `filterDef` - Filter definition to be removed

### removeFilterMap

    void removeFilterMap(FilterMap filterMap)

  Remove a filter mapping from this Context.

  Parameters:
    `filterMap` - The filter mapping to be removed

### removeInstanceListener

    void removeInstanceListener(java.lang.String listener)

  Remove a class name from the set of InstanceListener classes that will be added to newly created Wrappers.

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

### removeMimeMapping

    void removeMimeMapping(java.lang.String extension)

  Remove the MIME mapping for the specified extension, if it exists; otherwise, no action is taken.

  Parameters:
    `extension` - Extension to remove the mapping for

### removeParameter

    void removeParameter(java.lang.String name)

  Remove the context initialization parameter with the specified name, if it exists; otherwise, no action is taken.

  Parameters:
    `name` - Name of the parameter to remove

### removeRoleMapping

    void removeRoleMapping(java.lang.String role)

  Remove any security role reference for the specified name

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

### removeSecurityRole

    void removeSecurityRole(java.lang.String role)

  Remove any security role with the specified name.

  Parameters:
    `role` - Security role to remove

### removeServletMapping

    void removeServletMapping(java.lang.String pattern)

  Remove any servlet mapping for the specified pattern, if it exists; otherwise, no action is taken.

  Parameters:
    `pattern` - URL pattern of the mapping to remove

### removeTaglib

    void removeTaglib(java.lang.String uri)

  Remove the tag library location forthe specified tag library URI.

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

### removeWatchedResource

    void removeWatchedResource(java.lang.String name)

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

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

### removeWelcomeFile

    void removeWelcomeFile(java.lang.String name)

  Remove the specified welcome file name from the list recognized by this Context.

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

### removeWrapperLifecycle

    void removeWrapperLifecycle(java.lang.String listener)

  Remove a class name from the set of LifecycleListener classes that will be added to newly created Wrappers.

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

### removeWrapperListener

    void removeWrapperListener(java.lang.String listener)

  Remove a class name from the set of ContainerListener classes that will be added to newly created Wrappers.

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

### setMapperContextRootRedirectEnabled

    void setMapperContextRootRedirectEnabled(boolean mapperContextRootRedirectEnabled)

  If enabled, requests for a web application context root will be redirected (adding a trailing slash) by the Mapper. This is more efficient but has the side effect of confirming that the context path is valid.

  Parameters:
    `mapperContextRootRedirectEnabled` - Should the redirects be enabled?

### getMapperContextRootRedirectEnabled

    boolean getMapperContextRootRedirectEnabled()

  Determines if requests for a web application context root will be redirected (adding a trailing slash) by the Mapper. This is more efficient but has the side effect of confirming that the context path is valid.

  Returns:
    `true` if the Mapper level redirect is enabled for this Context.

### setMapperDirectoryRedirectEnabled

    void setMapperDirectoryRedirectEnabled(boolean mapperDirectoryRedirectEnabled)

  If enabled, requests for a directory will be redirected (adding a trailing slash) by the Mapper. This is more efficient but has the side effect of confirming that the directory is valid.

  Parameters:
    `mapperDirectoryRedirectEnabled` - Should the redirects be enabled?

### getMapperDirectoryRedirectEnabled

    boolean getMapperDirectoryRedirectEnabled()

  Determines if requests for a directory will be redirected (adding a trailing slash) by the Mapper. This is more efficient but has the side effect of confirming that the directory is valid.

  Returns:
    `true` if the Mapper level redirect is enabled for this Context.

### setDispatchersUseEncodedPaths

    void setDispatchersUseEncodedPaths(boolean dispatchersUseEncodedPaths)

  Are paths used in calls to obtain a request dispatcher expected to be encoded? This affects both how Tomcat handles calls to obtain a request dispatcher as well as how Tomcat generates paths used to obtain request dispatchers internally.

  Parameters:
    `dispatchersUseEncodedPaths` - `true` to use encoded paths, otherwise `false`

### getDispatchersUseEncodedPaths

    boolean getDispatchersUseEncodedPaths()

  Are paths used in calls to obtain a request dispatcher expected to be encoded? This applys to both how Tomcat handles calls to obtain a request dispatcher as well as how Tomcat generates paths used to obtain request dispatchers internally.

  Returns:
    `true` if encoded paths will be used, otherwise `false`

Overview | Package | Class | Tree | Deprecated | Index | Help
| Apache Tomcat 6.0.53
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Copyright © 2000-2017 Apache Software Foundation. All Rights Reserved.