Class MembershipServiceBase
java.lang.Object
org.apache.catalina.tribes.membership.MembershipServiceBase
- All Implemented Interfaces:
MembershipListener,MembershipService
- Direct Known Subclasses:
CloudMembershipService,McastService,StaticMembershipService
public abstract class MembershipServiceBase
extends Object
implements MembershipService, MembershipListener
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected Channelprotected MembershipListenerprotected PropertiesThe implementation specific propertiesFields inherited from interface org.apache.catalina.tribes.MembershipService
MBR_RX, MBR_TX -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoidbroadcast(ChannelMessage message) Broadcasts a message to all members.findMemberByName(String name) Get a member.Return the channel that is related to this MembershipServiceRetrieve the specified member from the membership.Member[]String[]booleanvoidmemberAdded(Member member) A member was added to the groupvoidmemberDisappeared(Member member) A member was removed from the group
If the member left voluntarily, the Member.getCommand will contain the Member.SHUTDOWN_PAYLOAD datavoidRemoves the membership listener.voidsetChannel(Channel channel) Set the channel that is related to this MembershipServicevoidsetMembershipListener(MembershipListener listener) Sets the membership listener, only one listener can be added.voidsetProperties(Properties properties) Sets the properties for the membership service.voidstart()Starts the membership service.Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface org.apache.catalina.tribes.MembershipService
getLocalMember, getMembershipProvider, setDomain, setLocalMemberProperties, setPayload, start, stop
-
Field Details
-
properties
The implementation specific properties -
listener
-
channel
-
-
Constructor Details
-
MembershipServiceBase
public MembershipServiceBase()
-
-
Method Details
-
setProperties
Description copied from interface:MembershipServiceSets the properties for the membership service. This must be called before thestart()method is called. The properties are implementation specific.- Specified by:
setPropertiesin interfaceMembershipService- Parameters:
properties- - to be used to configure the membership service.
-
getProperties
- Specified by:
getPropertiesin interfaceMembershipService- Returns:
- the properties for the configuration used.
-
hasMembers
public boolean hasMembers()- Specified by:
hasMembersin interfaceMembershipService- Returns:
- true if the the group contains members
-
getMember
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
- Specified by:
getMembersin interfaceMembershipService- Returns:
- a list of all the members in the cluster.
-
getMembersByName
- Specified by:
getMembersByNamein interfaceMembershipService- Returns:
- all members by name
-
findMemberByName
Description copied from interface:MembershipServiceGet a member.- Specified by:
findMemberByNamein interfaceMembershipService- Parameters:
name- The member name- Returns:
- the member
-
setMembershipListener
Description copied from interface:MembershipServiceSets the membership listener, only one listener can be added. If you call this method twice, the last listener will be used.- Specified by:
setMembershipListenerin interfaceMembershipService- Parameters:
listener- The listener
-
removeMembershipListener
public void removeMembershipListener()Description copied from interface:MembershipServiceRemoves the membership listener.- Specified by:
removeMembershipListenerin interfaceMembershipService
-
memberAdded
Description copied from interface:MembershipListenerA member was added to the group- Specified by:
memberAddedin interfaceMembershipListener- Parameters:
member- Member - the member that was added
-
memberDisappeared
Description copied from interface:MembershipListenerA member was removed from the group
If the member left voluntarily, the Member.getCommand will contain the Member.SHUTDOWN_PAYLOAD data- Specified by:
memberDisappearedin interfaceMembershipListener- Parameters:
member- Member- See Also:
-
broadcast
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
-
getChannel
Description copied from interface:MembershipServiceReturn the channel that is related to this MembershipService- Specified by:
getChannelin interfaceMembershipService- Returns:
- Channel
-
setChannel
Description copied from interface:MembershipServiceSet the channel that is related to this MembershipService- Specified by:
setChannelin interfaceMembershipService- Parameters:
channel- The channel
-
start
Description copied from interface:MembershipServiceStarts the membership service. If a membership listeners is added the listener will start to receive membership events. Performs a start level 1 and 2- Specified by:
startin interfaceMembershipService- Throws:
Exception- if the service fails to start.
-