Class McastService
- java.lang.Object
-
- org.apache.catalina.tribes.membership.McastService
-
- All Implemented Interfaces:
McastServiceMBean,MembershipListener,MembershipService,MessageListener
public class McastService extends java.lang.Object implements MembershipService, MembershipListener, MessageListener, McastServiceMBean
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.
-
-
Field Summary
Fields Modifier and Type Field Description protected byte[]domainprotected static Member[]EMPTY_MEMBERSReturn all the membersprotected McastServiceImplimplA handle to the actual low level implementationprotected MembershipListenerlistenerA membership listener delegate (should be the cluster :)protected MemberImpllocalMemberThe local memberprotected MessageListenermsglistenerA message listener delegate for broadcastsprotected byte[]payloadprotected java.util.PropertiespropertiesThe implementation specific propertiesprotected static StringManagersmThe string manager for this package.-
Fields inherited from interface org.apache.catalina.tribes.MembershipService
MBR_RX, MBR_TX
-
-
Constructor Summary
Constructors Constructor Description McastService()Create a membership service.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description booleanaccept(ChannelMessage msg)voidbroadcast(ChannelMessage message)Broadcasts a message to all members.MemberfindMemberByName(java.lang.String name)Return the member by namejava.lang.StringgetAddress()java.lang.StringgetBind()ChannelgetChannel()Return the channel that is related to this MembershipServicebyte[]getDomain()longgetDropTime()longgetFrequency()booleangetLocalLoopbackDisabled()MembergetLocalMember(boolean alive)Get the local member.java.lang.StringgetLocalMemberName()MembergetMember(Member mbr)Retrieve the specified member from the membership.Member[]getMembers()java.lang.String[]getMembersByName()Return all the members by namebyte[]getPayload()intgetPort()java.util.PropertiesgetProperties()intgetRecoveryCounter()booleangetRecoveryEnabled()longgetRecoverySleepTime()intgetSoTimeout()intgetTtl()booleanhasMembers()has members?protected voidhasProperty(java.util.Properties properties, java.lang.String name)Check if a required property is available.static voidmain(java.lang.String[] args)Simple test programvoidmemberAdded(Member member)A member was added to the groupvoidmemberDisappeared(Member member)Callback from the impl when a new member has been receivedvoidmessageReceived(ChannelMessage msg)Receive a message from the IO components in the Channel stackvoidremoveMembershipListener()Remove the membership listenervoidremoveMessageListener()voidsetAddress(java.lang.String addr)voidsetBind(java.lang.String bindaddr)voidsetChannel(Channel channel)Set the channel that is related to this MembershipServiceprotected voidsetDefaults(java.util.Properties properties)voidsetDomain(byte[] domain)voidsetDomain(java.lang.String domain)voidsetDropTime(long time)voidsetFrequency(long time)voidsetLocalLoopbackDisabled(boolean localLoopbackDisabled)voidsetLocalMemberProperties(java.lang.String listenHost, int listenPort, int securePort, int udpPort)Sets the local member properties for broadcasting.voidsetMcastBindAddress(java.lang.String bindaddr)voidsetMcastDropTime(long time)voidsetMembershipListener(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.voidsetMessageListener(MessageListener listener)voidsetPayload(byte[] payload)Set a payload to be broadcasted with each membership broadcast.voidsetPort(int port)voidsetProperties(java.util.Properties properties)Sets the properties for the membership service.voidsetRecoveryCounter(int recoveryCounter)voidsetRecoveryEnabled(boolean recoveryEnabled)voidsetRecoverySleepTime(long recoverySleepTime)voidsetSoTimeout(int mcastSoTimeout)voidsetTtl(int mcastTTL)voidstart()Start broadcasting and listening to membership pingsvoidstart(int level)Starts the membership service.voidstop(int svc)Stop broadcasting and listening to membership pings
-
-
-
Field Detail
-
sm
protected static final StringManager sm
The string manager for this package.
-
properties
protected java.util.Properties properties
The implementation specific properties
-
impl
protected McastServiceImpl impl
A handle to the actual low level implementation
-
listener
protected volatile MembershipListener listener
A membership listener delegate (should be the cluster :)
-
msglistener
protected MessageListener msglistener
A message listener delegate for broadcasts
-
localMember
protected MemberImpl localMember
The local member
-
payload
protected byte[] payload
-
domain
protected byte[] domain
-
EMPTY_MEMBERS
protected static final Member[] EMPTY_MEMBERS
Return all the members
-
-
Method Detail
-
setProperties
public void setProperties(java.util.Properties properties)
Sets the properties for the membership service.- Specified by:
setPropertiesin interfaceMembershipService- Parameters:
properties-
All are required
1. mcastPort - the port to listen to
2. mcastAddress - the mcast group address
4. bindAddress - the bind address if any - only one that can be null
5. memberDropTime - the time a member is gone before it is considered gone.
6. mcastFrequency - the frequency of sending messages
7. tcpListenPort - the port this member listens to
8. tcpListenHost - the bind address of this member- Throws:
java.lang.IllegalArgumentException- if a property is missing.
-
getProperties
public java.util.Properties getProperties()
- Specified by:
getPropertiesin interfaceMcastServiceMBean- Specified by:
getPropertiesin interfaceMembershipService- Returns:
- the properties for the configuration used.
-
getLocalMemberName
public java.lang.String getLocalMemberName()
- Specified by:
getLocalMemberNamein interfaceMcastServiceMBean- Returns:
- the local member name
-
getLocalMember
public Member getLocalMember(boolean alive)
Get the local member.- Specified by:
getLocalMemberin interfaceMembershipService- Parameters:
alive-trueto set the alive time on the local member- Returns:
- the member object that defines this member
-
setLocalMemberProperties
public void setLocalMemberProperties(java.lang.String listenHost, int listenPort, int securePort, int udpPort)Sets the local member properties for broadcasting.- Specified by:
setLocalMemberPropertiesin interfaceMembershipService- Parameters:
listenHost- Listen to hostlistenPort- Listen to portsecurePort- Use a secure portudpPort- Use UDP
-
setAddress
public void setAddress(java.lang.String addr)
-
getAddress
public java.lang.String getAddress()
- Specified by:
getAddressin interfaceMcastServiceMBean
-
setMcastBindAddress
public void setMcastBindAddress(java.lang.String bindaddr)
-
setBind
public void setBind(java.lang.String bindaddr)
-
getBind
public java.lang.String getBind()
- Specified by:
getBindin interfaceMcastServiceMBean
-
setPort
public void setPort(int port)
-
setRecoveryCounter
public void setRecoveryCounter(int recoveryCounter)
-
getRecoveryCounter
public int getRecoveryCounter()
- Specified by:
getRecoveryCounterin interfaceMcastServiceMBean
-
setRecoveryEnabled
public void setRecoveryEnabled(boolean recoveryEnabled)
-
getRecoveryEnabled
public boolean getRecoveryEnabled()
- Specified by:
getRecoveryEnabledin interfaceMcastServiceMBean
-
setRecoverySleepTime
public void setRecoverySleepTime(long recoverySleepTime)
-
getRecoverySleepTime
public long getRecoverySleepTime()
- Specified by:
getRecoverySleepTimein interfaceMcastServiceMBean
-
setLocalLoopbackDisabled
public void setLocalLoopbackDisabled(boolean localLoopbackDisabled)
-
getLocalLoopbackDisabled
public boolean getLocalLoopbackDisabled()
- Specified by:
getLocalLoopbackDisabledin interfaceMcastServiceMBean
-
getPort
public int getPort()
- Specified by:
getPortin interfaceMcastServiceMBean
-
setFrequency
public void setFrequency(long time)
-
getFrequency
public long getFrequency()
- Specified by:
getFrequencyin interfaceMcastServiceMBean
-
setMcastDropTime
public void setMcastDropTime(long time)
-
setDropTime
public void setDropTime(long time)
-
getDropTime
public long getDropTime()
- Specified by:
getDropTimein interfaceMcastServiceMBean
-
hasProperty
protected void hasProperty(java.util.Properties properties, java.lang.String name)Check if a required property is available.- Parameters:
properties- The set of propertiesname- The property to check for
-
start
public void start() throws java.lang.ExceptionStart broadcasting and listening to membership pings- Specified by:
startin interfaceMembershipService- Throws:
java.lang.Exception- if a IO error occurs
-
start
public void start(int level) throws java.lang.ExceptionDescription copied from interface:MembershipServiceStarts the membership service. If a membership listeners is added the listener will start to receive membership events.- Specified by:
startin interfaceMembershipService- Parameters:
level- - level MBR_RX starts listening for members, level MBR_TX starts broad casting the server- Throws:
java.lang.Exception- if the service fails to start.java.lang.IllegalArgumentException- if the level is incorrect.
-
stop
public void stop(int svc)
Stop broadcasting and listening to membership pings- Specified by:
stopin interfaceMembershipService- Parameters:
svc- - level MBR_RX stops listening for members, level MBR_TX stops broad casting the server
-
getMembersByName
public java.lang.String[] getMembersByName()
Return all the members by name- Specified by:
getMembersByNamein interfaceMcastServiceMBean- Specified by:
getMembersByNamein interfaceMembershipService- Returns:
- all members by name
-
findMemberByName
public Member findMemberByName(java.lang.String name)
Return the member by name- Specified by:
findMemberByNamein interfaceMcastServiceMBean- Specified by:
findMemberByNamein interfaceMembershipService- Parameters:
name- The member name- Returns:
- the member
-
hasMembers
public boolean hasMembers()
has members?- Specified by:
hasMembersin interfaceMcastServiceMBean- Specified by:
hasMembersin interfaceMembershipService- Returns:
- true if the the group contains members
-
getMember
public Member getMember(Member mbr)
Description copied from interface:MembershipServiceRetrieve the specified member from the membership.- Specified by:
getMemberin interfaceMembershipService- Parameters:
mbr- The member to retrieve- Returns:
- the member
-
getMembers
public Member[] getMembers()
- Specified by:
getMembersin interfaceMembershipService- Returns:
- a list of all the members in the cluster.
-
setMembershipListener
public void setMembershipListener(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.- Specified by:
setMembershipListenerin interfaceMembershipService- Parameters:
listener- The listener
-
setMessageListener
public void setMessageListener(MessageListener listener)
-
removeMessageListener
public void removeMessageListener()
-
removeMembershipListener
public void removeMembershipListener()
Remove the membership listener- Specified by:
removeMembershipListenerin interfaceMembershipService
-
memberAdded
public void memberAdded(Member member)
Description copied from interface:MembershipListenerA member was added to the group- Specified by:
memberAddedin interfaceMembershipListener- Parameters:
member- Member - the member that was added
-
memberDisappeared
public void memberDisappeared(Member member)
Callback from the impl when a new member has been received- Specified by:
memberDisappearedin interfaceMembershipListener- Parameters:
member- The member- See Also:
Member.SHUTDOWN_PAYLOAD
-
messageReceived
public void messageReceived(ChannelMessage msg)
Description copied from interface:MessageListenerReceive a message from the IO components in the Channel stack- Specified by:
messageReceivedin interfaceMessageListener- Parameters:
msg- ChannelMessage
-
accept
public boolean accept(ChannelMessage msg)
- Specified by:
acceptin interfaceMessageListener
-
broadcast
public void broadcast(ChannelMessage message) throws ChannelException
Description copied from interface:MembershipServiceBroadcasts a message to all members.- Specified by:
broadcastin interfaceMembershipService- Parameters:
message- The message to broadcast- Throws:
ChannelException- Message broadcast failed
-
getSoTimeout
public int getSoTimeout()
- Specified by:
getSoTimeoutin interfaceMcastServiceMBean
-
setSoTimeout
public void setSoTimeout(int mcastSoTimeout)
-
getTtl
public int getTtl()
- Specified by:
getTtlin interfaceMcastServiceMBean
-
getPayload
public byte[] getPayload()
-
getDomain
public byte[] getDomain()
- Specified by:
getDomainin interfaceMcastServiceMBean
-
setTtl
public void setTtl(int mcastTTL)
-
setPayload
public void setPayload(byte[] payload)
Description copied from interface:MembershipServiceSet a payload to be broadcasted with each membership broadcast.- Specified by:
setPayloadin interfaceMembershipService- Parameters:
payload- byte[]
-
setDomain
public void setDomain(byte[] domain)
- Specified by:
setDomainin interfaceMembershipService
-
setDomain
public void setDomain(java.lang.String domain)
-
getChannel
public Channel getChannel()
Description copied from interface:MembershipServiceReturn the channel that is related to this MembershipService- Specified by:
getChannelin interfaceMembershipService- Returns:
- Channel
-
setChannel
public void setChannel(Channel channel)
Description copied from interface:MembershipServiceSet the channel that is related to this MembershipService- Specified by:
setChannelin interfaceMembershipService- Parameters:
channel- The channel
-
setDefaults
protected void setDefaults(java.util.Properties properties)
-
main
public static void main(java.lang.String[] args) throws java.lang.ExceptionSimple test program- Parameters:
args- Command-line arguments- Throws:
java.lang.Exception- If an error occurs
-
-