org.apache.catalina
Interface DefaultContext

All Known Implementing Classes:
StandardDefaultContext

public interface DefaultContext

Used to store the default configuration a Host will use when creating a Context. A Context configured in server.xml can override these defaults by setting the Context attribute override="true".

Version:
$Revision: 1.6 $ $Date: 2004/08/26 22:05:20 $
Author:
Glenn Nielsen, Remy Maucherat

Method Summary
 void addApplicationListener(java.lang.String listener)
          Add a new Listener class name to the set of Listeners configured for this application.
 void addApplicationParameter(ApplicationParameter parameter)
          Add a new application parameter for this application.
 void 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 addInstanceListener(java.lang.String listener)
          Add the classname of an InstanceListener to be added to each Wrapper appended to this Context.
 void addParameter(java.lang.String name, java.lang.String value)
          Add a new context initialization parameter, replacing any existing value for the specified name.
 void addPropertyChangeListener(java.beans.PropertyChangeListener listener)
          Add a property change listener to this component.
 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 addResourceLink(ContextResourceLink resourceLink)
          Add a resource link for this web application.
 void addResourceParams(ResourceParams resourceParameters)
          Add resource parameters for this web application.
 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.
 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.
 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.
 java.lang.String[] findInstanceListeners()
          Return the set of InstanceListener classes that will be added to newly created Wrappers automatically.
 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.
 ContextResourceLink findResourceLink(java.lang.String name)
          Return the resource link with the specified name, if any; otherwise return null.
 ContextResourceLink[] findResourceLinks()
          Return the defined resource links for this application.
 ResourceParams[] findResourceParams()
          Return the set of defined resource parameters for this web application.
 ContextResource[] findResources()
          Return the defined resource references for this application.
 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.
 boolean getCookies()
          Return the "use cookies for session ids" flag.
 boolean getCrossContext()
          Return the "allow crossing servlet contexts" flag.
 java.lang.String getInfo()
          Return descriptive information about this Container implementation and the corresponding version number, in the format <description>/<version>.
 Loader getLoader()
          Return the Loader with which this Container is associated.
 Manager getManager()
          Return the Manager with which this Container is associated.
 java.lang.String getName()
          Return the name of this DefaultContext
 NamingResources getNamingResources()
          Return the naming resources associated with this web application.
 Container getParent()
          Return the Container for which this Container is a child, if there is one.
 boolean getReloadable()
          Return the reloadable flag for this web application.
 javax.naming.directory.DirContext getResources()
          Get the resources DirContext object with which this Container is associated.
 java.lang.String getWrapperClass()
          Return the Java class name of the Wrapper implementation used for servlets registered in this Context.
 void importDefaultContext(Context context)
          Import the configuration from the DefaultContext into current Context.
 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 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 removeInstanceListener(java.lang.String listener)
          Remove a class name from the set of InstanceListener classes that will be added to newly created Wrappers.
 void removeParameter(java.lang.String name)
          Remove the context initialization parameter with the specified name, if it exists; otherwise, no action is taken.
 void removePropertyChangeListener(java.beans.PropertyChangeListener listener)
          Remove a property change listener from this component.
 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 removeResourceLink(java.lang.String name)
          Remove any resource link with the specified name.
 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 setCookies(boolean cookies)
          Set the "use cookies for session ids" flag.
 void setCrossContext(boolean crossContext)
          Set the "allow crossing servlet contexts" flag.
 void setLoader(Loader loader)
          Set the Loader with which this Context is associated.
 void setManager(Manager manager)
          Set the Manager with which this Container is associated.
 void setName(java.lang.String name)
          Set the name of the default context.
 void setParent(Container container)
          Set the parent Container to which this Container is being added as a child.
 void setReloadable(boolean reloadable)
          Set the reloadable flag for this web application.
 void setResources(javax.naming.directory.DirContext resources)
          Set the resources DirContext object with which this Container is associated.
 void setWrapperClass(java.lang.String wrapperClass)
          Set the Java class name of the Wrapper implementation used for servlets registered in this Context.
 

