com.atlassian.crowd.openid.server.manager.login
Interface ForgottenLoginManager

All Known Implementing Classes:

ForgottenLoginManagerImpl

public interface ForgottenLoginManager

Manages functionality related to retrieving forgotten usernames or resetting forgotten passwords.

Since:

v2.1.0

Method Summary

void	sendResetLink(String username) Sends a reset link to the first user with the matching username from all the active directories assigned to the application.
void	sendUsernames(String email) Sends the usernames associated with the given email address.

Method Detail

sendResetLink

void sendResetLink(String username)
                   throws UserNotFoundException,
                          InvalidEmailAddressException

Sends a reset link to the first user with the matching username from all the active directories assigned to the application.

Parameters:

username - username of the user to send the password reset link

Throws:

UserNotFoundException - if no user with the supplied username exists

InvalidEmailAddressException - if the user does not have a valid email address to send the password reset email to

sendUsernames

void sendUsernames(String email)
                   throws InvalidEmailAddressException

Sends the usernames associated with the given email address. No email will be sent if there are no usernames associated with a given email.

Parameters:

email - email address of the user

Throws:

InvalidEmailAddressException - if the email is not valid