org.cyclos.impl.access

Interface PasswordHandler

public interface PasswordHandler

Contains methods used to validate passwords

Author:

rodrigo, luis

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ATTR_PASSWORD Script attribute: the password value to check
static java.lang.String	ATTR_PASSWORD_TYPE Script attribute: the password type being checked
static java.lang.String	ATTR_USER Script attribute: the user to check password

Method Summary

Modifier and Type	Method and Description
void	checkConfirmationPassword(java.lang.String password) Checks the confirmation password for the logged user, if used
void	checkPassword(boolean forLogin, PasswordType type, BasicUser user, java.lang.String password) Checks the password for the given user, doing different checks if it's for login
void	checkPassword(PasswordType type, BasicUser user, java.lang.String password) Checks the password for the given user
void	checkSecondaryPassword(java.lang.String password) Checks the secondary access password for the logged user.
java.lang.String	encode(BasicUser user, PasswordType passwordType, java.lang.String value) Encodes the password according to its type
PasswordType	getAccessPasswordType() Return the password type used as the primary (login) password for the logged user and the current channel.
PasswordInputDTO	getConfirmationPasswordInput() Returns the input for the confirmation password for the logged user
PasswordType	getConfirmationPasswordType() Returns the password type used to confirm operations for the logged user
PasswordInputDTO	getPasswordInput(BasicUser basicUser, PasswordType passwordType) Returns the password input information for the given user and password type
PasswordInputDTO	getPasswordInput(PasswordType passwordType) Returns the password input information for the logged user and the given password type
java.util.Map<PasswordType,java.lang.Boolean>	getPasswordTypesAtRegistration(Group group, UserRegistration registration, PasswordMode mode) Returns a map of PasswordType marked to be saved at registration for the specified group and registration type, and a flag indicating if the password type is also used for access.
PasswordInputDTO	getSecondaryPasswordInput() Returns the input used to for a secondary access password (if any) for the logged user and the current channel.
PasswordType	getSecondaryPasswordType() Return the password type used as the secondary password used to finish the login process.
boolean	matches(Password password, java.lang.String plainPassword) Returns whether the given plain password matches the stored password
void	notifyPasswordStatusChanged(PasswordType type, BasicUser user, PasswordStatus status) Notifies the user that a password has changed its status

Field Detail

ATTR_USER

static final java.lang.String ATTR_USER

Script attribute: the user to check password

See Also:

Constant Field Values

ATTR_PASSWORD_TYPE

static final java.lang.String ATTR_PASSWORD_TYPE

Script attribute: the password type being checked

See Also:

Constant Field Values

ATTR_PASSWORD

static final java.lang.String ATTR_PASSWORD

Script attribute: the password value to check

See Also:

Constant Field Values

Method Detail

checkConfirmationPassword

void checkConfirmationPassword(java.lang.String password)
                        throws PasswordException

Checks the confirmation password for the logged user, if used

Throws:

PasswordException

checkPassword

void checkPassword(boolean forLogin,
                   PasswordType type,
                   BasicUser user,
                   java.lang.String password)
            throws PasswordException

Checks the password for the given user, doing different checks if it's for login

Throws:

PasswordException

checkPassword

void checkPassword(PasswordType type,
                   BasicUser user,
                   java.lang.String password)
            throws PasswordException

Checks the password for the given user

Throws:

PasswordException

checkSecondaryPassword

void checkSecondaryPassword(java.lang.String password)
                     throws PasswordException

Checks the secondary access password for the logged user.

Throws:

PasswordException

encode

java.lang.String encode(BasicUser user,
                        PasswordType passwordType,
                        java.lang.String value)

Encodes the password according to its type

getAccessPasswordType

PasswordType getAccessPasswordType()

Return the password type used as the primary (login) password for the logged user and the current channel.

getConfirmationPasswordInput

PasswordInputDTO getConfirmationPasswordInput()

Returns the input for the confirmation password for the logged user

getConfirmationPasswordType

PasswordType getConfirmationPasswordType()

Returns the password type used to confirm operations for the logged user

getPasswordInput

PasswordInputDTO getPasswordInput(BasicUser basicUser,
                                  PasswordType passwordType)

Returns the password input information for the given user and password type

getPasswordInput

PasswordInputDTO getPasswordInput(PasswordType passwordType)

Returns the password input information for the logged user and the given password type

getPasswordTypesAtRegistration

java.util.Map<PasswordType,java.lang.Boolean> getPasswordTypesAtRegistration(Group group,
                                                                             UserRegistration registration,
                                                                             PasswordMode mode)

Returns a map of PasswordType marked to be saved at registration for the specified group and registration type, and a flag indicating if the password type is also used for access.

Parameters:

group - the group the user will be registered

registration - if UserRegistration.PUBLIC then it will read from the group's product. Otherwise it will read from the logged user's products.

mode - a filter (Optional) Only PasswordMode.MANUAL and PasswordMode.GENERATED are supported.

getSecondaryPasswordInput

PasswordInputDTO getSecondaryPasswordInput()

Returns the input used to for a secondary access password (if any) for the logged user and the current channel.

getSecondaryPasswordType

PasswordType getSecondaryPasswordType()

Return the password type used as the secondary password used to finish the login process.

matches

boolean matches(Password password,
                java.lang.String plainPassword)

Returns whether the given plain password matches the stored password

notifyPasswordStatusChanged

void notifyPasswordStatusChanged(PasswordType type,
                                 BasicUser user,
                                 PasswordStatus status)

Notifies the user that a password has changed its status