Package org.dspace.eperson.service

Interface AccountService

All Known Implementing Classes:

AccountServiceImpl

public interface AccountService

Methods for handling registration by email and forgotten passwords. When someone registers as a user, or forgets their password, the sendRegistrationInfo or sendForgotPasswordInfo methods can be used to send an email to the user. The email contains a special token, a long string which is randomly generated and thus hard to guess. When the user presents the token back to the system, the AccountManager can use the token to determine the identity of the eperson. *NEW* now ignores expiration dates so that tokens never expire

Version:

$Revision$

Author:

Peter Breton

Method Summary

Modifier and Type	Method	Description
void	deleteToken(Context context, String token)
boolean	existsAccountFor(Context context, String token)	Checks if exists an account related to the token provided
boolean	existsAccountWithEmail(Context context, String email)	Checks if exists an account related to the email provided
String	getEmail(Context context, String token)
EPerson	getEPerson(Context context, String token)
boolean	isTokenValidForCreation(RegistrationData registrationData)	Checks if the RegistrationData.token is valid.
EPerson	mergeRegistration(Context context, UUID userId, String token, List<String> overrides)	Merge registration data with an existing EPerson or create a new one.
RegistrationData	renewRegistrationForEmail(Context context, RegistrationDataPatch registrationDataPatch)	This method creates a fresh new RegistrationData based on the RegistrationDataPatch requested by a given user.
void	sendForgotPasswordInfo(Context context, String email)
void	sendRegistrationInfo(Context context, String email)

Method Details

sendRegistrationInfo

void sendRegistrationInfo(Context context,
 String email)
                   throws SQLException,
IOException,
jakarta.mail.MessagingException,
AuthorizeException

Throws:

SQLException

IOException

jakarta.mail.MessagingException

AuthorizeException

sendForgotPasswordInfo

void sendForgotPasswordInfo(Context context,
 String email)
                     throws SQLException,
IOException,
jakarta.mail.MessagingException,
AuthorizeException

Throws:

SQLException

IOException

jakarta.mail.MessagingException

AuthorizeException

existsAccountFor

boolean existsAccountFor(Context context,
 String token)
                  throws SQLException,
AuthorizeException

Checks if exists an account related to the token provided

Parameters:

context - DSpace context

token - Account token

Returns:

true if exists, false otherwise

Throws:

SQLException

AuthorizeException

existsAccountWithEmail

boolean existsAccountWithEmail(Context context,
 String email)
                        throws SQLException

Checks if exists an account related to the email provided

Parameters:

context - DSpace context

email - String email to search for

Returns:

true if exists, false otherwise

Throws:

SQLException

getEPerson

EPerson getEPerson(Context context,
 String token)
            throws SQLException,
AuthorizeException

Throws:

SQLException

AuthorizeException

getEmail

String getEmail(Context context,
 String token)
         throws SQLException

Throws:

SQLException

deleteToken

void deleteToken(Context context,
 String token)
          throws SQLException

Throws:

SQLException

mergeRegistration

EPerson mergeRegistration(Context context,
 UUID userId,
 String token,
 List<String> overrides)
                   throws AuthorizeException,
SQLException

Merge registration data with an existing EPerson or create a new one.

Parameters:

context - DSpace context

userId - The ID of the EPerson to merge with or create

token - The token to use for registration data

overrides - List of fields to override in the EPerson

Returns:

The merged or created EPerson

Throws:

AuthorizeException - If the user is not authorized to perform the action

SQLException - If a database error occurs

renewRegistrationForEmail

RegistrationData renewRegistrationForEmail(Context context,
 RegistrationDataPatch registrationDataPatch)
                                    throws AuthorizeException

This method creates a fresh new RegistrationData based on the RegistrationDataPatch requested by a given user.

Parameters:

context - - The DSapce Context

registrationDataPatch - - Details of the patch request coming from the Controller

Returns:

a newly created RegistrationData

Throws:

AuthorizeException

isTokenValidForCreation

boolean isTokenValidForCreation(RegistrationData registrationData)

Checks if the RegistrationData.token is valid.

Parameters:

registrationData - that will be checked

Returns:

true if valid, false otherwise