com.buckosoft.BSAccountMan.business

Class BSAccountManManImpl

java.lang.Object

com.buckosoft.BSAccountMan.business.BSAccountManManImpl

All Implemented Interfaces:

BSAccountManMan

public class BSAccountManManImpl
extends java.lang.Object
implements BSAccountManMan

Implement the API for BSAccountManMan

Since:

2007-09-19

Author:

dick

Field Summary

Fields

Modifier and Type	Field and Description
protected org.apache.commons.logging.Log	logger

Constructor Summary

Constructors

Constructor and Description
BSAccountManManImpl()

Method Summary

Modifier and Type	Method and Description
BSAccount	getAccount(int userid) Get a user account, given his BuckoSoft userid
BSAccount	getAccount(java.lang.String username) Get a user account, given his username (the name he registered with)
BSAccount	getAccountByToken(int token) Get a user account, given his recover password token
BSAccountMan	getBsAccountMan()
Database	getDb()
java.lang.String	getLoginSuccessPageRedirect()
BSAccountUser	getNewUser() Return a new user created by the UserFactory
BSAccountUserWebSession	getNewUserWebSession(BSAccountUser user)
int	getRandomInt() Return a random number.
BSAccountUser	getUser(BSAccount account)
int	getUserCount() Get the number of users in the system
void	insertAccount(BSAccount account)
boolean	isHelloForwards() Some apps like to redirect hello.do to home.do if the user is logged in.
java.lang.String	registerAccount(java.lang.String appName, BSAccount account) Register a new user to the BSAccount system.
java.lang.String	sendValidateEmail(java.lang.String appName, java.lang.String username, java.lang.String email) "Forgot password" helper method.
void	setBaseUrl(java.lang.String baseUrl) Set the base Url to prepend to the validate URL
void	setBsAccountMan(BSAccountMan bsAccountMan)
void	setDb(Database db)
void	setHelloForwards(boolean helloForwards) Some apps like to redirect hello.do to home.do if the user is logged in.
void	setLoginSuccessPageRedirect(java.lang.String loginSuccessPageRedirect) Maybe you don't want the default home.do after a successful login.
void	setSmtpHost(java.lang.String smtpHost) Set the host that will accept our outgoing email
void	setUserFactory(UserFactory userFactory)
void	updateAccount(BSAccount account) Store the account's attributes (excluding password) back to the database.
void	updateAccountPassword(BSAccount account, java.lang.String newPassword) Change the user's password
java.lang.String	validateAccount(java.lang.String userid, java.lang.String registerToken) After the user clicks on the emailed link, call this function with the two tokens passed in the url
java.lang.String	validateEmailAddress(java.lang.String email) Validate this email address, make sure it looks real.
java.lang.String	validateUserName(java.lang.String username) Validate this username, make sure it has no funny characters.
void	verifyUser(BSAccount account) After a user has clicked the link in his mail, fill in the rest of the fields, and call this.

Methods inherited from class java.lang.Object

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

Field Detail

logger

protected final org.apache.commons.logging.Log logger

Constructor Detail

BSAccountManManImpl

public BSAccountManManImpl()

Method Detail

getBsAccountMan

public BSAccountMan getBsAccountMan()

Returns:

the bsAccountMan

setBsAccountMan

public void setBsAccountMan(BSAccountMan bsAccountMan)

Parameters:

bsAccountMan - the bsAccountMan to set

setSmtpHost

public void setSmtpHost(java.lang.String smtpHost)

Description copied from interface: BSAccountManMan

Set the host that will accept our outgoing email

Specified by:

setSmtpHost in interface BSAccountManMan

Parameters:

smtpHost - the smtpHost to set

setBaseUrl

public void setBaseUrl(java.lang.String baseUrl)

Description copied from interface: BSAccountManMan

Set the base Url to prepend to the validate URL

Specified by:

setBaseUrl in interface BSAccountManMan

Parameters:

baseUrl - Looks something like "http://mae:8087/SPMCards/"

getDb

public Database getDb()

Returns:

the db

setDb

public void setDb(Database db)

Parameters:

db - the db to set

getNewUser

public BSAccountUser getNewUser()

Description copied from interface: BSAccountManMan

Return a new user created by the UserFactory

Specified by:

getNewUser in interface BSAccountManMan

Returns:

A newly minted User

getUser

public BSAccountUser getUser(BSAccount account)

getNewUserWebSession

public BSAccountUserWebSession getNewUserWebSession(BSAccountUser user)

Specified by:

getNewUserWebSession in interface BSAccountManMan

getUserCount

public int getUserCount()

Get the number of users in the system

Specified by:

getUserCount in interface BSAccountManMan

Returns:

The number of users

insertAccount

public void insertAccount(BSAccount account)

updateAccount

public void updateAccount(BSAccount account)

Description copied from interface: BSAccountManMan

Store the account's attributes (excluding password) back to the database.

Specified by:

updateAccount in interface BSAccountManMan

updateAccountPassword

public void updateAccountPassword(BSAccount account,
                                  java.lang.String newPassword)

Description copied from interface: BSAccountManMan

