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 | addChild(Container child) Add a child Container, only if the proposed child is an implementation
of Wrapper. |
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 String | addEnvironment(String envName, String type) 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 | addMessageDestination(MessageDestination md) Add a message destination for this web application. |
public void | addMessageDestinationRef(MessageDestinationRef mdr) Add a message destination reference for this web application. |
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. |
public void | addResource(ContextResource resource) Add a resource reference for this web application. |
public String | addResource(String resourceName, String type) 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 String | addResourceLink(String resourceLinkName, String global, String name, String type) Add a resource link for this web application. |
public void | addResourceParams(ResourceParams resourceParameters) Add resource parameters 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 | addServletMapping(String pattern, String name, boolean jspWildCard) 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. |
protected String | adjustURLPattern(String urlPattern) Adjust the URL pattern to begin with a leading slash, if appropriate
(i.e. |
public void | backgroundProcess() Execute a periodic task, such as reloading, etc. |
public void | create() |
public ObjectName | createObjectName(String hostDomain, ObjectName parentName) |
public Wrapper | createWrapper() Factory method to create and return a new Wrapper instance, of
the Java implementation class appropriate for this Context
implementation. |
public void | destroy() 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. |
protected File | engineBase() Return a File object representing the base directory for the
entire servlet container (i.e. |
public boolean | filterStart() Configure and initialize the set of filters for this Context. |
public boolean | filterStop() Finalize and release the set of filters for this Context. |
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 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 FilterConfig | findFilterConfig(String name) Find and return the initialized FilterConfig for the
specified filter name, if any; otherwise return null . |
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 Context | findMappingObject() FIXME: Fooling introspection ... |
public MessageDestination | findMessageDestination(String name) Return the message destination with the specified name, if any;
otherwise, return null . |
public MessageDestinationRef | findMessageDestinationRef(String name) Return the message destination ref with the specified name, if any;
otherwise, return null . |
public MessageDestinationRef[] | findMessageDestinationRefs() Return the set of defined message destination refs for this web
application. |
public MessageDestination[] | findMessageDestinations() Return the set of defined message destinations for this web
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 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 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 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. |
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. |
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. |
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() |
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 String | getEngineName() |
public String[] | getEnvironments() |
public String | getHostname() |
public String | getInfo() Return descriptive information about this Container implementation and
the corresponding version number, in the format
<description>/<version> . |
public String | getJ2EEApplication() |
public String | getJ2EEServer() |
public String[] | getJavaVMs() |
public LoginConfig | getLoginConfig() Return the login configuration descriptor for this web application. |
public int | getManagerChecksFrequency() Return the frequency of manager checks. |
public org.apache.tomcat.util.http.mapper.Mapper | getMapper() Get the mapper associated with the context. |
public NamingResources | getNamingResources() Return the naming resources associated with this web application. |
public boolean | getOverride() Return the DefaultContext override flag for this web application. |
public ObjectName | getParentName() |
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. |
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 String[] | getResourceLinks() |
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. |
public String[] | getServlets() |
public int | getSessionTimeout() Return the default session timeout (in minutes) for this
web application. |
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.xml attribute's xmlNamespaceAware. |
public long | getTldScanTime() |
public boolean | getTldValidation() Get the server.xml attribute's webXmlValidation. |
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. |
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 | init() |
public boolean | isAllowLinking() Is linking allowed. |
public boolean | isCachingAllowed() |
public boolean | isCaseSensitive() |
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() |
protected boolean | isServlet22() |
public boolean | isStateManageable() |
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. |
public boolean | listenerStop() Send an application stop event to all interested listeners. |
public void | loadOnStartup(Container children) Load and initialize all servlets marked "load on startup" in the
web application deployment descriptor. |
public void | preDeregister() |
public ObjectName | preRegister(MBeanServer server, ObjectName name) There are 2 cases:
1.The context is created and registered by internal APIS
2. |
public synchronized 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. |
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 | removeChild(Container child) Add a child Container, only if the proposed child is an implementation
of Wrapper. |
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 | removeMessageDestination(String name) Remove any message destination with the specified name. |
public void | removeMessageDestinationRef(String name) Remove any message destination ref 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 boolean | resourcesStart() Allocate resources, including proxy. |
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. |
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 | 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. |
public void | setCharsetMapperClass(String mapper) Set the Locale to character set mapper class for this Context. |
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. |
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 | setDefaultWebXml(String defaultWebXml) Set the location of the default web xml that will be used. |
public void | setDelegate(boolean delegate) Set the "follow standard delegation model" flag used to configure
our ClassLoader. |
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 | setEngineName(String engineName) |
public void | setJ2EEApplication(String j2EEApplication) |
public void | setJ2EEServer(String j2EEServer) |
public String[] | setJavaVMs(String[] javaVMs) |
public void | setLazy(boolean lazy) |
public synchronized void | setLoader(Loader loader) Set the Loader with which this Context is associated. |
public void | setLoginConfig(LoginConfig config) Set the login configuration descriptor for this web application. |
public void | setManagerChecksFrequency(int managerChecksFrequency) Set the manager checks frequency. |
public void | setName(String name) |
public void | setNamingResources(NamingResources namingResources) Set the naming resources for this web application. |
public void | setOverride(boolean override) Set the DefaultContext override flag for this web application. |
public void | setPath(String path) Set the context path for this Context. |
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 | setReplaceWelcomeFiles(boolean replaceWelcomeFiles) Set the "replace welcome files" property. |
public synchronized void | setResources(DirContext resources) Set the resources DirContext object with which this Container is
associated. |
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. |
public void | setStartupTime(long startupTime) |
public void | setSwallowOutput(boolean swallowOutput) Set the value of the swallowOutput flag. |
public void | setTldNamespaceAware(boolean tldNamespaceAware) Set the namespace aware feature of the XML parser used when
parsing xml instances. |
public void | setTldScanTime(long tldScanTime) |
public void | setTldValidation(boolean tldValidation) Set the validation feature of the XML parser used when
parsing tlds files. |
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. |
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 webXmlNamespaceAware) Set the namespace aware feature of the XML parser used when
parsing xml instances. |
public void | setXmlValidation(boolean webXmlValidation) Set the validation feature of the XML parser used when
parsing xml instances. |
public synchronized void | start() Start this Context component. |
public void | startRecursive() |
public synchronized void | stop() Stop this Context component. |
public synchronized void | stopNew() Stop this Context component. |
public String | toString() Return a String representation of this component. |