org.dspace.eperson

Class AccountManager

java.lang.Object

org.dspace.eperson.AccountManager

public class AccountManager
extends java.lang.Object

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

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AccountManager() Protected Constructor

Method Summary

Methods

Modifier and Type	Method and Description
static void	deleteToken(Context context, java.lang.String token) Delete token.
static java.lang.String	getEmail(Context context, java.lang.String token) Return the e-mail address referred to by a token, or null if email address can't be found ignores expiration of token
static EPerson	getEPerson(Context context, java.lang.String token) Return the EPerson corresponding to token, where token was emailed to the person by either the sendRegistrationInfo or sendForgotPasswordInfo methods.
static void	sendForgotPasswordInfo(Context context, java.lang.String email) Email forgot password info to the given email address.
protected static TableRow	sendInfo(Context context, java.lang.String email, boolean isRegister, boolean send)
static void	sendRegistrationInfo(Context context, java.lang.String email) Email registration info to the given email address.

Methods inherited from class java.lang.Object

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

Constructor Detail

AccountManager

protected AccountManager()

Protected Constructor

Method Detail

sendRegistrationInfo

public static void sendRegistrationInfo(Context context,
                        java.lang.String email)
                                 throws java.sql.SQLException,
                                        java.io.IOException,
                                        javax.mail.MessagingException,
                                        AuthorizeException

Email registration info to the given email address. Potential error conditions: Cannot create registration data in database (throws SQLException) Error sending email (throws MessagingException) Error reading email template (throws IOException) Authorization error (throws AuthorizeException)

Parameters:

context - DSpace context

email - Email address to send the registration email to

Throws:

java.sql.SQLException

java.io.IOException

javax.mail.MessagingException

AuthorizeException

sendForgotPasswordInfo

public static void sendForgotPasswordInfo(Context context,
                          java.lang.String email)
                                   throws java.sql.SQLException,
                                          java.io.IOException,
                                          javax.mail.MessagingException,
                                          AuthorizeException

Email forgot password info to the given email address. Potential error conditions: No EPerson with that email (returns null) Cannot create registration data in database (throws SQLException) Error sending email (throws MessagingException) Error reading email template (throws IOException) Authorization error (throws AuthorizeException)

Parameters:

context - DSpace context

email - Email address to send the forgot-password email to

Throws:

java.sql.SQLException

java.io.IOException

javax.mail.MessagingException

AuthorizeException

getEPerson

public static EPerson getEPerson(Context context,
                 java.lang.String token)
                          throws java.sql.SQLException,
                                 AuthorizeException

Return the EPerson corresponding to token, where token was emailed to the person by either the sendRegistrationInfo or sendForgotPasswordInfo methods.

If the token is not found return null.

Parameters:

context - DSpace context

token - Account token

Returns:

The EPerson corresponding to token, or null.

Throws:

java.sql.SQLException - If the token or eperson cannot be retrieved from the database.

AuthorizeException

getEmail

public static java.lang.String getEmail(Context context,
                        java.lang.String token)
                                 throws java.sql.SQLException

Return the e-mail address referred to by a token, or null if email address can't be found ignores expiration of token

Parameters:

context - DSpace context

token - Account token

Returns:

The email address corresponding to token, or null.

Throws:

java.sql.SQLException

deleteToken

public static void deleteToken(Context context,
               java.lang.String token)
                        throws java.sql.SQLException

Delete token.

Parameters:

context - DSpace context

token - The token to delete

Throws:

java.sql.SQLException - If a database error occurs

sendInfo

protected static TableRow sendInfo(Context context,
                java.lang.String email,
                boolean isRegister,
                boolean send)
                            throws java.sql.SQLException,
                                   java.io.IOException,
                                   javax.mail.MessagingException,
                                   AuthorizeException

Throws:

java.sql.SQLException

java.io.IOException

javax.mail.MessagingException

AuthorizeException