com.atlassian.confluence.security.login
Enum LoginResult

java.lang.Object
  extended by java.lang.Enum<LoginResult>
      extended by com.atlassian.confluence.security.login.LoginResult
All Implemented Interfaces:
Serializable, Comparable<LoginResult>

public enum LoginResult
extends Enum<LoginResult>

Result of an authentication attempt.


Enum Constant Summary
AUTHENTICATION_DENIED
          The user is not allowed to even attempt a login
AUTHENTICATION_FAILED
          The user could not be authenticated.
OK
          The login was OK
OK_WITH_ELEVATED_SECURITY_CHECK_REQUIRED
          Authentication succeeded (username and password match) but an elevated security check is required.
USER_DOES_NOT_EXIST
          The username does not exist
 
Method Summary
static LoginResult valueOf(String name)
          Returns the enum constant of this type with the specified name.
static LoginResult[] 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

USER_DOES_NOT_EXIST

public static final LoginResult USER_DOES_NOT_EXIST
The username does not exist


AUTHENTICATION_DENIED

public static final LoginResult AUTHENTICATION_DENIED
The user is not allowed to even attempt a login


OK_WITH_ELEVATED_SECURITY_CHECK_REQUIRED

public static final LoginResult OK_WITH_ELEVATED_SECURITY_CHECK_REQUIRED
Authentication succeeded (username and password match) but an elevated security check is required.


AUTHENTICATION_FAILED

public static final LoginResult AUTHENTICATION_FAILED
The user could not be authenticated.


OK

public static final LoginResult OK
The login was OK

Method Detail

values

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

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

valueOf

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


Copyright © 2003-2013 Atlassian. All Rights Reserved.