Prev Class | Next Class | Frames | No Frames |
Summary: Nested | Field | Method | Constr | Detail: Nested | Field | Method | Constr |
java.lang.Object
org.apache.catalina.core.ContainerBase
org.apache.catalina.core.StandardContext
Nested Class Summary |
Nested classes/interfaces inherited from class org.apache.catalina.core.ContainerBase | |
ContainerBase.ContainerBackgroundProcessor , ContainerBase.PrivilegedAddChild |
Field Summary | |
protected boolean |
|
protected int |
|
protected int |
|
protected boolean |
|
Fields inherited from class org.apache.catalina.core.ContainerBase | |
backgroundProcessorDelay , children , cluster , controller , debug , domain , initialized , lifecycle , listeners , loader , logger , manager , mserver , name , oname , parent , parentClassLoader , pipeline , realm , resources , sm , started , suffix , support , type |
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 |
Fields inherited from interface org.apache.catalina.Context | |
RELOAD_EVENT |
Fields inherited from interface org.apache.catalina.Lifecycle | |
AFTER_START_EVENT , AFTER_STOP_EVENT , BEFORE_START_EVENT , BEFORE_STOP_EVENT , START_EVENT , STOP_EVENT |
Constructor Summary | |
|
Method Summary | |
void |
|
void |
|
void | |
void |
|
void |
|
String |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
String |
|
void |
|
void |
|
String |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
protected String |
|
void |
|
void |
|
ObjectName |
|
Wrapper |
|
void |
|
protected File |
|
boolean |
|
boolean |
|
String[] |
|
ApplicationParameter[] |
|
SecurityConstraint[] |
|
ContextEjb |
|
ContextEjb[] |
|
ContextEnvironment |
|
ContextEnvironment[] |
|
ErrorPage |
|
ErrorPage |
|
ErrorPage[] |
|
FilterConfig |
|
FilterDef |
|
FilterDef[] |
|
FilterMap[] |
|
String[] |
|
ContextLocalEjb |
|
ContextLocalEjb[] |
|
Context |
|
MessageDestination |
|
MessageDestinationRef |
|
MessageDestinationRef[] |
|
MessageDestination[] |
|
String |
|
String[] |
|
String |
|
String[] |
|
ContextResource |
|
String |
|
String[] |
|
ContextResourceLink |
|
ContextResourceLink[] |
|
ContextResource[] |
|
String |
|
boolean |
|
String[] |
|
String |
|
String[] |
|
javax.naming.directory.DirContext |
|
String |
|
int[] |
|
String |
|
String[] |
|
boolean |
|
String[] |
|
String[] |
|
String[] |
|
String |
|
Object[] |
|
Object[] |
|
boolean |
|
int |
|
int |
|
CharsetMapper |
|
String |
|
String |
|
String |
|
boolean |
|
boolean |
|
boolean |
|
protected String |
|
String | |
boolean |
|
String |
|
String |
|
boolean |
|
String |
|
String | |
String[] |
|
String | |
String |
|
String | |
String | |
String[] | |
LoginConfig |
|
int |
|
Mapper |
|
NamingResources |
|
boolean |
|
ObjectName | |
String |
|
boolean |
|
boolean |
|
boolean |
|
String |
|
boolean |
|
String[] |
|
String[] |
|
String | |
ServletContext |
|
String[] |
|
int |
|
long | |
long | |
int |
|
javax.naming.directory.DirContext |
|
boolean |
|
boolean |
|
long | |
boolean |
|
boolean |
|
String[] |
|
String |
|
String |
|
String |
|
boolean |
|
boolean |
|
void |
|
boolean |
|
boolean |
|
boolean |
|
boolean | |
boolean |
|
boolean |
|
boolean |
|
boolean |
|
protected boolean |
|
boolean |
|
boolean | |
boolean |
|
boolean |
|
boolean |
|
void |
|
void | |
ObjectName |
|
protected void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
boolean |
|
boolean |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
String[] |
|
void |
|
void | |
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
String |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void | |
void |
|
void |
|
String |
|
protected boolean allowLinking
Allow linking.
protected int cacheMaxSize
Cache max size in KB.
protected int cacheTTL
Cache TTL in ms.
protected boolean caseSensitive
Case sensitivity.
public StandardContext()
Create a new StandardContext component with the default basic Valve.
public void addApplicationListener(String listener)
Add a new Listener class name to the set of Listeners configured for this application.
- Specified by:
- addApplicationListener in interface Context
- Parameters:
listener
- Java class name of a listener class
public void addApplicationParameter(ApplicationParameter parameter)
Add a new application parameter for this application.
- Specified by:
- addApplicationParameter in interface Context
- Parameters:
parameter
- The new application parameter
public void addChild(Container child)
Add a child Container, only if the proposed child is an implementation of Wrapper.
- Overrides:
- addChild in interface ContainerBase
- Parameters:
child
- Child container to be added
public void addConstraint(SecurityConstraint constraint)
Add a security constraint to the set for this web application.
- Specified by:
- addConstraint in interface Context
public void addEjb(ContextEjb ejb)
Add an EJB resource reference for this web application.
- Parameters:
ejb
- New EJB resource reference
public String addEnvironment(String envName, String type) throws MalformedObjectNameException
Add an environment entry for this web application.
- Parameters:
envName
- New environment entry name
public void addEnvironment(ContextEnvironment environment)
Add an environment entry for this web application.
- Specified by:
- addEnvironment in interface Context
- Parameters:
environment
- New environment entry
public void addErrorPage(ErrorPage errorPage)
Add an error page for the specified error or Java exception.
- Specified by:
- addErrorPage in interface Context
- Parameters:
errorPage
- The error page definition to be added
public void addFilterDef(FilterDef filterDef)
Add a filter definition to this Context.
- Specified by:
- addFilterDef in interface Context
- Parameters:
filterDef
- The filter definition to be added
public void addFilterMap(FilterMap filterMap)
Add a filter mapping to this Context.
- Specified by:
- addFilterMap in interface Context
- Parameters:
filterMap
- The filter mapping to be added
public void addInstanceListener(String listener)
Add the classname of an InstanceListener to be added to each Wrapper appended to this Context.
- Specified by:
- addInstanceListener in interface Context
- Parameters:
listener
- Java class name of an InstanceListener class
public void addJspMapping(String pattern)
Add the given URL pattern as a jsp-property-group. This maps resources that match the given pattern so they will be passed to the JSP container. Though there are other elements in the property group, we only care about the URL pattern here. The JSP container will parse the rest.
- Specified by:
- addJspMapping in interface Context
- Parameters:
pattern
- URL pattern to be mapped
public void addLocalEjb(ContextLocalEjb ejb)
Add a local EJB resource reference for this web application.
- Specified by:
- addLocalEjb in interface Context
- Parameters:
ejb
- New EJB resource reference
public void addLocaleEncodingMappingParameter(String locale, String encoding)
Add a Locale Encoding Mapping (see Sec 5.4 of Servlet spec 2.4)
- Specified by:
- addLocaleEncodingMappingParameter in interface Context
- Parameters:
locale
- locale to map an encoding forencoding
- encoding to be used for a give locale
public void addMessageDestination(MessageDestination md)
Add a message destination for this web application.
- Parameters:
md
- New message destination
public void addMessageDestinationRef(MessageDestinationRef mdr)
Add a message destination reference for this web application.
- Parameters:
mdr
- New message destination reference
public void addMimeMapping(String extension, String mimeType)
Add a new MIME mapping, replacing any existing mapping for the specified extension.
- Specified by:
- addMimeMapping in interface Context
- Parameters:
extension
- Filename extension being mappedmimeType
- Corresponding MIME type
public void addParameter(String name, String value)
Add a new context initialization parameter.
- Specified by:
- addParameter in interface Context
- Parameters:
name
- Name of the new parametervalue
- Value of the new parameter
public String addResource(String resourceName, String type) throws MalformedObjectNameException
Add a resource reference for this web application.
- Parameters:
resourceName
- New resource reference name
public void addResource(ContextResource resource)
Add a resource reference for this web application.
- Specified by:
- addResource in interface Context
- Parameters:
resource
- New resource reference
public void addResourceEnvRef(String name, String type)
Add a resource environment reference for this web application.
- Specified by:
- addResourceEnvRef in interface Context
- Parameters:
name
- The resource environment reference nametype
- The resource environment reference type
public String addResourceLink(String resourceLinkName, String global, String name, String type) throws MalformedObjectNameException
Add a resource link for this web application.
- Parameters:
resourceLinkName
- New resource link name
public void addResourceLink(ContextResourceLink resourceLink)
Add a resource link for this web application.
- Specified by:
- addResourceLink in interface Context
- Parameters:
resourceLink
- New resource link
public void addResourceParams(ResourceParams resourceParameters)
Add resource parameters for this web application.
- Parameters:
resourceParameters
- New resource parameters
public void addRoleMapping(String role, String link)
Add a security role reference for this web application.
- Specified by:
- addRoleMapping in interface Context
- Parameters:
role
- Security role used in the applicationlink
- Actual security role to check for
public void addSecurityRole(String role)
Add a new security role for this web application.
- Specified by:
- addSecurityRole in interface Context
- Parameters:
role
- New security role
public void addServletMapping(String pattern, String name)
Add a new servlet mapping, replacing any existing mapping for the specified pattern.
- Specified by:
- addServletMapping in interface Context
- Parameters:
pattern
- URL pattern to be mappedname
- Name of the corresponding servlet to execute
public void addServletMapping(String pattern, String name, boolean jspWildCard)
Add a new servlet mapping, replacing any existing mapping for the specified pattern.
- Parameters:
pattern
- URL pattern to be mappedname
- Name of the corresponding servlet to executejspWildCard
- true if name identifies the JspServlet and pattern contains a wildcard; false otherwise
public void addTaglib(String uri, String location)
Add a JSP tag library for the specified URI.
- Parameters:
uri
- URI, relative to the web.xml file, of this tag librarylocation
- Location of the tag library descriptor
public void addWelcomeFile(String name)
Add a new welcome file to the set recognized by this Context.
- Specified by:
- addWelcomeFile in interface Context
- Parameters:
name
- New welcome file name
public void addWrapperLifecycle(String listener)
Add the classname of a LifecycleListener to be added to each Wrapper appended to this Context.
- Specified by:
- addWrapperLifecycle in interface Context
- Parameters:
listener
- Java class name of a LifecycleListener class
public void addWrapperListener(String listener)
Add the classname of a ContainerListener to be added to each Wrapper appended to this Context.
- Specified by:
- addWrapperListener in interface Context
- Parameters:
listener
- Java class name of a ContainerListener class
protected String adjustURLPattern(String urlPattern)
Adjust the URL pattern to begin with a leading slash, if appropriate (i.e. we are running a servlet 2.2 application). Otherwise, return the specified URL pattern unchanged.
- Parameters:
urlPattern
- The URL pattern to be adjusted (if needed) and returned
public void backgroundProcess()
Execute a periodic task, such as reloading, etc. This method will be invoked inside the classloading context of this container. Unexpected throwables will be caught and logged.
- Specified by:
- backgroundProcess in interface Container
- Overrides:
- backgroundProcess in interface ContainerBase
public void create() throws Exception
public ObjectName createObjectName(String hostDomain, ObjectName parentName) throws MalformedObjectNameException
- Overrides:
- createObjectName in interface ContainerBase
public Wrapper createWrapper()
Factory method to create and return a new Wrapper instance, of the Java implementation class appropriate for this Context implementation. The constructor of the instantiated Wrapper will have been called, but no properties will have been set.
- Specified by:
- createWrapper in interface Context
public void destroy() throws Exception
Destroy needs to clean up the context completely. The problem is that undoing all the config in start() and restoring a 'fresh' state is impossible. After stop()/destroy()/init()/start() we should have the same state as if a fresh start was done - i.e read modified web.xml, etc. This can only be done by completely removing the context object and remapping a new one, or by cleaning up everything. XXX Should this be done in stop() ?
- Overrides:
- destroy in interface ContainerBase
protected File engineBase()
Return a File object representing the base directory for the entire servlet container (i.e. the Engine container if present).
public boolean filterStart()
Configure and initialize the set of filters for this Context. Returntrue
if all filter initialization completed successfully, orfalse
otherwise.
public boolean filterStop()
Finalize and release the set of filters for this Context. Returntrue
if all filter finalization completed successfully, orfalse
otherwise.
public String[] findApplicationListeners()
Return the set of application listener class names configured for this application.
- Specified by:
- findApplicationListeners in interface Context
public ApplicationParameter[] findApplicationParameters()
Return the set of application parameters for this application.
- Specified by:
- findApplicationParameters in interface Context
public SecurityConstraint[] findConstraints()
Return the security constraints for this web application. If there are none, a zero-length array is returned.
- Specified by:
- findConstraints in interface Context
public ContextEjb findEjb(String name)
Return the EJB resource reference with the specified name, if any; otherwise, returnnull
.
- Parameters:
name
- Name of the desired EJB resource reference
public ContextEjb[] findEjbs()
Return the defined EJB resource references for this application. If there are none, a zero-length array is returned.
public ContextEnvironment findEnvironment(String name)
Return the environment entry with the specified name, if any; otherwise, returnnull
.
- Specified by:
- findEnvironment in interface Context
- Parameters:
name
- Name of the desired environment entry
public ContextEnvironment[] findEnvironments()
Return the set of defined environment entries for this web application. If none have been defined, a zero-length array is returned.
- Specified by:
- findEnvironments in interface Context
public ErrorPage findErrorPage(String exceptionType)
Return the error page entry for the specified Java exception type, if any; otherwise returnnull
.
- Specified by:
- findErrorPage in interface Context
- Parameters:
exceptionType
- Exception type to look up
public ErrorPage findErrorPage(int errorCode)
Return the error page entry for the specified HTTP error code, if any; otherwise returnnull
.
- Specified by:
- findErrorPage in interface Context
- Parameters:
errorCode
- Error code to look up
public ErrorPage[] findErrorPages()
Return the set of defined error pages for all specified error codes and exception types.
- Specified by:
- findErrorPages in interface Context
public FilterConfig findFilterConfig(String name)
Find and return the initializedFilterConfig
for the specified filter name, if any; otherwise returnnull
.
- Parameters:
name
- Name of the desired filter
public FilterDef findFilterDef(String filterName)
Return the filter definition for the specified filter name, if any; otherwise returnnull
.
- Specified by:
- findFilterDef in interface Context
- Parameters:
filterName
- Filter name to look up
public FilterDef[] findFilterDefs()
Return the set of defined filters for this Context.
- Specified by:
- findFilterDefs in interface Context
public FilterMap[] findFilterMaps()
Return the set of filter mappings for this Context.
- Specified by:
- findFilterMaps in interface Context
public String[] findInstanceListeners()
Return the set of InstanceListener classes that will be added to newly created Wrappers automatically.
- Specified by:
- findInstanceListeners in interface Context
public ContextLocalEjb findLocalEjb(String name)
Return the local EJB resource reference with the specified name, if any; otherwise, returnnull
.
- Specified by:
- findLocalEjb in interface Context
- Parameters:
name
- Name of the desired EJB resource reference
public ContextLocalEjb[] findLocalEjbs()
Return the defined local EJB resource references for this application. If there are none, a zero-length array is returned.
- Specified by:
- findLocalEjbs in interface Context
public MessageDestination findMessageDestination(String name)
Return the message destination with the specified name, if any; otherwise, returnnull
.
- Parameters:
name
- Name of the desired message destination
public MessageDestinationRef findMessageDestinationRef(String name)
Return the message destination ref with the specified name, if any; otherwise, returnnull
.
- Parameters:
name
- Name of the desired message destination ref
public MessageDestinationRef[] findMessageDestinationRefs()
Return the set of defined message destination refs for this web application. If none have been defined, a zero-length array is returned.
public MessageDestination[] findMessageDestinations()
Return the set of defined message destinations for this web application. If none have been defined, a zero-length array is returned.
public String findMimeMapping(String extension)
Return the MIME type to which the specified extension is mapped, if any; otherwise returnnull
.
- Specified by:
- findMimeMapping in interface Context
- Parameters:
extension
- Extension to map to a MIME type
public String[] findMimeMappings()
Return the extensions for which MIME mappings are defined. If there are none, a zero-length array is returned.
- Specified by:
- findMimeMappings in interface Context
public String findParameter(String name)
Return the value for the specified context initialization parameter name, if any; otherwise returnnull
.
- Specified by:
- findParameter in interface Context
- Parameters:
name
- Name of the parameter to return
public String[] findParameters()
Return the names of all defined context initialization parameters for this Context. If no parameters are defined, a zero-length array is returned.
- Specified by:
- findParameters in interface Context
public ContextResource findResource(String name)
Return the resource reference with the specified name, if any; otherwise returnnull
.
- Specified by:
- findResource in interface Context
- Parameters:
name
- Name of the desired resource reference
public String findResourceEnvRef(String name)
Return the resource environment reference type for the specified name, if any; otherwise returnnull
.
- Specified by:
- findResourceEnvRef in interface Context
- Parameters:
name
- Name of the desired resource environment reference
public String[] findResourceEnvRefs()
Return the set of resource environment reference names for this web application. If none have been specified, a zero-length array is returned.
- Specified by:
- findResourceEnvRefs in interface Context
public ContextResourceLink findResourceLink(String name)
Return the resource link with the specified name, if any; otherwise returnnull
.
- Specified by:
- findResourceLink in interface Context
- Parameters:
name
- Name of the desired resource link
public ContextResourceLink[] findResourceLinks()
Return the defined resource links for this application. If none have been defined, a zero-length array is returned.
- Specified by:
- findResourceLinks in interface Context
public ContextResource[] findResources()
Return the defined resource references for this application. If none have been defined, a zero-length array is returned.
- Specified by:
- findResources in interface Context
public String findRoleMapping(String role)
For the given security role (as used by an application), return the corresponding role name (as defined by the underlying Realm) if there is one. Otherwise, return the specified role unchanged.
- Specified by:
- findRoleMapping in interface Context
- Parameters:
role
- Security role to map
public boolean findSecurityRole(String role)
Returntrue
if the specified security role is defined for this application; otherwise returnfalse
.
- Specified by:
- findSecurityRole in interface Context
- Parameters:
role
- Security role to verify
public String[] findSecurityRoles()
Return the security roles defined for this application. If none have been defined, a zero-length array is returned.
- Specified by:
- findSecurityRoles in interface Context
public String findServletMapping(String pattern)
Return the servlet name mapped by the specified pattern (if any); otherwise returnnull
.
- Specified by:
- findServletMapping in interface Context
- Parameters:
pattern
- Pattern for which a mapping is requested
public String[] findServletMappings()
Return the patterns of all defined servlet mappings for this Context. If no mappings are defined, a zero-length array is returned.
- Specified by:
- findServletMappings in interface Context
public javax.naming.directory.DirContext findStaticResources()
Return the naming resources associated with this web application. FIXME: Fooling introspection ...
public String findStatusPage(int status)
Return the context-relative URI of the error page for the specified HTTP status code, if any; otherwise returnnull
.
- Specified by:
- findStatusPage in interface Context
- Parameters:
status
- HTTP status code to look up
public int[] findStatusPages()
Return the set of HTTP status codes for which error pages have been specified. If none are specified, a zero-length array is returned.
- Specified by:
- findStatusPages in interface Context
public String findTaglib(String uri)
Return the tag library descriptor location for the specified taglib URI, if any; otherwise, returnnull
.
- Specified by:
- findTaglib in interface Context
- Parameters:
uri
- URI, relative to the web.xml file
public String[] findTaglibs()
Return the URIs of all tag libraries for which a tag library descriptor location has been specified. If none are specified, a zero-length array is returned.
- Specified by:
- findTaglibs in interface Context
public boolean findWelcomeFile(String name)
Returntrue
if the specified welcome file is defined for this Context; otherwise returnfalse
.
- Specified by:
- findWelcomeFile in interface Context
- Parameters:
name
- Welcome file to verify
public String[] findWelcomeFiles()
Return the set of welcome files defined for this Context. If none are defined, a zero-length array is returned.
- Specified by:
- findWelcomeFiles in interface Context
public String[] findWrapperLifecycles()
Return the set of LifecycleListener classes that will be added to newly created Wrappers automatically.
- Specified by:
- findWrapperLifecycles in interface Context
public String[] findWrapperListeners()
Return the set of ContainerListener classes that will be added to newly created Wrappers automatically.
- Specified by:
- findWrapperListeners in interface Context
public String getAltDDName()
Return the alternate Deployment Descriptor name.
- Specified by:
- getAltDDName in interface Context
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.
- Specified by:
- getApplicationEventListeners in interface Context
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.
- Specified by:
- getApplicationLifecycleListeners in interface Context
public boolean getAvailable()
Return the application available flag for this Context.
- Specified by:
- getAvailable in interface Context
public int getCacheMaxSize()
Return the maximum size of the cache in KB.
public int getCacheTTL()
Get cache TTL.
public CharsetMapper getCharsetMapper()
Return the Locale to character set mapper for this Context.
- Specified by:
- getCharsetMapper in interface Context
public String getCharsetMapperClass()
Return the Locale to character set mapper class for this Context.
public String getCompilerClasspath()
Return the compiler classpath.
public String getConfigFile()
Return the path to a file to save this Context information.
- Specified by:
- getConfigFile in interface Context
public boolean getConfigured()
Return the "correctly configured" flag for this Context.
- Specified by:
- getConfigured in interface Context
public boolean getCookies()
Return the "use cookies for session ids" flag.
- Specified by:
- getCookies in interface Context
public boolean getCrossContext()
Return the "allow crossing servlet contexts" flag.
- Specified by:
- getCrossContext in interface Context
protected String getDefaultConfigFile()
Given a context path, get the config file name.
public String getDefaultWebXml()
public boolean getDelegate()
Return the "follow standard delegation model" flag used to configure our ClassLoader.
public String getDeploymentDescriptor()
JSR77 deploymentDescriptor attribute
- Returns:
- string deployment descriptor
public String getDisplayName()
Return the display name of this web application.
- Specified by:
- getDisplayName in interface Context
public boolean getDistributable()
Return the distributable flag for this web application.
- Specified by:
- getDistributable in interface Context
public String getDocBase()
Return the document root for this Context. This can be an absolute pathname, a relative pathname, or a URL.
- Specified by:
- getDocBase in interface Context
public String getEngineName()
public String[] getEnvironments()
Return the MBean Names of the set of defined environment entries for this web application
public String getHostname()
public String getInfo()
Return descriptive information about this Container implementation and the corresponding version number, in the format<description>/<version>
.
- Overrides:
- getInfo in interface ContainerBase
public String getJ2EEApplication()
public String getJ2EEServer()
public String[] getJavaVMs()
public LoginConfig getLoginConfig()
Return the login configuration descriptor for this web application.
- Specified by:
- getLoginConfig in interface Context
public int getManagerChecksFrequency()
Return the frequency of manager checks.
public NamingResources getNamingResources()
Return the naming resources associated with this web application.
- Specified by:
- getNamingResources in interface Context
public boolean getOverride()
Return the DefaultContext override flag for this web application.
- Specified by:
- getOverride in interface Context
public ObjectName getParentName() throws MalformedObjectNameException
- Overrides:
- getParentName in interface ContainerBase
public String getPath()
Return the context path for this Context.
public boolean getPaused()
Return the request processing paused flag for this Context.
public boolean getPrivileged()
Return the privileged flag for this web application.
- Specified by:
- getPrivileged in interface Context
public boolean getProcessTlds()
Returns the processTlds attribute value.
public String getPublicId()
Return the public identifier of the deployment descriptor DTD that is currently being parsed.
- Specified by:
- getPublicId in interface Context
public boolean getReloadable()
Return the reloadable flag for this web application.
- Specified by:
- getReloadable in interface Context
public String[] getResourceLinks()
Return the MBean Names of all the defined resource links for this application
public String[] getResourceNames()
Return the MBean Names of all the defined resource references for this application.
public String getServer()
public ServletContext getServletContext()
Return the servlet context for which this Context is a facade.
- Specified by:
- getServletContext in interface Context
public String[] getServlets()
JSR77 servlets attribute
- Returns:
- list of all servlets ( we know about )
public int getSessionTimeout()
Return the default session timeout (in minutes) for this web application.
- Specified by:
- getSessionTimeout in interface Context
public long getStartTime()
public long getStartupTime()
public int getState()
public javax.naming.directory.DirContext getStaticResources()
Return the naming resources associated with this web application.
public boolean getSwallowOutput()
Return the value of the swallowOutput flag.
public boolean getTldNamespaceAware()
Get the server.xmlattribute's xmlNamespaceAware.
- Specified by:
- getTldNamespaceAware in interface Context
- Returns:
- true if namespace awarenes is enabled.
public long getTldScanTime()
public boolean getTldValidation()
Get the server.xmlattribute's webXmlValidation.
- Specified by:
- getTldValidation in interface Context
- Returns:
- true if validation is enabled.
public boolean getUnpackWAR()
Unpack WAR flag accessor.
public String[] getWelcomeFiles()
Return the naming resources associated with this web application.
public String getWorkDir()
Return the work directory for this Context.
public String getWorkPath()
Get the absolute path to the work dir. To avoid duplication.
- Returns:
- The work path
public String getWrapperClass()
Return the Java class name of the Wrapper implementation used for servlets registered in this Context.
- Specified by:
- getWrapperClass in interface Context
public boolean getXmlNamespaceAware()
Get the server.xmlattribute's xmlNamespaceAware.
- Specified by:
- getXmlNamespaceAware in interface Context
- Returns:
- true if namespace awarenes is enabled.
public boolean getXmlValidation()
Get the server.xmlattribute's xmlValidation.
- Specified by:
- getXmlValidation in interface Context
- Returns:
- true if validation is enabled.
public boolean isAllowLinking()
Is linking allowed.
public boolean isCachingAllowed()
Is caching allowed ?
public boolean isCaseSensitive()
Is case sensitive ?
public boolean isEventProvider()
public boolean isFilesystemBased()
Returns true if the resources associated with this context are filesystem based.
public boolean isLazy()
public boolean isReplaceWelcomeFiles()
Return the "replace welcome files" property.
public boolean isSaveConfig()
Save config ?
protected boolean isServlet22()
Are we processing a version 2.2 deployment descriptor?
public boolean isStateManageable()
Support for "stateManageable" JSR77
public boolean isStatisticsProvider()
public boolean isUseNaming()
Returns true if the internal naming support is used.
public boolean listenerStart()
Configure the set of instantiated application event listeners for this Context. Returntrue
if all listeners wre initialized successfully, orfalse
otherwise.
public boolean listenerStop()
Send an application stop event to all interested listeners. Returntrue
if all events were sent successfully, orfalse
otherwise.
public void loadOnStartup(children[] )
Load and initialize all servlets marked "load on startup" in the web application deployment descriptor.
- Parameters:
public void preDeregister() throws Exception
- Overrides:
- preDeregister in interface ContainerBase
public ObjectName preRegister(MBeanServer server, ObjectName name) throws Exception
There are 2 cases: 1.The context is created and registered by internal APIS 2. The context is created by JMX, and it'll self-register.
- Overrides:
- preRegister in interface ContainerBase
- Parameters:
server
- The servername
- The object name
- Returns:
- ObjectName The name of the object
protected void processTlds() throws LifecycleException
Processes the TLDs.
- Throws:
LifecycleException
- If an error occurs
public void reload()
Reload this web application, if reloading is supported. IMPLEMENTATION NOTE: This method is designed to deal with reloads required by changes to classes in the underlying repositories of our class loader. It does not handle changes to the web application deployment descriptor. If that has occurred, you should stop this Context and create (and start) a new Context instance instead.
public void removeApplicationListener(String listener)
Remove the specified application listener class from the set of listeners for this application.
- Specified by:
- removeApplicationListener in interface Context
- Parameters:
listener
- Java class name of the listener to be removed
public void removeApplicationParameter(String name)
Remove the application parameter with the specified name from the set for this application.
- Specified by:
- removeApplicationParameter in interface Context
- Parameters:
name
- Name of the application parameter to remove
public void removeChild(Container child)
Add a child Container, only if the proposed child is an implementation of Wrapper.
- Specified by:
- removeChild in interface Container
- Overrides:
- removeChild in interface ContainerBase
- Parameters:
child
- Child container to be added
public void removeConstraint(SecurityConstraint constraint)
Remove the specified security constraint from this web application.
- Specified by:
- removeConstraint in interface Context
- Parameters:
constraint
- Constraint to be removed
public void removeEjb(String name)
Remove any EJB resource reference with the specified name.
- Parameters:
name
- Name of the EJB resource reference to remove
public void removeEnvironment(String name)
Remove any environment entry with the specified name.
- Specified by:
- removeEnvironment in interface Context
- Parameters:
name
- Name of the environment entry to remove
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.
- Specified by:
- removeErrorPage in interface Context
- Parameters:
errorPage
- The error page definition to be removed
public void removeFilterDef(FilterDef filterDef)
Remove the specified filter definition from this Context, if it exists; otherwise, no action is taken.
- Specified by:
- removeFilterDef in interface Context
- Parameters:
filterDef
- Filter definition to be removed
public void removeFilterMap(FilterMap filterMap)
Remove a filter mapping from this Context.
- Specified by:
- removeFilterMap in interface Context
- Parameters:
filterMap
- The filter mapping to be removed
public void removeInstanceListener(String listener)
Remove a class name from the set of InstanceListener classes that will be added to newly created Wrappers.
- Specified by:
- removeInstanceListener in interface Context
- Parameters:
listener
- Class name of an InstanceListener class to be removed
public void removeLocalEjb(String name)
Remove any local EJB resource reference with the specified name.
- Specified by:
- removeLocalEjb in interface Context
- Parameters:
name
- Name of the EJB resource reference to remove
public void removeMessageDestination(String name)
Remove any message destination with the specified name.
- Parameters:
name
- Name of the message destination to remove
public void removeMessageDestinationRef(String name)
Remove any message destination ref with the specified name.
- Parameters:
name
- Name of the message destination ref to remove
public void removeMimeMapping(String extension)
Remove the MIME mapping for the specified extension, if it exists; otherwise, no action is taken.
- Specified by:
- removeMimeMapping in interface Context
- Parameters:
extension
- Extension to remove the mapping for
public void removeParameter(String name)
Remove the context initialization parameter with the specified name, if it exists; otherwise, no action is taken.
- Specified by:
- removeParameter in interface Context
- Parameters:
name
- Name of the parameter to remove
public void removeResource(String name)
Remove any resource reference with the specified name.
- Specified by:
- removeResource in interface Context
- Parameters:
name
- Name of the resource reference to remove
public void removeResourceEnvRef(String name)
Remove any resource environment reference with the specified name.
- Specified by:
- removeResourceEnvRef in interface Context
- Parameters:
name
- Name of the resource environment reference to remove
public void removeResourceLink(String name)
Remove any resource link with the specified name.
- Specified by:
- removeResourceLink in interface Context
- Parameters:
name
- Name of the resource link to remove
public void removeRoleMapping(String role)
Remove any security role reference for the specified name
- Specified by:
- removeRoleMapping in interface Context
- Parameters:
role
- Security role (as used in the application) to remove
public void removeSecurityRole(String role)
Remove any security role with the specified name.
- Specified by:
- removeSecurityRole in interface Context
- Parameters:
role
- Security role to remove
public void removeServletMapping(String pattern)
Remove any servlet mapping for the specified pattern, if it exists; otherwise, no action is taken.
- Specified by:
- removeServletMapping in interface Context
- Parameters:
pattern
- URL pattern of the mapping to remove
public void removeTaglib(String uri)
Remove the tag library location forthe specified tag library URI.
- Specified by:
- removeTaglib in interface Context
- Parameters:
uri
- URI, relative to the web.xml file
public void removeWelcomeFile(String name)
Remove the specified welcome file name from the list recognized by this Context.
- Specified by:
- removeWelcomeFile in interface Context
- Parameters:
name
- Name of the welcome file to be removed
public void removeWrapperLifecycle(String listener)
Remove a class name from the set of LifecycleListener classes that will be added to newly created Wrappers.
- Specified by:
- removeWrapperLifecycle in interface Context
- Parameters:
listener
- Class name of a LifecycleListener class to be removed
public void removeWrapperListener(String listener)
Remove a class name from the set of ContainerListener classes that will be added to newly created Wrappers.
- Specified by:
- removeWrapperListener in interface Context
- Parameters:
listener
- Class name of a ContainerListener class to be removed
public boolean resourcesStart()
Allocate resources, including proxy. Returntrue
if initialization was successfull, orfalse
otherwise.
public boolean resourcesStop()
Deallocate resources and destroy proxy.
public void setAllowLinking(boolean allowLinking)
Set allow linking.
public void setAltDDName(String altDDName)
Set an alternate Deployment Descriptor name.
- Specified by:
- setAltDDName in interface Context
public void setApplicationEventListeners(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.
- Specified by:
- setApplicationEventListeners in interface Context
- Parameters:
public void setApplicationLifecycleListeners(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.
- Specified by:
- setApplicationLifecycleListeners in interface Context
- Parameters:
public void setAvailable(boolean available)
Set the application available flag for this Context.
- Specified by:
- setAvailable in interface Context
- Parameters:
available
- The new application available flag
public void setCacheMaxSize(int cacheMaxSize)
Set the maximum size of the cache in KB.
public void setCacheTTL(int cacheTTL)
Set cache TTL.
public void setCachingAllowed(boolean cachingAllowed)
Set caching allowed flag.
public void setCaseSensitive(boolean caseSensitive)
Set case sensitivity.
public void setCharsetMapper(CharsetMapper mapper)
Set the Locale to character set mapper for this Context.
- Specified by:
- setCharsetMapper in interface Context
- Parameters:
mapper
- The new mapper
public void setCharsetMapperClass(String mapper)
Set the Locale to character set mapper class for this Context.
- Parameters:
mapper
- The new mapper class
public void setCompilerClasspath(String compilerClasspath)
Set the compiler classpath.
public void setConfigFile(String configFile)
Set the path to a file to save this Context information.
- Specified by:
- setConfigFile in interface Context
- Parameters:
configFile
- The path to a file to save this Context information.
public void setConfigured(boolean configured)
Set the "correctly configured" flag for this Context. This can be set to false by startup listeners that detect a fatal configuration error to avoid the application from being made available.
- Specified by:
- setConfigured in interface Context
- Parameters:
configured
- The new correctly configured flag
public void setCookies(boolean cookies)
Set the "use cookies for session ids" flag.
- Specified by:
- setCookies in interface Context
- Parameters:
cookies
- The new flag
public void setCrossContext(boolean crossContext)
Set the "allow crossing servlet contexts" flag.
- Specified by:
- setCrossContext in interface Context
- Parameters:
crossContext
- The new cross contexts flag
public void setDefaultWebXml(String defaultWebXml)
Set the location of the default web xml that will be used. If not absolute, it'll be made relative to the engine's base dir ( which defaults to catalina.base system property ). XXX If a file is not found - we can attempt a getResource()
- Parameters:
defaultWebXml
- The default web xml
public void setDelegate(boolean delegate)
Set the "follow standard delegation model" flag used to configure our ClassLoader.
- Parameters:
delegate
- The new flag
public void setDisplayName(String displayName)
Set the display name of this web application.
- Specified by:
- setDisplayName in interface Context
- Parameters:
displayName
- The new display name
public void setDistributable(boolean distributable)
Set the distributable flag for this web application.
- Specified by:
- setDistributable in interface Context
- Parameters:
distributable
- The new distributable flag
public void setDocBase(String docBase)
Set the document root for this Context. This can be an absolute pathname, a relative pathname, or a URL.
- Specified by:
- setDocBase in interface Context
- Parameters:
docBase
- The new document root
public void setEngineName(String engineName)
public void setJ2EEApplication(String j2EEApplication)
public void setJ2EEServer(String j2EEServer)
public String[] setJavaVMs(String[] javaVMs)
public void setLazy(boolean lazy)
public void setLoader(Loader loader)
Set the Loader with which this Context is associated.
- Overrides:
- setLoader in interface ContainerBase
- Parameters:
loader
- The newly associated loader
public void setLoginConfig(LoginConfig config)
Set the login configuration descriptor for this web application.
- Specified by:
- setLoginConfig in interface Context
- Parameters:
config
- The new login configuration
public void setManagerChecksFrequency(int managerChecksFrequency)
Set the manager checks frequency.
- Parameters:
managerChecksFrequency
- the new manager checks frequency
public void setNamingResources(NamingResources namingResources)
Set the naming resources for this web application.
- Specified by:
- setNamingResources in interface Context
- Parameters:
namingResources
- The new naming resources
public void setOverride(boolean override)
Set the DefaultContext override flag for this web application.
- Specified by:
- setOverride in interface Context
- Parameters:
override
- The new override flag
public void setPath(String path)
Set the context path for this Context. IMPLEMENTATION NOTE: The context path is used as the "name" of a Context, because it must be unique.
- Parameters:
path
- The new context path
public void setPrivileged(boolean privileged)
Set the privileged flag for this web application.
- Specified by:
- setPrivileged in interface Context
- Parameters:
privileged
- The new privileged flag
public void setProcessTlds(boolean newProcessTlds)
Sets the processTlds attribute value.
- Parameters:
newProcessTlds
- The new attribute value
public void setPublicId(String publicId)
Set the public identifier of the deployment descriptor DTD that is currently being parsed.
- Specified by:
- setPublicId in interface Context
- Parameters:
publicId
- The public identifier
public void setReloadable(boolean reloadable)
Set the reloadable flag for this web application.
- Specified by:
- setReloadable in interface Context
- Parameters:
reloadable
- The new reloadable flag
public void setReplaceWelcomeFiles(boolean replaceWelcomeFiles)
Set the "replace welcome files" property.
- Parameters:
replaceWelcomeFiles
- The new property value
public void setResources(DirContext resources)
Set the resources DirContext object with which this Container is associated.
- Specified by:
- setResources in interface Container
- Overrides:
- setResources in interface ContainerBase
- Parameters:
resources
- The newly associated DirContext
public void setSaveConfig(boolean saveConfig)
Set save config flag.
public String setServer(String server)
public void setSessionTimeout(int timeout)
Set the default session timeout (in minutes) for this web application.
- Specified by:
- setSessionTimeout in interface Context
- Parameters:
timeout
- The new default session timeout
public void setStartupTime(long startupTime)
public void setSwallowOutput(boolean swallowOutput)
Set the value of the swallowOutput flag. If set to true, the system.out and system.err will be redirected to the logger during a servlet execution.
- Parameters:
swallowOutput
- The new value
public void setTldNamespaceAware(boolean tldNamespaceAware)
Set the namespace aware feature of the XML parser used when parsing xml instances.
- Specified by:
- setTldNamespaceAware in interface Context
- Parameters:
tldNamespaceAware
- true to enable namespace awareness
public void setTldScanTime(long tldScanTime)
public void setTldValidation(boolean tldValidation)
Set the validation feature of the XML parser used when parsing tlds files.
- Specified by:
- setTldValidation in interface Context
- Parameters:
tldValidation
- true to enable xml instance validation
public void setUnpackWAR(boolean unpackWAR)
Unpack WAR flag mutator.
public void setUseNaming(boolean useNaming)
Enables or disables naming.
public void setWorkDir(String workDir)
Set the work directory for this Context.
- Parameters:
workDir
- The new work directory
public void setWrapperClass(String wrapperClass)
Set the Java class name of the Wrapper implementation used for servlets registered in this Context.
- Specified by:
- setWrapperClass in interface Context
- Parameters:
wrapperClass
- The new wrapper class
public void setXmlNamespaceAware(boolean webXmlNamespaceAware)
Set the namespace aware feature of the XML parser used when parsing xml instances.
- Specified by:
- setXmlNamespaceAware in interface Context
- Parameters:
webXmlNamespaceAware
- true to enable namespace awareness
public void setXmlValidation(boolean webXmlValidation)
Set the validation feature of the XML parser used when parsing xml instances.
- Specified by:
- setXmlValidation in interface Context
- Parameters:
webXmlValidation
- true to enable xml instance validation
public void start() throws LifecycleException
Start this Context component.
- Overrides:
- start in interface ContainerBase
- Throws:
LifecycleException
- if a startup error occurs
public void stop() throws LifecycleException
Stop this Context component.
- Overrides:
- stop in interface ContainerBase
- Throws:
LifecycleException
- if a shutdown error occurs
public void stopNew() throws LifecycleException
Stop this Context component. Experimental, please ignore.
- Throws:
LifecycleException
- if a shutdown error occurs
public String toString()
Return a String representation of this component.