Package com.atlassian.bitbucket.scm

Enum Class AuthenticationState

java.lang.Object

java.lang.Enum<AuthenticationState>

com.atlassian.bitbucket.scm.AuthenticationState

All Implemented Interfaces:

Serializable, Comparable<AuthenticationState>, Constable

public enum AuthenticationState
extends Enum<AuthenticationState>

Indicates the result of a user's authentication attempt.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
AUTHENTICATED	Indicates that authentication has succeeded.
CAPTCHA_REQUIRED	Indicates that the user's account is locked and they must navigate to the Stash Web UI and solve a CAPTCHA test.
NOT_AUTHENTICATED	Indicates that authentication failed or no attempt to authenticate was made.
UNLICENSED	Indicates that authentication succeeded but the user account is not licensed to use Stash.

Method Summary

Modifier and Type	Method	Description
static AuthenticationState	valueOf(String name)	Returns the enum constant of this class with the specified name.
static AuthenticationState[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

AUTHENTICATED

public static final AuthenticationState AUTHENTICATED

Indicates that authentication has succeeded.

NOT_AUTHENTICATED

public static final AuthenticationState NOT_AUTHENTICATED

Indicates that authentication failed or no attempt to authenticate was made.

UNLICENSED

public static final AuthenticationState UNLICENSED

Indicates that authentication succeeded but the user account is not licensed to use Stash.

CAPTCHA_REQUIRED

public static final AuthenticationState CAPTCHA_REQUIRED

Indicates that the user's account is locked and they must navigate to the Stash Web UI and solve a CAPTCHA test.

Method Details

values

public static AuthenticationState[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static AuthenticationState valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null