Package org.apache.catalina.tribes
Interface MembershipService
- 
- All Known Implementing Classes:
- McastService
 
 public interface MembershipServiceMembershipService Interface
 TheMembershipServiceinterface is the membership component at the bottom layer, the IO layer (for layers see the javadoc for theChannelinterface).
- 
- 
Method SummaryAll Methods Instance Methods Abstract 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 MembershipServiceMembergetLocalMember(boolean incAliveTime)Get the local member.MembergetMember(Member mbr)Retrieve the specified member from the membership.Member[]getMembers()java.lang.String[]getMembersByName()java.util.PropertiesgetProperties()booleanhasMembers()voidremoveMembershipListener()Removes the membership listener.voidsetChannel(Channel channel)Set the channel that is related to this MembershipServicevoidsetDomain(byte[] domain)voidsetLocalMemberProperties(java.lang.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(java.util.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 Detail- 
MBR_RXstatic final int MBR_RX - See Also:
- Constant Field Values
 
 - 
MBR_TXstatic final int MBR_TX - See Also:
- Constant Field Values
 
 
- 
 - 
Method Detail- 
setPropertiesvoid setProperties(java.util.Properties properties) Sets 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.
 
 - 
getPropertiesjava.util.Properties getProperties() - Returns:
- the properties for the configuration used.
 
 - 
startvoid start() throws java.lang.ExceptionStarts 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:
- java.lang.Exception- if the service fails to start.
 
 - 
startvoid start(int level) throws java.lang.ExceptionStarts 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:
- java.lang.Exception- if the service fails to start.
- java.lang.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:
- java.lang.IllegalArgumentException- if the level is incorrect.
 
 - 
hasMembersboolean hasMembers() - Returns:
- true if the the group contains members
 
 - 
getMemberMember getMember(Member mbr) Retrieve 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.
 
 - 
getLocalMemberMember getLocalMember(boolean incAliveTime) Get the local member.- Parameters:
- incAliveTime-- trueto set the alive time on the local member
- Returns:
- the member object that defines this member
 
 - 
getMembersByNamejava.lang.String[] getMembersByName() - Returns:
- all members by name
 
 - 
findMemberByNameMember findMemberByName(java.lang.String name) Get a member.- Parameters:
- name- The member name
- Returns:
- the member
 
 - 
setLocalMemberPropertiesvoid setLocalMemberProperties(java.lang.String listenHost, int listenPort, int securePort, int udpPort)Sets the local member properties for broadcasting.- Parameters:
- listenHost- Listen to host
- listenPort- Listen to port
- securePort- Use a secure port
- udpPort- Use UDP
 
 - 
setMembershipListenervoid setMembershipListener(MembershipListener listener) Sets 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) 
 - 
broadcastvoid broadcast(ChannelMessage message) throws ChannelException Broadcasts 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
 
 - 
setChannelvoid setChannel(Channel channel) Set the channel that is related to this MembershipService- Parameters:
- channel- The channel
 
 
- 
 
-