org.apache.catalina.core
クラス StandardContext

java.lang.Object
  |
  +--org.apache.catalina.core.ContainerBase
        |
        +--org.apache.catalina.core.StandardContext
すべての実装インタフェース:
Container, Context, Lifecycle, Pipeline

public class StandardContext
extends ContainerBase
implements Context

Standard implementation of the Context interface. Each child container must be a Wrapper implementation to process the requests directed to a particular servlet.

バージョン:
$Revision: 1.78.2.17 $ $Date: 2002/06/05 16:46:53 $
作成者:
Craig R. McClanahan, Remy Maucherat

フィールドの概要
protected  boolean cachingAllowed
          Caching allowed flag.
 
クラス org.apache.catalina.core.ContainerBase から継承したフィールド
children, cluster, debug, lifecycle, listeners, loader, logger, manager, mapper, mapperClass, mappers, name, parent, parentClassLoader, pipeline, realm, resources, sm, started, support
 
インタフェース org.apache.catalina.Container から継承したフィールド
ADD_CHILD_EVENT, ADD_MAPPER_EVENT, ADD_VALVE_EVENT, REMOVE_CHILD_EVENT, REMOVE_MAPPER_EVENT, REMOVE_VALVE_EVENT
 
インタフェース org.apache.catalina.Lifecycle から継承したフィールド
START_EVENT, STOP_EVENT
 
コンストラクタの概要
StandardContext()
          Create a new StandardContext component with the default basic Valve.
 
メソッドの概要
 void addApplicationListener(java.lang.String listener)
          Add a new Listener class name to the set of Listeners configured for this application.
 void addApplicationParameter(ApplicationParameter parameter)
          Add a new application parameter for this application.
 void addChild(Container child)
          Add a child Container, only if the proposed child is an implementation of Wrapper.
 void addConstraint(SecurityConstraint constraint)
          Add a security constraint to the set for this web application.
protected  void addDefaultMapper(java.lang.String mapperClass)
          Add a default Mapper implementation if none have been configured explicitly.
 void addEjb(ContextEjb ejb)
          Add an EJB resource reference for this web application.
 void addEnvironment(ContextEnvironment environment)
          Add an environment entry for this web application.
 void addErrorPage(ErrorPage errorPage)
          Add an error page for the specified error or Java exception.
 void addFilterDef(FilterDef filterDef)
          Add a filter definition to this Context.
 void addFilterMap(FilterMap filterMap)
          Add a filter mapping to this Context.
 void addInstanceListener(java.lang.String listener)
          Add the classname of an InstanceListener to be added to each Wrapper appended to this Context.
 void addLocalEjb(ContextLocalEjb ejb)
          Add a local EJB resource reference for this web application.
 void addMimeMapping(java.lang.String extension, java.lang.String mimeType)
          Add a new MIME mapping, replacing any existing mapping for the specified extension.
 void addParameter(java.lang.String name, java.lang.String value)
          Add a new context initialization parameter.
 void addResource(ContextResource resource)
          Add a resource reference for this web application.
 void addResourceEnvRef(java.lang.String name, java.lang.String type)
          Add a resource environment reference for this web application.
 void addResourceParams(ResourceParams resourceParameters)
          Add resource parameters for this web application.
 void addRoleMapping(java.lang.String role, java.lang.String link)
          Add a security role reference for this web application.
 void addSecurityRole(java.lang.String role)
          Add a new security role for this web application.
 void addServletMapping(java.lang.String pattern, java.lang.String name)
          Add a new servlet mapping, replacing any existing mapping for the specified pattern.
 void addTaglib(java.lang.String uri, java.lang.String location)
          Add a JSP tag library for the specified URI.
 void addWelcomeFile(java.lang.String name)
          Add a new welcome file to the set recognized by this Context.
 void addWrapperLifecycle(java.lang.String listener)
          Add the classname of a LifecycleListener to be added to each Wrapper appended to this Context.
 void addWrapperListener(java.lang.String listener)
          Add the classname of a ContainerListener to be added to each Wrapper appended to this Context.
protected  java.lang.String adjustURLPattern(java.lang.String urlPattern)
          Adjust the URL pattern to begin with a leading slash, if appropriate (i.e. we are running a servlet 2.2 application).
 Wrapper createWrapper()
          Factory method to create and return a new Wrapper instance, of the Java implementation class appropriate for this Context implementation.
