Package org.apache.catalina.tribes
Interface MembershipService
- All Known Implementing Classes:
- CloudMembershipService,- McastService,- MembershipServiceBase,- StaticMembershipService
public interface MembershipService
MembershipService Interface
The
The
MembershipService interface is the membership component
 at the bottom layer, the IO layer (for layers see the javadoc for the Channel interface).- 
Field SummaryFields
- 
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 MembershipServicegetLocalMember(boolean incAliveTime) Get the local member.Retrieve the specified member from the membership.Member[]String[]Get the MembershipProviderbooleanvoidRemoves the membership listener.voidsetChannel(Channel channel) Set the channel that is related to this MembershipServicevoidsetDomain(byte[] domain) voidsetLocalMemberProperties(String listenHost, int listenPort, int securePort, int udpPort) Sets the local member properties for broadcasting.voidsetMembershipListener(MembershipListener listener) Sets the membership listener, only one listener can be added.voidsetPayload(byte[] payload) Set a payload to be broadcasted with each membership broadcast.voidsetProperties(Properties properties) Sets the properties for the membership service.voidstart()Starts the membership service.voidstart(int level) Starts the membership service.voidstop(int level) Starts the membership service.
- 
Field Details- 
MBR_RXstatic final int MBR_RX- See Also:
 
- 
MBR_TXstatic final int MBR_TX- See Also:
 
 
- 
- 
Method Details- 
setPropertiesSets the properties for the membership service. This must be called before thestart()method is called. The properties are implementation specific.- Parameters:
- properties- - to be used to configure the membership service.
 
- 
getPropertiesProperties getProperties()- Returns:
- the properties for the configuration used.
 
- 
startStarts the membership service. If a membership listeners is added the listener will start to receive membership events. Performs a start level 1 and 2- Throws:
- Exception- if the service fails to start.
 
- 
startStarts the membership service. If a membership listeners is added the listener will start to receive membership events.- Parameters:
- level- - level MBR_RX starts listening for members, level MBR_TX starts broad casting the server
- Throws:
- Exception- if the service fails to start.
- IllegalArgumentException- if the level is incorrect.
 
- 
stopvoid stop(int level) Starts the membership service. If a membership listeners is added the listener will start to receive membership events.- Parameters:
- level- - level MBR_RX stops listening for members, level MBR_TX stops broad casting the server
- Throws:
- IllegalArgumentException- if the level is incorrect.
 
- 
hasMembersboolean hasMembers()- Returns:
- true if the the group contains members
 
- 
getMemberRetrieve the specified member from the membership.- Parameters:
- mbr- The member to retrieve
- Returns:
- the member
 
- 
getMembersMember[] getMembers()- Returns:
- a list of all the members in the cluster.
 
- 
getLocalMemberGet the local member.- Parameters:
- incAliveTime-- trueto set the alive time on the local member
- Returns:
- the member object that defines this member
 
- 
getMembersByNameString[] getMembersByName()- Returns:
- all members by name
 
- 
findMemberByNameGet a member.- Parameters:
- name- The member name
- Returns:
- the member
 
- 
setLocalMemberPropertiesSets the local member properties for broadcasting.- Parameters:
- listenHost- Listen to host
- listenPort- Listen to port
- securePort- Use a secure port
- udpPort- Use UDP
 
- 
setMembershipListenerSets the membership listener, only one listener can be added. If you call this method twice, the last listener will be used.- Parameters:
- listener- The listener
 
- 
removeMembershipListenervoid removeMembershipListener()Removes the membership listener.
- 
setPayloadvoid setPayload(byte[] payload) Set a payload to be broadcasted with each membership broadcast.- Parameters:
- payload- byte[]
 
- 
setDomainvoid setDomain(byte[] domain) 
- 
broadcastBroadcasts a message to all members.- Parameters:
- message- The message to broadcast
- Throws:
- ChannelException- Message broadcast failed
 
- 
getChannelChannel getChannel()Return the channel that is related to this MembershipService- Returns:
- Channel
 
- 
setChannelSet the channel that is related to this MembershipService- Parameters:
- channel- The channel
 
- 
getMembershipProviderMembershipProvider getMembershipProvider()Get the MembershipProvider- Returns:
- MembershipProvider
 
 
-