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 SummaryFieldsModifier and TypeFieldDescriptionprotected Channelprotected MembershipListenerprotected PropertiesThe implementation specific propertiesFields inherited from interface org.apache.catalina.tribes.MembershipServiceMBR_RX, MBR_TX
- 
Constructor SummaryConstructors
- 
Method SummaryModifier 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.Objectclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface org.apache.catalina.tribes.MembershipServicegetLocalMember, getMembershipProvider, setDomain, setLocalMemberProperties, setPayload, start, stop
- 
Field Details- 
propertiesThe implementation specific properties
- 
listener
- 
channel
 
- 
- 
Constructor Details- 
MembershipServiceBasepublic MembershipServiceBase()
 
- 
- 
Method Details- 
setPropertiesDescription 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 interface- MembershipService
- Parameters:
- properties- - to be used to configure the membership service.
 
- 
getProperties- Specified by:
- getPropertiesin interface- MembershipService
- Returns:
- the properties for the configuration used.
 
- 
hasMemberspublic boolean hasMembers()- Specified by:
- hasMembersin interface- MembershipService
- Returns:
- true if the the group contains members
 
- 
getMemberDescription copied from interface:MembershipServiceRetrieve the specified member from the membership.- Specified by:
- getMemberin interface- MembershipService
- Parameters:
- mbr- The member to retrieve
- Returns:
- the member
 
- 
getMembers- Specified by:
- getMembersin interface- MembershipService
- Returns:
- a list of all the members in the cluster.
 
- 
getMembersByName- Specified by:
- getMembersByNamein interface- MembershipService
- Returns:
- all members by name
 
- 
findMemberByNameDescription copied from interface:MembershipServiceGet a member.- Specified by:
- findMemberByNamein interface- MembershipService
- Parameters:
- name- The member name
- Returns:
- the member
 
- 
setMembershipListenerDescription 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 interface- MembershipService
- Parameters:
- listener- The listener
 
- 
removeMembershipListenerpublic void removeMembershipListener()Description copied from interface:MembershipServiceRemoves the membership listener.- Specified by:
- removeMembershipListenerin interface- MembershipService
 
- 
memberAddedDescription copied from interface:MembershipListenerA member was added to the group- Specified by:
- memberAddedin interface- MembershipListener
- Parameters:
- member- Member - the member that was added
 
- 
memberDisappearedDescription 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 interface- MembershipListener
- Parameters:
- member- Member
- See Also:
 
- 
broadcastDescription copied from interface:MembershipServiceBroadcasts a message to all members.- Specified by:
- broadcastin interface- MembershipService
- Parameters:
- message- The message to broadcast
- Throws:
- ChannelException- Message broadcast failed
 
- 
getChannelDescription copied from interface:MembershipServiceReturn the channel that is related to this MembershipService- Specified by:
- getChannelin interface- MembershipService
- Returns:
- Channel
 
- 
setChannelDescription copied from interface:MembershipServiceSet the channel that is related to this MembershipService- Specified by:
- setChannelin interface- MembershipService
- Parameters:
- channel- The channel
 
- 
startDescription 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 interface- MembershipService
- Throws:
- Exception- if the service fails to start.
 
 
-