org.apache.catalina.tribes.group

Class ChannelInterceptorBase

public abstract class ChannelInterceptorBase extends Object implements ChannelInterceptor

Abstract class for the interceptor base class.

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

Author: Filip Hanik

Field Summary
protected static Loglog
protected intoptionFlag
Constructor Summary
ChannelInterceptorBase()
Method Summary
booleanaccept(ChannelMessage msg)
voidfireInterceptorEvent(InterceptorEvent event)
MembergetLocalMember(boolean incAlive)
Return the member that represents this node.
MembergetMember(Member mbr)
Member[]getMembers()
Get all current cluster members
ChannelInterceptorgetNext()
intgetOptionFlag()
ChannelInterceptorgetPrevious()
booleanhasMembers()
has members
voidheartbeat()
voidmemberAdded(Member member)
voidmemberDisappeared(Member member)
voidmessageReceived(ChannelMessage msg)
booleanokToProcess(int messageFlags)
voidsendMessage(Member[] destination, ChannelMessage msg, InterceptorPayload payload)
voidsetNext(ChannelInterceptor next)
voidsetOptionFlag(int optionFlag)
voidsetPrevious(ChannelInterceptor previous)
voidstart(int svc)
Starts up the channel.
voidstop(int svc)
Shuts down the channel.

Field Detail

log

protected static Log log

optionFlag

protected int optionFlag

Constructor Detail

ChannelInterceptorBase

public ChannelInterceptorBase()

Method Detail

accept

public boolean accept(ChannelMessage msg)

fireInterceptorEvent

public void fireInterceptorEvent(InterceptorEvent event)

getLocalMember

public Member getLocalMember(boolean incAlive)
Return the member that represents this node.

Returns: Member

getMember

public Member getMember(Member mbr)

Parameters: mbr Member

Returns: Member

getMembers

public Member[] getMembers()
Get all current cluster members

Returns: all members or empty array

getNext

public final ChannelInterceptor getNext()

getOptionFlag

public int getOptionFlag()

getPrevious

public final ChannelInterceptor getPrevious()

hasMembers

public boolean hasMembers()
has members

heartbeat

public void heartbeat()

memberAdded

public void memberAdded(Member member)

memberDisappeared

public void memberDisappeared(Member member)

messageReceived

public void messageReceived(ChannelMessage msg)

okToProcess

public boolean okToProcess(int messageFlags)

sendMessage

public void sendMessage(Member[] destination, ChannelMessage msg, InterceptorPayload payload)

setNext

public final void setNext(ChannelInterceptor next)

setOptionFlag

public void setOptionFlag(int optionFlag)

setPrevious

public final void setPrevious(ChannelInterceptor previous)

start

public void start(int svc)
Starts up the channel. This can be called multiple times for individual services to start The svc parameter can be the logical or value of any constants

Parameters: svc int value of
DEFAULT - will start all services
MBR_RX_SEQ - starts the membership receiver
MBR_TX_SEQ - starts the membership broadcaster
SND_TX_SEQ - starts the replication transmitter
SND_RX_SEQ - starts the replication receiver

Throws: ChannelException if a startup error occurs or the service is already started.

stop

public void stop(int svc)
Shuts down the channel. This can be called multiple times for individual services to shutdown The svc parameter can be the logical or value of any constants

Parameters: svc int value of
DEFAULT - will shutdown all services
MBR_RX_SEQ - stops the membership receiver
MBR_TX_SEQ - stops the membership broadcaster
SND_TX_SEQ - stops the replication transmitter
SND_RX_SEQ - stops the replication receiver

Throws: ChannelException if a startup error occurs or the service is already started.

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