org.apache.catalina.tribes
Interface MembershipService

All Known Implementing Classes:

McastService

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:

$Id: MembershipService.java 939305 2010-04-29 13:43:39Z kkolinko $

Author:

Filip Hanik

Field Summary

static int	MBR_RX
static int	MBR_TX

Method Summary

void	broadcast(ChannelMessage message) Broadcasts a message to all members
Member	findMemberByName(String name) Return the member by name
Member	getLocalMember(boolean incAliveTime) Returns the member object that defines this member
Member	getMember(Member mbr)
Member[]	getMembers() Returns a list of all the members in the cluster.
String[]	getMembersByName() Return all members by name
Properties	getProperties() Returns the properties for the configuration used.
boolean	hasMembers()
void	removeMembershipListener() removes the membership listener.
void	setDomain(byte[] domain)
void	setLocalMemberProperties(String listenHost, int listenPort, int securePort, int udpPort) Sets the local member properties for broadcasting
void	setMembershipListener(MembershipListener listener) Sets the membership listener, only one listener can be added.
void	setPayload(byte[] payload) Set a payload to be broadcasted with each membership broadcast.
void	setProperties(Properties properties) Sets the properties for the membership service.
void	start() Starts the membership service.
void	start(int level) Starts the membership service.
void	stop(int level) Starts the membership service.

Field Detail

MBR_RX

static final int MBR_RX

See Also:

Constant Field Values

MBR_TX

static final int MBR_TX

See Also:

Constant Field Values

Method Detail

setProperties

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.

getProperties

Properties getProperties()

Returns the properties for the configuration used.

start

void start()
           throws Exception

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:

Exception - if the service fails to start.

start

void start(int level)
           throws Exception

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:

Exception - if the service fails to start.

IllegalArgumentException - if the level is incorrect.

stop

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:

Exception - if the service fails to stop

IllegalArgumentException - if the level is incorrect.

hasMembers

boolean hasMembers()

Returns:

true if the the group contains members

getMember

Member getMember(Member mbr)

Parameters:

mbr - Member

Returns:

Member

getMembers

Member[] getMembers()

Returns a list of all the members in the cluster.

getLocalMember

Member getLocalMember(boolean incAliveTime)

Returns the member object that defines this member

getMembersByName

String[] getMembersByName()

Return all members by name

findMemberByName

Member findMemberByName(String name)

Return the member by name

setLocalMemberProperties

void setLocalMemberProperties(String listenHost,
                              int listenPort,
                              int securePort,
                              int udpPort)

Sets the local member properties for broadcasting

setMembershipListener

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

removeMembershipListener

void removeMembershipListener()

removes the membership listener.

setPayload

void setPayload(byte[] payload)

Set a payload to be broadcasted with each membership broadcast.

Parameters:

payload - byte[]

setDomain

void setDomain(byte[] domain)

broadcast

void broadcast(ChannelMessage message)
               throws ChannelException

Broadcasts a message to all members

Parameters:

message -

Throws:

ChannelException