File	Doc	Category	Size	Date	Package
Cluster.java	API Doc	Glassfish v2 API	8063	Fri May 04 22:31:50 BST 2007	org.apache.catalina

Cluster

Fields Summary

Constructors Summary

Methods Summary
public Manager	createManager(java.lang.String name) Create a new manager which will use this cluster to replicate its sessions. param name Name (key) of the application with which the manager is associated
public java.lang.String	getClusterName() Return the name of the cluster that this Server is currently configured to operate within. return The name of the cluster associated with this server
public Container	getContainer() Get the Container associated with our Cluster return The Container associated with our Cluster
public int	getDebug() Returns the debug level for this Cluster return The debug level
public java.lang.String	getInfo() Return descriptive information about this Cluster implementation and the corresponding version number, in the format <description>/<version>.
public java.lang.String	getProtocol() Get the protocol used by the cluster. return The protocol
public void	installContext(java.lang.String contextPath, java.net.URL war) Install a new web application, whose web application archive is at the specified URL, into this container with the specified context path. A context path of "" (the empty string) should be used for the root application for this container. Otherwise, the context path must start with a slash. If this application is successfully installed, a ContainerEvent of type PRE_INSTALL_EVENT will be sent to registered listeners before the associated Context is started, and a ContainerEvent of type INSTALL_EVENT will be sent to all registered listeners after the associated Context is started, with the newly created Context as an argument. param contextPath The context path to which this application should be installed (must be unique) param war A URL of type "jar:" that points to a WAR file, or type "file:" that points to an unpacked directory structure containing the web application to be installed exception IllegalArgumentException if the specified context path is malformed (it must be "" or start with a slash) exception IllegalStateException if the specified context path is already attached to an existing web application exception IOException if an input/output error was encountered during installation
public void	setClusterName(java.lang.String clusterName) Set the name of the cluster to join, if no cluster with this name is present create one. param clusterName The clustername to join
public void	setContainer(Container container) Set the Container associated with our Cluster param container The Container to use
public void	setDebug(int debug) The debug detail level for this Cluster param debug The debug level
public void	setDistributable(java.lang.String contextName, boolean distributable) Notifies the cluster if a context is distributable or not param contextName - the name of the registed context param distributable - true means that the sessions will be replicated
public void	setProtocol(java.lang.String protocol) Set the protocol parameters. param protocol The protocol used by the cluster
public void	startContext(java.lang.String contextPath) Start an existing web application, attached to the specified context path in all the other nodes in the cluster. Only starts a web application if it is not running. param contextPath The context path of the application to be started exception IllegalArgumentException if the specified context path is malformed (it must be "" or start with a slash) exception IllegalArgumentException if the specified context path does not identify a currently installed web application exception IOException if an input/output error occurs during startup
public void	stop(java.lang.String contextPath) Stop an existing web application, attached to the specified context path. Only stops a web application if it is running. param contextPath The context path of the application to be stopped exception IllegalArgumentException if the specified context path is malformed (it must be "" or start with a slash) exception IllegalArgumentException if the specified context path does not identify a currently installed web application exception IOException if an input/output error occurs while stopping the web application