org.appng.core.security

Interface PasswordHandler

All Known Implementing Classes:

BCryptPasswordHandler, Sha1PasswordHandler

public interface PasswordHandler

Provides methods to handle passwords. Different implementations of this interface can provide different algorithms to hash, salt and store a password. It can be expected that the constructor of an implementation of this interfaces requires an instance of AuthSubject or SubjectImpl as argument.

Author:

Matthias Herlitzius

Method Summary

Modifier and Type	Method and Description
String	getPasswordResetDigest() Returns a digest which can be used for the "Forgot password?" function.
boolean	isValidPassword(String password) Checks whether the password is valid.
boolean	isValidPasswordResetDigest(String digest) Checks whether the digest is valid.
void	migrate(CoreService service, String password) Migrates passwords of the current PasswordHandler instance to passwords handled by CoreService.getDefaultPasswordHandler(org.appng.api.model.AuthSubject).
void	savePassword(String password) Hashes and persists the password.
void	updateSubject(CoreService service) Updates the SubjectImpl instance in the database.

Method Detail

savePassword

void savePassword(String password)

Hashes and persists the password.

Parameters:

password - The cleartext password.

isValidPassword

boolean isValidPassword(String password)

Checks whether the password is valid.

Parameters:

password - The cleartext password.

Returns:

True if the password is valid, false if it is invalid.

getPasswordResetDigest

String getPasswordResetDigest()

Returns a digest which can be used for the "Forgot password?" function.

Returns:

A digest.

isValidPasswordResetDigest

boolean isValidPasswordResetDigest(String digest)

Checks whether the digest is valid.

Parameters:

digest - The digest.

Returns:

True if the digest is valid, false if it is invalid.

updateSubject

void updateSubject(CoreService service)
            throws BusinessException

Updates the SubjectImpl instance in the database. Must be called if modifications have been made to the instance of AuthSubject / SubjectImpl by methods of this interface and the instance is not updated later during the same transaction.

Parameters:

service - The CoreService instance.

Throws:

BusinessException - Throws a BusinessException if the SubjectImpl can not be updated.

migrate

void migrate(CoreService service,
             String password)

Migrates passwords of the current PasswordHandler instance to passwords handled by CoreService.getDefaultPasswordHandler(org.appng.api.model.AuthSubject).

Parameters:

service - Instance of CoreService

password - The current password.