de.terrestris.shogun2.service

Class AbstractUserTokenService<E extends UserToken,D extends AbstractUserTokenDao<E>>

java.lang.Object

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

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

de.terrestris.shogun2.service.PermissionAwareCrudService<E,D>

de.terrestris.shogun2.service.AbstractTokenService<E,D>

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

Direct Known Subclasses:

PasswordResetTokenService, RegistrationTokenService

public abstract class AbstractUserTokenService<E extends UserToken,D extends AbstractUserTokenDao<E>>
extends AbstractTokenService<E,D>

Author:

Daniel Koch, Nils Bühner

Field Summary

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

permissionCollectionService

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

dao, LOG

Constructor Summary

Constructors

Modifier	Constructor and Description
	AbstractUserTokenService() Default constructor, which calls the type-constructor
protected	AbstractUserTokenService(Class<E> entityClass) Constructor that sets the concrete entity class for the service.

Method Summary

Modifier and Type	Method and Description
protected abstract E	buildConcreteInstance(User user, Integer expirationTimeInMinutes) Has to be implemented by subclasses to return a concrete instance for the given values.
E	findByUser(User user)
protected E	getValidTokenForUser(User user, Integer expirationTimeInMinutes) Returns a valid (i.e. non-expired) UserToken for the given user.
void	validateToken(E 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.AbstractTokenService

findByTokenValue

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

addAndSaveGroupPermissions, addAndSaveUserPermissions, findAllUserGroupPermissionsOfUserGroup, findAllUserPermissionsOfUser, getPermissionCollectionService, removeAndSaveGroupPermissions, removeAndSaveUserPermissions, setDao, setPermissionCollectionService

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

delete, findAll, findById, loadById, saveOrUpdate, updatePartialWithJsonNode

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

getDao, getEntityClass

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractUserTokenService

public AbstractUserTokenService()

Default constructor, which calls the type-constructor

AbstractUserTokenService

protected AbstractUserTokenService(Class<E> entityClass)

Constructor that sets the concrete entity class for the service. Subclasses MUST call this constructor.

Method Detail

buildConcreteInstance

protected abstract E buildConcreteInstance(User user,
                                           Integer expirationTimeInMinutes)

Has to be implemented by subclasses to return a concrete instance for the given values. Should return an instance with a default expiration time if expirationTimeInMinutes is null.

Parameters:

user -

expirationTimeInMinutes -

Returns:

findByUser

public E findByUser(User user)

Parameters:

user -

Returns:

validateToken

public void validateToken(E 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.

Overrides:

validateToken in class AbstractTokenService<E extends UserToken,D extends AbstractUserTokenDao<E>>

Parameters:

userToken -

Throws:

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

getValidTokenForUser

protected E getValidTokenForUser(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