de.terrestris.shogun2.service

Class AbstractUserTokenService<E extends de.terrestris.shogun2.model.token.UserToken>

java.lang.Object

de.terrestris.shogun2.service.AbstractDaoService<E>

de.terrestris.shogun2.service.AbstractCrudService<E>

de.terrestris.shogun2.service.AbstractUserTokenService<E>

Direct Known Subclasses:

PasswordResetTokenService, RegistrationTokenService

public abstract class AbstractUserTokenService<E extends de.terrestris.shogun2.model.token.UserToken>
extends AbstractCrudService<E>

Author:

Daniel Koch, Nils Bühner

Field Summary

Fields inherited from class de.terrestris.shogun2.service.AbstractDaoService

dao

Constructor Summary

Constructors

Constructor and Description
AbstractUserTokenService()

Method Summary

Methods

Modifier and Type	Method and Description
E	findByTokenValue(String token)
E	findByUser(de.terrestris.shogun2.model.User user)
protected E	getValidTokenForUser(de.terrestris.shogun2.model.User user, Integer expirationTimeInMinutes) Returns a valid (i.e. non-expired) UserToken for the given user.
protected void	validateToken(de.terrestris.shogun2.model.token.UserToken userToken) If the passed token is null or expired or if there is no user associated with the token, this method will throw an Exception.

Methods inherited from class de.terrestris.shogun2.service.AbstractCrudService

delete, findAll, findById, loadById, saveOrUpdate

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractUserTokenService

public AbstractUserTokenService()

Method Detail

findByUser

public E findByUser(de.terrestris.shogun2.model.User user)

Parameters:

user -

Returns:

findByTokenValue

public E findByTokenValue(String token)

Returns:

validateToken

protected void validateToken(de.terrestris.shogun2.model.token.UserToken userToken)
                      throws Exception

If the passed token is null or expired or if there is no user associated with the token, this method will throw an Exception.

Parameters:

userToken -

Throws:

Exception - if the token is not valid (e.g. because it is expired)

getValidTokenForUser

protected E getValidTokenForUser(de.terrestris.shogun2.model.User user,
                     Integer expirationTimeInMinutes)
                                                                              throws NoSuchMethodException,
                                                                                     SecurityException,
                                                                                     InstantiationException,
                                                                                     IllegalAccessException,
                                                                                     IllegalArgumentException,
                                                                                     InvocationTargetException

Returns a valid (i.e. non-expired) UserToken for the given user. If the user already owns a valid token, it will be returned. If the user has an invalid/expired token, it will be deleted and a new one will be generated and returned by this method. An expiration time in minutes can also be passed. If this value is null, the default value will be used.

Parameters:

user - The user that needs a token.

expirationTimeInMinutes - The expiration time in minutes. If null, the default value will be used.

Returns:

A valid user token.

Throws:

SecurityException

NoSuchMethodException

InvocationTargetException

IllegalArgumentException

IllegalAccessException

InstantiationException