TokenService.java

package org.molgenis.security.core.token;

import org.springframework.security.core.userdetails.UserDetails;

/**
 * Store and remove molgenis security tokens
 */
public interface TokenService
{

	/**
	 * Generates a token and associates it with a user. Token expires after 2 hours.
	 *
	 * @param username
	 * @return
	 */
	String generateAndStoreToken(String username, String description);

	/**
	 * Find a user by a security token
	 *
	 * @param token
	 * @return the user or null if not found or token is expired
	 */
	UserDetails findUserByToken(String token) throws UnknownTokenException;

	/**
	 * Remove a token from the store
	 *
	 * @param token
	 * @return true if removed or false when the token is not found
	 */
	void removeToken(String token) throws UnknownTokenException;
}