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.
java.lang.String	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.Set<OTPSendMedium>	getAllowedOTPSendMediums(BasicUser basicUser, PasswordType passwordType) Returns the allowed mediums for the given user and password type.
PasswordData	getData(BasicUser user, PasswordType passwordType) Returns the PasswordData for the given user and password type.
Pair<Password,PasswordStatus>	getPasswordAndStatus(BasicUser user, PasswordType passwordType) Returns the status and the password record for the given user and password 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	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

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

activate, allowActivation, change, changeForgottenPassword, disable, enable, forgotPasswordRequest, generateNew, getChangeForgottenPasswordData, getChangePasswordData, getData, requestNewOTP, 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)
             throws FrameworkException,
                    IllegalActionException

Adds all password validations according to specified password type.

Throws:

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

FrameworkException

create

java.lang.String create(BasicUser user,
                        PasswordType passwordType,
                        java.lang.String password,
                        PasswordStatus status)
                 throws FrameworkException,
                        IllegalActionException

Creates a password for the given user and password type. When the given password is null, a value is generated if status is active. Returns the plain value

Throws:

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

FrameworkException

exists

boolean exists(BasicUser user,
               PasswordType passwordType)
        throws FrameworkException

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

Throws:

FrameworkException

getAllowedOTPSendMediums

java.util.Set<OTPSendMedium> getAllowedOTPSendMediums(BasicUser basicUser,
                                                      PasswordType passwordType)
                                               throws FrameworkException

Returns the allowed mediums for the given user and password type.

Throws:

FrameworkException

getData

PasswordData getData(BasicUser user,
                     PasswordType passwordType)
              throws FrameworkException

Returns the PasswordData for the given user and password type. Returns null if the user has no access to the given password type

Throws:

FrameworkException

getPasswordAndStatus

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

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.

Throws:

FrameworkException

getStatusAndActions

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

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

Throws:

FrameworkException

isUserCanChangePassword

boolean isUserCanChangePassword(BasicUser user,
                                PasswordType passwordType)
                         throws FrameworkException

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

Throws:

FrameworkException

remove

boolean remove(BasicUser user,
               PasswordType passwordType)
        throws FrameworkException

Removes the password of the given user and type

Throws:

FrameworkException