com.fr.third.jgroups.protocols

类 AUTH

java.lang.Object

com.fr.third.jgroups.stack.Protocol

com.fr.third.jgroups.protocols.AUTH

public class AUTH
extends Protocol

The AUTH protocol adds a layer of authentication to JGroups

作者:

Chris Mills, Bela Ban

嵌套类概要

嵌套类

限定符和类型	类和说明
static interface	AUTH.UpHandler Interface to provide callbacks for handling up events

字段概要

字段

限定符和类型	字段和说明
protected AuthToken	auth_token Used on the coordinator to authentication joining member requests against
protected static short	gms_id
protected Address	local_addr
protected java.util.List<AUTH.UpHandler>	up_handlers List of UpHandler which are called when an up event has been received.

从类继承的字段 com.fr.third.jgroups.stack.Protocol

down_prot, ergonomics, id, log, name, stack, stats, up_prot

构造器概要

构造器

构造器和说明
AUTH()

方法概要

方法

限定符和类型	方法和说明
protected boolean	callUpHandlers(Event evt)
java.lang.Object	down(Event evt) An event is to be sent down the stack.
Address	getAddress()
java.lang.String	getAuthClass()
AuthToken	getAuthToken()
protected java.util.List<java.lang.Object>	getConfigurableObjects() After configuring the protocol itself from the properties defined in the XML config, a protocol might have additional objects which need to be configured.
protected static GMS.GmsHeader	getGMSHeader(Event evt) Get the header from a GMS message
protected static GMS.GmsHeader	getGMSHeader(Message msg)
protected boolean	handleAuthHeader(GMS.GmsHeader gms_hdr, AuthHeader auth_hdr, Message msg) Handles a GMS header
void	init() Called after instance has been created (null constructor) and before protocol is started.
protected boolean	needsAuthentication(GMS.GmsHeader hdr)
void	register(AUTH.UpHandler handler)
protected void	sendJoinRejectionMessage(Address dest, java.lang.String error_msg)
protected void	sendMergeRejectionMessage(Address dest)
protected void	sendRejectionMessage(byte type, Address dest, java.lang.String error_msg)
void	setAuthClass(java.lang.String class_name)
void	setAuthCoord(boolean authenticateCoord)
void	setAuthToken(AuthToken token)
void	unregister(AUTH.UpHandler handler)
java.lang.Object	up(Event evt) An event was received from the layer below.
void	up(MessageBatch batch) Sends up a multiple messages in a MessageBatch.

从类继承的方法 com.fr.third.jgroups.stack.Protocol

accept, destroy, dumpStats, enableStats, getDownProtocol, getDownServices, getId, getIdsAbove, getLevel, getName, getProtocolStack, getSocketFactory, getThreadFactory, getTransport, getUpProtocol, getUpServices, getValue, isErgonomics, level, parse, printStats, providedDownServices, providedUpServices, requiredDownServices, requiredUpServices, resetStatistics, resetStats, setDownProtocol, setErgonomics, setId, setLevel, setProtocolStack, setSocketFactory, setUpProtocol, setValue, setValues, start, statsEnabled, stop

从类继承的方法 java.lang.Object

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

字段详细资料

auth_token

protected AuthToken auth_token

Used on the coordinator to authentication joining member requests against

gms_id

protected static final short gms_id

up_handlers

protected final java.util.List<AUTH.UpHandler> up_handlers

List of UpHandler which are called when an up event has been received. Usually used by AuthToken impls

local_addr

protected Address local_addr

构造器详细资料

AUTH

public AUTH()

方法详细资料

setAuthCoord

public void setAuthCoord(boolean authenticateCoord)

setAuthClass

public void setAuthClass(java.lang.String class_name)
                  throws java.lang.Exception

抛出:

java.lang.Exception

getAuthClass

public java.lang.String getAuthClass()

getAuthToken

public AuthToken getAuthToken()

setAuthToken

public void setAuthToken(AuthToken token)

