org.jgroups.protocols

Class SASL

java.lang.Object

org.jgroups.stack.Protocol

org.jgroups.protocols.SASL

public class SASL
extends Protocol

The SASL protocol implements authentication and, if requested by the mech, encryption

Author:

Tristan Tarrant

Field Summary

Fields

Modifier and Type	Field and Description
protected javax.security.auth.callback.CallbackHandler	client_callback_handler
protected java.lang.String	client_name
protected java.lang.String	client_password
protected javax.security.auth.Subject	client_subject
static short	GMS_ID
protected Address	local_addr
protected java.lang.String	login_module_name
protected java.lang.String	mech
protected java.util.Map<Address,SaslContext>	sasl_context
static short	SASL_ID
protected java.util.Map<java.lang.String,java.lang.String>	sasl_props
static java.lang.String	SASL_PROTOCOL_NAME
protected javax.security.auth.callback.CallbackHandler	server_callback_handler
protected java.lang.String	server_name
protected javax.security.auth.Subject	server_subject
protected long	timeout

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

Method Summary

Modifier and Type	Method and Description
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()
javax.security.auth.callback.CallbackHandler	getClientCallbackHandler()
java.lang.String	getClientCallbackHandlerClass()
javax.security.auth.Subject	getClientSubject()
java.lang.String	getLoginModulename()
java.lang.String	getMech()
java.util.Map<java.lang.String,java.lang.String>	getSaslProps()
javax.security.auth.callback.CallbackHandler	getServerCallbackHandler()
java.lang.String	getServerCallbackHandlerClass()
java.lang.String	getServerName(java.lang.String server_name)
javax.security.auth.Subject	getServerSubject()
long	getTimeout()
void	init() Called after instance has been created (null constructor) and before protocol is started.
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)
protected boolean	serverChallenge(GMS.GmsHeader gmsHeader, SaslHeader saslHeader, Message msg)
void	setClientCallbackHandler(javax.security.auth.callback.CallbackHandler client_callback_handler)
void	setClientCallbackHandlerClass(java.lang.String handlerClass)
void	setClientSubject(javax.security.auth.Subject client_subject)
void	setLoginModuleName(java.lang.String login_module_name)
void	setMech(java.lang.String mech)
void	setSaslProps(java.util.Map<java.lang.String,java.lang.String> sasl_props)
void	setServerCallbackHandler(javax.security.auth.callback.CallbackHandler server_callback_handler)
void	setServerCallbackHandlerClass(java.lang.String handlerClass)
void	setServerName(java.lang.String server_name)
void	setServerSubject(javax.security.auth.Subject server_subject)
void	setTimeout(long timeout)
void	stop() This method is called on a Channel.disconnect().
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, getConfigurableObjects, 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, start, statsEnabled

Methods inherited from class java.lang.Object

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

Field Detail

GMS_ID

public static final short GMS_ID

SASL_ID

public static final short SASL_ID

SASL_PROTOCOL_NAME

public static final java.lang.String SASL_PROTOCOL_NAME

See Also:

Constant Field Values

login_module_name

protected java.lang.String login_module_name

client_name

protected java.lang.String client_name

client_password

protected java.lang.String client_password

mech

protected java.lang.String mech

sasl_props

protected java.util.Map<java.lang.String,java.lang.String> sasl_props

server_name

protected java.lang.String server_name

timeout

protected long timeout

client_callback_handler

protected javax.security.auth.callback.CallbackHandler client_callback_handler

server_callback_handler

protected javax.security.auth.callback.CallbackHandler server_callback_handler

client_subject

protected javax.security.auth.Subject client_subject

server_subject

protected javax.security.auth.Subject server_subject

local_addr

protected Address local_addr

sasl_context

protected final java.util.Map<Address,SaslContext> sasl_context

Constructor Detail

SASL

public SASL()

Method Detail

setClientCallbackHandlerClass

public void setClientCallbackHandlerClass(java.lang.String handlerClass)
                                   throws java.lang.Exception

Throws:

java.lang.Exception

getClientCallbackHandlerClass

public java.lang.String getClientCallbackHandlerClass()

getClientCallbackHandler

public javax.security.auth.callback.CallbackHandler getClientCallbackHandler()

setClientCallbackHandler

public void setClientCallbackHandler(javax.security.auth.callback.CallbackHandler client_callback_handler)

setServerCallbackHandlerClass

public void setServerCallbackHandlerClass(java.lang.String handlerClass)
                                   throws java.lang.Exception

Throws:

java.lang.Exception

getServerCallbackHandlerClass

public java.lang.String getServerCallbackHandlerClass()

getServerCallbackHandler

public javax.security.auth.callback.CallbackHandler getServerCallbackHandler()

setServerCallbackHandler

public void setServerCallbackHandler(javax.security.auth.callback.CallbackHandler server_callback_handler)

setLoginModuleName

public void setLoginModuleName(java.lang.String login_module_name)

getLoginModulename

public java.lang.String getLoginModulename()

setMech

public void setMech(java.lang.String mech)

getMech

public java.lang.String getMech()

setSaslProps

public void setSaslProps(java.util.Map<java.lang.String,java.lang.String> sasl_props)

getSaslProps

public java.util.Map<java.lang.String,java.lang.String> getSaslProps()

setClientSubject

public void setClientSubject(javax.security.auth.Subject client_subject)

getClientSubject

public javax.security.auth.Subject getClientSubject()

setServerSubject

public void setServerSubject(javax.security.auth.Subject server_subject)

getServerSubject

public javax.security.auth.Subject getServerSubject()

setServerName

public void setServerName(java.lang.String server_name)

getServerName

public java.lang.String getServerName(java.lang.String server_name)

setTimeout

public void setTimeout(long timeout)

getTimeout

public long getTimeout()

getAddress

public Address getAddress()

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

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)

Description copied from class: Protocol

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)

Description copied from class: Protocol

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

serverChallenge

protected boolean serverChallenge(GMS.GmsHeader gmsHeader,
                                  SaslHeader saslHeader,
                                  Message msg)

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)