protected  java.io.File engineBase()
          Return a File object representing the base directory for the entire servlet container (i.e. the Engine container if present).
 boolean filterStart()
          Configure and initialize the set of filters for this Context.
 boolean filterStop()
          Finalize and release the set of filters for this Context.
 java.lang.String[] findApplicationListeners()
          Return the set of application listener class names configured for this application.
 ApplicationParameter[] findApplicationParameters()
          Return the set of application parameters for this application.
 SecurityConstraint[] findConstraints()
          Return the security constraints for this web application.
 ContextEjb findEjb(java.lang.String name)
          Return the EJB resource reference with the specified name, if any; otherwise, return null.
 ContextEjb[] findEjbs()
          Return the defined EJB resource references for this application.
 ContextEnvironment findEnvironment(java.lang.String name)
          Return the environment entry with the specified name, if any; otherwise, return null.
 ContextEnvironment[] findEnvironments()
          Return the set of defined environment entries for this web application.
 ErrorPage findErrorPage(int errorCode)
          Return the error page entry for the specified HTTP error code, if any; otherwise return null.
 ErrorPage findErrorPage(java.lang.String exceptionType)
          Return the error page entry for the specified Java exception type, if any; otherwise return null.
 ErrorPage[] findErrorPages()
          Return the set of defined error pages for all specified error codes and exception types.
 javax.servlet.FilterConfig findFilterConfig(java.lang.String name)
          Find and return the initialized FilterConfig for the specified filter name, if any; otherwise return null.
 FilterDef findFilterDef(java.lang.String filterName)
          Return the filter definition for the specified filter name, if any; otherwise return null.
 FilterDef[] findFilterDefs()
          Return the set of defined filters for this Context.
 FilterMap[] findFilterMaps()
          Return the set of filter mappings for this Context.
 java.lang.String[] findInstanceListeners()
          Return the set of InstanceListener classes that will be added to newly created Wrappers automatically.
 ContextLocalEjb findLocalEjb(java.lang.String name)
          Return the local EJB resource reference with the specified name, if any; otherwise, return null.
 ContextLocalEjb[] findLocalEjbs()
          Return the defined local EJB resource references for this application.
 java.lang.String findMimeMapping(java.lang.String extension)
          Return the MIME type to which the specified extension is mapped, if any; otherwise return null.
 java.lang.String[] findMimeMappings()
          Return the extensions for which MIME mappings are defined.
 java.lang.String findParameter(java.lang.String name)
          Return the value for the specified context initialization parameter name, if any; otherwise return null.
 java.lang.String[] findParameters()
          Return the names of all defined context initialization parameters for this Context.
 ContextResource findResource(java.lang.String name)
          Return the resource reference with the specified name, if any; otherwise return null.
 java.lang.String findResourceEnvRef(java.lang.String name)
          Return the resource environment reference type for the specified name, if any; otherwise return null.
 java.lang.String[] findResourceEnvRefs()
          Return the set of resource environment reference names for this web application.
 ContextResource[] findResources()
          Return the defined resource references for this application.
 java.lang.String findRoleMapping(java.lang.String role)
          For the given security role (as used by an application), return the corresponding role name (as defined by the underlying Realm) if there is one.
 boolean findSecurityRole(java.lang.String role)
          Return true if the specified security role is defined for this application; otherwise return false.
 java.lang.String[] findSecurityRoles()
          Return the security roles defined for this application.
 java.lang.String findServletMapping(java.lang.String pattern)
          Return the servlet name mapped by the specified pattern (if any); otherwise return null.
 java.lang.String[] findServletMappings()
          Return the patterns of all defined servlet mappings for this Context.
 java.lang.String findStatusPage(int status)
          Return the context-relative URI of the error page for the specified HTTP status code, if any; otherwise return null.
 int[] findStatusPages()
          Return the set of HTTP status codes for which error pages have been specified.
 java.lang.String findTaglib(java.lang.String uri)
          Return the tag library descriptor location for the specified taglib URI, if any; otherwise, return null.
 java.lang.String[] findTaglibs()
          Return the URIs of all tag libraries for which a tag library descriptor location has been specified.
 boolean findWelcomeFile(java.lang.String name)
          Return true if the specified welcome file is defined for this Context; otherwise return false.
 java.lang.String[] findWelcomeFiles()
          Return the set of welcome files defined for this Context.
 java.lang.String[] findWrapperLifecycles()
          Return the set of LifecycleListener classes that will be added to newly created Wrappers automatically.
 java.lang.String[] findWrapperListeners()
          Return the set of ContainerListener classes that will be added to newly created Wrappers automatically.
 java.lang.Object[] getApplicationListeners()
          Return the set of initialized application listener objects, in the order they were specified in the web application deployment descriptor, for this application.
 boolean getAvailable()
          Return the application available flag for this Context.
 CharsetMapper getCharsetMapper()
          Return the Locale to character set mapper for this Context.
 java.lang.String getCharsetMapperClass()
          Return the Locale to character set mapper class for this Context.
 boolean getConfigured()
          Return the "correctly configured" flag for this Context.
 boolean getCookies()
          Return the "use cookies for session ids" flag.
 boolean getCrossContext()
          Return the "allow crossing servlet contexts" flag.
 java.lang.String getDisplayName()
          Return the display name of this web application.
 boolean getDistributable()
          Return the distributable flag for this web application.
 java.lang.String getDocBase()
          Return the document root for this Context.
 java.lang.String getInfo()
          Return descriptive information about this Container implementation and the corresponding version number, in the format <description>/<version>.
 LoginConfig getLoginConfig()
          Return the login configuration descriptor for this web application.
 java.lang.String getMapperClass()
          Return the default Mapper class name.
 boolean getOverride()
          Return the DefaultContext override flag for this web application.
 java.lang.String getPath()
          Return the context path for this Context.
 boolean getPrivileged()
          Return the privileged flag for this web application.
 java.lang.String getPublicId()
          Return the public identifier of the deployment descriptor DTD that is currently being parsed.
 boolean getReloadable()
          Return the reloadable flag for this web application.
 javax.servlet.ServletContext getServletContext()
          Return the servlet context for which this Context is a facade.
 int getSessionTimeout()
          Return the default session timeout (in minutes) for this web application.
 java.lang.String getWorkDir()
          Return the work directory for this Context.
 java.lang.String getWrapperClass()
          Return the Java class name of the Wrapper implementation used for servlets registered in this Context.
 void invoke(Request request, Response response)
          Process the specified Request, and generate the corresponding Response, according to the design of this particular Container.
 boolean isCachingAllowed()
          Is caching allowed ?
 boolean isFilesystemBased()
          Returns true if the resources associated with this context are filesystem based.
 boolean isReplaceWelcomeFiles()
          Return the "replace welcome files" property.
