org.jboss.sasl.util

Class AbstractSaslParticipant

java.lang.Object

org.jboss.sasl.util.AbstractSaslParticipant

Direct Known Subclasses:

AbstractSaslClient, AbstractSaslServer

public abstract class AbstractSaslParticipant
extends java.lang.Object

A common base class for SASL participants.

Field Summary

Fields

Modifier and Type	Field and Description
private javax.security.auth.callback.CallbackHandler	callbackHandler
private SaslStateContext	context
private java.lang.String	mechanismName
static byte[]	NO_BYTES An empty byte array.
private java.lang.String	protocol
private java.lang.String	serverName
private SaslState	state
private SaslWrapper	wrapper

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractSaslParticipant(java.lang.String mechanismName, java.lang.String protocol, java.lang.String serverName, javax.security.auth.callback.CallbackHandler callbackHandler) Construct a new instance.

Method Summary

Modifier and Type	Method and Description
void	dispose() Dispose of this participant.
(package private) byte[]	evaluateMessage(byte[] message)
protected javax.security.auth.callback.CallbackHandler	getCallbackHandler() Get the configured authentication callback handler.
SaslStateContext	getContext() Get the current negotiation state context.
java.lang.String	getMechanismName() Get the name of this mechanism.
java.lang.Object	getNegotiatedProperty(java.lang.String propName) Get a property negotiated between this participant and the other.
protected java.lang.String	getProtocol() Get the protocol name.
protected java.lang.String	getServerName() Get the server name.
protected SaslWrapper	getWrapper() Get the current configured SASL wrapper, if any.
protected void	handleCallbacks(javax.security.auth.callback.Callback... callbacks) Handle callbacks, wrapping exceptions as needed (including unsupported callbacks).
void	init()
boolean	isComplete() Determine whether the authentication exchange has completed.
protected void	setWrapper(SaslWrapper wrapper) Set the current configured SASL wrapper, if any.
protected void	tryHandleCallbacks(javax.security.auth.callback.Callback... callbacks) Handle callbacks, wrapping exceptions as needed.
byte[]	unwrap(byte[] incoming, int offset, int len) Unwraps a byte array received from the other participant.
byte[]	wrap(byte[] outgoing, int offset, int len) Wraps a byte array to be sent to the other participant.

Methods inherited from class java.lang.Object

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

Field Detail

NO_BYTES

public static final byte[] NO_BYTES

An empty byte array.

context

private final SaslStateContext context

mechanismName

private final java.lang.String mechanismName

callbackHandler

private final javax.security.auth.callback.CallbackHandler callbackHandler

protocol

private final java.lang.String protocol

serverName

private final java.lang.String serverName

state

private SaslState state

wrapper

private SaslWrapper wrapper

Constructor Detail

AbstractSaslParticipant

protected AbstractSaslParticipant(java.lang.String mechanismName,
                                  java.lang.String protocol,
                                  java.lang.String serverName,
                                  javax.security.auth.callback.CallbackHandler callbackHandler)

Construct a new instance.

Parameters:

mechanismName - the name of the defined mechanism

protocol - the protocol

serverName - the server name

callbackHandler - the callback handler

Method Detail

handleCallbacks

protected void handleCallbacks(javax.security.auth.callback.Callback... callbacks)
                        throws javax.security.sasl.SaslException

Handle callbacks, wrapping exceptions as needed (including unsupported callbacks).

Parameters:

callbacks - the callbacks to handle

Throws:

javax.security.sasl.SaslException - if a callback failed

tryHandleCallbacks

protected void tryHandleCallbacks(javax.security.auth.callback.Callback... callbacks)
                           throws javax.security.sasl.SaslException,
                                  javax.security.auth.callback.UnsupportedCallbackException

Handle callbacks, wrapping exceptions as needed.

Parameters:

callbacks - the callbacks to handle

Throws:

javax.security.sasl.SaslException - if a callback failed

javax.security.auth.callback.UnsupportedCallbackException - if a callback isn't supported

init

public void init()

getMechanismName

public java.lang.String getMechanismName()

Get the name of this mechanism.

Returns:

the mechanism name

getProtocol

protected java.lang.String getProtocol()

Get the protocol name.

Returns:

the protocol name

getServerName

protected java.lang.String getServerName()

Get the server name.

Returns:

the server name

getCallbackHandler

protected javax.security.auth.callback.CallbackHandler getCallbackHandler()

Get the configured authentication callback handler.

Returns:

the callback handler

getWrapper

protected SaslWrapper getWrapper()

Get the current configured SASL wrapper, if any.

Returns:

the SASL wrapper, or null if none is configured

getContext

public SaslStateContext getContext()

Get the current negotiation state context.

Returns:

the context

evaluateMessage

byte[] evaluateMessage(byte[] message)
                throws javax.security.sasl.SaslException

Throws:

javax.security.sasl.SaslException

setWrapper

protected void setWrapper(SaslWrapper wrapper)

Set the current configured SASL wrapper, if any.

Parameters:

wrapper - the SASL wrapper, or null to disable wrapping

wrap

public byte[] wrap(byte[] outgoing,
                   int offset,
                   int len)
            throws javax.security.sasl.SaslException

Wraps a byte array to be sent to the other participant.

Parameters:

outgoing - a non-null byte array containing the bytes to encode

offset - the first byte to encode

len - the number of bytes to use

Returns:

A non-null byte array containing the encoded bytes

Throws:

javax.security.sasl.SaslException - if wrapping fails

java.lang.IllegalStateException - if wrapping is not configured

unwrap

public byte[] unwrap(byte[] incoming,
                     int offset,
                     int len)
              throws javax.security.sasl.SaslException

Unwraps a byte array received from the other participant.

Parameters:

incoming - a non-null byte array containing the bytes to decode

offset - the first byte to decode

len - the number of bytes to use

Returns:

A non-null byte array containing the decoded bytes

Throws:

javax.security.sasl.SaslException - if wrapping fails

java.lang.IllegalStateException - if wrapping is not configured

isComplete

public boolean isComplete()

Determine whether the authentication exchange has completed.

Returns:

true if the exchange has completed

getNegotiatedProperty

public java.lang.Object getNegotiatedProperty(java.lang.String propName)

Get a property negotiated between this participant and the other.

Parameters:

propName - the property name

Returns:

the property value or null if not defined

dispose

public void dispose()
             throws javax.security.sasl.SaslException

Dispose of this participant.

Throws:

javax.security.sasl.SaslException - if disposal failed