Method Detail

getCookies

public boolean getCookies()
Return the "use cookies for session ids" flag.


setCookies

public void setCookies(boolean cookies)
Set the "use cookies for session ids" flag.

Parameters:
cookies - The new flag

getCrossContext

public boolean getCrossContext()
Return the "allow crossing servlet contexts" flag.


setCrossContext

public void setCrossContext(boolean crossContext)
Set the "allow crossing servlet contexts" flag.

Parameters:
crossContext - The new cross contexts flag

getInfo

public java.lang.String getInfo()
Return descriptive information about this Container implementation and the corresponding version number, in the format <description>/<version>.


getReloadable

public boolean getReloadable()
Return the reloadable flag for this web application.


setReloadable

public void setReloadable(boolean reloadable)
Set the reloadable flag for this web application.

Parameters:
reloadable - The new reloadable flag

getWrapperClass

public java.lang.String getWrapperClass()
Return the Java class name of the Wrapper implementation used for servlets registered in this Context.


setWrapperClass

public void setWrapperClass(java.lang.String wrapperClass)
Set the Java class name of the Wrapper implementation used for servlets registered in this Context.

Parameters:
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.

Parameters:
resources - The newly associated DirContext

getResources

public javax.naming.directory.DirContext getResources()
Get the resources DirContext object with which this Container is associated.


getLoader

public Loader getLoader()
Return the Loader with which this Container is associated. If there is no associated Loader return null.


setLoader

public void setLoader(Loader loader)
Set the Loader with which this Context is associated.

Parameters:
loader - The newly associated loader

getManager

public Manager getManager()
Return the Manager with which this Container is associated. If there is no associated Manager return null.


setManager

public void setManager(Manager manager)
Set the Manager with which this Container is associated.

Parameters:
manager - The newly associated Manager

getNamingResources

public NamingResources getNamingResources()
Return the naming resources associated with this web application.


getName

public java.lang.String getName()
Return the name of this DefaultContext


setName

public void setName(java.lang.String name)
Set the name of the default context.

Parameters:
name - The new name

getParent

public Container getParent()
Return the Container for which this Container is a child, if there is one. If there is no defined parent, return null.


setParent

public void setParent(Container container)
Set the parent Container to which this Container is being added as a child. This Container may refuse to become attached to the specified Container by throwing an exception.

Parameters:
container - Container to which this Container is being added as a child
Throws:
java.lang.IllegalArgumentException - if this Container refuses to become attached to the specified Container

addApplicationListener

public void addApplicationListener(java.lang.String listener)
Add a new Listener class name to the set of Listeners configured for this application.

Parameters:
listener - Java class name of a listener class

addApplicationParameter

public void addApplicationParameter(ApplicationParameter parameter)
Add a new application parameter for this application.

Parameters:
parameter - The new application parameter

addEjb

public void addEjb(ContextEjb ejb)
Add an EJB resource reference for this web application.

Parameters:
ejb - New EJB resource reference

addEnvironment

public void addEnvironment(ContextEnvironment environment)
Add an environment entry for this web application.

Parameters:
environment - New environment entry

addResourceParams

public void addResourceParams(ResourceParams resourceParameters)
Add resource parameters for this web application.

Parameters:
resourceParameters - New resource parameters

addInstanceListener

public void addInstanceListener(java.lang.String listener)
Add the classname of an InstanceListener to be added to each Wrapper appended to this Context.

Parameters:
listener - Java class name of an InstanceListener class

addParameter

public void addParameter(java.lang.String name,
                         java.lang.String value)
Add a new context initialization parameter, replacing any existing value for the specified name.

Parameters:
name - Name of the new parameter
value - Value of the new parameter
Throws:
java.lang.IllegalArgumentException - if the name or value is missing, or if this context initialization parameter has already been registered

