Package com.atlassian.bitbucket.auth

Enum Class RememberMeMode

java.lang.Object

java.lang.Enum<RememberMeMode>

com.atlassian.bitbucket.auth.RememberMeMode

All Implemented Interfaces:

Serializable, Comparable<RememberMeMode>, Constable

public enum RememberMeMode
extends Enum<RememberMeMode>

Controls whether remember-me authentication is disabled, always performed or only performed when a checkbox is checked on the login form.

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
ALWAYS	Remember-me authentication is enabled and always performed on form-based login.
NEVER	Remember-me authentication is disabled.
OPTIONAL	Remember-me authentication is enabled but only performed when a user checks the 'Remember my login' checkbox on the login form.

Method Summary

Modifier and Type	Method	Description
static RememberMeMode	fromId(String id)
String	getId()
static RememberMeMode	valueOf(String name)	Returns the enum constant of this class with the specified name.
static RememberMeMode[]	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

ALWAYS

public static final RememberMeMode ALWAYS

Remember-me authentication is enabled and always performed on form-based login. The 'Remember my login' checkbox is not displayed on the login form.

OPTIONAL

public static final RememberMeMode OPTIONAL

Remember-me authentication is enabled but only performed when a user checks the 'Remember my login' checkbox on the login form.

NEVER

public static final RememberMeMode NEVER

Remember-me authentication is disabled. No remember-me cookies are returned. Any provided remember-me cookies are not accepted for authentication. The 'Remember my login' checkbox is not displayed on the login form.

Method Details

values

public static RememberMeMode[] 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 RememberMeMode 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

getId

@Nonnull
public String getId()

fromId

@Nonnull
public static RememberMeMode fromId(@Nonnull
 String id)