register

public void register(AUTH.UpHandler handler)

unregister

public void unregister(AUTH.UpHandler handler)

getAddress

public Address getAddress()

getConfigurableObjects

protected java.util.List<java.lang.Object> getConfigurableObjects()

从类复制的说明: Protocol

After configuring the protocol itself from the properties defined in the XML config, a protocol might have additional objects which need to be configured. This callback allows a protocol developer to configure those other objects. This call is guaranteed to be invoked after the protocol itself has been configured. See AUTH for an example.

覆盖:

getConfigurableObjects 在类中 Protocol

返回:

init

public void init()
          throws java.lang.Exception

从类复制的说明: Protocol

Called after instance has been created (null constructor) and before protocol is started. Properties are already set. Other protocols are not yet connected and events cannot yet be sent.

覆盖:

init 在类中 Protocol

抛出:

java.lang.Exception - Thrown if protocol cannot be initialized successfully. This will cause the ProtocolStack to fail, so the channel constructor will throw an exception

up

public java.lang.Object up(Event evt)

An event was received from the layer below. Usually the current layer will want to examine the event type and - depending on its type - perform some computation (e.g. removing headers from a MSG event type, or updating the internal membership list when receiving a VIEW_CHANGE event). Finally the event is either a) discarded, or b) an event is sent down the stack using down_prot.down() or c) the event (or another event) is sent up the stack using up_prot.up().

覆盖:

up 在类中 Protocol

up

public void up(MessageBatch batch)

从类复制的说明: Protocol

Sends up a multiple messages in a MessageBatch. The sender of the batch is always the same, and so is the destination (null == multicast messages). Messages in a batch can be OOB messages, regular messages, or mixed messages, although the transport itself will create initial MessageBatches that contain only either OOB or regular messages.

The default processing below sends messages up the stack individually, based on a matching criteria (calling Protocol.accept(Message)), and - if true - calls Protocol.up(Event) for that message and removes the message. If the batch is not empty, it is passed up, or else it is dropped.

Subclasses should check if there are any messages destined for them (e.g. using MessageBatch.getMatchingMessages(short, boolean)), then possibly remove and process them and finally pass the batch up to the next protocol. Protocols can also modify messages in place, e.g. ENCRYPT could decrypt all encrypted messages in the batch, not remove them, and pass the batch up when done.

覆盖:

up 在类中 Protocol

参数:

batch - The message batch

down

public java.lang.Object down(Event evt)

An event is to be sent down the stack. The layer may want to examine its type and perform some action on it, depending on the event's type. If the event is a message MSG, then the layer may need to add a header to it (or do nothing at all) before sending it down the stack using down_prot.down(). In case of a GET_ADDRESS event (which tries to retrieve the stack's address from one of the bottom layers), the layer may need to send a new response event back up the stack using up_prot.up().

覆盖:

down 在类中 Protocol

needsAuthentication

protected boolean needsAuthentication(GMS.GmsHeader hdr)

handleAuthHeader

protected boolean handleAuthHeader(GMS.GmsHeader gms_hdr,
                       AuthHeader auth_hdr,
                       Message msg)

Handles a GMS header

参数:

gms_hdr -

msg -

返回:

true if the message should be passed up, or else false

sendRejectionMessage

protected void sendRejectionMessage(byte type,
                        Address dest,
                        java.lang.String error_msg)

sendJoinRejectionMessage

protected void sendJoinRejectionMessage(Address dest,
                            java.lang.String error_msg)

sendMergeRejectionMessage

protected void sendMergeRejectionMessage(Address dest)

callUpHandlers

protected boolean callUpHandlers(Event evt)

getGMSHeader

protected static GMS.GmsHeader getGMSHeader(Event evt)

Get the header from a GMS message

参数:

evt - The event object passed in to AUTH

返回:

A GmsHeader object or null if the event contains a message of a different type

getGMSHeader

protected static GMS.GmsHeader getGMSHeader(Message msg)