Package org.wildfly.security.sasl.util

Class AbstractSaslServer

java.lang.Object

org.wildfly.security.sasl.util.AbstractSaslParticipant

org.wildfly.security.sasl.util.AbstractSaslServer

All Implemented Interfaces:

SaslServer, SaslWrapper

Direct Known Subclasses:

AnonymousSaslServer, EntitySaslServer, Gs2SaslServer, LocalUserServer, OAuth2SaslServer, OTPSaslServer, ScramSaslServer

public abstract class AbstractSaslServer
extends AbstractSaslParticipant
implements SaslServer

A base class for SASL client implementations.

Author:

David M. Lloyd

Field Summary

Fields inherited from class org.wildfly.security.sasl.util.AbstractSaslParticipant

COMPLETE_STATE, FAILED_STATE, NO_BYTES

Fields inherited from interface org.wildfly.security.sasl.util.SaslWrapper

IDENTITY

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractSaslServer(String mechanismName, String protocol, String serverName, CallbackHandler callbackHandler)	Deprecated.
protected	AbstractSaslServer(String mechanismName, String protocol, String serverName, CallbackHandler callbackHandler, ElytronMessages log)	Construct a new instance.

Method Summary

Modifier and Type	Method	Description
byte[]	evaluateResponse(byte[] response)	Evaluate an authentication response received from the client.

Methods inherited from class org.wildfly.security.sasl.util.AbstractSaslParticipant

assertComplete, dispose, evaluateMessage, evaluateMessage, getCallbackHandler, getIntProperty, getMechanismName, getNegotiatedProperty, getProtocol, getServerName, getStringProperty, getWrapper, handleCallbacks, init, isComplete, negotiationComplete, setNegotiationState, setWrapper, tryHandleCallbacks, unwrap, wrap

Methods inherited from class java.lang.Object

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

Methods inherited from interface javax.security.sasl.SaslServer

dispose, getAuthorizationID, getMechanismName, getNegotiatedProperty, isComplete, unwrap, wrap

Constructor Detail

AbstractSaslServer

protected AbstractSaslServer(String mechanismName,
                             String protocol,
                             String serverName,
                             CallbackHandler callbackHandler,
                             ElytronMessages log)

Construct a new instance.

Parameters:

mechanismName - the name of the defined mechanism

protocol - the protocol

serverName - the server name

callbackHandler - the callback handler

log - mechanism specific logger

AbstractSaslServer

@Deprecated
protected AbstractSaslServer(String mechanismName,
                             String protocol,
                             String serverName,
                             CallbackHandler callbackHandler)

Deprecated.

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

evaluateResponse

public byte[] evaluateResponse(byte[] response)
                        throws SaslException

Evaluate an authentication response received from the client.

Specified by:

evaluateResponse in interface SaslServer

Parameters:

response - the authentication response

Returns:

the next challenge to send to the client

Throws:

SaslException - if there is an error processing the client message