File	Doc	Category	Size	Date	Package
Container.java	API Doc	Glassfish v2 API	16967	Fri May 04 22:31:52 BST 2007	org.apache.catalina

Container

Fields Summary
public static final String	ADD_CHILD_EVENT The ContainerEvent event type sent when a child container is added by addChild().
public static final String	ADD_MAPPER_EVENT The ContainerEvent event type sent when a Mapper is added by addMapper().
public static final String	ADD_VALVE_EVENT The ContainerEvent event type sent when a valve is added by addValve(), if this Container supports pipelines.
public static final String	REMOVE_CHILD_EVENT The ContainerEvent event type sent when a child container is removed by removeChild().
public static final String	REMOVE_MAPPER_EVENT The ContainerEvent event type sent when a Mapper is removed by removeMapper().
public static final String	REMOVE_VALVE_EVENT The ContainerEvent event type sent when a valve is removed by removeValve(), if this Container supports pipelines.

Constructors Summary

Methods Summary
public void	addChild(org.apache.catalina.Container child) Add a new child Container to those associated with this Container, if supported. Prior to adding this Container to the set of children, the child's setParent() method must be called, with this Container as an argument. This method may thrown an IllegalArgumentException if this Container chooses not to be attached to the specified Container, in which case it is not added param child New child Container to be added exception IllegalArgumentException if this exception is thrown by the setParent() method of the child Container exception IllegalArgumentException if the new child does not have a name unique from that of existing children of this Container exception IllegalStateException if this Container does not support child Containers
public void	addContainerListener(ContainerListener listener) Add a container event listener to this component. param listener The listener to add
public void	addPropertyChangeListener(java.beans.PropertyChangeListener listener) Add a property change listener to this component. param listener The listener to add
public void	backgroundProcess() Execute a periodic task, such as reloading, etc. This method will be invoked inside the classloading context of this container. Unexpected throwables will be caught and logged.
public org.apache.catalina.Container	findChild(java.lang.String name) Return the child Container, associated with this Container, with the specified name (if any); otherwise, return null param name Name of the child Container to be retrieved
public org.apache.catalina.Container[]	findChildren() Return the set of children Containers associated with this Container. If this Container has no children, a zero-length array is returned.
public ContainerListener[]	findContainerListeners() Return the set of container listeners associated with this Container. If this Container has no registered container listeners, a zero-length array is returned.
public void	fireContainerEvent(java.lang.String type, java.lang.Object data) Notifies all event listeners of this Container of the given event. param type Event type param data Event data
public int	getBackgroundProcessorDelay() Get the delay between the invocation of the backgroundProcess method on this container and its children. Child containers will not be invoked if their delay value is not negative (which would mean they are using their own thread). Setting this to a positive value will cause a thread to be spawn. After waiting the specified amount of time, the thread will invoke the executePeriodic method on this container and all its children.
public Cluster	getCluster() Return the Cluster with which this Container is associated. If there is no associated Cluster, return the Cluster associated with our parent Container (if any); otherwise return null.
public java.lang.String	getInfo() Return descriptive information about this Container implementation and the corresponding version number, in the format <description>/<version>.
public Loader	getLoader() Return the Loader with which this Container is associated. If there is no associated Loader, return the Loader associated with our parent Container (if any); otherwise, return null.
public Logger	getLogger() Return the Logger with which this Container is associated. If there is no associated Logger, return the Logger associated with our parent Container (if any); otherwise return null.
public Manager	getManager() Return the Manager with which this Container is associated. If there is no associated Manager, return the Manager associated with our parent Container (if any); otherwise return null.
public java.lang.Object	getMappingObject() Return an object which may be utilized for mapping to this component.
public java.lang.String	getName() Return a name string (suitable for use by humans) that describes this Container. Within the set of child containers belonging to a particular parent, Container names must be unique.
public org.apache.catalina.Container	getParent() Return the Container for which this Container is a child, if there is one. If there is no defined parent, return null.
public java.lang.ClassLoader	getParentClassLoader() Return the parent class loader (if any) for web applications.
public Pipeline	getPipeline() Return the Pipeline object that manages the Valves associated with this Container.
public Realm	getRealm() Return the Realm with which this Container is associated. If there is no associated Realm, return the Realm associated with our parent Container (if any); otherwise return null.
public javax.naming.directory.DirContext	getResources() Return the Resources with which this Container is associated. If there is no associated Resources object, return the Resources associated with our parent Container (if any); otherwise return null.
public void	invoke(Request request, Response response) Process the specified Request, and generate the corresponding Response, according to the design of this particular Container. param request Request to be processed param response Response to be produced exception IOException if an input/output error occurred while processing exception ServletException if a ServletException was thrown while processing this request
public boolean	isCheckIfRequestIsSecure() Indicates whether the request will be checked to see if it is secure before adding Pragma and Cache-control headers when proxy caching has been disabled. return true if the check is required; false otherwise.
public void	removeChild(org.apache.catalina.Container child) Remove an existing child Container from association with this parent Container. param child Existing child Container to be removed
public void	removeContainerListener(ContainerListener listener) Remove a container event listener from this component. param listener The listener to remove
public void	removePropertyChangeListener(java.beans.PropertyChangeListener listener) Remove a property change listener from this component. param listener The listener to remove
public void	setBackgroundProcessorDelay(int delay) Set the delay between the invocation of the execute method on this container and its children. param delay The delay in seconds between the invocation of backgroundProcess methods
public void	setCheckIfRequestIsSecure(boolean checkIfRequestIsSecure) Sets the checkIfRequestIsSecure property of this Container. Setting this property to true will check if the request is secure before adding Pragma and Cache-Control headers when proxy caching has been disabled. param checkIfRequestIsSecure true if check is required, false otherwise
public void	setCluster(Cluster cluster) Set the Cluster with which this Container is associated. param connector The Connector to be added
public void	setLoader(Loader loader) Set the Loader with which this Container is associated. param loader The newly associated loader
public void	setLogger(Logger logger) Set the Logger with which this Container is associated. param logger The newly associated Logger
public void	setManager(Manager manager) Set the Manager with which this Container is associated. param manager The newly associated Manager
public void	setName(java.lang.String name) Set a name string (suitable for use by humans) that describes this Container. Within the set of child containers belonging to a particular parent, Container names must be unique. param name New name of this container exception IllegalStateException if this Container has already been added to the children of a parent Container (after which the name may not be changed)
public void	setParent(org.apache.catalina.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. param container Container to which this Container is being added as a child exception IllegalArgumentException if this Container refuses to become attached to the specified Container
public void	setParentClassLoader(java.lang.ClassLoader parent) Set the parent class loader (if any) for web applications. This call is meaningful only before a Loader has been configured, and the specified value (if non-null) should be passed as an argument to the class loader constructor. param parent The new parent class loader
public void	setRealm(Realm realm) Set the Realm with which this Container is associated. param realm The newly associated Realm
public void	setResources(javax.naming.directory.DirContext resources) Set the Resources object with which this Container is associated. param resources The newly associated Resources