org.alfresco.repo.security.authentication

Interface ResetPasswordService

All Known Implementing Classes:

ResetPasswordServiceImpl

public interface ResetPasswordService

Reset password service.

Since:

5.2.1

Author:

Jamal Kaabi-Mofrad

Method Summary

Modifier and Type	Method and Description
ClientAppConfig.ClientApp	getClientAppConfig(String clientName) Gets the registered client.
void	initiateResetPassword(ResetPasswordServiceImpl.ResetPasswordDetails resetDetails) Validates the request reset password workflow and updates the workflow.
void	performResetPassword(org.activiti.engine.delegate.DelegateExecution execution) Updates the user's new password.
void	requestReset(String userId, String clientName) Request password reset (starts the workflow).
void	sendResetPasswordConfirmationEmail(org.activiti.engine.delegate.DelegateExecution execution, String fallbackEmailTemplatePath, String emailSubject) Updates the user's new password.
void	sendResetPasswordEmail(org.activiti.engine.delegate.DelegateExecution execution, String fallbackEmailTemplatePath, String emailSubject) Sends reset password email.

Method Detail

requestReset

void requestReset(String userId,
                  String clientName)

Request password reset (starts the workflow).

Parameters:

userId - the user id

clientName - the client app name (used to lookup the client that is registered to send emails so that client's specific configuration could be used.)

initiateResetPassword

void initiateResetPassword(ResetPasswordServiceImpl.ResetPasswordDetails resetDetails)

Validates the request reset password workflow and updates the workflow.

Parameters:

resetDetails - the ResetPasswordDetails object

sendResetPasswordEmail

void sendResetPasswordEmail(org.activiti.engine.delegate.DelegateExecution execution,
                            String fallbackEmailTemplatePath,
                            String emailSubject)

Sends reset password email.

Parameters:

execution - the DelegateExecution object (is provided when a user requests password reset)

fallbackEmailTemplatePath - the class path of the fallback email template (request reset password email)

emailSubject - the email subject key

performResetPassword

void performResetPassword(org.activiti.engine.delegate.DelegateExecution execution)

Updates the user's new password.

Parameters:

execution - the DelegateExecution object

sendResetPasswordConfirmationEmail

void sendResetPasswordConfirmationEmail(org.activiti.engine.delegate.DelegateExecution execution,
                                        String fallbackEmailTemplatePath,
                                        String emailSubject)

Updates the user's new password.

Parameters:

execution - the DelegateExecution object

fallbackEmailTemplatePath - the class path of the fallback email template (confirmation email)

emailSubject - the email subject key

getClientAppConfig

ClientAppConfig.ClientApp getClientAppConfig(String clientName)

Gets the registered client.

Parameters:

clientName - the client name

Returns:

ClientApp object

Throws:

ClientAppNotFoundException - if no ClientApp is found with the given name