protected  boolean isServlet22()
          Are we processing a version 2.2 deployment descriptor?
 boolean isUseNaming()
          Returns true if the internal naming support is used.
 boolean listenerStart()
          Configure the set of instantiated application event listeners for this Context.
 boolean listenerStop()
          Send an application stop event to all interested listeners.
 void loadOnStartup(Container[] children)
          Load and initialize all servlets marked "load on startup" in the web application deployment descriptor.
 void reload()
          Reload this web application, if reloading is supported.
 void removeApplicationListener(java.lang.String listener)
          Remove the specified application listener class from the set of listeners for this application.
 void removeApplicationParameter(java.lang.String name)
          Remove the application parameter with the specified name from the set for this application.
 void removeConstraint(SecurityConstraint constraint)
          Remove the specified security constraint from this web application.
 void removeEjb(java.lang.String name)
          Remove any EJB resource reference with the specified name.
 void removeEnvironment(java.lang.String name)
          Remove any environment entry with the specified name.
 void removeErrorPage(ErrorPage errorPage)
          Remove the error page for the specified error code or Java language exception, if it exists; otherwise, no action is taken.
 void removeFilterDef(FilterDef filterDef)
          Remove the specified filter definition from this Context, if it exists; otherwise, no action is taken.
 void removeFilterMap(FilterMap filterMap)
          Remove a filter mapping from this Context.
 void removeInstanceListener(java.lang.String listener)
          Remove a class name from the set of InstanceListener classes that will be added to newly created Wrappers.
 void removeLocalEjb(java.lang.String name)
          Remove any local EJB resource reference with the specified name.
 void removeMimeMapping(java.lang.String extension)
          Remove the MIME mapping for the specified extension, if it exists; otherwise, no action is taken.
 void removeParameter(java.lang.String name)
          Remove the context initialization parameter with the specified name, if it exists; otherwise, no action is taken.
 void removeResource(java.lang.String name)
          Remove any resource reference with the specified name.
 void removeResourceEnvRef(java.lang.String name)
          Remove any resource environment reference with the specified name.
 void removeRoleMapping(java.lang.String role)
          Remove any security role reference for the specified name
 void removeSecurityRole(java.lang.String role)
          Remove any security role with the specified name.
 void removeServletMapping(java.lang.String pattern)
          Remove any servlet mapping for the specified pattern, if it exists; otherwise, no action is taken.
 void removeTaglib(java.lang.String uri)
          Remove the tag library location forthe specified tag library URI.
 void removeWelcomeFile(java.lang.String name)
          Remove the specified welcome file name from the list recognized by this Context.
 void removeWrapperLifecycle(java.lang.String listener)
          Remove a class name from the set of LifecycleListener classes that will be added to newly created Wrappers.
 void removeWrapperListener(java.lang.String listener)
          Remove a class name from the set of ContainerListener classes that will be added to newly created Wrappers.
 void setApplicationListeners(java.lang.Object[] listeners)
          Store the set of initialized application listener objects, in the order they were specified in the web application deployment descriptor, for this application.
 void setAvailable(boolean available)
          Set the application available flag for this Context.
 void setCachingAllowed(boolean cachingAllowed)
          Set caching allowed flag.
 void setCharsetMapper(CharsetMapper mapper)
          Set the Locale to character set mapper for this Context.
 void setCharsetMapperClass(java.lang.String mapper)
          Set the Locale to character set mapper class for this Context.
 void setConfigured(boolean configured)
          Set the "correctly configured" flag for this Context.
 void setCookies(boolean cookies)
          Set the "use cookies for session ids" flag.
 void setCrossContext(boolean crossContext)
          Set the "allow crossing servlet contexts" flag.
 void setDisplayName(java.lang.String displayName)
          Set the display name of this web application.
 void setDistributable(boolean distributable)
          Set the distributable flag for this web application.
 void setDocBase(java.lang.String docBase)
          Set the document root for this Context.
 void setLoader(Loader loader)
          Set the Loader with which this Context is associated.
 void setLoginConfig(LoginConfig config)
          Set the login configuration descriptor for this web application.
 void setMapperClass(java.lang.String mapperClass)
          Set the default Mapper class name.
 void setOverride(boolean override)
          Set the DefaultContext override flag for this web application.
 void setPath(java.lang.String path)
          Set the context path for this Context.
 void setPrivileged(boolean privileged)
          Set the privileged flag for this web application.
 void setPublicId(java.lang.String publicId)
          Set the public identifier of the deployment descriptor DTD that is currently being parsed.
 void setReloadable(boolean reloadable)
          Set the reloadable flag for this web application.
 void setReplaceWelcomeFiles(boolean replaceWelcomeFiles)
          Set the "replace welcome files" property.
 void setResources(javax.naming.directory.DirContext resources)
          Set the resources DirContext object with which this Container is associated.
 void setSessionTimeout(int timeout)
          Set the default session timeout (in minutes) for this web application.
 void setUseNaming(boolean useNaming)
          Enables or disables naming.
 void setWorkDir(java.lang.String workDir)
          Set the work directory for this Context.
 void setWrapperClass(java.lang.String wrapperClass)
          Set the Java class name of the Wrapper implementation used for servlets registered in this Context.
 void start()
          Start this Context component.
 void stop()
          Stop this Context component.
 java.lang.String toString()
          Return a String representation of this component.
 
クラス org.apache.catalina.core.ContainerBase から継承したメソッド
addContainerListener, addLifecycleListener, addMapper, addPropertyChangeListener, addValve, findChild, findChildren, findMapper, findMappers, fireContainerEvent, getBasic, getCluster, getDebug, getLoader, getLogger, getManager, getName, getParent, getParentClassLoader, getPipeline, getRealm, getResources, getValves, log, log, logName, map, removeChild, removeContainerListener, removeLifecycleListener, removeMapper, removePropertyChangeListener, removeValve, setBasic, setCluster, setDebug, setLogger, setManager, setName, setParent, setParentClassLoader, setRealm
 
クラス java.lang.Object から継承したメソッド
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
インタフェース org.apache.catalina.Container から継承したメソッド
addContainerListener, addMapper, addPropertyChangeListener, findChild, findChildren, findMapper, findMappers, getCluster, getLoader, getLogger, getManager, getName, getParent, getParentClassLoader, getRealm, getResources, map, removeChild, removeContainerListener, removeMapper, removePropertyChangeListener, setCluster, setLogger, setManager, setName, setParent, setParentClassLoader, setRealm
 

フィールドの詳細

cachingAllowed

protected boolean cachingAllowed
Caching allowed flag.
コンストラクタの詳細

StandardContext

public StandardContext()
Create a new StandardContext component with the default basic Valve.
メソッドの詳細

isCachingAllowed

