org.apache.qpid.jms.provider.amqp

Class AmqpSaslAuthenticator

java.lang.Object

org.apache.qpid.jms.provider.amqp.AmqpSaslAuthenticator

public class AmqpSaslAuthenticator
extends Object

Manage the SASL authentication process

Constructor Summary

Constructors

Constructor and Description
AmqpSaslAuthenticator(org.apache.qpid.proton.engine.Sasl sasl, JmsConnectionInfo info, Principal localPrincipal, String[] mechanismsRestriction) Create the authenticator and initialize it.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	authenticate() Process the SASL authentication cycle until such time as an outcome is determine.

Methods inherited from class java.lang.Object

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

Constructor Detail

AmqpSaslAuthenticator

public AmqpSaslAuthenticator(org.apache.qpid.proton.engine.Sasl sasl,
                     JmsConnectionInfo info,
                     Principal localPrincipal,
                     String[] mechanismsRestriction)

Create the authenticator and initialize it.

Parameters:

sasl - The Proton SASL entry point this class will use to manage the authentication.

info - The Connection information used to provide credentials to the remote peer.

localPrincipal - The local Principal associated with the transport, or null if there is none.

mechanismsRestriction - The possible mechanism(s) to which the client should restrict its mechanism selection to if offered by the server

Method Detail

authenticate

public boolean authenticate()
                     throws javax.jms.JMSSecurityException

Process the SASL authentication cycle until such time as an outcome is determine. This method must be called by the managing entity until the return value is true indicating a successful authentication or a JMSSecurityException is thrown indicating that the handshake failed.

Returns:

true if the SASL handshake completes successfully.

Throws:

javax.jms.JMSSecurityException - if a security violation is detected during the handshake.