addPropertyChangeListener

public void addPropertyChangeListener(java.beans.PropertyChangeListener listener)
Add a property change listener to this component.

Parameters:
listener - The listener to add

addResource

public void addResource(ContextResource resource)
Add a resource reference for this web application.

Parameters:
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.

Parameters:
name - The resource environment reference name
type - The resource environment reference type

addResourceLink

public void addResourceLink(ContextResourceLink resourceLink)
Add a resource link for this web application.


addWrapperLifecycle

public void addWrapperLifecycle(java.lang.String listener)
Add the classname of a LifecycleListener to be added to each Wrapper appended to this Context.

Parameters:
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.

Parameters:
listener - Java class name of a ContainerListener class

findApplicationListeners

public java.lang.String[] findApplicationListeners()
Return the set of application listener class names configured for this application.


findApplicationParameters

public ApplicationParameter[] findApplicationParameters()
Return the set of application parameters for this application.


findEjb

public ContextEjb findEjb(java.lang.String name)
Return the EJB resource reference with the specified name, if any; otherwise, return null.

Parameters:
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.


findEnvironment

public ContextEnvironment findEnvironment(java.lang.String name)
Return the environment entry with the specified name, if any; otherwise, return null.

Parameters:
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.


findResourceParams

public ResourceParams[] findResourceParams()
Return the set of defined resource parameters for this web application. If none have been defined, a zero-length array is returned.


findInstanceListeners

public java.lang.String[] findInstanceListeners()
Return the set of InstanceListener classes that will be added to newly created Wrappers automatically.


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.

Parameters:
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.


findResource

public ContextResource findResource(java.lang.String name)
Return the resource reference with the specified name, if any; otherwise return null.

Parameters:
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.

Parameters:
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.


findResourceLink

public ContextResourceLink findResourceLink(java.lang.String name)
Return the resource link with the specified name, if any; otherwise return null.

Parameters:
name - Name of the desired resource link

findResourceLinks

public ContextResourceLink[] findResourceLinks()
Return the defined resource links for this application. If none have been defined, a zero-length array is returned.


findResources

public ContextResource[] findResources()
Return the defined resource references for this application. If none have been defined, a zero-length array is returned.


findWrapperLifecycles

public java.lang.String[] findWrapperLifecycles()
Return the set of LifecycleListener classes that will be added to newly created Wrappers automatically.


findWrapperListeners

public java.lang.String[] findWrapperListeners()
Return the set of ContainerListener classes that will be added to newly created Wrappers automatically.


removeApplicationListener

public void removeApplicationListener(java.lang.String listener)
Remove the specified application listener class from the set of listeners for this application.

Parameters:
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.

Parameters:
name - Name of the application parameter to remove

removeEjb

public void removeEjb(java.lang.String name)
Remove any EJB resource reference with the specified name.

Parameters:
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.

Parameters:
name - Name of the environment entry to remove

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.

Parameters:
listener - Class name of an InstanceListener class to be removed

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.

Parameters:
name - Name of the parameter to remove

removePropertyChangeListener

public void removePropertyChangeListener(java.beans.PropertyChangeListener listener)
Remove a property change listener from this component.

Parameters:
listener - The listener to remove

removeResource

public void removeResource(java.lang.String name)
Remove any resource reference with the specified name.

Parameters:
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.

Parameters:
name - Name of the resource environment reference to remove

removeResourceLink

public void removeResourceLink(java.lang.String name)
Remove any resource link with the specified name.

Parameters:
name - Name of the resource link to remove

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.

Parameters:
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.

Parameters:
listener - Class name of a ContainerListener class to be removed

importDefaultContext

public void importDefaultContext(Context context)
Import the configuration from the DefaultContext into current Context.

Parameters:
context - current web application context


Copyright 2000-2002 Apache Software Foundation. All Rights Reserved.