org.apache.catalina
public interface Context extends Container
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).
Version: $Revision: 784615 $ $Date: 2009-06-14 22:39:30 +0200 (Sun, 14 Jun 2009) $
Field Summary | |
---|---|
static String | RELOAD_EVENT
The LifecycleEvent type sent when a context is reloaded. |
Method Summary | |
---|---|
void | addApplicationListener(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(String listener)
Add the classname of an InstanceListener to be added to each
Wrapper appended to this Context.
|
void | addJspMapping(String pattern)
Add the given URL pattern as a jsp-property-group. |
void | addLocaleEncodingMappingParameter(String locale, String encoding)
Add a Locale Encoding Mapping (see Sec 5.4 of Servlet spec 2.4)
|
void | addMimeMapping(String extension, String mimeType)
Add a new MIME mapping, replacing any existing mapping for
the specified extension.
|
void | addParameter(String name, String value)
Add a new context initialization parameter, replacing any existing
value for the specified name.
|
void | addRoleMapping(String role, String link)
Add a security role reference for this web application.
|
void | addSecurityRole(String role)
Add a new security role for this web application.
|
void | addServletMapping(String pattern, String name)
Add a new servlet mapping, replacing any existing mapping for
the specified pattern.
|
void | addTaglib(String uri, String location)
Add a JSP tag library for the specified URI.
|
void | addWatchedResource(String name)
Add a resource which will be watched for reloading by the host auto
deployer. |
void | addWelcomeFile(String name)
Add a new welcome file to the set recognized by this Context.
|
void | addWrapperLifecycle(String listener)
Add the classname of a LifecycleListener to be added to each
Wrapper appended to this Context.
|
void | addWrapperListener(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. |
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(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(String filterName)
Return the filter definition for the specified filter name, if any;
otherwise return null .
|
FilterDef[] | findFilterDefs()
Return the set of defined filters for this Context. |
FilterMap[] | findFilterMaps()
Return the set of filter mappings for this Context. |
String[] | findInstanceListeners()
Return the set of InstanceListener classes that will be added to
newly created Wrappers automatically. |
String | findMimeMapping(String extension)
Return the MIME type to which the specified extension is mapped,
if any; otherwise return null .
|
String[] | findMimeMappings()
Return the extensions for which MIME mappings are defined. |
String | findParameter(String name)
Return the value for the specified context initialization
parameter name, if any; otherwise return null .
|
String[] | findParameters()
Return the names of all defined context initialization parameters
for this Context. |
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. |
boolean | findSecurityRole(String role)
Return true if the specified security role is defined
for this application; otherwise return false .
|
String[] | findSecurityRoles()
Return the security roles defined for this application. |
String | findServletMapping(String pattern)
Return the servlet name mapped by the specified pattern (if any);
otherwise return null .
|
String[] | findServletMappings()
Return the patterns of all defined servlet mappings for this
Context. |
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. |
String | findTaglib(String uri)
Return the tag library descriptor location for the specified taglib
URI, if any; otherwise, return null .
|
String[] | findTaglibs()
Return the URIs of all tag libraries for which a tag library
descriptor location has been specified. |
String[] | findWatchedResources()
Return the set of watched resources for this Context. |
boolean | findWelcomeFile(String name)
Return true if the specified welcome file is defined
for this Context; otherwise return false .
|
String[] | findWelcomeFiles()
Return the set of welcome files defined for this Context. |
String[] | findWrapperLifecycles()
Return the set of LifecycleListener classes that will be added to
newly created Wrappers automatically. |
String[] | findWrapperListeners()
Return the set of ContainerListener classes that will be added to
newly created Wrappers automatically. |
String | getAltDDName()
Return the alternate Deployment Descriptor name. |
Object[] | getApplicationEventListeners()
Return the set of initialized application event listener objects,
in the order they were specified in the web application deployment
descriptor, for this application.
|
Object[] | getApplicationLifecycleListeners()
Return the set of initialized application lifecycle listener objects,
in the order they were specified in the web application deployment
descriptor, for this application.
|
boolean | getAvailable()
Return the application available flag for this Context. |
CharsetMapper | getCharsetMapper()
Return the Locale to character set mapper for this Context. |
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. |
String | getDisplayName()
Return the display name of this web application. |
boolean | getDistributable()
Return the distributable flag for this web application. |
String | getDocBase()
Return the document root for this Context. |
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. |
NamingResources | getNamingResources()
Return the naming resources associated with this web application. |
boolean | getOverride()
Return the override flag for this web application. |
String | getPath()
Return the context path for this web application. |
boolean | getPrivileged()
Return the privileged flag for this web application. |
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. |
ServletContext | getServletContext()
Return the servlet context for which this Context is a facade. |
int | getSessionTimeout()
Return the default session timeout (in minutes) for this
web application. |
boolean | getSwallowOutput()
Return the value of the swallowOutput flag. |
boolean | getTldNamespaceAware()
Get the server.xml <host> attribute's xmlNamespaceAware. |
boolean | getTldValidation()
Get the server.xml |
boolean | getUseHttpOnly()
Gets the value of the use HttpOnly cookies for session cookies flag.
|
String | getWrapperClass()
Return the Java class name of the Wrapper implementation used
for servlets registered in this Context. |
boolean | getXmlNamespaceAware()
Get the server.xml |
boolean | getXmlValidation()
Get the server.xml |
void | reload()
Reload this web application, if reloading is supported.
|
void | removeApplicationListener(String listener)
Remove the specified application listener class from the set of
listeners for this application.
|
void | removeApplicationParameter(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(String listener)
Remove a class name from the set of InstanceListener classes that
will be added to newly created Wrappers.
|
void | removeMimeMapping(String extension)
Remove the MIME mapping for the specified extension, if it exists;
otherwise, no action is taken.
|
void | removeParameter(String name)
Remove the context initialization parameter with the specified
name, if it exists; otherwise, no action is taken.
|
void | removeRoleMapping(String role)
Remove any security role reference for the specified name
|
void | removeSecurityRole(String role)
Remove any security role with the specified name.
|
void | removeServletMapping(String pattern)
Remove any servlet mapping for the specified pattern, if it exists;
otherwise, no action is taken.
|
void | removeTaglib(String uri)
Remove the tag library location forthe specified tag library URI.
|
void | removeWatchedResource(String name)
Remove the specified watched resource name from the list associated
with this Context.
|
void | removeWelcomeFile(String name)
Remove the specified welcome file name from the list recognized
by this Context.
|
void | removeWrapperLifecycle(String listener)
Remove a class name from the set of LifecycleListener classes that
will be added to newly created Wrappers.
|
void | removeWrapperListener(String listener)
Remove a class name from the set of ContainerListener classes that
will be added to newly created Wrappers.
|
void | setAltDDName(String altDDName)
Set an alternate Deployment Descriptor name. |
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.
|
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.
|
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(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 | setDisplayName(String displayName)
Set the display name of this web application.
|
void | setDistributable(boolean distributable)
Set the distributable flag for this web application.
|
void | setDocBase(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 | 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(String path)
Set the context path for this web application.
|
void | setPrivileged(boolean privileged)
Set the privileged flag for this web application.
|
void | setPublicId(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 | 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)
Set the namespace aware feature of the XML parser used when
parsing xml instances. |
void | setTldValidation(boolean tldValidation)
Set the validation feature of the XML parser used when
parsing tlds files. |
void | setUseHttpOnly(boolean useHttpOnly)
Sets the use HttpOnly cookies for session cookies flag.
|
void | setWrapperClass(String wrapperClass)
Set the Java class name of the Wrapper implementation used
for servlets registered in this Context.
|
void | setXmlNamespaceAware(boolean xmlNamespaceAware)
Set the namespace aware feature of the XML parser used when
parsing xml instances. |
void | setXmlValidation(boolean xmlValidation)
Set the validation feature of the XML parser used when
parsing xml instances. |
Parameters: listener Java class name of a listener class
Parameters: parameter The new application parameter
Parameters: errorPage The error page definition to be added
Parameters: filterDef The filter definition to be added
Parameters: filterMap The filter mapping to be added
Parameters: listener Java class name of an InstanceListener class
Parameters: pattern URL pattern to be mapped
Parameters: locale locale to map an encoding for encoding encoding to be used for a give locale
Parameters: extension Filename extension being mapped mimeType Corresponding MIME type
Parameters: name Name of the new parameter value Value of the new parameter
Parameters: role Security role used in the application link Actual security role to check for
Parameters: role New security role
Parameters: pattern URL pattern to be mapped name Name of the corresponding servlet to execute
Parameters: uri URI, relative to the web.xml file, of this tag library location Location of the tag library descriptor
Parameters: name Path to the resource, relative to docBase
Parameters: name New welcome file name
Parameters: listener Java class name of a LifecycleListener class
Parameters: listener Java class name of a ContainerListener class
null
.
Parameters: errorCode Error code to look up
null
.
Parameters: exceptionType Exception type to look up
null
.
Parameters: filterName Filter name to look up
null
.
Parameters: extension Extension to map to a MIME type
null
.
Parameters: name Name of the parameter to return
Parameters: role Security role to map
true
if the specified security role is defined
for this application; otherwise return false
.
Parameters: role Security role to verify
null
.
Parameters: pattern Pattern for which a mapping is requested
null
.
Parameters: status HTTP status code to look up
null
.
Parameters: uri URI, relative to the web.xml file
true
if the specified welcome file is defined
for this Context; otherwise return false
.
Parameters: name Welcome file to verify
Throws: IllegalStateException if this method is called before this application has started, or after it has been stopped
Throws: IllegalStateException if this method is called before this application has started, or after it has been stopped
Returns: true if namespace awarenes is enabled.
Returns: true if validation is enabled.
Returns: true
if the HttpOnly flag should be set on session
cookies
Returns: true if namespace awarenes is enabled.
Returns: true if validation is enabled.
Throws: IllegalStateException if the reloadable
property is set to false
.
Parameters: listener Java class name of the listener to be removed
Parameters: name Name of the application parameter to remove
Parameters: constraint Constraint to be removed
Parameters: errorPage The error page definition to be removed
Parameters: filterDef Filter definition to be removed
Parameters: filterMap The filter mapping to be removed
Parameters: listener Class name of an InstanceListener class to be removed
Parameters: extension Extension to remove the mapping for
Parameters: name Name of the parameter to remove
Parameters: role Security role (as used in the application) to remove
Parameters: role Security role to remove
Parameters: pattern URL pattern of the mapping to remove
Parameters: uri URI, relative to the web.xml file
Parameters: name Name of the watched resource to be removed
Parameters: name Name of the welcome file to be removed
Parameters: listener Class name of a LifecycleListener class to be removed
Parameters: listener Class name of a ContainerListener class to be removed
Parameters: listeners The set of instantiated listener objects.
Parameters: listeners The set of instantiated listener objects.
Parameters: available The new application available flag
Parameters: mapper The new mapper
Parameters: configFile The path to a file to save this Context information.
Parameters: configured The new correctly configured flag
Parameters: cookies The new flag
Parameters: crossContext The new cross contexts flag
Parameters: displayName The new display name
Parameters: distributable The new distributable flag
Parameters: docBase The new document root
Parameters: ignoreAnnotations The boolean on the annotations parsing
Parameters: config The new login configuration
Parameters: namingResources The new naming resources
Parameters: override The new override flag
Parameters: path The new context path
Parameters: privileged The new privileged flag
Parameters: publicId The public identifier
Parameters: reloadable The new reloadable flag
Parameters: timeout The new default session timeout
Parameters: swallowOutput The new value
Parameters: tldNamespaceAware true to enable namespace awareness
Parameters: tldValidation true to enable xml instance validation
Parameters: useHttpOnly Set to true
to use HttpOnly cookies
for session cookies
Parameters: wrapperClass The new wrapper class
Parameters: xmlNamespaceAware true to enable namespace awareness
Parameters: xmlValidation true to enable xml instance validation