| Method Summary |
|
| public void | addApplicationListener(String listener)
Add a new Listener class name to the set of Listeners
configured for this application. |
| public void | addApplicationParameter(ApplicationParameter parameter)
Add a new application parameter for this application. |
| public void | addConstraint(SecurityConstraint constraint)
Add a security constraint to the set for this web application. |
| public void | addEjb(ContextEjb ejb)
Add an EJB resource reference for this web application. |
| public void | addEnvironment(ContextEnvironment environment)
Add an environment entry for this web application. |
| public void | addErrorPage(ErrorPage errorPage)
Add an error page for the specified error or Java exception. |
| public void | addFilterDef(FilterDef filterDef)
Add a filter definition to this Context. |
| public void | addFilterMap(FilterMap filterMap)
Add a filter mapping to this Context. |
| public void | addInstanceListener(String listener)
Add the classname of an InstanceListener to be added to each
Wrapper appended to this Context. |
| public void | addJspMapping(String pattern)
Add the given URL pattern as a jsp-property-group. |
| public void | addLocalEjb(ContextLocalEjb ejb)
Add a local EJB resource reference for this web application. |
| public void | addLocaleEncodingMappingParameter(String locale, String encoding)
|
| public void | addMimeMapping(String extension, String mimeType)
Add a new MIME mapping, replacing any existing mapping for
the specified extension. |
| public void | addParameter(String name, String value)
Add a new context initialization parameter, replacing any existing
value for the specified name. |
| public void | addResource(ContextResource resource)
Add a resource reference for this web application. |
| public void | addResourceEnvRef(String name, String type)
Add a resource environment reference for this web application. |
| public void | addResourceLink(ContextResourceLink resourceLink)
Add a resource link for this web application. |
| public void | addRoleMapping(String role, String link)
Add a security role reference for this web application. |
| public void | addSecurityRole(String role)
Add a new security role for this web application. |
| public void | addServletMapping(String pattern, String name)
Add a new servlet mapping, replacing any existing mapping for
the specified pattern. |
| public void | addTaglib(String uri, String location)
Add a JSP tag library for the specified URI. |
| public void | addWelcomeFile(String name)
Add a new welcome file to the set recognized by this Context. |
| public void | addWrapperLifecycle(String listener)
Add the classname of a LifecycleListener to be added to each
Wrapper appended to this Context. |
| public void | addWrapperListener(String listener)
Add the classname of a ContainerListener to be added to each
Wrapper appended to this Context. |
| public Wrapper | createWrapper()
Factory method to create and return a new Wrapper instance, of
the Java implementation class appropriate for this Context
implementation. |
| public String[] | findApplicationListeners()
Return the set of application listener class names configured
for this application. |
| public ApplicationParameter[] | findApplicationParameters()
Return the set of application parameters for this application. |
| public SecurityConstraint[] | findConstraints()
Return the set of security constraints for this web application. |
| public ContextEjb | findEjb(String name)
Return the EJB resource reference with the specified name, if any;
otherwise, return null. |
| public ContextEjb[] | findEjbs()
Return the defined EJB resource references for this application. |
| public ContextEnvironment | findEnvironment(String name)
Return the environment entry with the specified name, if any;
otherwise, return null. |
| public ContextEnvironment[] | findEnvironments()
Return the set of defined environment entries for this web
application. |
| public ErrorPage | findErrorPage(int errorCode)
Return the error page entry for the specified HTTP error code,
if any; otherwise return null. |
| public ErrorPage | findErrorPage(String exceptionType)
Return the error page entry for the specified Java exception type,
if any; otherwise return null. |
| public ErrorPage[] | findErrorPages()
Return the set of defined error pages for all specified error codes
and exception types. |
| public FilterDef | findFilterDef(String filterName)
Return the filter definition for the specified filter name, if any;
otherwise return null. |
| public FilterDef[] | findFilterDefs()
Return the set of defined filters for this Context. |
| public FilterMap[] | findFilterMaps()
Return the set of filter mappings for this Context. |
| public String[] | findInstanceListeners()
Return the set of InstanceListener classes that will be added to
newly created Wrappers automatically. |
| public ContextLocalEjb | findLocalEjb(String name)
Return the local EJB resource reference with the specified name, if any;
otherwise, return null. |
| public ContextLocalEjb[] | findLocalEjbs()
Return the defined local EJB resource references for this application. |
| public String | findMimeMapping(String extension)
Return the MIME type to which the specified extension is mapped,
if any; otherwise return null. |
| public String[] | findMimeMappings()
Return the extensions for which MIME mappings are defined. |
| public String | findParameter(String name)
Return the value for the specified context initialization
parameter name, if any; otherwise return null. |
| public String[] | findParameters()
Return the names of all defined context initialization parameters
for this Context. |
| public ContextResource | findResource(String name)
Return the resource reference with the specified name, if any;
otherwise return null. |
| public String | findResourceEnvRef(String name)
Return the resource environment reference type for the specified
name, if any; otherwise return null. |
| public String[] | findResourceEnvRefs()
Return the set of resource environment reference names for this
web application. |
| public ContextResourceLink | findResourceLink(String name)
Return the resource link with the specified name, if any;
otherwise return null. |
| public ContextResourceLink[] | findResourceLinks()
Return the defined resource links for this application. |
| public ContextResource[] | findResources()
Return the defined resource references for this application. |
| public String | findRoleMapping(String role)
For the given security role (as used by an application), return the
corresponding role name (as defined by the underlying Realm) if there
is one. |
| public boolean | findSecurityRole(String role)
Return true if the specified security role is defined
for this application; otherwise return false. |
| public String[] | findSecurityRoles()
Return the security roles defined for this application. |
| public String | findServletMapping(String pattern)
Return the servlet name mapped by the specified pattern (if any);
otherwise return null. |
| public String[] | findServletMappings()
Return the patterns of all defined servlet mappings for this
Context. |
| public String | findStatusPage(int status)
Return the context-relative URI of the error page for the specified
HTTP status code, if any; otherwise return null. |
| public int[] | findStatusPages()
Return the set of HTTP status codes for which error pages have
been specified. |
| public String | findTaglib(String uri)
Return the tag library descriptor location for the specified taglib
URI, if any; otherwise, return null. |
| public String[] | findTaglibs()
Return the URIs of all tag libraries for which a tag library
descriptor location has been specified. |
| public boolean | findWelcomeFile(String name)
Return true if the specified welcome file is defined
for this Context; otherwise return false. |
| public String[] | findWelcomeFiles()
Return the set of welcome files defined for this Context. |
| public String[] | findWrapperLifecycles()
Return the set of LifecycleListener classes that will be added to
newly created Wrappers automatically. |
| public String[] | findWrapperListeners()
Return the set of ContainerListener classes that will be added to
newly created Wrappers automatically. |
| public String | getAltDDName()
Return the alternate Deployment Descriptor name. |
| public Object[] | getApplicationEventListeners()
Return the set of initialized application event listener objects,
in the order they were specified in the web application deployment
descriptor, for this application. |
| public Object[] | getApplicationLifecycleListeners()
Return the set of initialized application lifecycle listener objects,
in the order they were specified in the web application deployment
descriptor, for this application. |
| public boolean | getAvailable()
Return the application available flag for this Context. |
| public CharsetMapper | getCharsetMapper()
Return the Locale to character set mapper for this Context. |
| public String | getConfigFile()
Return the path to a file to save this Context information. |
| public boolean | getConfigured()
Return the "correctly configured" flag for this Context. |
| public boolean | getCookies()
Return the "use cookies for session ids" flag. |
| public boolean | getCrossContext()
Return the "allow crossing servlet contexts" flag. |
| public String | getDisplayName()
Return the display name of this web application. |
| public boolean | getDistributable()
Return the distributable flag for this web application. |
| public String | getDocBase()
Return the document root for this Context. |
| public LoginConfig | getLoginConfig()
Return the login configuration descriptor for this web application. |
| public Mapper | getMapper()
Get the request dispatcher mapper. |
| public NamingResources | getNamingResources()
Return the naming resources associated with this web application. |
| public boolean | getOverride()
Return the override flag for this web application. |
| public String | getPath()
Return the context path for this web application. |
| public boolean | getPrivileged()
Return the privileged flag for this web application. |
| public String | getPublicId()
Return the public identifier of the deployment descriptor DTD that is
currently being parsed. |
| public boolean | getReloadable()
Return the reloadable flag for this web application. |
| public ServletContext | getServletContext()
Return the servlet context for which this Context is a facade. |
| public int | getSessionTimeout()
Return the default session timeout (in minutes) for this
web application. |
| public boolean | getTldNamespaceAware()
Get the server.xml attribute's xmlNamespaceAware. |
| public boolean | getTldValidation()
Get the server.xml attribute's webXmlValidation. |
| public String | getWrapperClass()
Return the Java class name of the Wrapper implementation used
for servlets registered in this Context. |
| public boolean | getXmlNamespaceAware()
Get the server.xml attribute's xmlNamespaceAware. |
| public boolean | getXmlValidation()
Get the server.xml attribute's xmlValidation. |
| public void | reload()
Reload this web application, if reloading is supported. |
| public void | removeApplicationListener(String listener)
Remove the specified application listener class from the set of
listeners for this application. |
| public void | removeApplicationParameter(String name)
Remove the application parameter with the specified name from
the set for this application. |
| public void | removeConstraint(SecurityConstraint constraint)
Remove the specified security constraint from this web application. |
| public void | removeEjb(String name)
Remove any EJB resource reference with the specified name. |
| public void | removeEnvironment(String name)
Remove any environment entry with the specified name. |
| public void | removeErrorPage(ErrorPage errorPage)
Remove the error page for the specified error code or
Java language exception, if it exists; otherwise, no action is taken. |
| public void | removeFilterDef(FilterDef filterDef)
Remove the specified filter definition from this Context, if it exists;
otherwise, no action is taken. |
| public void | removeFilterMap(FilterMap filterMap)
Remove a filter mapping from this Context. |
| public void | removeInstanceListener(String listener)
Remove a class name from the set of InstanceListener classes that
will be added to newly created Wrappers. |
| public void | removeLocalEjb(String name)
Remove any local EJB resource reference with the specified name. |
| public void | removeMimeMapping(String extension)
Remove the MIME mapping for the specified extension, if it exists;
otherwise, no action is taken. |
| public void | removeParameter(String name)
Remove the context initialization parameter with the specified
name, if it exists; otherwise, no action is taken. |
| public void | removeResource(String name)
Remove any resource reference with the specified name. |
| public void | removeResourceEnvRef(String name)
Remove any resource environment reference with the specified name. |
| public void | removeResourceLink(String name)
Remove any resource link with the specified name. |
| public void | removeRoleMapping(String role)
|
| public void | removeSecurityRole(String role)
Remove any security role with the specified name. |
| public void | removeServletMapping(String pattern)
Remove any servlet mapping for the specified pattern, if it exists;
otherwise, no action is taken. |
| public void | removeTaglib(String uri)
Remove the tag library location forthe specified tag library URI. |
| public void | removeWelcomeFile(String name)
Remove the specified welcome file name from the list recognized
by this Context. |
| public void | removeWrapperLifecycle(String listener)
Remove a class name from the set of LifecycleListener classes that
will be added to newly created Wrappers. |
| public void | removeWrapperListener(String listener)
Remove a class name from the set of ContainerListener classes that
will be added to newly created Wrappers. |
| public void | setAltDDName(String altDDName)
Set an alternate Deployment Descriptor name. |
| public void | setApplicationEventListeners(Object listeners)
Store the set of initialized application event listener objects,
in the order they were specified in the web application deployment
descriptor, for this application. |
| public void | setApplicationLifecycleListeners(Object listeners)
Store the set of initialized application lifecycle listener objects,
in the order they were specified in the web application deployment
descriptor, for this application. |
| public void | setAvailable(boolean available)
Set the application available flag for this Context. |
| public void | setCharsetMapper(CharsetMapper mapper)
Set the Locale to character set mapper for this Context. |
| public void | setConfigFile(String configFile)
Set the path to a file to save this Context information. |
| public void | setConfigured(boolean configured)
Set the "correctly configured" flag for this Context. |
| public void | setCookies(boolean cookies)
Set the "use cookies for session ids" flag. |
| public void | setCrossContext(boolean crossContext)
Set the "allow crossing servlet contexts" flag. |
| public void | setDisplayName(String displayName)
Set the display name of this web application. |
| public void | setDistributable(boolean distributable)
Set the distributable flag for this web application. |
| public void | setDocBase(String docBase)
Set the document root for this Context. |
| public void | setLoginConfig(LoginConfig config)
Set the login configuration descriptor for this web application. |
| public void | setNamingResources(NamingResources namingResources)
Set the naming resources for this web application. |
| public void | setOverride(boolean override)
Set the override flag for this web application. |
| public void | setPath(String path)
Set the context path for this web application. |
| public void | setPrivileged(boolean privileged)
Set the privileged flag for this web application. |
| public void | setPublicId(String publicId)
Set the public identifier of the deployment descriptor DTD that is
currently being parsed. |
| public void | setReloadable(boolean reloadable)
Set the reloadable flag for this web application. |
| public void | setSessionTimeout(int timeout)
Set the default session timeout (in minutes) for this
web application. |
| public void | setTldNamespaceAware(boolean tldNamespaceAware)
Set the namespace aware feature of the XML parser used when
parsing xml instances. |
| public void | setTldValidation(boolean tldValidation)
Set the validation feature of the XML parser used when
parsing tlds files. |
| public void | setWrapperClass(String wrapperClass)
Set the Java class name of the Wrapper implementation used
for servlets registered in this Context. |
| public void | setXmlNamespaceAware(boolean xmlNamespaceAware)
Set the namespace aware feature of the XML parser used when
parsing xml instances. |
| public void | setXmlValidation(boolean xmlValidation)
Set the validation feature of the XML parser used when
parsing xml instances. |