KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > catalina > cluster > Member


1 /*
2  * Copyright 1999,2004 The Apache Software Foundation.
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16
17 package org.apache.catalina.cluster;
18
19 /**
20  * The Member interface, defines a member in the Cluster.
21  * A member is a Tomcat process that participates in session replication.<BR>
22  * Each member can carry a set of properties, defined by the actual implementation.<BR>
23  * For TCP replication has been targeted for the first release, the hostname and listen port
24  * of the member is defined as hardcoded stuff.<BR>
25  * The Member interface together with MembershipListener, MembershipService are interfaces used to
26  * switch out the service used to establish membership in between the cluster nodes.
27  *
28  * @author Filip Hanik
29  * @version $Revision: 1.5 $, $Date: 2004/05/26 16:31:23 $
30  */
31
32
33 public interface Member {
34     /**
35      * Return implementation specific properties about this cluster node.
36      */
37     public java.util.HashMap JavaDoc getMemberProperties();
38     /**
39      * Returns the name of this node, should be unique within the cluster.
40      */
41     public String JavaDoc getName();
42     /**
43      * Returns the TCP listen host for the TCP implementation
44      */
45     public String JavaDoc getHost();
46     /**
47      * Returns the TCP listen portfor the TCP implementation
48      */
49     public int getPort();
50
51     /**
52      * Contains information on how long this member has been online.
53      * The result is the number of milli seconds this member has been
54      * broadcasting its membership to the cluster.
55      * @return nr of milliseconds since this member started.
56      */
57     public long getMemberAliveTime();
58     
59 }
60
Popular Tags