com.helger.photon.basic.security.password.hash

Class PasswordHashCreatorManager

java.lang.Object

com.helger.photon.basic.security.password.hash.PasswordHashCreatorManager

@ThreadSafe
public class PasswordHashCreatorManager
extends Object

This class manages multiple IPasswordHashCreator instances

Author:

Philip Helger

Constructor Summary

Constructors

Constructor and Description
PasswordHashCreatorManager()

Method Summary

Methods

Modifier and Type	Method and Description
PasswordHash	createUserDefaultPasswordHash(IPasswordSalt aSalt, String sPlainTextPassword) Create the password hash from the passed plain text password, using the default password hash creator.
PasswordHash	createUserPasswordHash(String sAlgorithmName, IPasswordSalt aSalt, String sPlainTextPassword) Create the password hash from the passed plain text password, using the default password hash creator.
Set<String>	getAllPasswordHashCreatorAlgorithms()
Collection<IPasswordHashCreator>	getAllPasswordHashCreators()
IPasswordHashCreator	getDefaultPasswordHashCreator()
String	getDefaultPasswordHashCreatorAlgorithmName()
IPasswordHashCreator	getPasswordHashCreatorOfAlgorithm(String sAlgorithmName) Get the password hash creator of the specified algorithm name.
void	registerPasswordHashCreator(IPasswordHashCreator aPasswordHashCreator) Register a new password hash creator.
void	setDefaultPasswordHashCreatorAlgorithm(String sAlgorithm) Set the default password hash creator algorithm.
String	toString()
void	unregisterPasswordHashCreator(IPasswordHashCreator aPasswordHashCreator)

Methods inherited from class java.lang.Object

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

Constructor Detail

PasswordHashCreatorManager

public PasswordHashCreatorManager()

Method Detail

registerPasswordHashCreator

public void registerPasswordHashCreator(@Nonnull
                               IPasswordHashCreator aPasswordHashCreator)

Register a new password hash creator. No other password hash creator with the same algorithm name may be registered.

Parameters:

aPasswordHashCreator - The password hash creator to be registered. May not be null.

unregisterPasswordHashCreator

public void unregisterPasswordHashCreator(@Nullable
                                 IPasswordHashCreator aPasswordHashCreator)

getPasswordHashCreatorOfAlgorithm

@Nullable
public IPasswordHashCreator getPasswordHashCreatorOfAlgorithm(@Nullable
                                                              String sAlgorithmName)

Get the password hash creator of the specified algorithm name.

Parameters:

sAlgorithmName - The algorithm name to query. May be null.

Returns:

null if no such hash creator is registered.

getAllPasswordHashCreatorAlgorithms

@Nonnull
@ReturnsMutableCopy
public Set<String> getAllPasswordHashCreatorAlgorithms()

getAllPasswordHashCreators

@Nonnull
@ReturnsMutableCopy
public Collection<IPasswordHashCreator> getAllPasswordHashCreators()

setDefaultPasswordHashCreatorAlgorithm

public void setDefaultPasswordHashCreatorAlgorithm(@Nonnull@Nonempty
                                          String sAlgorithm)

Set the default password hash creator algorithm. A matching IPasswordHashCreator object must be registered previously using registerPasswordHashCreator(IPasswordHashCreator).

Parameters:

sAlgorithm - The name of the algorithm to use as the default. May neither be null nor empty.

getDefaultPasswordHashCreator

@Nonnull
public IPasswordHashCreator getDefaultPasswordHashCreator()

Returns:

The default IPasswordHashCreator algorithm to use. Never null.

getDefaultPasswordHashCreatorAlgorithmName

@Nonnull
public String getDefaultPasswordHashCreatorAlgorithmName()

Returns:

The default password hash creator algorithm name currently in use.

createUserDefaultPasswordHash

@Nonnull
public 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.

See Also:

getDefaultPasswordHashCreator()

createUserPasswordHash

@Nonnull
public 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.

See Also:

getDefaultPasswordHashCreator()

toString

public String toString()

Overrides:

toString in class Object