com.communote.server.core.user.security

Enum ApplicationPropertyUserPassword

java.lang.Object

java.lang.Enum<ApplicationPropertyUserPassword>

com.communote.server.core.user.security.ApplicationPropertyUserPassword

All Implemented Interfaces:

ApplicationConfigurationPropertyConstant, ConfigurationPropertyConstant, Serializable, Comparable<ApplicationPropertyUserPassword>

public enum ApplicationPropertyUserPassword
extends Enum<ApplicationPropertyUserPassword>
implements ApplicationConfigurationPropertyConstant

Since:

3.5

Author:

Communote team - http://communote.github.io/

Enum Constant Summary

Enum Constants

Enum Constant and Description
LOCAL_USER_PASSWORD_HASH_BCRYPT_COST Property holding the cost factor of the bcrypt password hash function which can be used for hashing the password of local Communote users.
LOCAL_USER_PASSWORD_HASH_FUNCTION Property holding the identifier of the password hash function which should be used for storing the passwords of local (i.e.
LOCAL_USER_PASSWORD_UPDATE_ON_LOGIN Property holding a boolean value which determines whether the password of a local user should be updated during login with the hash produced by the current hash function.

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	DEFAULT_LOCAL_USER_PASSWORD_UPDATE_ON_LOGIN Default value for property LOCAL_USER_PASSWORD_UPDATE_ON_LOGIN

Method Summary

Modifier and Type	Method and Description
String	getKeyString() String representation of the constant to be used as key in Properties objects.
static ApplicationPropertyUserPassword	valueOf(String name) Returns the enum constant of this type with the specified name.
static ApplicationPropertyUserPassword[]	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

LOCAL_USER_PASSWORD_UPDATE_ON_LOGIN

public static final ApplicationPropertyUserPassword LOCAL_USER_PASSWORD_UPDATE_ON_LOGIN

Property holding a boolean value which determines whether the password of a local user should be updated during login with the hash produced by the current hash function.

LOCAL_USER_PASSWORD_HASH_FUNCTION

public static final ApplicationPropertyUserPassword LOCAL_USER_PASSWORD_HASH_FUNCTION

Property holding the identifier of the password hash function which should be used for storing the passwords of local (i.e. not provided by an external user repository) Communote users.

LOCAL_USER_PASSWORD_HASH_BCRYPT_COST

public static final ApplicationPropertyUserPassword LOCAL_USER_PASSWORD_HASH_BCRYPT_COST

Property holding the cost factor of the bcrypt password hash function which can be used for hashing the password of local Communote users. The value of the property can be an integer in the range of 4 to 31, inclusive.

Field Detail

DEFAULT_LOCAL_USER_PASSWORD_UPDATE_ON_LOGIN

public static final boolean DEFAULT_LOCAL_USER_PASSWORD_UPDATE_ON_LOGIN

Default value for property LOCAL_USER_PASSWORD_UPDATE_ON_LOGIN

See Also:

Constant Field Values

Method Detail

values

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

Returns:

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

valueOf

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

getKeyString

public String getKeyString()

Description copied from interface: ConfigurationPropertyConstant

String representation of the constant to be used as key in Properties objects.

Specified by:

getKeyString in interface ConfigurationPropertyConstant

Returns:

the constant as string