org.cyclos.impl.access

Interface PasswordServiceLocal

All Superinterfaces:

PasswordService, Service

public interface PasswordServiceLocal
extends PasswordService

Local interface for PasswordService

Author:

rodrigo

Method Summary

Modifier and Type	Method and Description
void	addValidations(org.cyclos.impl.utils.validation.Property property, BasicUser user, java.lang.String username, PasswordType passwordType) Adds all password validations according to specified password type.
Pair<java.lang.String,Password>	create(BasicUser user, PasswordType passwordType, java.lang.String password, PasswordStatus status) Creates a password for the given user and password type.
boolean	exists(BasicUser user, PasswordType passwordType) Returns whether a valid password exists for the given user / password type
java.util.Date	getExpirationDate(Password password) Returns the expiration date according to the password's type.
Pair<Password,PasswordStatus>	getPasswordAndStatus(BasicUser user, PasswordType passwordType) Returns the status and the password record for the given user and password type.
PasswordData	getPasswordData(BasicUser user, PasswordType passwordType) Returns the PasswordData for the given user and password type.
PasswordStatus	getStatus(BasicUser user, PasswordType type, boolean forAccess) Returns current password status for the given user and type.
Pair<PasswordStatus,java.util.Set<PasswordAction>>	getStatusAndActions(BasicUser user, PasswordType passwordType) Similar to PasswordService.getData(org.cyclos.model.users.users.UserLocatorVO), but with fewer data and preventing calculating the status twice
boolean	isPendingSecurityQuestion() Returns whether the currently authenticated user needs to set a security question
boolean	isUserCanChangePassword(BasicUser user, PasswordType passwordType) Returns if the given user can change the password for the given type
boolean	remove(BasicUser user, PasswordType passwordType) Removes the password of the given user and type
void	setSecurityQuestion(BasicUser user, SetSecurityQuestionDTO params) Sets the securiy question for the given user
void	updateUser(BasicUser user) Update the redundant password status information on the user

Methods inherited from interface org.cyclos.services.access.PasswordService

activate, allowActivation, change, changeForgottenPassword, disable, enable, forgotPasswordRequest, generateNew, getChangeForgottenPasswordData, getChangePasswordData, getData, getPasswordData, getSetSecurityQuestionData, requestNewOTP, requestNewOTPForSecondaryPassword, reset, resetAndSend, resetSecurityQuestion, setSecurityQuestion, unblock

Method Detail

addValidations

void addValidations(org.cyclos.impl.utils.validation.Property property,
                    BasicUser user,
                    java.lang.String username,
                    PasswordType passwordType)

Adds all password validations according to specified password type.

Throws:

IllegalActionException - When the given password type doesn't apply to the given user

create

Pair<java.lang.String,Password> create(BasicUser user,
                                       PasswordType passwordType,
                                       java.lang.String password,
                                       PasswordStatus status)

Creates a password for the given user and password type. When the given password is null, a value is generated if status is PasswordStatus.ACTIVE, PasswordStatus.EXPIRED, PasswordStatus.RESET.

Returns:

a pair with the plain password value and the Password entity.

Throws:

IllegalActionException - When the given password type doesn't apply to the given user or the password should be generated

exists

boolean exists(BasicUser user,
               PasswordType passwordType)

Returns whether a valid password exists for the given user / password type

getExpirationDate

java.util.Date getExpirationDate(Password password)

Returns the expiration date according to the password's type. Null if the password does not expire.

getPasswordAndStatus

Pair<Password,PasswordStatus> getPasswordAndStatus(BasicUser user,
                                                   PasswordType passwordType)

Returns the status and the password record for the given user and password type. The returned status may be different from the one in the password. For example, the password might have never been created (will be null) or there could be one of the calculated statuses, like blocked or expired.

getPasswordData

PasswordData getPasswordData(BasicUser user,
                             PasswordType passwordType)

Returns the PasswordData for the given user and password type.

getStatus

PasswordStatus getStatus(BasicUser user,
                         PasswordType type,
                         boolean forAccess)

Returns current password status for the given user and type.

Parameters:

forAccess - if true means the status is used to check access (use with caution)

getStatusAndActions

Pair<PasswordStatus,java.util.Set<PasswordAction>> getStatusAndActions(BasicUser user,
                                                                       PasswordType passwordType)

Similar to PasswordService.getData(org.cyclos.model.users.users.UserLocatorVO), but with fewer data and preventing calculating the status twice

isPendingSecurityQuestion

boolean isPendingSecurityQuestion()

Returns whether the currently authenticated user needs to set a security question

isUserCanChangePassword

boolean isUserCanChangePassword(BasicUser user,
                                PasswordType passwordType)

Returns if the given user can change the password for the given type

remove

boolean remove(BasicUser user,
               PasswordType passwordType)

Removes the password of the given user and type

setSecurityQuestion

void setSecurityQuestion(BasicUser user,
                         SetSecurityQuestionDTO params)

Sets the securiy question for the given user

updateUser

void updateUser(BasicUser user)

Update the redundant password status information on the user