Package org.apache.qpid.server.security.auth

Class AuthenticationResult

java.lang.Object

org.apache.qpid.server.security.auth.AuthenticationResult

public class AuthenticationResult
extends Object

Encapsulates the result of an attempt to authenticate using an AuthenticationProvider.

The authentication status describes the overall outcome.

1. If authentication status is SUCCESS, at least one Principal will be populated.
2. If authentication status is CONTINUE, the authentication has failed because the user supplied incorrect credentials (etc). If the authentication requires it, the next challenge is made available.
3. If authentication status is ERROR , the authentication decision could not be made due to a failure (such as an external system), the getCause() will provide the underlying exception.

The main principal provided to the constructor is wrapped in an AuthenticatedPrincipal to make it easier for the rest of the application to identify it among the set of other principals.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AuthenticationResult.AuthenticationStatus

Constructor Summary

Constructors

Constructor	Description
AuthenticationResult(byte[] challenge, AuthenticationResult.AuthenticationStatus status)
AuthenticationResult(byte[] challenge, AuthenticationResult.AuthenticationStatus status, Exception cause)
AuthenticationResult(Principal mainPrincipal)
AuthenticationResult(Principal mainPrincipal, byte[] challenge)
AuthenticationResult(Principal mainPrincipal, Set<Principal> otherPrincipals, byte[] challenge)
AuthenticationResult(AuthenticationResult.AuthenticationStatus status)
AuthenticationResult(AuthenticationResult.AuthenticationStatus error, Exception cause)

Method Summary

Modifier and Type	Method	Description
Exception	getCause()
byte[]	getChallenge()
Principal	getMainPrincipal()
Set<Principal>	getPrincipals()
AuthenticationResult.AuthenticationStatus	getStatus()

Methods inherited from class java.lang.Object

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

Constructor Detail

AuthenticationResult

public AuthenticationResult(AuthenticationResult.AuthenticationStatus status)

AuthenticationResult

public AuthenticationResult(Principal mainPrincipal)

AuthenticationResult

public AuthenticationResult(Principal mainPrincipal,
                            byte[] challenge)

AuthenticationResult

public AuthenticationResult(Principal mainPrincipal,
                            Set<Principal> otherPrincipals,
                            byte[] challenge)

AuthenticationResult

public AuthenticationResult(byte[] challenge,
                            AuthenticationResult.AuthenticationStatus status)

AuthenticationResult

public AuthenticationResult(AuthenticationResult.AuthenticationStatus error,
                            Exception cause)

AuthenticationResult

public AuthenticationResult(byte[] challenge,
                            AuthenticationResult.AuthenticationStatus status,
                            Exception cause)

Method Detail

getCause

public Exception getCause()

getStatus

public AuthenticationResult.AuthenticationStatus getStatus()

getChallenge

public byte[] getChallenge()

getPrincipals

public Set<Principal> getPrincipals()

getMainPrincipal

public Principal getMainPrincipal()