io.stallion.users

Class UserController<T extends IUser>

java.lang.Object

io.stallion.dataAccess.StandardModelController<T>

io.stallion.users.UserController<T>

All Implemented Interfaces:

ModelController<T>

public class UserController<T extends IUser>
extends StandardModelController<T>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	UserController.ResetEmailEmailer
static class	UserController.SessionInfo
static class	UserController.UserValetResult
class	UserController.VerifyEmailEmailer

Field Summary

Fields

Modifier and Type	Field and Description
static String	USER_COOKIE_NAME

Constructor Summary

Constructors

Constructor and Description
UserController()

Method Summary

Modifier and Type	Method and Description
T	addSessionCookieForUser(T user, Boolean rememberMe) Add a session cookie to the current request response for this user.
T	addSessionCookieForUser(T user, Boolean rememberMe, T valetUser) Add a session cookie to the current request response for this user.
T	changePassword(String email, String token, String newPassword, String confirmNewPassword)
T	changePassword(T user, String token, String newPassword, String confirmNewPassword)
boolean	changePrimaryEmail(T user, String newPrimaryEmail) Change the primary email of this user to an already validated and verified that is alaread an alias for the user id.
boolean	checkCookieAndAuthorizeForRequest(StRequest request) Checks the standard Stallion auth cookie, loads and validates the user, and hydrates the current request Context user, and returns true.
T	checkUserLoginValid(String username, String password) Returns a user if the login information is valid, throws a ClientException exception otherwise.
UserController.UserValetResult	cookieStringToUser(String cookie)
T	createUser(T user)
T	forEmail(String email)
T	forUsername(String username)
void	hydratePassword(T user, String password, String passwordConfirm) Hydrates the bycryptedPassword field, validiating the password for minimum length and matching confirmation.
static <Y extends IUser> UserController<Y>	instance()
static void	load()
T	loginUser(String username, String password, Boolean rememberMe) Checks the user information represents a valid login, adds the user to the context, and adds a cookie to the current request response.
void	logoff() Void out the authentication cookie
void	logoutCurrentUser()
String	makeEncryptedToken(T user, String type, String value)
String	makeVerifyEmailToken(T user)
void	markEmailVerified(String email, String token)
void	markEmailVerified(T user, String token)
void	markFailed(String username) Mark a login failure in the local cache, too many failures and the user or IP address will be locked out.
void	onPreCreatePrepare(T user) Override this to prepare the object with any default values before it is saved to the datastore for the first time.
String	readEncryptedToken(T user, String expectedType, String encrypted, int expiresMinutes)
boolean	sendEmailVerifyEmail(String email)
boolean	sendEmailVerifyEmail(String email, String returnUrl)
boolean	sendEmailVerifyEmail(T user)
boolean	sendEmailVerifyEmail(T user, String returnUrl)
boolean	sendPasswordResetEmail(String email)
boolean	sendPasswordResetEmail(String email, String returnUrl)
boolean	sendPasswordResetEmail(T user, String returnUrl)
String	userToCookieString(T user, Boolean rememberMe)
String	userToCookieString(T user, Boolean rememberMe, Long valetId)
T	valetLoginIfAllowed(Long userId)
T	valetLoginIfAllowed(String email)
T	valetLoginIfAllowed(T user)
boolean	verifyEmailVerifyToken(String email, String encryptedToken)
boolean	verifyEmailVerifyToken(T user, String encryptedToken)
boolean	verifyPasswordResetToken(String email, String encryptedToken)
boolean	verifyPasswordResetToken(T user, String encryptedToken)

Methods inherited from class io.stallion.dataAccess.StandardModelController

all, countForKey, detach, filter, filter, filterBy, filterByKey, filterChain, forId, forIdWithDeleted, forUniqueKey, getBucket, getKeyFields, getModelClass, getPersister, getReadonlyWrapper, getStash, getUniqueFields, hardDelete, init, isWritable, listForKey, newModel, newModel, newModel, onPostCreate, onPostLoadItem, onPostSave, onPreCreateValidate, onPreRead, onPreSavePrepare, onPreSaveValidate, originalForId, originalForId, postInitialize, preInitialize, reset, save, setPersister, setWritable, softDelete

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.stallion.dataAccess.ModelController

anyOf, anyOf, find, forIdOrNotFound, forUniqueKeyOrNotFound, onPostSaveAuditTrailLog, search, update, updateValues

Field Detail

USER_COOKIE_NAME

public static String USER_COOKIE_NAME

Constructor Detail

UserController

public UserController()

Method Detail

instance

public static <Y extends IUser> UserController<Y> instance()

load

public static void load()

forEmail

public T forEmail(String email)

forUsername

public T forUsername(String username)

createUser

