001: /*
002: * $Header: /home/cvs/jakarta-tomcat-4.0/catalina/src/share/org/apache/catalina/Cluster.java,v 1.5 2001/07/22 20:13:30 pier Exp $
003: * $Revision: 1.5 $
004: * $Date: 2001/07/22 20:13:30 $
005: *
006: * ====================================================================
007: *
008: * The Apache Software License, Version 1.1
009: *
010: * Copyright (c) 1999 The Apache Software Foundation. All rights
011: * reserved.
012: *
013: * Redistribution and use in source and binary forms, with or without
014: * modification, are permitted provided that the following conditions
015: * are met:
016: *
017: * 1. Redistributions of source code must retain the above copyright
018: * notice, this list of conditions and the following disclaimer.
019: *
020: * 2. Redistributions in binary form must reproduce the above copyright
021: * notice, this list of conditions and the following disclaimer in
022: * the documentation and/or other materials provided with the
023: * distribution.
024: *
025: * 3. The end-user documentation included with the redistribution, if
026: * any, must include the following acknowlegement:
027: * "This product includes software developed by the
028: * Apache Software Foundation (http://www.apache.org/)."
029: * Alternately, this acknowlegement may appear in the software itself,
030: * if and wherever such third-party acknowlegements normally appear.
031: *
032: * 4. The names "The Jakarta Project", "Tomcat", and "Apache Software
033: * Foundation" must not be used to endorse or promote products derived
034: * from this software without prior written permission. For written
035: * permission, please contact apache@apache.org.
036: *
037: * 5. Products derived from this software may not be called "Apache"
038: * nor may "Apache" appear in their names without prior written
039: * permission of the Apache Group.
040: *
041: * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
042: * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
043: * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
044: * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
045: * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
046: * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
047: * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
048: * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
049: * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
050: * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
051: * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
052: * SUCH DAMAGE.
053: * ====================================================================
054: *
055: * This software consists of voluntary contributions made by many
056: * individuals on behalf of the Apache Software Foundation. For more
057: * information on the Apache Software Foundation, please see
058: * <http://www.apache.org/>.
059: *
060: * [Additional notices, if required by prior licensing conditions]
061: *
062: */
063:
064: package org.apache.catalina;
065:
066: import java.beans.PropertyChangeListener;
067: import java.util.Collection;
068: import org.apache.catalina.cluster.ClusterMemberInfo;
069: import org.apache.catalina.cluster.ClusterReceiver;
070: import org.apache.catalina.cluster.ClusterSender;
071:
072: /**
073: * A <b>Cluster</b> works as a Cluster client/server for the local host
074: * Different Cluster implementations can be used to support different
075: * ways to communicate within the Cluster. A Cluster implementation is
076: * responsible for setting up a way to communicate within the Cluster
077: * and also supply "ClientApplications" with <code>ClusterSender</code>
078: * used when sending information in the Cluster and
079: * <code>ClusterInfo</code> used for receiving information in the Cluster.
080: *
081: * @author Bip Thelin
082: * @version $Revision: 1.5 $, $Date: 2001/07/22 20:13:30 $
083: */
084:
085: public interface Cluster {
086:
087: // ------------------------------------------------------------- Properties
088:
089: /**
090: * Return descriptive information about this Cluster implementation and
091: * the corresponding version number, in the format
092: * <code><description>/<version></code>.
093: */
094: public String getInfo();
095:
096: /**
097: * Return the name of the cluster that this Server is currently
098: * configured to operate within.
099: *
100: * @return The name of the cluster associated with this server
101: */
102: public String getClusterName();
103:
104: /**
105: * Set the time in seconds that the Cluster waits before
106: * checking for changes and replicated data.
107: *
108: * @param checkInterval The time in seconds to sleep
109: */
110: public void setCheckInterval(int checkInterval);
111:
112: /**
113: * Get the time in seconds that this Cluster sleeps.
114: *
115: * @return The value in seconds
116: */
117: public int getCheckInterval();
118:
119: /**
120: * Set the name of the cluster to join, if no cluster with
121: * this name is present create one.
122: *
123: * @param clusterName The clustername to join
124: */
125: public void setClusterName(String clusterName);
126:
127: /**
128: * Set the Container associated with our Cluster
129: *
130: * @param container The Container to use
131: */
132: public void setContainer(Container container);
133:
134: /**
135: * Get the Container associated with our Cluster
136: *
137: * @return The Container associated with our Cluster
138: */
139: public Container getContainer();
140:
141: /**
142: * The debug detail level for this Cluster
143: *
144: * @param debug The debug level
145: */
146: public void setDebug(int debug);
147:
148: /**
149: * Returns the debug level for this Cluster
150: *
151: * @return The debug level
152: */
153: public int getDebug();
154:
155: // --------------------------------------------------------- Public Methods
156:
157: /**
158: * Returns a collection containing <code>ClusterMemberInfo</code>
159: * on the remote members of this Cluster. This method does
160: * not include the local host, to retrieve
161: * <code>ClusterMemberInfo</code> on the local host
162: * use <code>getLocalClusterInfo()</code> instead.
163: *
164: * @return Collection with all members in the Cluster
165: */
166: public ClusterMemberInfo[] getRemoteClusterMembers();
167:
168: /**
169: * Returns a <code>ClusterSender</code> which is the interface
170: * to use when sending information in the Cluster. senderId is
171: * used as a identifier so that information sent through this
172: * instance can only be used with the respectice
173: * <code>ClusterReceiver</code>
174: *
175: * @return The ClusterSender
176: */
177: public ClusterSender getClusterSender(String senderId);
178:
179: /**
180: * Returns a <code>ClusterReceiver</code> which is the interface
181: * to use when receiving information in the Cluster. senderId is
182: * used as a indentifier, only information send through the
183: * <code>ClusterSender</code> with the same senderId can be received.
184: *
185: * @return The ClusterReceiver
186: */
187: public ClusterReceiver getClusterReceiver(String senderId);
188:
189: /**
190: * Return cluster information about the local host
191: *
192: * @return Cluster information
193: */
194: public ClusterMemberInfo getLocalClusterMember();
195: }
|