com.helger.photon.basic.auth.credentials

Class CredentialValidationResult

java.lang.Object

com.helger.photon.basic.auth.credentials.CredentialValidationResult

All Implemented Interfaces:

com.helger.commons.state.ISuccessIndicator, Serializable

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

This class represents the result of a credential validation.

Author:

Philip Helger

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static CredentialValidationResult	SUCCESS

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	CredentialValidationResult() Success only constructor.
	CredentialValidationResult(String sErrorMsg) Constructor with an error message

Method Summary

Modifier and Type	Method and Description
String	getErrorMessage()
boolean	isFailure()
boolean	isSuccess()
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

SUCCESS

public static final CredentialValidationResult SUCCESS

Constructor Detail

CredentialValidationResult

protected CredentialValidationResult()

Success only constructor.

CredentialValidationResult

public CredentialValidationResult(@Nonnull @Nonempty
                                  String sErrorMsg)

Constructor with an error message

Parameters:

sErrorMsg - The error message. May neither be null nor empty.

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

getErrorMessage

@Nullable
public String getErrorMessage()

Returns:

The error message or null if this is a success.

toString

public String toString()

Overrides:

toString in class Object