public T createUser(T user)

hydratePassword

public void hydratePassword(T user,
                            String password,
                            String passwordConfirm)

Hydrates the bycryptedPassword field, validiating the password for minimum length and matching confirmation.

Parameters:

user -

password -

passwordConfirm -

onPreCreatePrepare

public void onPreCreatePrepare(T user)

Description copied from interface: ModelController

Override this to prepare the object with any default values before it is saved to the datastore for the first time.

Specified by:

onPreCreatePrepare in interface ModelController<T extends IUser>

Overrides:

onPreCreatePrepare in class StandardModelController<T extends IUser>

checkCookieAndAuthorizeForRequest

public boolean checkCookieAndAuthorizeForRequest(StRequest request)

Checks the standard Stallion auth cookie, loads and validates the user, and hydrates the current request Context user, and returns true. Returns false if there is not cookie, or it did not represent a valid user.

Parameters:

request -

Returns:

logoff

public void logoff()

Void out the authentication cookie

loginUser

public T loginUser(String username,
                   String password,
                   Boolean rememberMe)

Checks the user information represents a valid login, adds the user to the context, and adds a cookie to the current request response.

Parameters:

username -

password -

rememberMe -

Returns:

valetLoginIfAllowed

public T valetLoginIfAllowed(String email)

valetLoginIfAllowed

public T valetLoginIfAllowed(Long userId)

valetLoginIfAllowed

public T valetLoginIfAllowed(T user)

logoutCurrentUser

public void logoutCurrentUser()

checkUserLoginValid

public T checkUserLoginValid(String username,
                             String password)
                      throws ClientException

Returns a user if the login information is valid, throws a ClientException exception otherwise.

Parameters:

username -

password -

Returns:

Throws:

ClientException

markFailed

public void markFailed(String username)

Mark a login failure in the local cache, too many failures and the user or IP address will be locked out.

Parameters:

username -

addSessionCookieForUser

public T addSessionCookieForUser(T user,
                                 Boolean rememberMe)

Add a session cookie to the current request response for this user.

Parameters:

user -

rememberMe -

Returns:

addSessionCookieForUser

public T addSessionCookieForUser(T user,
                                 Boolean rememberMe,
                                 T valetUser)

Add a session cookie to the current request response for this user.

Parameters:

user -

rememberMe -

Returns:

changePrimaryEmail

public boolean changePrimaryEmail(T user,
                                  String newPrimaryEmail)

Change the primary email of this user to an already validated and verified that is alaread an alias for the user id. Returns false if invalid for any reseason.

Parameters:

user -

newPrimaryEmail -

Returns:

sendEmailVerifyEmail

public boolean sendEmailVerifyEmail(String email)

sendEmailVerifyEmail

public boolean sendEmailVerifyEmail(String email,
                                    String returnUrl)

sendEmailVerifyEmail

public boolean sendEmailVerifyEmail(T user)

sendEmailVerifyEmail

public boolean sendEmailVerifyEmail(T user,
                                    String returnUrl)

makeVerifyEmailToken

public String makeVerifyEmailToken(T user)

makeEncryptedToken

public String makeEncryptedToken(T user,
                                 String type,
                                 String value)

readEncryptedToken

public String readEncryptedToken(T user,
                                 String expectedType,
                                 String encrypted,
                                 int expiresMinutes)

verifyEmailVerifyToken

public boolean verifyEmailVerifyToken(String email,
                                      String encryptedToken)

verifyEmailVerifyToken

public boolean verifyEmailVerifyToken(T user,
                                      String encryptedToken)

markEmailVerified

public void markEmailVerified(String email,
                              String token)

markEmailVerified

public void markEmailVerified(T user,
                              String token)

sendPasswordResetEmail

public boolean sendPasswordResetEmail(String email)

sendPasswordResetEmail

public boolean sendPasswordResetEmail(String email,
                                      String returnUrl)

sendPasswordResetEmail

public boolean sendPasswordResetEmail(T user,
                                      String returnUrl)

verifyPasswordResetToken

public boolean verifyPasswordResetToken(String email,
                                        String encryptedToken)

verifyPasswordResetToken

public boolean verifyPasswordResetToken(T user,
                                        String encryptedToken)

changePassword

public T changePassword(String email,
                        String token,
                        String newPassword,
                        String confirmNewPassword)

changePassword

public T changePassword(T user,
                        String token,
                        String newPassword,
                        String confirmNewPassword)

userToCookieString

public String userToCookieString(T user,
                                 Boolean rememberMe)

userToCookieString

public String userToCookieString(T user,
                                 Boolean rememberMe,
                                 Long valetId)

cookieStringToUser

public UserController.UserValetResult cookieStringToUser(String cookie)