Package com.atlassian.crowd.service.email

Class EmailChangeManagerImpl

java.lang.Object

com.atlassian.crowd.service.email.EmailChangeManagerImpl

All Implemented Interfaces:

EmailChangeManager

@Transactional
public class EmailChangeManagerImpl
extends Object
implements EmailChangeManager

Constructor Summary

Constructors

Constructor

Description

EmailChangeManagerImpl(ChangeEmailLinkMailer changeEmailLinkMailer, com.atlassian.security.random.SecureTokenGenerator tokenGenerator, ExpirableUserTokenDao expirableUserTokenDao, ApplicationService applicationService, com.atlassian.sal.api.ApplicationProperties applicationProperties, Clock clock, ApplicationManager applicationManager, ClientProperties clientProperties, com.atlassian.event.api.EventPublisher eventPublisher, DirectoryManager directoryManager, MailConfigurationService mailConfigurationService, PermissionManager permissionManager, EmailAddressValidator emailValidator)

Method Summary

Modifier and Type	Method	Description
void	abort(String username, long directoryId)	Aborts a pending e-mail validation for a given user in crowd app.
void	changeEmail(String token, String username)	Changes e-mail for a user in crowd app.
String	getPendingNewEmailByToken(String token)	Returns new e-mail address for a e-mail change token.
String	getPendingNewEmailByUser(String username, long directoryId)	Returns new e-mail address for a user in crowd app for whom there's a pending e-mail verification.
boolean	hasUserEmailChangePending(String username, long directoryId)	Returns true if there is a pending e-mail verification for a user in crowd app, false otherwise.
boolean	isAvailableForDirectory(long dirId)	Returns true if e-mail change by end-user feature is available for a given directory.
boolean	isTokenValid(String token)	Returns true if a given token is a valid e-mail change verification token.
void	resendEmail(String username, long directoryId)	Resends an e-mail with a new token for a user in crowd app that has a pending e-mail verification.
void	sendEmailAuthorization(String username, String password, long directoryId, String newEmail)	Starts e-mail change flow for a user in crowd app, by sending two e-mails.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

EmailChangeManagerImpl

public EmailChangeManagerImpl(ChangeEmailLinkMailer changeEmailLinkMailer,
 com.atlassian.security.random.SecureTokenGenerator tokenGenerator,
 ExpirableUserTokenDao expirableUserTokenDao,
 ApplicationService applicationService,
 com.atlassian.sal.api.ApplicationProperties applicationProperties,
 Clock clock,
 ApplicationManager applicationManager,
 ClientProperties clientProperties,
 com.atlassian.event.api.EventPublisher eventPublisher,
 DirectoryManager directoryManager,
 MailConfigurationService mailConfigurationService,
 PermissionManager permissionManager,
 EmailAddressValidator emailValidator)

Method Details

sendEmailAuthorization

public void sendEmailAuthorization(String username,
 String password,
 long directoryId,
 String newEmail)
                            throws InvalidAuthenticationException,
InvalidEmailAddressException,
MailSendException,
OperationNotPermittedException,
ApplicationNotFoundException,
SameEmailAddressException

Description copied from interface: EmailChangeManager

Starts e-mail change flow for a user in crowd app, by sending two e-mails. First one to the current user's e-mail and the second one to the newEmail. The first one contains info for an ongoing e-mail change. The second one contains a link with a token which is required to change an e-mail. In order to do change an e-mail, EmailChangeManager.changeEmail(java.lang.String, java.lang.String) needs to be called with the aforementioned token passed as an argument.

Specified by:

sendEmailAuthorization in interface EmailChangeManager

Parameters:

username - username of the user for whom we're changing an e-mail

password - password of the user for whom we're changing an e-mail

directoryId - directory ID of the user for whom we're changing an e-mail

newEmail - e-mail to which we'll replace an old email of the user

Throws:

InvalidAuthenticationException - if authentication fails for given username and password

InvalidEmailAddressException - if passed newEmail is not a valid e-mail address

MailSendException - if Crowd failed to send e-mail with a token

OperationNotPermittedException - if feature is not available

ApplicationNotFoundException - if 'crowd' app has not been found

SameEmailAddressException - if passed newEmail is the same as the one currently used by a user

changeEmail

public void changeEmail(String token,
 String username)
                 throws UserNotFoundException,
InvalidChangeEmailTokenException,
InvalidAuthenticationException,
OperationFailedException,
ApplicationNotFoundException,
OperationNotPermittedException

Description copied from interface: EmailChangeManager

Changes e-mail for a user in crowd app.

This method SHALL only be called after calling EmailChangeManager.sendEmailAuthorization(java.lang.String, java.lang.String, long, java.lang.String).

Specified by:

changeEmail in interface EmailChangeManager

Parameters:

token - token sent in email by EmailChangeManager.sendEmailAuthorization(java.lang.String, java.lang.String, long, java.lang.String)

username - username of the user for whom we're changing an e-mail

Throws:

UserNotFoundException - if user does not exist

InvalidChangeEmailTokenException - if provide token is not valid

InvalidAuthenticationException - if user identified by username is not the one who generated a token

OperationFailedException - if Crowd failed to update e-mail

ApplicationNotFoundException - if 'crowd' app has not been found

OperationNotPermittedException - if feature is not available

hasUserEmailChangePending

public boolean hasUserEmailChangePending(String username,
 long directoryId)

Description copied from interface: EmailChangeManager

Returns true if there is a pending e-mail verification for a user in crowd app, false otherwise.

Specified by:

hasUserEmailChangePending in interface EmailChangeManager

Parameters:

username - username of the user

directoryId - directory ID of the user

Returns:

true if there is a pending e-mail verification for a user, false otherwise

getPendingNewEmailByUser

public String getPendingNewEmailByUser(String username,
 long directoryId)

Description copied from interface: EmailChangeManager

Returns new e-mail address for a user in crowd app for whom there's a pending e-mail verification.

Specified by:

getPendingNewEmailByUser in interface EmailChangeManager

Parameters:

username - username of the user

directoryId - directory ID of the user

Returns:

new e-mail address

getPendingNewEmailByToken

public String getPendingNewEmailByToken(String token)

Description copied from interface: EmailChangeManager

Returns new e-mail address for a e-mail change token.

Specified by:

getPendingNewEmailByToken in interface EmailChangeManager

Parameters:

token - e-mail change token

Returns:

new e-mail address

resendEmail

public void resendEmail(String username,
 long directoryId)
                 throws InvalidEmailAddressException,
MailSendException,
UserNotFoundException,
ApplicationNotFoundException

Description copied from interface: EmailChangeManager

Resends an e-mail with a new token for a user in crowd app that has a pending e-mail verification. Old token is invalidated.

Specified by:

resendEmail in interface EmailChangeManager

Parameters:

username - of the user

directoryId - directory ID of the user

Throws:

InvalidEmailAddressException - if pending e-mail address is not a valid e-mail address

MailSendException - if Crowd failed to re-send e-mail with a token

UserNotFoundException - if user does not exist

ApplicationNotFoundException - if 'crowd' app has not been found

abort

public void abort(String username,
 long directoryId)

Description copied from interface: EmailChangeManager

Aborts a pending e-mail validation for a given user in crowd app.

Specified by:

abort in interface EmailChangeManager

Parameters:

username - username of the user

directoryId - directory ID of the user

isTokenValid

public boolean isTokenValid(String token)

Description copied from interface: EmailChangeManager

Returns true if a given token is a valid e-mail change verification token. False otherwise.

Specified by:

isTokenValid in interface EmailChangeManager

Parameters:

token - e-mail change token

Returns:

true if a given token is a valid e-mail change verification token, false otherwise

isAvailableForDirectory

public boolean isAvailableForDirectory(long dirId)

Description copied from interface: EmailChangeManager

Returns true if e-mail change by end-user feature is available for a given directory. False otherwise.

Feature might be disabled for a given directory because: - Crowd's e-mail server is NOT configured - Directory does not have permissions to change user e-mail

Specified by:

isAvailableForDirectory in interface EmailChangeManager

Parameters:

dirId - ID of the directory

Returns:

true if e-mail change by end-user feature is available for a given directory, false otherwise.