com.helger.security.authentication.result

Class AuthIdentificationResult

java.lang.Object

com.helger.security.authentication.result.AuthIdentificationResult

All Implemented Interfaces:

com.helger.commons.state.ISuccessIndicator, Serializable

public class AuthIdentificationResult
extends Object
implements com.helger.commons.state.ISuccessIndicator, Serializable

This class contains the overall authentication result.

Author:

Philip Helger

See Also:

Serialized Form

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AuthIdentificationResult(IAuthToken aAuthToken, ICredentialValidationResult aCredentialValidationFailure) Constructor.

Method Summary

Modifier and Type	Method and Description
static AuthIdentificationResult	createFailure(ICredentialValidationResult aCredentialValidationFailure) Factory method for error in authentication.
static AuthIdentificationResult	createSuccess(IAuthToken aAuthToken) Factory method for success authentication.
IAuthToken	getAuthToken()
ICredentialValidationResult	getCredentialValidationFailure()
boolean	isFailure()
boolean	isSuccess()
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.helger.commons.state.ISuccessIndicator

and, or

Constructor Detail

AuthIdentificationResult

protected AuthIdentificationResult(@Nullable
                                   IAuthToken aAuthToken,
                                   @Nullable
                                   ICredentialValidationResult aCredentialValidationFailure)

Constructor.

Parameters:

aAuthToken - The auth token. May not be null in case of success. Must be null in case of failure.

aCredentialValidationFailure - The validation failure. May not be null in case of failure. Must be null in case of success.

Method Detail

isSuccess

public boolean isSuccess()

Specified by:

isSuccess in interface com.helger.commons.state.ISuccessIndicator

isFailure

public boolean isFailure()

Specified by:

isFailure in interface com.helger.commons.state.ISuccessIndicator

getAuthToken

@Nullable
public IAuthToken getAuthToken()

Returns:

The auth token in case of successful identification or null in case of an error.

getCredentialValidationFailure

@Nullable
public ICredentialValidationResult getCredentialValidationFailure()

Returns:

The credential validation failure or null in case of success.

toString

public String toString()

Overrides:

toString in class Object

createSuccess

@Nonnull
public static AuthIdentificationResult createSuccess(@Nonnull
                                                               IAuthToken aAuthToken)

Factory method for success authentication.

Parameters:

aAuthToken - The auth token. May not be null.

Returns:

Never null.

createFailure

@Nonnull
public static AuthIdentificationResult createFailure(@Nonnull
                                                               ICredentialValidationResult aCredentialValidationFailure)

Factory method for error in authentication.

Parameters:

aCredentialValidationFailure - The validation failure. May not be null in case of failure!

Returns:

Never null.