com.helger.photon.basic.auth.identify

Class AuthIdentificationResult

java.lang.Object

com.helger.photon.basic.auth.identify.AuthIdentificationResult

All Implemented Interfaces:

com.helger.commons.state.ISuccessIndicator

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

Constructor Summary

Constructors

Constructor and Description
AuthIdentificationResult(CredentialValidationResult aCredentialValidationResult) Constructor for a failure.
AuthIdentificationResult(IAuthToken aAuthToken) Constructor for success.

Method Summary

Methods

Modifier and Type	Method and Description
IAuthToken	getAuthToken()
String	getCredentialValidationErrorMessage()
boolean	isFailure()
boolean	isSuccess()
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

AuthIdentificationResult

public AuthIdentificationResult(@Nonnull
                        CredentialValidationResult aCredentialValidationResult)

Constructor for a failure.

Parameters:

aCredentialValidationResult - The validation result. May not be null and must be a failure!

AuthIdentificationResult

public AuthIdentificationResult(@Nonnull
                        IAuthToken aAuthToken)

Constructor for success.

Parameters:

aAuthToken - The auth token. May not be null.

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

getCredentialValidationErrorMessage

@Nullable
public String getCredentialValidationErrorMessage()

Returns:

The credential validation error message or null in case of successful identification

getAuthToken

@Nullable
public IAuthToken getAuthToken()

Returns:

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

toString

public String toString()

Overrides:

toString in class Object