| org.apache.catalina.Cluster
| Cluster | | public interface Cluster (Code) | | A Cluster works as a Cluster client/server for the local host
Different Cluster implementations can be used to support different
ways to communicate within the Cluster. A Cluster implementation is
responsible for setting up a way to communicate within the Cluster
and also supply "ClientApplications" with ClusterSender
used when sending information in the Cluster and
ClusterInfo used for receiving information in the Cluster.
author:
Bip Thelin
author:
Remy Maucherat
author:
Filip Hanik
version:
$Revision: 1.7 $, $Date: 2004/05/26 15:24:59 $ |
| Method Summary | |
| public Manager | createManager(String name)
Create a new manager which will use this cluster to replicate its
sessions. | | public String | getClusterName()
Return the name of the cluster that this Server is currently
configured to operate within. | | public Container | getContainer()
| | public int | getDebug()
| | public String | getInfo()
Return descriptive information about this Cluster implementation and
the corresponding version number, in the format
<description>/<version>. | | public String | getProtocol()
Get the protocol used by the cluster. | | public void | installContext(String contextPath, 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. | | public void | setClusterName(String clusterName)
Set the name of the cluster to join, if no cluster with
this name is present create one. | | public void | setContainer(Container container)
| | public void | setDebug(int debug)
| | public void | setProtocol(String protocol)
Set the protocol parameters. | | public void | startContext(String contextPath)
Start an existing web application, attached to the specified context
path in all the other nodes in the cluster. | | public void | stop(String contextPath)
Stop an existing web application, attached to the specified context
path. |
| createManager | | public Manager createManager(String name)(Code) | | Create a new manager which will use this cluster to replicate its
sessions.
Parameters:
name - Name (key) of the application with which the manager isassociated |
| getClusterName | | public String getClusterName()(Code) | | Return the name of the cluster that this Server is currently
configured to operate within.
The name of the cluster associated with this server |
| getContainer | | public Container getContainer()(Code) | | Get the Container associated with our Cluster
The Container associated with our Cluster |
| getDebug | | public int getDebug()(Code) | | Returns the debug level for this Cluster
The debug level |
| getInfo | | public String getInfo()(Code) | | Return descriptive information about this Cluster implementation and
the corresponding version number, in the format
<description>/<version>.
|
| getProtocol | | public String getProtocol()(Code) | | Get the protocol used by the cluster.
The protocol |
| installContext | | public void installContext(String contextPath, URL war)(Code) | | 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.
Parameters:
contextPath - The context path to which this application shouldbe installed (must be unique)
Parameters:
war - A URL of type "jar:" that points to a WAR file, or type"file:" that points to an unpacked directory structure containingthe web application to be installed
exception:
IllegalArgumentException - if the specified context pathis malformed (it must be "" or start with a slash)
exception:
IllegalStateException - if the specified context pathis already attached to an existing web application |
| setClusterName | | public void setClusterName(String clusterName)(Code) | | Set the name of the cluster to join, if no cluster with
this name is present create one.
Parameters:
clusterName - The clustername to join |
| setContainer | | public void setContainer(Container container)(Code) | | Set the Container associated with our Cluster
Parameters:
container - The Container to use |
| setDebug | | public void setDebug(int debug)(Code) | | The debug detail level for this Cluster
Parameters:
debug - The debug level |
| setProtocol | | public void setProtocol(String protocol)(Code) | | Set the protocol parameters.
Parameters:
protocol - The protocol used by the cluster |
| startContext | | public void startContext(String contextPath) throws IOException(Code) | | 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.
Parameters:
contextPath - The context path of the application to be started
exception:
IllegalArgumentException - if the specified context pathis malformed (it must be "" or start with a slash)
exception:
IllegalArgumentException - if the specified context path doesnot identify a currently installed web application
exception:
IOException - if an input/output error occurs duringstartup |
| stop | | public void stop(String contextPath) throws IOException(Code) | | Stop an existing web application, attached to the specified context
path. Only stops a web application if it is running.
Parameters:
contextPath - The context path of the application to be stopped
exception:
IllegalArgumentException - if the specified context pathis malformed (it must be "" or start with a slash)
exception:
IllegalArgumentException - if the specified context path doesnot identify a currently installed web application
exception:
IOException - if an input/output error occurs while stoppingthe web application |
|
|