org.apache.catalina.tribes

Interface MembershipService

public interface MembershipService

MembershipService Interface
The MembershipService interface is the membership component at the bottom layer, the IO layer (for layers see the javadoc for the Channel interface).

Version: $Revision: 467222 $, $Date: 2006-10-24 05:17:11 +0200 (Tue, 24 Oct 2006) $

Author: Filip Hanik

Field Summary
static intMBR_RX
static intMBR_TX
Method Summary
MemberfindMemberByName(String name)
Return the member by name
MembergetLocalMember(boolean incAliveTime)
Returns the member object that defines this member
MembergetMember(Member mbr)
Member[]getMembers()
Returns a list of all the members in the cluster.
String[]getMembersByName()
Return all members by name
PropertiesgetProperties()
Returns the properties for the configuration used.
booleanhasMembers()
voidremoveMembershipListener()
removes the membership listener.
voidsetDomain(byte[] domain)
voidsetLocalMemberProperties(String listenHost, int listenPort)
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 Detail

MBR_RX

public static final int MBR_RX

MBR_TX

public static final int MBR_TX

Method Detail

findMemberByName

public Member findMemberByName(String name)
Return the member by name

getLocalMember

public Member getLocalMember(boolean incAliveTime)
Returns the member object that defines this member

getMember

public Member getMember(Member mbr)

Parameters: mbr Member

Returns: Member

getMembers

public Member[] getMembers()
Returns a list of all the members in the cluster.

getMembersByName

public String[] getMembersByName()
Return all members by name

getProperties

public Properties getProperties()
Returns the properties for the configuration used.

hasMembers

public boolean hasMembers()

Returns: true if the the group contains members

removeMembershipListener

public void removeMembershipListener()
removes the membership listener.

setDomain

public void setDomain(byte[] domain)

setLocalMemberProperties

public void setLocalMemberProperties(String listenHost, int listenPort)
Sets the local member properties for broadcasting

setMembershipListener

public void 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

setPayload

public void setPayload(byte[] payload)
Set a payload to be broadcasted with each membership broadcast.

Parameters: payload byte[]

setProperties

public void setProperties(Properties properties)
Sets the properties for the membership service. This must be called before the start() method is called. The properties are implementation specific.

Parameters: properties - to be used to configure the membership service.

start

public void start()
Starts 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.

start

public void start(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 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.

stop

public void 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.Exception if the service fails to stop java.lang.IllegalArgumentException if the level is incorrect.

Copyright © 2000-2011 Apache Software Foundation. All Rights Reserved.