org.jbei.ice.lib.account

Class AccountController

java.lang.Object

org.jbei.ice.lib.account.AccountController

public class AccountController
extends Object

ABI to manipulate Account objects.

This class contains methods that wrap AccountDAO to manipulate Account objects.

Author:

Timothy Ham, Zinovii Dmytriv, Hector Plahar

Constructor Summary

Constructors

Constructor and Description
AccountController() Default constructor.

Method Summary

Modifier and Type	Method and Description
AccountTransfer	authenticate(AccountTransfer transfer) Authenticate a user in the database.
protected Account	authenticate(String login, String password, String ip) Authenticate a user in the database.
Account	createAdminAccount()
AccountTransfer	createNewAccount(AccountTransfer info, boolean sendEmail) Creates a new account using the parameters passed.
AccountTransfer	getAccountBySessionKey(String sessionKey)
long	getAccountId(String email)
Account	getByEmail(String email) Retrieve Account by user id.
void	invalidate(String sessionKey) De-authenticate the given sessionKey.
boolean	isAdministrator(String userId) Check in the database if an account is a moderator.
void	removeMemberFromGroup(long id, String email)
boolean	resetPassword(String targetEmail) Reset a user's password
Account	save(Account account) Store Account into the database.
AccountTransfer	updateAccount(String requester, long userId, AccountTransfer transfer)
AccountTransfer	updatePassword(String userId, long id, AccountTransfer transfer) Updates the specified user account's password

Methods inherited from class java.lang.Object

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

Constructor Detail

AccountController

public AccountController()

Default constructor.

Method Detail

updateAccount

public AccountTransfer updateAccount(String requester,
                                     long userId,
                                     AccountTransfer transfer)

Parameters:

requester -

userId -

transfer -

Returns:

updated account object

resetPassword

public boolean resetPassword(String targetEmail)

Reset a user's password

Parameters:

targetEmail - email address of user account to be changed

Returns:

true if the user account is found with email specified in the parameter and password for it is successfully reset, false otherwise

updatePassword

public AccountTransfer updatePassword(String userId,
                                      long id,
                                      AccountTransfer transfer)
                               throws PermissionException

Updates the specified user account's password

Parameters:

userId - email of user making change. If it is not the same as the email associated with the id, then this account must have administrator privileges

id - unique (db) identifier for user whose password is to be changed.

transfer - wrapper around new password

Returns:

updated account object

Throws:

PermissionException - if the account associated with userId and id are not the same but the userId does not have administrative privileges

createNewAccount

public AccountTransfer createNewAccount(AccountTransfer info,
                                        boolean sendEmail)

Creates a new account using the parameters passed. A random password is initially generated , encrypted and assigned to the account

Parameters:

info - contains information needed to create account

sendEmail - whether to send account information (including password by email)

Returns:

generated password

createAdminAccount

public Account createAdminAccount()

Returns:

new admin account

getByEmail

public Account getByEmail(String email)

Retrieve Account by user id.

Parameters:

email - unique identifier for account, typically email

Returns:

Account

getAccountId

public long getAccountId(String email)

Parameters:

email - an account identifier (usually email)

Returns:

database identifier of account matching account identifier (email)

Throws:

IllegalArgumentException - for an invalid account identifier

getAccountBySessionKey

public AccountTransfer getAccountBySessionKey(String sessionKey)

Parameters:

sessionKey -

Returns:

Account object matching a session key, or null

save

public Account save(Account account)

Store Account into the database.

Parameters:

account -

Returns:

Account that has been saved.

isAdministrator

public boolean isAdministrator(String userId)

Check in the database if an account is a moderator.

Parameters:

userId - unique account identifier for user

Returns:

True, if the account is a moderator.

authenticate

protected Account authenticate(String login,
                               String password,
                               String ip)

Authenticate a user in the database.

Using the IAuthentication specified in the settings file, authenticate the user, and return the sessionData

Parameters:

login -

password -

ip - IP Address of the user.

Returns:

the account identifier (email) on a successful login, otherwise null

authenticate

public AccountTransfer authenticate(AccountTransfer transfer)

Authenticate a user in the database.

Using the IAuthentication specified in the settings file, authenticate the user, and return the sessionData

Parameters:

transfer - user information containing the email and password to be used for authentication If the sessionId field is set, it may or may not be used as the user's session id

Returns:

AccountTransfer

invalidate

public void invalidate(String sessionKey)

De-authenticate the given sessionKey. The user is logged out from the system.

Parameters:

sessionKey - unique session identifier

removeMemberFromGroup

public void removeMemberFromGroup(long id,
                                  String email)

Parameters:

id -

email -