Class AuthenticationResult
- java.lang.Object
-
- org.apache.qpid.server.security.auth.AuthenticationResult
-
public class AuthenticationResult extends java.lang.Object
Encapsulates the result of an attempt to authenticate using anAuthenticationProvider
.The authentication status describes the overall outcome.
- If authentication status is SUCCESS, at least one
Principal
will be populated. - 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.
- 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.
AuthenticatedPrincipal
to make it easier for the rest of the application to identify it among the set of other principals. - If authentication status is SUCCESS, at least one
-
-
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, java.lang.Exception cause)
AuthenticationResult(java.security.Principal mainPrincipal)
AuthenticationResult(java.security.Principal mainPrincipal, byte[] challenge)
AuthenticationResult(java.security.Principal mainPrincipal, java.util.Set<java.security.Principal> otherPrincipals, byte[] challenge)
AuthenticationResult(AuthenticationResult.AuthenticationStatus status)
AuthenticationResult(AuthenticationResult.AuthenticationStatus error, java.lang.Exception cause)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.Exception
getCause()
byte[]
getChallenge()
java.security.Principal
getMainPrincipal()
java.util.Set<java.security.Principal>
getPrincipals()
AuthenticationResult.AuthenticationStatus
getStatus()
-
-
-
Constructor Detail
-
AuthenticationResult
public AuthenticationResult(AuthenticationResult.AuthenticationStatus status)
-
AuthenticationResult
public AuthenticationResult(java.security.Principal mainPrincipal)
-
AuthenticationResult
public AuthenticationResult(java.security.Principal mainPrincipal, byte[] challenge)
-
AuthenticationResult
public AuthenticationResult(java.security.Principal mainPrincipal, java.util.Set<java.security.Principal> otherPrincipals, byte[] challenge)
-
AuthenticationResult
public AuthenticationResult(byte[] challenge, AuthenticationResult.AuthenticationStatus status)
-
AuthenticationResult
public AuthenticationResult(AuthenticationResult.AuthenticationStatus error, java.lang.Exception cause)
-
AuthenticationResult
public AuthenticationResult(byte[] challenge, AuthenticationResult.AuthenticationStatus status, java.lang.Exception cause)
-
-
Method Detail
-
getCause
public java.lang.Exception getCause()
-
getStatus
public AuthenticationResult.AuthenticationStatus getStatus()
-
getChallenge
public byte[] getChallenge()
-
getPrincipals
public java.util.Set<java.security.Principal> getPrincipals()
-
getMainPrincipal
public java.security.Principal getMainPrincipal()
-
-