public boolean isCachingAllowed()
Is caching allowed ?

setCachingAllowed

public void setCachingAllowed(boolean cachingAllowed)
Set caching allowed flag.

isUseNaming

public boolean isUseNaming()
Returns true if the internal naming support is used.

setUseNaming

public void setUseNaming(boolean useNaming)
Enables or disables naming.

isFilesystemBased

public boolean isFilesystemBased()
Returns true if the resources associated with this context are filesystem based.

getApplicationListeners

public java.lang.Object[] getApplicationListeners()
Return the set of initialized application listener objects, in the order they were specified in the web application deployment descriptor, for this application.
定義:
インタフェース Context 内の getApplicationListeners
例外:
java.lang.IllegalStateException - if this method is called before this application has started, or after it has been stopped

setApplicationListeners

public void setApplicationListeners(java.lang.Object[] listeners)
Store the set of initialized application listener objects, in the order they were specified in the web application deployment descriptor, for this application.
定義:
インタフェース Context 内の setApplicationListeners
パラメータ:
listeners - The set of instantiated listener objects.

getAvailable

public boolean getAvailable()
Return the application available flag for this Context.
定義:
インタフェース Context 内の getAvailable

setAvailable

public void setAvailable(boolean available)
Set the application available flag for this Context.
定義:
インタフェース Context 内の setAvailable
パラメータ:
available - The new application available flag

getCharsetMapper

public CharsetMapper getCharsetMapper()
Return the Locale to character set mapper for this Context.
定義:
インタフェース Context 内の getCharsetMapper

setCharsetMapper

public void setCharsetMapper(CharsetMapper mapper)
Set the Locale to character set mapper for this Context.
定義:
インタフェース Context 内の setCharsetMapper
パラメータ:
mapper - The new mapper

getConfigured

public boolean getConfigured()
Return the "correctly configured" flag for this Context.
定義:
インタフェース Context 内の getConfigured

setConfigured

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.
定義:
インタフェース Context 内の setConfigured
パラメータ:
configured - The new correctly configured flag

getCookies

public boolean getCookies()
Return the "use cookies for session ids" flag.
定義:
インタフェース Context 内の getCookies

setCookies

public void setCookies(boolean cookies)
Set the "use cookies for session ids" flag.
定義:
インタフェース Context 内の setCookies
パラメータ:
cookies - The new flag

getCrossContext

public boolean getCrossContext()
Return the "allow crossing servlet contexts" flag.
定義:
インタフェース Context 内の getCrossContext

setCrossContext

public void setCrossContext(boolean crossContext)
Set the "allow crossing servlet contexts" flag.
定義:
インタフェース Context 内の setCrossContext
パラメータ:
crossContext - The new cross contexts flag

getDisplayName

public java.lang.String getDisplayName()
Return the display name of this web application.
定義:
インタフェース Context 内の getDisplayName

setDisplayName

public void setDisplayName(java.lang.String displayName)
Set the display name of this web application.
定義:
インタフェース Context 内の setDisplayName
パラメータ:
displayName - The new display name

getDistributable

public boolean getDistributable()
Return the distributable flag for this web application.
定義:
インタフェース Context 内の getDistributable

setDistributable

public void setDistributable(boolean distributable)
Set the distributable flag for this web application.
定義:
インタフェース Context 内の setDistributable
パラメータ:
distributable - The new distributable flag

getDocBase

public java.lang.String getDocBase()
Return the document root for this Context. This can be an absolute pathname, a relative pathname, or a URL.
定義:
インタフェース Context 内の getDocBase

setDocBase

public void setDocBase(java.lang.String docBase)
Set the document root for this Context. This can be an absolute pathname, a relative pathname, or a URL.
定義:
インタフェース Context 内の setDocBase
パラメータ:
docBase - The new document root

getInfo

public java.lang.String getInfo()
Return descriptive information about this Container implementation and the corresponding version number, in the format <description>/<version>.
定義:
インタフェース Container 内の getInfo
オーバーライド:
クラス ContainerBase 内の getInfo

setLoader

public void setLoader(Loader loader)
Set the Loader with which this Context is associated.
定義:
インタフェース Container 内の setLoader
オーバーライド:
クラス ContainerBase 内の setLoader
パラメータ:
loader - The newly associated loader

getLoginConfig

public LoginConfig getLoginConfig()
Return the login configuration descriptor for this web application.
定義:
インタフェース Context 内の getLoginConfig

setLoginConfig

public void setLoginConfig(LoginConfig config)
Set the login configuration descriptor for this web application.
定義:
インタフェース Context 内の setLoginConfig
パラメータ:
config - The new login configuration

getPath

public java.lang.String getPath()
Return the context path for this Context.
定義:
インタフェース Context 内の getPath

setPath