Change the user's password

Specified by:

updateAccountPassword in interface BSAccountManMan

Parameters:

account - His BSAccount

newPassword - His new cleartext password

registerAccount

public java.lang.String registerAccount(java.lang.String appName,
                                        BSAccount account)

Description copied from interface: BSAccountManMan

Register a new user to the BSAccount system.

Specified by:

registerAccount in interface BSAccountManMan

Parameters:

appName - The application that we want to return to.

account - The user's account. username and email should be filled in before calling this.

Returns:

empty string on success. Error message on failure.

verifyUser

public void verifyUser(BSAccount account)

Description copied from interface: BSAccountManMan

After a user has clicked the link in his mail, fill in the rest of the fields, and call this. At a minimum, the password should be filled in.

Specified by:

verifyUser in interface BSAccountManMan

Parameters:

account - The user's account. username, email, and password should be filled in.

validateUserName

public java.lang.String validateUserName(java.lang.String username)

Description copied from interface: BSAccountManMan

Validate this username, make sure it has no funny characters.

Specified by:

validateUserName in interface BSAccountManMan

Parameters:

username - The username to check

Returns:

A zero length string on success. An error string if the email didn't validate.

validateEmailAddress

public java.lang.String validateEmailAddress(java.lang.String email)

Description copied from interface: BSAccountManMan

Validate this email address, make sure it looks real.

Specified by:

validateEmailAddress in interface BSAccountManMan

Parameters:

email - The email address to check

Returns:

A zero length string on success. An error string if the email didn't validate.

sendValidateEmail

public java.lang.String sendValidateEmail(java.lang.String appName,
                                          java.lang.String username,
                                          java.lang.String email)

Description copied from interface: BSAccountManMan

"Forgot password" helper method. Given a username and/or an email address, find that account, reset the registerToken and send a "Forgot password" email to the user. If username and email are both given, then the username is read and the email is ignored.

Specified by:

sendValidateEmail in interface BSAccountManMan

Parameters:

appName - The application that we want to return to.

username - The username that the guy typed in.

email - The email address that the guy typed in.

Returns:

An empty string upon success. Otherwise, an error message.

validateAccount

public java.lang.String validateAccount(java.lang.String userid,
                                        java.lang.String registerToken)

Description copied from interface: BSAccountManMan

After the user clicks on the emailed link, call this function with the two tokens passed in the url

Specified by:

validateAccount in interface BSAccountManMan

Parameters:

userid - the value of the id= parameter that was in the url

registerToken - The value of the validate= parameter that was in the url (should be a number)

Returns:

An empty string on success. Otherwise an error message.

getRandomInt

public int getRandomInt()

Description copied from interface: BSAccountManMan

Return a random number. Calling this without even needing a response can be fun, it adds entropy to the system; especially from a timer.

Specified by:

getRandomInt in interface BSAccountManMan

Returns:

some integer

getAccount

public BSAccount getAccount(java.lang.String username)

Description copied from interface: BSAccountManMan

Get a user account, given his username (the name he registered with)

Specified by:

getAccount in interface BSAccountManMan

Parameters:

username - A String that his a name

Returns:

A BSAccount if found, null if not found

getAccount

public BSAccount getAccount(int userid)

Description copied from interface: BSAccountManMan

Get a user account, given his BuckoSoft userid

Specified by:

getAccount in interface BSAccountManMan

Parameters:

userid - The int that was assigned to him when his record was created.

Returns:

The BSAcount matching this id, or null if not found.

getAccountByToken

public BSAccount getAccountByToken(int token)

Description copied from interface: BSAccountManMan

Get a user account, given his recover password token

Specified by:

getAccountByToken in interface BSAccountManMan

Parameters:

token - The token that was emailed to the lost user.

Returns:

The BSAccount matching this token, or null if not found.

setLoginSuccessPageRedirect

public void setLoginSuccessPageRedirect(java.lang.String loginSuccessPageRedirect)

Description copied from interface: BSAccountManMan

Maybe you don't want the default home.do after a successful login. Put the page name here.

Specified by:

setLoginSuccessPageRedirect in interface BSAccountManMan

getLoginSuccessPageRedirect

public java.lang.String getLoginSuccessPageRedirect()

Specified by:

getLoginSuccessPageRedirect in interface BSAccountManMan

setUserFactory

public void setUserFactory(UserFactory userFactory)

Specified by:

setUserFactory in interface BSAccountManMan

isHelloForwards

public boolean isHelloForwards()

Description copied from interface: BSAccountManMan

Some apps like to redirect hello.do to home.do if the user is logged in. This is convienent, but effectively hides hello.do

Specified by:

isHelloForwards in interface BSAccountManMan

Returns:

true if we should redirect hello.do to home.do

setHelloForwards

public void setHelloForwards(boolean helloForwards)

Description copied from interface: BSAccountManMan

Some apps like to redirect hello.do to home.do if the user is logged in. This is convienent, but effectively hides hello.do

Specified by:

setHelloForwards in interface BSAccountManMan

Parameters:

helloForwards - the helloForwards to set