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 java.lang.Object implements MembershipService, MembershipListener 
- 
- 
Field SummaryFields Modifier and Type Field Description protected Channelchannelprotected MembershipListenerlistenerprotected java.util.PropertiespropertiesThe implementation specific properties- 
Fields inherited from interface org.apache.catalina.tribes.MembershipServiceMBR_RX, MBR_TX
 
- 
 - 
Constructor SummaryConstructors Constructor Description MembershipServiceBase()
 - 
Method SummaryAll Methods Instance Methods Concrete Methods Modifier and Type Method Description voidbroadcast(ChannelMessage message)Broadcasts a message to all members.MemberfindMemberByName(java.lang.String name)Get a member.ChannelgetChannel()Return the channel that is related to this MembershipServiceMembergetMember(Member mbr)Retrieve the specified member from the membership.Member[]getMembers()java.lang.String[]getMembersByName()java.util.PropertiesgetProperties()booleanhasMembers()voidmemberAdded(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 datavoidremoveMembershipListener()Removes 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(java.util.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, wait
 - 
Methods inherited from interface org.apache.catalina.tribes.MembershipServicegetLocalMember, getMembershipProvider, setDomain, setLocalMemberProperties, setPayload, start, stop
 
- 
 
- 
- 
- 
Field Detail- 
propertiesprotected java.util.Properties properties The implementation specific properties
 - 
listenerprotected volatile MembershipListener listener 
 - 
channelprotected Channel channel 
 
- 
 - 
Method Detail- 
setPropertiespublic void setProperties(java.util.Properties properties) 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 interface- MembershipService
- Parameters:
- properties- - to be used to configure the membership service.
 
 - 
getPropertiespublic java.util.Properties 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
 
 - 
getMemberpublic Member getMember(Member mbr) Description copied from interface:MembershipServiceRetrieve the specified member from the membership.- Specified by:
- getMemberin interface- MembershipService
- Parameters:
- mbr- The member to retrieve
- Returns:
- the member
 
 - 
getMemberspublic Member[] getMembers() - Specified by:
- getMembersin interface- MembershipService
- Returns:
- a list of all the members in the cluster.
 
 - 
getMembersByNamepublic java.lang.String[] getMembersByName() - Specified by:
- getMembersByNamein interface- MembershipService
- Returns:
- all members by name
 
 - 
findMemberByNamepublic Member findMemberByName(java.lang.String name) Description copied from interface:MembershipServiceGet a member.- Specified by:
- findMemberByNamein interface- MembershipService
- Parameters:
- name- The member name
- Returns:
- the member
 
 - 
setMembershipListenerpublic void setMembershipListener(MembershipListener listener) 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 interface- MembershipService
- Parameters:
- listener- The listener
 
 - 
removeMembershipListenerpublic void removeMembershipListener() Description copied from interface:MembershipServiceRemoves the membership listener.- Specified by:
- removeMembershipListenerin interface- MembershipService
 
 - 
memberAddedpublic void memberAdded(Member member) Description copied from interface:MembershipListenerA member was added to the group- Specified by:
- memberAddedin interface- MembershipListener
- Parameters:
- member- Member - the member that was added
 
 - 
memberDisappearedpublic void memberDisappeared(Member member) 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 interface- MembershipListener
- Parameters:
- member- Member
- See Also:
- Member.SHUTDOWN_PAYLOAD
 
 - 
broadcastpublic void broadcast(ChannelMessage message) throws ChannelException Description 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
 
 - 
getChannelpublic Channel getChannel() Description copied from interface:MembershipServiceReturn the channel that is related to this MembershipService- Specified by:
- getChannelin interface- MembershipService
- Returns:
- Channel
 
 - 
setChannelpublic void setChannel(Channel channel) Description copied from interface:MembershipServiceSet the channel that is related to this MembershipService- Specified by:
- setChannelin interface- MembershipService
- Parameters:
- channel- The channel
 
 - 
startpublic void start() 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. Performs a start level 1 and 2- Specified by:
- startin interface- MembershipService
- Throws:
- java.lang.Exception- if the service fails to start.
 
 
- 
 
-