org.usergrid.security.tokens.TokenService Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of usergrid-services Show documentation

Service layer for Usergrid system.

There is a newer version: 0.0.27.1

package org.usergrid.security.tokens;

import java.util.Map;

import org.usergrid.security.AuthPrincipalInfo;

public interface TokenService {

	public String createToken(TokenCategory tokenType, String type,
			Map state) throws Exception;

	public String createToken(AuthPrincipalInfo principal) throws Exception;

	public String createToken(AuthPrincipalInfo principal,
			Map state) throws Exception;

	public String createToken(TokenCategory tokenCategory, String type,
			AuthPrincipalInfo principal, Map state)
			throws Exception;

	/**
	 * Create the token with the given duration.  A duration value of 0 equals the default value specified in the properties
	 * It is not possible to specify a duration greater than the maximum system allowed duration.
	 */
	public String createToken(TokenCategory tokenCategory, String type,
            AuthPrincipalInfo principal, Map state, long duration)
            throws Exception;
	
	public TokenInfo getTokenInfo(String token) throws Exception;

	public String refreshToken(String token) throws Exception;

	/**
	 * Get the max token age in milliseconds
	 * @param token
	 * @return
	 */
	public long getMaxTokenAge(String token);
	
	
	/**
	 * Get the max token age in seconds
	 * @param token
	 * @return
	 */
	public long getMaxTokenAgeInSeconds(String token);
	/**
	 * Expire the token.  If the token does not exist, this operation will not throw an error.  Implementations
	 * should always delete this token, regardless of state.
	 * 
	 * @param token
	 */
	public void revokeToken(String token);

	/**
	 * Remove all tokens currently issued for the given AuthPrincipal.  Removes the specified type of token
	 * for the given principal uuid and application uuid
	 * @param principal
	 * @throws Exception 
	 */
	public void removeTokens(AuthPrincipalInfo principal) throws Exception;
}