public void setPath(java.lang.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.

定義:
インタフェース Context 内の setPath
パラメータ:
path - The new context path

getPublicId

public java.lang.String getPublicId()
Return the public identifier of the deployment descriptor DTD that is currently being parsed.
定義:
インタフェース Context 内の getPublicId

setPublicId

public void setPublicId(java.lang.String publicId)
Set the public identifier of the deployment descriptor DTD that is currently being parsed.
定義:
インタフェース Context 内の setPublicId
パラメータ:
publicId - The public identifier

getReloadable

public boolean getReloadable()
Return the reloadable flag for this web application.
定義:
インタフェース Context 内の getReloadable

getOverride

public boolean getOverride()
Return the DefaultContext override flag for this web application.
定義:
インタフェース Context 内の getOverride

setReloadable

public void setReloadable(boolean reloadable)
Set the reloadable flag for this web application.
定義:
インタフェース Context 内の setReloadable
パラメータ:
reloadable - The new reloadable flag

setOverride

public void setOverride(boolean override)
Set the DefaultContext override flag for this web application.
定義:
インタフェース Context 内の setOverride
パラメータ:
override - The new override flag

getPrivileged

public boolean getPrivileged()
Return the privileged flag for this web application.
定義:
インタフェース Context 内の getPrivileged

setPrivileged

public void setPrivileged(boolean privileged)
Set the privileged flag for this web application.
定義:
インタフェース Context 内の setPrivileged
パラメータ:
privileged - The new privileged flag

isReplaceWelcomeFiles

public boolean isReplaceWelcomeFiles()
Return the "replace welcome files" property.

setReplaceWelcomeFiles

public void setReplaceWelcomeFiles(boolean replaceWelcomeFiles)
Set the "replace welcome files" property.
パラメータ:
replaceWelcomeFiles - The new property value

getServletContext

public javax.servlet.ServletContext getServletContext()
Return the servlet context for which this Context is a facade.
定義:
インタフェース Context 内の getServletContext

getSessionTimeout

public int getSessionTimeout()
Return the default session timeout (in minutes) for this web application.
定義:
インタフェース Context 内の getSessionTimeout

setSessionTimeout

public void setSessionTimeout(int timeout)
Set the default session timeout (in minutes) for this web application.
定義:
インタフェース Context 内の setSessionTimeout
パラメータ:
timeout - The new default session timeout

getWrapperClass

public java.lang.String getWrapperClass()
Return the Java class name of the Wrapper implementation used for servlets registered in this Context.
定義:
インタフェース Context 内の getWrapperClass

setWrapperClass

public void setWrapperClass(java.lang.String wrapperClass)
Set the Java class name of the Wrapper implementation used for servlets registered in this Context.
定義:
インタフェース Context 内の setWrapperClass
パラメータ:
wrapperClass - The new wrapper class

setResources

public void setResources(javax.naming.directory.DirContext resources)
Set the resources DirContext object with which this Container is associated.
定義:
インタフェース Container 内の setResources
オーバーライド:
クラス ContainerBase 内の setResources
パラメータ:
resources - The newly associated DirContext

getCharsetMapperClass

public java.lang.String getCharsetMapperClass()
Return the Locale to character set mapper class for this Context.

setCharsetMapperClass

public void setCharsetMapperClass(java.lang.String mapper)
Set the Locale to character set mapper class for this Context.
パラメータ:
mapper - The new mapper class

getMapperClass

public java.lang.String getMapperClass()
Return the default Mapper class name.

setMapperClass

public void setMapperClass(java.lang.String mapperClass)
Set the default Mapper class name.
パラメータ:
mapperClass - The new default Mapper class name

getWorkDir

public java.lang.String getWorkDir()
Return the work directory for this Context.

setWorkDir

public void setWorkDir(java.lang.String workDir)
Set the work directory for this Context.
パラメータ:
workDir - The new work directory

addApplicationListener

public void addApplicationListener(java.lang.String listener)
Add a new Listener class name to the set of Listeners configured for this application.
定義:
インタフェース Context 内の addApplicationListener
パラメータ:
listener - Java class name of a listener class

addApplicationParameter

public void addApplicationParameter(ApplicationParameter parameter)
Add a new application parameter for this application.
定義:
インタフェース Context 内の addApplicationParameter
パラメータ:
parameter - The new application parameter

addChild

public void addChild(Container child)
Add a child Container, only if the proposed child is an implementation of Wrapper.
定義:
インタフェース Container 内の addChild
オーバーライド:
クラス ContainerBase 内の addChild
パラメータ:
child - Child container to be added
例外:
java.lang.IllegalArgumentException - if the proposed container is not an implementation of Wrapper

addConstraint

public void addConstraint(SecurityConstraint constraint)
Add a security constraint to the set for this web application.
定義:
インタフェース Context 内の addConstraint

addEjb

public void addEjb(ContextEjb ejb)
Add an EJB resource reference for this web application.
定義:
インタフェース Context 内の addEjb
パラメータ:
ejb - New EJB resource reference

addEnvironment

public void addEnvironment(ContextEnvironment environment)
Add an environment entry for this web application.
定義:
インタフェース Context 内の addEnvironment
パラメータ:
environment - New environment entry

addResourceParams

public void addResourceParams(ResourceParams resourceParameters)
Add resource parameters for this web application.
パラメータ:
resourceParameters - New resource parameters

addErrorPage

public void addErrorPage(ErrorPage errorPage)
Add an error page for the specified error or Java exception.
定義:
インタフェース Context 内の addErrorPage
パラメータ:
errorPage - The error page definition to be added

addFilterDef

public void addFilterDef(FilterDef filterDef)
Add a filter definition to this Context.
定義:
インタフェース Context 内の addFilterDef
パラメータ:
filterDef - The filter definition to be added

addFilterMap

public void addFilterMap(FilterMap filterMap)
Add a filter mapping to this Context.
定義:
インタフェース Context 内の addFilterMap
パラメータ:
filterMap - The filter mapping to be added
例外:
java.lang.IllegalArgumentException - if the specified filter name does not match an existing filter definition, or the filter mapping is malformed

addInstanceListener

public void addInstanceListener(java.lang.String listener)
Add the classname of an InstanceListener to be added to each Wrapper appended to this Context.
定義:
インタフェース Context 内の addInstanceListener
パラメータ:
listener - Java class name of an InstanceListener class

addLocalEjb

public void addLocalEjb(ContextLocalEjb ejb)
Add a local EJB resource reference for this web application.
定義:
インタフェース Context 内の addLocalEjb
パラメータ:
ejb - New EJB resource reference

addMimeMapping

public void addMimeMapping(java.lang.String extension,
                           java.lang.String mimeType)
Add a new MIME mapping, replacing any existing mapping for the specified extension.
定義:
インタフェース Context 内の addMimeMapping
パラメータ:
extension - Filename extension being mapped
mimeType - Corresponding MIME type

addParameter

public void addParameter(java.lang.String name,
                         java.lang.String value)
Add a new context initialization parameter.
定義:
インタフェース Context 内の addParameter
パラメータ:
name - Name of the new parameter
value - Value of the new parameter
例外:
java.lang.IllegalArgumentException - if the name or value is missing, or if this context initialization parameter has already been registered

addResource

public void addResource(ContextResource resource)
Add a resource reference for this web application.
定義:
インタフェース Context 内の addResource
パラメータ:
resource - New resource reference

addResourceEnvRef

public void addResourceEnvRef(java.lang.String name,
                              java.lang.String type)
Add a resource environment reference for this web application.
定義:
インタフェース Context 内の addResourceEnvRef
パラメータ:
name - The resource environment reference name
type - The resource environment reference type

addRoleMapping

public void addRoleMapping(java.lang.String role,
                           java.lang.String link)
Add a security role reference for this web application.
定義:
インタフェース Context 内の addRoleMapping
パラメータ:
role - Security role used in the application
link - Actual security role to check for

addSecurityRole

public void addSecurityRole(java.lang.String role)
Add a new security role for this web application.
定義:
インタフェース Context 内の addSecurityRole
パラメータ:
role - New security role

addServletMapping

public void addServletMapping(java.lang.String pattern,
                              java.lang.String name)
Add a new servlet mapping, replacing any existing mapping for the specified pattern.
定義:
インタフェース Context 内の addServletMapping
パラメータ:
pattern - URL pattern to be mapped
name - Name of the corresponding servlet to execute
例外:
java.lang.IllegalArgumentException - if the specified servlet name is not known to this Context

addTaglib

public void addTaglib(java.lang.String uri,
                      java.lang.String location)
Add a JSP tag library for the specified URI.
定義:
インタフェース Context 内の addTaglib
パラメータ:
uri - URI, relative to the web.xml file, of this tag library
location - Location of the tag library descriptor

addWelcomeFile

public void addWelcomeFile(java.lang.String name)
Add a new welcome file to the set recognized by this Context.
定義:
インタフェース Context 内の addWelcomeFile
パラメータ:
name - New welcome file name

addWrapperLifecycle

public void addWrapperLifecycle(java.lang.String listener)
Add the classname of a LifecycleListener to be added to each Wrapper appended to this Context.
定義:
インタフェース Context 内の addWrapperLifecycle
パラメータ:
listener - Java class name of a LifecycleListener class

addWrapperListener

public void addWrapperListener(java.lang.String listener)
Add the classname of a ContainerListener to be added to each Wrapper appended to this Context.
定義:
インタフェース Context 内の addWrapperListener
パラメータ:
listener - Java class name of a ContainerListener class

createWrapper

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.
定義:
インタフェース Context 内の createWrapper

findApplicationListeners

public java.lang.String[] findApplicationListeners()
Return the set of application listener class names configured for this application.
定義:
インタフェース Context 内の findApplicationListeners

findApplicationParameters

public ApplicationParameter[] findApplicationParameters()
Return the set of application parameters for this application.
定義:
インタフェース Context 内の findApplicationParameters

findConstraints

public SecurityConstraint[] findConstraints()
Return the security constraints for this web application. If there are none, a zero-length array is returned.
定義:
インタフェース Context 内の findConstraints

findEjb

public ContextEjb findEjb(java.lang.String name)
Return the EJB resource reference with the specified name, if any; otherwise, return null.
定義:
インタフェース Context 内の findEjb
パラメータ:
name - Name of the desired EJB resource reference

findEjbs

public ContextEjb[] findEjbs()
Return the defined EJB resource references for this application. If there are none, a zero-length array is returned.
定義:
インタフェース Context 内の findEjbs

findEnvironment

public ContextEnvironment findEnvironment(java.lang.String name)
Return the environment entry with the specified name, if any; otherwise, return null.
定義:
インタフェース Context 内の findEnvironment
パラメータ:
name - Name of the desired environment entry

findEnvironments

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.
定義:
インタフェース Context 内の findEnvironments

findErrorPage

public ErrorPage findErrorPage(int errorCode)
Return the error page entry for the specified HTTP error code, if any; otherwise return null.
定義:
インタフェース Context 内の findErrorPage
パラメータ:
errorCode - Error code to look up

findErrorPage

public ErrorPage findErrorPage(java.lang.String exceptionType)
Return the error page entry for the specified Java exception type, if any; otherwise return null.
定義:
インタフェース Context 内の findErrorPage
パラメータ:
exceptionType - Exception type to look up

findErrorPages

public ErrorPage[] findErrorPages()
Return the set of defined error pages for all specified error codes and exception types.
定義:
インタフェース Context 内の findErrorPages

findFilterDef

public FilterDef findFilterDef(java.lang.String filterName)
Return the filter definition for the specified filter name, if any; otherwise return null.
定義:
インタフェース Context 内の findFilterDef
パラメータ:
filterName - Filter name to look up

findFilterDefs

public FilterDef[] findFilterDefs()
Return the set of defined filters for this Context.
定義:
インタフェース Context 内の findFilterDefs

findFilterMaps

public FilterMap[] findFilterMaps()
Return the set of filter mappings for this Context.
定義:
インタフェース Context 内の findFilterMaps

findInstanceListeners

public java.lang.String[] findInstanceListeners()
Return the set of InstanceListener classes that will be added to newly created Wrappers automatically.
定義:
インタフェース Context 内の findInstanceListeners

findLocalEjb

public ContextLocalEjb findLocalEjb(java.lang.String name)
Return the local EJB resource reference with the specified name, if any; otherwise, return null.
定義:
インタフェース Context 内の findLocalEjb
パラメータ:
name - Name of the desired EJB resource reference

findLocalEjbs

public ContextLocalEjb[] findLocalEjbs()
Return the defined local EJB resource references for this application. If there are none, a zero-length array is returned.
定義:
インタフェース Context 内の findLocalEjbs

findMimeMapping

public java.lang.String findMimeMapping(java.lang.String extension)
Return the MIME type to which the specified extension is mapped, if any; otherwise return null.
定義:
インタフェース Context 内の findMimeMapping
パラメータ:
extension - Extension to map to a MIME type

findMimeMappings

public java.lang.String[] findMimeMappings()
Return the extensions for which MIME mappings are defined. If there are none, a zero-length array is returned.
定義:
インタフェース Context 内の findMimeMappings

findParameter

public java.lang.String findParameter(java.lang.String name)
Return the value for the specified context initialization parameter name, if any; otherwise return null.
定義:
インタフェース Context 内の findParameter
パラメータ:
name - Name of the parameter to return

findParameters

public java.lang.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.
定義:
インタフェース Context 内の findParameters

findResource

public ContextResource findResource(java.lang.String name)
Return the resource reference with the specified name, if any; otherwise return null.
定義:
インタフェース Context 内の findResource
パラメータ:
name - Name of the desired resource reference

findResourceEnvRef

public java.lang.String findResourceEnvRef(java.lang.String name)
Return the resource environment reference type for the specified name, if any; otherwise return null.
定義:
インタフェース Context 内の findResourceEnvRef
パラメータ:
name - Name of the desired resource environment reference

findResourceEnvRefs

public java.lang.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.
定義:
インタフェース Context 内の findResourceEnvRefs

findResources

public ContextResource[] findResources()
Return the defined resource references for this application. If none have been defined, a zero-length array is returned.
定義:
インタフェース Context 内の findResources

findRoleMapping

public java.lang.String findRoleMapping(java.lang.String role)
For the given security role (as used by an application), return the corresponding role name (as defined by the underlying Realm) if there is one. Otherwise, return the specified role unchanged.
定義:
インタフェース Context 内の findRoleMapping
パラメータ:
role - Security role to map

findSecurityRole

public boolean findSecurityRole(java.lang.String role)
Return true if the specified security role is defined for this application; otherwise return false.
定義:
インタフェース Context 内の findSecurityRole
パラメータ:
role - Security role to verify

findSecurityRoles

public java.lang.String[] findSecurityRoles()
Return the security roles defined for this application. If none have been defined, a zero-length array is returned.
定義:
インタフェース Context 内の findSecurityRoles

findServletMapping

public java.lang.String findServletMapping(java.lang.String pattern)
Return the servlet name mapped by the specified pattern (if any); otherwise return null.
定義:
インタフェース Context 内の findServletMapping
パラメータ:
pattern - Pattern for which a mapping is requested

findServletMappings

public java.lang.String[] findServletMappings()
Return the patterns of all defined servlet mappings for this Context. If no mappings are defined, a zero-length array is returned.
定義:
インタフェース Context 内の findServletMappings

findStatusPage

public java.lang.String findStatusPage(int status)
Return the context-relative URI of the error page for the specified HTTP status code, if any; otherwise return null.
定義:
インタフェース Context 内の findStatusPage
パラメータ:
status - HTTP status code to look up

findStatusPages

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.
定義:
インタフェース Context 内の findStatusPages

findTaglib

public java.lang.String findTaglib(java.lang.String uri)
Return the tag library descriptor location for the specified taglib URI, if any; otherwise, return null.
定義:
インタフェース Context 内の findTaglib
パラメータ:
uri - URI, relative to the web.xml file

findTaglibs

public java.lang.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.
定義:
インタフェース Context 内の findTaglibs

findWelcomeFile

public boolean findWelcomeFile(java.lang.String name)
Return true if the specified welcome file is defined for this Context; otherwise return false.
定義:
インタフェース Context 内の findWelcomeFile
パラメータ:
name - Welcome file to verify

findWelcomeFiles

public java.lang.String[] findWelcomeFiles()
Return the set of welcome files defined for this Context. If none are defined, a zero-length array is returned.
定義:
インタフェース Context 内の findWelcomeFiles

findWrapperLifecycles

public java.lang.String[] findWrapperLifecycles()
Return the set of LifecycleListener classes that will be added to newly created Wrappers automatically.
定義:
インタフェース Context 内の findWrapperLifecycles

findWrapperListeners

public java.lang.String[] findWrapperListeners()
Return the set of ContainerListener classes that will be added to newly created Wrappers automatically.
定義:
インタフェース Context 内の findWrapperListeners

invoke

public void invoke(Request request,
                   Response response)
            throws java.io.IOException,
                   javax.servlet.ServletException
Process the specified Request, and generate the corresponding Response, according to the design of this particular Container.
定義:
インタフェース Container 内の invoke
オーバーライド:
クラス ContainerBase 内の invoke
パラメータ:
request - Request to be processed
response - Response to be produced
例外:
java.io.IOException - if an input/output error occurred while processing
javax.servlet.ServletException - if a ServletException was thrown while processing this request

reload

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.

定義:
インタフェース Context 内の reload
例外:
java.lang.IllegalStateException - if the reloadable property is set to false.

removeApplicationListener

public void removeApplicationListener(java.lang.String listener)
Remove the specified application listener class from the set of listeners for this application.
定義:
インタフェース Context 内の removeApplicationListener
パラメータ:
listener - Java class name of the listener to be removed

removeApplicationParameter

public void removeApplicationParameter(java.lang.String name)
Remove the application parameter with the specified name from the set for this application.
定義:
インタフェース Context 内の removeApplicationParameter
パラメータ:
name - Name of the application parameter to remove

removeConstraint

public void removeConstraint(SecurityConstraint constraint)
Remove the specified security constraint from this web application.
定義:
インタフェース Context 内の removeConstraint
パラメータ:
constraint - Constraint to be removed

removeEjb

public void removeEjb(java.lang.String name)
Remove any EJB resource reference with the specified name.
定義:
インタフェース Context 内の removeEjb
パラメータ:
name - Name of the EJB resource reference to remove

removeEnvironment

public void removeEnvironment(java.lang.String name)
Remove any environment entry with the specified name.
定義:
インタフェース Context 内の removeEnvironment
パラメータ:
name - Name of the environment entry to remove

removeErrorPage

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.
定義:
インタフェース Context 内の removeErrorPage
パラメータ:
errorPage - The error page definition to be removed

removeFilterDef

public void removeFilterDef(FilterDef filterDef)
Remove the specified filter definition from this Context, if it exists; otherwise, no action is taken.
定義:
インタフェース Context 内の removeFilterDef
パラメータ:
filterDef - Filter definition to be removed

removeFilterMap

public void removeFilterMap(FilterMap filterMap)
Remove a filter mapping from this Context.
定義:
インタフェース Context 内の removeFilterMap
パラメータ:
filterMap - The filter mapping to be removed

removeInstanceListener

public void removeInstanceListener(java.lang.String listener)
Remove a class name from the set of InstanceListener classes that will be added to newly created Wrappers.
定義:
インタフェース Context 内の removeInstanceListener
パラメータ:
listener - Class name of an InstanceListener class to be removed

removeLocalEjb

public void removeLocalEjb(java.lang.String name)
Remove any local EJB resource reference with the specified name.
定義:
インタフェース Context 内の removeLocalEjb
パラメータ:
name - Name of the EJB resource reference to remove

removeMimeMapping

public void removeMimeMapping(java.lang.String extension)
Remove the MIME mapping for the specified extension, if it exists; otherwise, no action is taken.
定義:
インタフェース Context 内の removeMimeMapping
パラメータ:
extension - Extension to remove the mapping for

removeParameter

public void removeParameter(java.lang.String name)
Remove the context initialization parameter with the specified name, if it exists; otherwise, no action is taken.
定義:
インタフェース Context 内の removeParameter
パラメータ:
name - Name of the parameter to remove

removeResource

public void removeResource(java.lang.String name)
Remove any resource reference with the specified name.
定義:
インタフェース Context 内の removeResource
パラメータ:
name - Name of the resource reference to remove

removeResourceEnvRef

public void removeResourceEnvRef(java.lang.String name)
Remove any resource environment reference with the specified name.
定義:
インタフェース Context 内の removeResourceEnvRef
パラメータ:
name - Name of the resource environment reference to remove

removeRoleMapping

public void removeRoleMapping(java.lang.String role)
Remove any security role reference for the specified name
定義:
インタフェース Context 内の removeRoleMapping
パラメータ:
role - Security role (as used in the application) to remove

removeSecurityRole

public void removeSecurityRole(java.lang.String role)
Remove any security role with the specified name.
定義:
インタフェース Context 内の removeSecurityRole
パラメータ:
role - Security role to remove

removeServletMapping

public void removeServletMapping(java.lang.String pattern)
Remove any servlet mapping for the specified pattern, if it exists; otherwise, no action is taken.
定義:
インタフェース Context 内の removeServletMapping
パラメータ:
pattern - URL pattern of the mapping to remove

removeTaglib

public void removeTaglib(java.lang.String uri)
Remove the tag library location forthe specified tag library URI.
定義:
インタフェース Context 内の removeTaglib
パラメータ:
uri - URI, relative to the web.xml file

removeWelcomeFile

public void removeWelcomeFile(java.lang.String name)
Remove the specified welcome file name from the list recognized by this Context.
定義:
インタフェース Context 内の removeWelcomeFile
パラメータ:
name - Name of the welcome file to be removed

removeWrapperLifecycle

public void removeWrapperLifecycle(java.lang.String listener)
Remove a class name from the set of LifecycleListener classes that will be added to newly created Wrappers.
定義:
インタフェース Context 内の removeWrapperLifecycle
パラメータ:
listener - Class name of a LifecycleListener class to be removed

removeWrapperListener

public void removeWrapperListener(java.lang.String listener)
Remove a class name from the set of ContainerListener classes that will be added to newly created Wrappers.
定義:
インタフェース Context 内の removeWrapperListener
パラメータ:
listener - Class name of a ContainerListener class to be removed

filterStart

public boolean filterStart()
Configure and initialize the set of filters for this Context. Return true if all filter initialization completed successfully, or false otherwise.

filterStop

public boolean filterStop()
Finalize and release the set of filters for this Context. Return true if all filter finalization completed successfully, or false otherwise.

findFilterConfig

public javax.servlet.FilterConfig findFilterConfig(java.lang.String name)
Find and return the initialized FilterConfig for the specified filter name, if any; otherwise return null.
パラメータ:
name - Name of the desired filter

listenerStart

public boolean listenerStart()
Configure the set of instantiated application event listeners for this Context. Return true if all listeners wre initialized successfully, or false otherwise.

listenerStop

public boolean listenerStop()
Send an application stop event to all interested listeners. Return true if all events were sent successfully, or false otherwise.

loadOnStartup

public void loadOnStartup(Container[] children)
Load and initialize all servlets marked "load on startup" in the web application deployment descriptor.
パラメータ:
children - Array of wrappers for all currently defined servlets (including those not declared load on startup)

start

public void start()
           throws LifecycleException
Start this Context component.
オーバーライド:
クラス ContainerBase 内の start
例外:
LifecycleException - if a startup error occurs

stop

public void stop()
          throws LifecycleException
Stop this Context component.
オーバーライド:
クラス ContainerBase 内の stop
例外:
LifecycleException - if a shutdown error occurs

toString

public java.lang.String toString()
Return a String representation of this component.
オーバーライド:
クラス java.lang.Object 内の toString

addDefaultMapper

protected void addDefaultMapper(java.lang.String mapperClass)
Add a default Mapper implementation if none have been configured explicitly.
オーバーライド:
クラス ContainerBase 内の addDefaultMapper
パラメータ:
mapperClass - Java class name of the default Mapper

adjustURLPattern

protected java.lang.String adjustURLPattern(java.lang.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.
パラメータ:
urlPattern - The URL pattern to be adjusted (if needed) and returned

isServlet22

protected boolean isServlet22()
Are we processing a version 2.2 deployment descriptor?

engineBase

protected java.io.File engineBase()
Return a File object representing the base directory for the entire servlet container (i.e. the Engine container if present).


Copyright ? 2000-2001 Apache Software Foundation. All Rights Reserved.