|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.apache.catalina.cluster.mcast.McastService
A membership implementation using simple multicast. This is the representation of a multicast membership service. This class is responsible for maintaining a list of active cluster nodes in the cluster. If a node fails to send out a heartbeat, the node will be dismissed. FIXME i18n messages
Field Summary | |
protected McastServiceImpl |
impl
A handle to the actual low level implementation |
protected MembershipListener |
listener
A membership listener delegate (should be the cluster :) |
protected McastMember |
localMember
The local member |
protected java.util.Properties |
properties
The implementation specific properties |
protected StringManager |
sm
The string manager for this package. |
Constructor Summary | |
McastService()
Create a membership service. |
Method Summary | |
void |
addMembershipListener(MembershipListener listener)
Add a membership listener, this version only supports one listener per service, so calling this method twice will result in only the second listener being active. |
Member |
findMemberByName(java.lang.String name)
Return the member by name |
Cluster |
getCatalinaCluster()
Return the cluster for this membership service |
java.lang.String |
getInfo()
Return descriptive information about this implementation and the corresponding version number, in the format <description>/<version> . |
Member |
getLocalMember()
Return the local member |
java.lang.String |
getLocalMemberName()
Return the local member name |
java.lang.String |
getMcastAddr()
|
java.lang.String |
getMcastBindAddress()
|
java.lang.String |
getMcastClusterDomain()
|
long |
getMcastDropTime()
|
long |
getMcastFrequency()
|
int |
getMcastPort()
|
int |
getMcastSoTimeout()
|
int |
getMcastTTL()
|
Member[] |
getMembers()
Return all the members |
java.lang.String[] |
getMembersByName()
Return all the members by name |
javax.management.ObjectName |
getObjectName()
|
java.util.Properties |
getProperties()
Return the properties, see setProperties |
int |
getRecoveryCounter()
|
long |
getRecoverySleepTime()
|
boolean |
hasMembers()
has members? |
protected void |
hasProperty(java.util.Properties properties,
java.lang.String name)
Check if a required property is available. |
protected void |
initMBeans()
register mbean descriptor for package mcast |
boolean |
isRecoveryEnabled()
|
static void |
main(java.lang.String[] args)
Simple test program |
void |
memberAdded(Member member)
|
void |
memberDisappeared(Member member)
Callback from the impl when a new member has been received |
protected void |
registerMBean()
register MBeans for Membership |
void |
removeMembershipListener()
Remove the membership listener |
void |
setCatalinaCluster(SimpleTcpCluster cluster)
|
void |
setLocalMemberProperties(java.lang.String listenHost,
int listenPort)
Sets the local member properties for broadcasting |
void |
setMcastAddr(java.lang.String addr)
|
void |
setMcastBindAddress(java.lang.String bindaddr)
|
void |
setMcastClusterDomain(java.lang.String clusterDomain)
|
void |
setMcastDropTime(long time)
|
void |
setMcastFrequency(long time)
|
void |
setMcastPort(int port)
|
void |
setMcastSoTimeout(int mcastSoTimeout)
|
void |
setMcastTTL(int mcastTTL)
|
void |
setObjectName(javax.management.ObjectName name)
Transmitter ObjectName |
void |
setProperties(java.util.Properties properties)
Sets the properties for the membership service. |
void |
setRecoveryCounter(int recoveryCounter)
|
void |
setRecoveryEnabled(boolean recoveryEnabled)
|
void |
setRecoverySleepTime(long recoverySleepTime)
|
void |
start()
Start broadcasting and listening to membership pings |
void |
start(int level)
Starts the membership service. |
void |
stop()
Stop broadcasting and listening to membership pings |
protected void |
unregisterMBean()
unregister MBeans for Membership |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
protected StringManager sm
protected java.util.Properties properties
protected McastServiceImpl impl
protected MembershipListener listener
protected McastMember localMember
Constructor Detail |
public McastService()
Method Detail |
public java.lang.String getInfo()
<description>/<version>
.
public void setObjectName(javax.management.ObjectName name)
name
- public javax.management.ObjectName getObjectName()
public void setProperties(java.util.Properties properties)
MembershipService
start()
method is called.
The properties are implementation specific.
setProperties
in interface MembershipService
properties
- java.lang.IllegalArgumentException
- if a property is missing.public java.util.Properties getProperties()
getProperties
in interface MembershipService
public void setCatalinaCluster(SimpleTcpCluster cluster)
setCatalinaCluster
in interface MembershipService
cluster
- public Cluster getCatalinaCluster()
public java.lang.String getLocalMemberName()
public Member getLocalMember()
getLocalMember
in interface MembershipService
public void setLocalMemberProperties(java.lang.String listenHost, int listenPort)
setLocalMemberProperties
in interface MembershipService
public void setMcastAddr(java.lang.String addr)
public java.lang.String getMcastAddr()
public void setMcastBindAddress(java.lang.String bindaddr)
public java.lang.String getMcastBindAddress()
public void setMcastClusterDomain(java.lang.String clusterDomain)
public java.lang.String getMcastClusterDomain()
public void setMcastPort(int port)
public int getMcastPort()
public void setMcastFrequency(long time)
public long getMcastFrequency()
public void setMcastDropTime(long time)
public long getMcastDropTime()
protected void hasProperty(java.util.Properties properties, java.lang.String name)
properties
- The set of propertiesname
- The property to check forpublic void start() throws java.lang.Exception
start
in interface MembershipService
java.lang.Exception
- if a IO error occurspublic void start(int level) throws java.lang.Exception
MembershipService
start
in interface MembershipService
level
- - level 1 starts listening for members, level 2
starts broad casting the server
java.lang.Exception
- if the service fails to start.public void stop()
stop
in interface MembershipService
protected void initMBeans() throws java.lang.Exception
java.lang.Exception
protected void registerMBean()
protected void unregisterMBean()
public java.lang.String[] getMembersByName()
getMembersByName
in interface MembershipService
public Member findMemberByName(java.lang.String name)
findMemberByName
in interface MembershipService
public boolean hasMembers()
hasMembers
in interface MembershipService
public Member[] getMembers()
getMembers
in interface MembershipService
public void addMembershipListener(MembershipListener listener)
addMembershipListener
in interface MembershipService
listener
- The listenerpublic void removeMembershipListener()
removeMembershipListener
in interface MembershipService
public void memberAdded(Member member)
memberAdded
in interface MembershipListener
public void memberDisappeared(Member member)
memberDisappeared
in interface MembershipListener
member
- The memberpublic int getMcastSoTimeout()
public void setMcastSoTimeout(int mcastSoTimeout)
public int getMcastTTL()
public void setMcastTTL(int mcastTTL)
public int getRecoveryCounter()
public boolean isRecoveryEnabled()
public long getRecoverySleepTime()
public void setRecoveryCounter(int recoveryCounter)
public void setRecoveryEnabled(boolean recoveryEnabled)
public void setRecoverySleepTime(long recoverySleepTime)
public static void main(java.lang.String[] args) throws java.lang.Exception
args
- Command-line arguments
java.lang.Exception
- If an error occurs
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |