com.atlassian.bitbucket.scm

Enum AuthenticationState

java.lang.Object

java.lang.Enum<AuthenticationState>

com.atlassian.bitbucket.scm.AuthenticationState

All Implemented Interfaces:

Serializable, Comparable<AuthenticationState>

public enum AuthenticationState
extends Enum<AuthenticationState>

Indicates the result of a user's authentication attempt.

Enum Constant Summary

Enum Constants

Enum Constant and 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 and Description
static AuthenticationState	valueOf(String name) Returns the enum constant of this type with the specified name.
static AuthenticationState[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

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 Detail

values

public static AuthenticationState[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (AuthenticationState c : AuthenticationState.values())
    System.out.println(c);

Returns:

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

valueOf

public static AuthenticationState valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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 type has no constant with the specified name

NullPointerException - if the argument is null