com.atlassian.jira.bc.security.login
Enum LoginReason

java.lang.Object
  java.lang.Enum<LoginReason>
      com.atlassian.jira.bc.security.login.LoginReason

All Implemented Interfaces:

Serializable, Comparable<LoginReason>

public enum LoginReason
extends Enum<LoginReason>

An enum of reasons as to how a login attempt went

Since:

v4.0.1

Enum Constant Summary

AUTHENTICATED_FAILED
The user could not be authenticated.

AUTHENTICATION_DENIED
The user is not allowed to even attempt a login

AUTHORISATION_FAILED
The user could not be authorised.

OK
The login was OK

Method Summary

static LoginReason	valueOf(String name) Returns the enum constant of this type with the specified name.
static LoginReason[]	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

AUTHENTICATION_DENIED

public static final LoginReason AUTHENTICATION_DENIED

The user is not allowed to even attempt a login

AUTHENTICATED_FAILED

public static final LoginReason AUTHENTICATED_FAILED

The user could not be authenticated.

AUTHORISATION_FAILED

public static final LoginReason AUTHORISATION_FAILED

The user could not be authorised.

OK

public static final LoginReason OK

The login was OK

Method Detail

values

public static LoginReason[] 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 (LoginReason c : LoginReason.values())
    System.out.println(c);

Returns:

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

valueOf

public static LoginReason 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