Package org.apache.catalina.tribes.membership

Class MembershipProviderBase

java.lang.Object

org.apache.catalina.tribes.membership.MembershipProviderBase

All Implemented Interfaces:

MembershipProvider

Direct Known Subclasses:

CloudMembershipProvider, McastServiceImpl, StaticMembershipProvider

public abstract class MembershipProviderBase
extends java.lang.Object
implements MembershipProvider

Base implementation for membership providers.

Field Summary

Fields

Modifier and Type	Field	Description
protected java.util.concurrent.ScheduledExecutorService	executor	The event notification executor.
protected Membership	membership	The membership.
protected MembershipListener	membershipListener	The membership listener.
protected MembershipService	service	The membership service.

Constructor Summary

Constructors

Constructor	Description
MembershipProviderBase()	Default constructor.

Method Summary

Modifier and Type	Method	Description
Member	getMember(Member mbr)	Get the specified member from the associated membership.
Member[]	getMembers()	Get the members from the associated membership.
boolean	hasMembers()	Checks whether the membership contains any members.
void	init(java.util.Properties properties)	Initialize the membership provider with the specified configuration.
void	setMembershipListener(MembershipListener listener)	Set the associated membership listener.
void	setMembershipService(MembershipService service)	Set the associated membership service.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.catalina.tribes.MembershipProvider

start, stop

Field Detail

membership

protected Membership membership

The membership.

membershipListener

protected MembershipListener membershipListener

The membership listener.

service

protected MembershipService service

The membership service.

executor

protected java.util.concurrent.ScheduledExecutorService executor

The event notification executor.

Constructor Detail

MembershipProviderBase

public MembershipProviderBase()

Default constructor.

Method Detail

init

public void init(java.util.Properties properties)
          throws java.lang.Exception

Description copied from interface: MembershipProvider

Initialize the membership provider with the specified configuration.

Specified by:

init in interface MembershipProvider

Parameters:

properties - configuration

Throws:

java.lang.Exception - if an error occurs

hasMembers

public boolean hasMembers()

Description copied from interface: MembershipProvider

Checks whether the membership contains any members.

Specified by:

hasMembers in interface MembershipProvider

Returns:

true if there are members

getMember

public Member getMember(Member mbr)

Description copied from interface: MembershipProvider

Get the specified member from the associated membership.

Specified by:

getMember in interface MembershipProvider

Parameters:

mbr - the member

Returns:

the member

getMembers

public Member[] getMembers()

Description copied from interface: MembershipProvider

Get the members from the associated membership.

Specified by:

getMembers in interface MembershipProvider

Returns:

the members

setMembershipListener

public void setMembershipListener(MembershipListener listener)

Description copied from interface: MembershipProvider

Set the associated membership listener.

Specified by:

setMembershipListener in interface MembershipProvider

Parameters:

listener - the listener

setMembershipService

public void setMembershipService(MembershipService service)

Description copied from interface: MembershipProvider

Set the associated membership service.

Specified by:

setMembershipService in interface MembershipProvider

Parameters:

service - the service