org.jgroups.protocols

Class AUTH

java.lang.Object

org.jgroups.stack.Protocol

org.jgroups.protocols.AUTH

public class AUTH
extends Protocol

The AUTH protocol adds a layer of authentication to JGroups. It intercepts join and merge requests and rejects them if the joiner or merger is not permitted to join a or merge into a cluster. AUTH should be placed right below GMS in the configuration.

Author:

Chris Mills, Bela Ban

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	AUTH.UpHandler Interface to provide callbacks for handling up events

Field Summary

Fields

Modifier and Type	Field and Description
protected AuthToken	auth_token Used on the coordinator to authentication joining member requests against
protected boolean	authenticate_coord
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.

Fields inherited from class org.jgroups.stack.Protocol

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

Constructor Summary

Constructors

Constructor and Description
AUTH()

Method Summary

Modifier and Type	Method and Description
protected boolean	callUpHandlers(Event evt)
void	destroy() This method is called on a Channel.close().
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)
PhysicalAddress	getPhysicalAddress()
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)
AUTH	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)
AUTH	setAuthCoord(boolean authenticateCoord)
AUTH	setAuthToken(AuthToken token)
void	start() This method is called on a Channel.connect(String).
void	stop() This method is called on a Channel.disconnect().
AUTH	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.

Methods inherited from class org.jgroups.stack.Protocol

accept, afterCreationHook, dumpStats, enableStats, getDownProtocol, getDownServices, getId, getIdsAbove, getLevel, getLog, 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, statsEnabled

Methods inherited from class java.lang.Object

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

Field Detail

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

authenticate_coord

protected volatile boolean authenticate_coord

Constructor Detail

AUTH

public AUTH()

Method Detail

setAuthCoord

public AUTH setAuthCoord(boolean authenticateCoord)

setAuthClass

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

Throws:

java.lang.Exception

getAuthClass

public java.lang.String getAuthClass()

getAuthToken

public AuthToken getAuthToken()

setAuthToken

public AUTH setAuthToken(AuthToken token)

register

public AUTH register(AUTH.UpHandler handler)

unregister

public AUTH unregister(AUTH.UpHandler handler)

getAddress

public Address getAddress()

getPhysicalAddress

public PhysicalAddress getPhysicalAddress()

getConfigurableObjects

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

Description copied from class: 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.

Overrides:

getConfigurableObjects in class Protocol

Returns:

init

public void init()
          throws java.lang.Exception

Description copied from class: 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.

Overrides:

init in class Protocol

Throws:

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

start

public void start()
           throws java.lang.Exception

Description copied from class: Protocol

This method is called on a Channel.connect(String). Starts work. Protocols are connected and queues are ready to receive events. Will be called from bottom to top. This call will replace the START and START_OK events.

Overrides:

start in class Protocol

Throws:

java.lang.Exception - Thrown if protocol cannot be started successfully. This will cause the ProtocolStack to fail, so Channel.connect(String) will throw an exception

stop

public void stop()

Description copied from class: Protocol

This method is called on a Channel.disconnect(). Stops work (e.g. by closing multicast socket). Will be called from top to bottom. This means that at the time of the method invocation the neighbor protocol below is still working. This method will replace the STOP, STOP_OK, CLEANUP and CLEANUP_OK events. The ProtocolStack guarantees that when this method is called all messages in the down queue will have been flushed

Overrides:

stop in class Protocol

destroy

public void destroy()

Description copied from class: Protocol

This method is called on a Channel.close(). Does some cleanup; after the call the VM will terminate

Overrides:

destroy in class Protocol

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().

Overrides:

up in class Protocol

up

public void up(MessageBatch batch)

Description copied from class: 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(org.jgroups.Message)), and - if true - calls Protocol.up(org.jgroups.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.

Overrides:

up in class Protocol

Parameters:

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().

Overrides:

down in class 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

Parameters:

gms_hdr -

msg -

Returns:

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

Parameters:

evt - The event object passed in to AUTH

Returns:

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

getGMSHeader

protected static GMS.GmsHeader getGMSHeader(Message msg)