|
Context (Catalina Internal API Documentation)
org.apache.catalina
|
Field Summary |
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 |
addEjb(ContextEjb ejb)
Add an EJB resource reference for this web application. |
void |
addEnvironment(ContextEnvironment environment)
Add an environment entry 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 |
addLocalEjb(ContextLocalEjb ejb)
Add a local EJB resource reference for this web application. |
void |
addMimeMapping(java.lang.String extension,
java.lang.String mimeType)
Add a new MIME mapping, replacing any existing mapping for the specified extension. |
void |
addParameter(java.lang.String name,
java.lang.String value)
Add a new context initialization parameter, replacing any existing value for the specified name. |
void |
addResource(ContextResource resource)
Add a resource reference for this web application. |
void |
addResourceEnvRef(java.lang.String name,
java.lang.String type)
Add a resource environment reference for this web application. |
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 |
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. |
ContextEjb |
findEjb(java.lang.String name)
Return the EJB resource reference with the specified name, if any; otherwise, return null . |
ContextEjb[] |
findEjbs()
Return the defined EJB resource references for this application. |
ContextEnvironment |
findEnvironment(java.lang.String name)
Return the environment entry with the specified name, if any; otherwise, return null . |
ContextEnvironment[] |
findEnvironments()
Return the set of defined environment entries 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. |
ContextLocalEjb |
findLocalEjb(java.lang.String name)
Return the local EJB resource reference with the specified name, if any; otherwise, return null . |
ContextLocalEjb[] |
findLocalEjbs()
Return the defined local EJB resource references for this application. |
java.lang.String |
findMimeMapping(java.lang.String extension)
Return the MIME type to which the specified extension is mapped, if any; otherwise return null . |
java.lang.String[] |
findMimeMappings()
Return the extensions for which MIME mappings are defined. |
java.lang.String |
findParameter(java.lang.String name)
Return the value for the specified context initialization parameter name, if any; otherwise return null . |
java.lang.String[] |
findParameters()
Return the names of all defined context initialization parameters for this Context. |
ContextResource |
findResource(java.lang.String name)
Return the resource reference with the specified name, if any; otherwise return null . |
java.lang.String |
findResourceEnvRef(java.lang.String name)
Return the resource environment reference type for the specified name, if any; otherwise return null . |
java.lang.String[] |
findResourceEnvRefs()
Return the set of resource environment reference names for this web application. |
ContextResource[] |
findResources()
Return the defined resource references for this application. |
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. |
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.Object[] |
getApplicationListeners()
Return the set of initialized application 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. |
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. |
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. |
LoginConfig |
getLoginConfig()
Return the login configuration descriptor for 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. |
int |
getSessionTimeout()
Return the default session timeout (in minutes) for this web application. |
java.lang.String |
getWrapperClass()
Return the Java class name of the Wrapper implementation used for servlets registered in this Context. |
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 |
removeEjb(java.lang.String name)
Remove any EJB resource reference with the specified name. |
void |
removeEnvironment(java.lang.String name)
Remove any environment entry with the specified name. |
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 |
removeLocalEjb(java.lang.String name)
Remove any local EJB resource reference with the specified name. |
void |
removeMimeMapping(java.lang.String extension)
Remove the MIME mapping for the specified extension, if it exists; otherwise, no action is taken. |
void |
removeParameter(java.lang.String name)
Remove the context initialization parameter with the specified name, if it exists; otherwise, no action is taken. |
void |
removeResource(java.lang.String name)
Remove any resource reference with the specified name. |
void |
removeResourceEnvRef(java.lang.String name)
Remove any resource environment reference with the specified name. |
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 |
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 |
setApplicationListeners(java.lang.Object[] listeners)
Store the set of initialized application 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 |
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(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 |
setLoginConfig(LoginConfig config)
Set the login configuration descriptor 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 |
setSessionTimeout(int timeout)
Set the default session timeout (in minutes) for this web application. |
void |
setWrapperClass(java.lang.String wrapperClass)
Set the Java class name of the Wrapper implementation used for servlets registered in this Context. |
Methods inherited from interface org.apache.catalina.Container |
addChild, addContainerListener, addMapper, addPropertyChangeListener, findChild, findChildren, findMapper, findMappers, getCluster, getInfo, getLoader, getLogger, getManager, getName, getParent, getParentClassLoader, getRealm, getResources, invoke, map, removeChild, removeContainerListener, removeMapper, removePropertyChangeListener, setCluster, setLoader, setLogger, setManager, setName, setParent, setParentClassLoader, setRealm, setResources |
Method Detail |
public java.lang.Object[] getApplicationListeners()
java.lang.IllegalStateException
- if this method is called before
this application has started, or after it has been stoppedpublic void setApplicationListeners(java.lang.Object[] listeners)
listeners
- The set of instantiated listener objects.public boolean getAvailable()
public void setAvailable(boolean available)
available
- The new application available flagpublic CharsetMapper getCharsetMapper()
public void setCharsetMapper(CharsetMapper mapper)
mapper
- The new mapperpublic boolean getConfigured()
public void setConfigured(boolean configured)
configured
- The new correctly configured flagpublic boolean getCookies()
public void setCookies(boolean cookies)
cookies
- The new flagpublic boolean getCrossContext()
public void setCrossContext(boolean crossContext)
crossContext
- The new cross contexts flagpublic java.lang.String getDisplayName()
public void setDisplayName(java.lang.String displayName)
displayName
- The new display namepublic boolean getDistributable()
public void setDistributable(boolean distributable)
distributable
- The new distributable flagpublic java.lang.String getDocBase()
public void setDocBase(java.lang.String docBase)
docBase
- The new document rootpublic LoginConfig getLoginConfig()
public void setLoginConfig(LoginConfig config)
config
- The new login configurationpublic java.lang.String getPath()
public void setPath(java.lang.String path)
path
- The new context pathpublic java.lang.String getPublicId()
public void setPublicId(java.lang.String publicId)
publicId
- The public identifierpublic boolean getReloadable()
public void setReloadable(boolean reloadable)
reloadable
- The new reloadable flagpublic boolean getOverride()
public void setOverride(boolean override)
override
- The new override flagpublic boolean getPrivileged()
public void setPrivileged(boolean privileged)
privileged
- The new privileged flagpublic javax.servlet.ServletContext getServletContext()
public int getSessionTimeout()
public void setSessionTimeout(int timeout)
timeout
- The new default session timeoutpublic java.lang.String getWrapperClass()
public void setWrapperClass(java.lang.String wrapperClass)
wrapperClass
- The new wrapper classpublic void addApplicationListener(java.lang.String listener)
listener
- Java class name of a listener classpublic void addApplicationParameter(ApplicationParameter parameter)
parameter
- The new application parameterpublic void addConstraint(SecurityConstraint constraint)
public void addEjb(ContextEjb ejb)
ejb
- New EJB resource referencepublic void addEnvironment(ContextEnvironment environment)
environment
- New environment entrypublic void addErrorPage(ErrorPage errorPage)
errorPage
- The error page definition to be addedpublic void addFilterDef(FilterDef filterDef)
filterDef
- The filter definition to be addedpublic void addFilterMap(FilterMap filterMap)
filterMap
- The filter mapping to be addedpublic void addInstanceListener(java.lang.String listener)
listener
- Java class name of an InstanceListener classpublic void addLocalEjb(ContextLocalEjb ejb)
ejb
- New local EJB resource referencepublic void addMimeMapping(java.lang.String extension, java.lang.String mimeType)
extension
- Filename extension being mappedmimeType
- Corresponding MIME typepublic void addParameter(java.lang.String name, java.lang.String value)
name
- Name of the new parametervalue
- Value of the new parameterpublic void addResource(ContextResource resource)
resource
- New resource referencepublic void addResourceEnvRef(java.lang.String name, java.lang.String type)
name
- The resource environment reference nametype
- The resource environment reference typepublic void addRoleMapping(java.lang.String role, java.lang.String link)
role
- Security role used in the applicationlink
- Actual security role to check forpublic void addSecurityRole(java.lang.String role)
role
- New security rolepublic void addServletMapping(java.lang.String pattern, java.lang.String name)
pattern
- URL pattern to be mappedname
- Name of the corresponding servlet to executepublic void addTaglib(java.lang.String uri, java.lang.String location)
public void addWelcomeFile(java.lang.String name)
name
- New welcome file namepublic void addWrapperLifecycle(java.lang.String listener)
listener
- Java class name of a LifecycleListener classpublic void addWrapperListener(java.lang.String listener)
listener
- Java class name of a ContainerListener classpublic Wrapper createWrapper()
public java.lang.String[] findApplicationListeners()
public ApplicationParameter[] findApplicationParameters()
public SecurityConstraint[] findConstraints()
public ContextEjb findEjb(java.lang.String name)
null
.
name
- Name of the desired EJB resource referencepublic ContextEjb[] findEjbs()
public ContextEnvironment findEnvironment(java.lang.String name)
null
.
name
- Name of the desired environment entrypublic ContextEnvironment[] findEnvironments()
public ErrorPage findErrorPage(int errorCode)
null
.
errorCode
- Error code to look uppublic ErrorPage findErrorPage(java.lang.String exceptionType)
null
.
exceptionType
- Exception type to look uppublic ErrorPage[] findErrorPages()
public FilterDef findFilterDef(java.lang.String filterName)
null
.
filterName
- Filter name to look uppublic FilterDef[] findFilterDefs()
public FilterMap[] findFilterMaps()
public java.lang.String[] findInstanceListeners()
public ContextLocalEjb findLocalEjb(java.lang.String name)
null
.
name
- Name of the desired EJB resource referencepublic ContextLocalEjb[] findLocalEjbs()
public java.lang.String findMimeMapping(java.lang.String extension)
null
.
extension
- Extension to map to a MIME typepublic java.lang.String[] findMimeMappings()
public java.lang.String findParameter(java.lang.String name)
null
.
name
- Name of the parameter to returnpublic java.lang.String[] findParameters()
public ContextResource findResource(java.lang.String name)
null
.
name
- Name of the desired resource referencepublic java.lang.String findResourceEnvRef(java.lang.String name)
null
.
name
- Name of the desired resource environment referencepublic java.lang.String[] findResourceEnvRefs()
public ContextResource[] findResources()
public java.lang.String findRoleMapping(java.lang.String role)
role
- Security role to mappublic boolean findSecurityRole(java.lang.String role)
true
if the specified security role is defined
for this application; otherwise return false
.
role
- Security role to verifypublic java.lang.String[] findSecurityRoles()
public java.lang.String findServletMapping(java.lang.String pattern)
null
.
pattern
- Pattern for which a mapping is requestedpublic java.lang.String[] findServletMappings()
public java.lang.String findStatusPage(int status)
null
.
status
- HTTP status code to look uppublic int[] findStatusPages()
public java.lang.String findTaglib(java.lang.String uri)
null
.
public java.lang.String[] findTaglibs()
public boolean findWelcomeFile(java.lang.String name)
true
if the specified welcome file is defined
for this Context; otherwise return false
.
name
- Welcome file to verifypublic java.lang.String[] findWelcomeFiles()
public java.lang.String[] findWrapperLifecycles()
public java.lang.String[] findWrapperListeners()
public void reload()
java.lang.IllegalStateException
- if the reloadable
property is set to false
.public void removeApplicationListener(java.lang.String listener)
listener
- Java class name of the listener to be removedpublic void removeApplicationParameter(java.lang.String name)
name
- Name of the application parameter to removepublic void removeConstraint(SecurityConstraint constraint)
constraint
- Constraint to be removedpublic void removeEjb(java.lang.String name)
name
- Name of the EJB resource reference to removepublic void removeEnvironment(java.lang.String name)
name
- Name of the environment entry to removepublic void removeErrorPage(ErrorPage errorPage)
errorPage
- The error page definition to be removedpublic void removeFilterDef(FilterDef filterDef)
filterDef
- Filter definition to be removedpublic void removeFilterMap(FilterMap filterMap)
filterMap
- The filter mapping to be removedpublic void removeInstanceListener(java.lang.String listener)
listener
- Class name of an InstanceListener class to be removedpublic void removeLocalEjb(java.lang.String name)
name
- Name of the EJB resource reference to removepublic void removeMimeMapping(java.lang.String extension)
extension
- Extension to remove the mapping forpublic void removeParameter(java.lang.String name)
name
- Name of the parameter to removepublic void removeResource(java.lang.String name)
name
- Name of the resource reference to removepublic void removeResourceEnvRef(java.lang.String name)
name
- Name of the resource environment reference to removepublic void removeRoleMapping(java.lang.String role)
role
- Security role (as used in the application) to removepublic void removeSecurityRole(java.lang.String role)
role
- Security role to removepublic void removeServletMapping(java.lang.String pattern)
pattern
- URL pattern of the mapping to removepublic void removeTaglib(java.lang.String uri)
public void removeWelcomeFile(java.lang.String name)
name
- Name of the welcome file to be removedpublic void removeWrapperLifecycle(java.lang.String listener)
listener
- Class name of a LifecycleListener class to be removedpublic void removeWrapperListener(java.lang.String listener)
listener
- Class name of a ContainerListener class to be removed
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |