com.helger.photon.basic.security.password

Class GlobalPasswordSettings

java.lang.Object

com.helger.photon.basic.security.password.GlobalPasswordSettings

@ThreadSafe
public final class GlobalPasswordSettings
extends Object

Central class for all password related elements.

Author:

Philip Helger

Method Summary

Methods

Modifier and Type	Method and Description
static PasswordHash	createUserDefaultPasswordHash(IPasswordSalt aSalt, String sPlainTextPassword) Create the password hash from the passed plain text password, using the default password hash creator.
static PasswordHash	createUserPasswordHash(String sAlgorithmName, IPasswordSalt aSalt, String sPlainTextPassword) Create the password hash from the passed plain text password, using the default password hash creator.
static IPasswordConstraintList	getPasswordConstraintList()
static PasswordHashCreatorManager	getPasswordHashCreatorManager()
static boolean	isAnyPasswordConstraintDefined()
static void	setPasswordConstraintList(IPasswordConstraintList aPasswordConstraintList) Set the global password constraint list.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getPasswordConstraintList

@Nonnull
@ReturnsMutableCopy
public static IPasswordConstraintList getPasswordConstraintList()

Returns:

The current password constraint list. Never null but maybe empty.

setPasswordConstraintList

public static void setPasswordConstraintList(@Nonnull
                             IPasswordConstraintList aPasswordConstraintList)

Set the global password constraint list.

Parameters:

aPasswordConstraintList - The list to be set. May not be null.

isAnyPasswordConstraintDefined

public static boolean isAnyPasswordConstraintDefined()

Returns:

true if any password constraint is defined, false if not.

getPasswordHashCreatorManager

@Nonnull
public static PasswordHashCreatorManager getPasswordHashCreatorManager()

Returns:

The central PasswordHashCreatorManager.

createUserDefaultPasswordHash

@Nonnull
public static PasswordHash createUserDefaultPasswordHash(@Nullable
                                                 IPasswordSalt aSalt,
                                                 @Nonnull
                                                 String sPlainTextPassword)

Create the password hash from the passed plain text password, using the default password hash creator.

Parameters:

aSalt - Optional salt to be used. This parameter is only null for backwards compatibility reasons.

sPlainTextPassword - Plain text password. May not be null.

Returns:

The password hash. Never null.

createUserPasswordHash

@Nonnull
public static PasswordHash createUserPasswordHash(@Nonnull@Nonempty
                                          String sAlgorithmName,
                                          @Nullable
                                          IPasswordSalt aSalt,
                                          @Nonnull
                                          String sPlainTextPassword)

Create the password hash from the passed plain text password, using the default password hash creator.

Parameters:

sAlgorithmName - The password hash creator algorithm name to query. May neither be null nor empty.

aSalt - Optional salt to be used. This parameter is only null for backwards compatibility reasons.

sPlainTextPassword - Plain text password. May not be null.

Returns:

The password hash. Never null.