Package org.ametys.core.authentication.token

Class AuthenticationTokenManager

java.lang.Object
org.ametys.runtime.plugin.component.AbstractLogEnabled
org.ametys.core.authentication.token.AuthenticationTokenManager
All Implemented Interfaces:
LogEnabled, Initializable, Component, Serviceable
public class AuthenticationTokenManager extends AbstractLogEnabled implements Component, Serviceable, Initializable
The component to handle temporary authentication token.
Token can only be used once and are available for a short time only.

  • Field Details

  • Constructor Details

  • Method Details

    • service

      public void service(ServiceManager manager) throws ServiceException
      Specified by:
      service in interface Serviceable
      Throws:
      ServiceException

    • initialize

      public void initialize() throws Exception
      Specified by:
      initialize in interface Initializable
      Throws:
      Exception

    • getUserTokens

      public List<Map<String,Object>> getUserTokens() throws RuntimeException
      Get the existing tokens for the connected user
      Returns:
      The tokens as JSON
      Throws:
      RuntimeException - If there is no user connected or if there is a database error

    • getTokens

      public List<AuthenticationTokenManager.Token> getTokens(String type) throws RuntimeException
      Get the existing tokens for the connected user
      Parameters:
      type - The type of tokens to return. null to return all.
      Returns:
      The tokens
      Throws:
      RuntimeException - If there is no user connected or if there is a database error

    • getTokens

      public List<AuthenticationTokenManager.Token> getTokens(UserIdentity user, String type) throws RuntimeException
      Get the existing tokens for this user
      Parameters:
      user - The user. Cannot be null
      type - The type of tokens to return. null to return all.
      Returns:
      The tokens identifier and associated comment
      Throws:
      RuntimeException - If the user is null or if there is a database error

    • generateToken

      public String generateToken(long duration, String type, String comment) throws RuntimeException
      Generates a new token for the current user
      Parameters:
      duration - The time the token is valid in seconds. 0 means for ever and moreover the ticket will be reusable.
      type - The type of token. Mandatory but can be anything you want between 1 to 32 characters. Such as "Cookie".
      comment - An optional token comment to remember the reason of its creation
      Returns:
      The token
      Throws:
      RuntimeException - If the user is not authenticated, or if there is a database error

    • generateToken

      public String generateToken(UserIdentity user, long duration, String type, String comment) throws RuntimeException
      Generates a new token
      Parameters:
      user - The user that will be authenticated with the token
      duration - The time the token is valid in seconds. 0 means for ever and moreover the ticket will be reusable
      type - The type of token. Mandatory but can be anything you want between 1 to 32 characters. Such as "Cookie".
      comment - An optional token comment to remember the reason of its creation
      Returns:
      The token
      Throws:
      RuntimeException - If the user is null or if there is a database error or if duration is negative

    • generateToken

      public String generateToken(UserIdentity user, long duration, Integer nbUsesLeft, String type, String comment) throws RuntimeException
      Generates a new token
      Parameters:
      user - The user that will be authenticated with the token
      duration - The time the token is valid in seconds. 0 means for ever and moreover the ticket will be reusable
      nbUsesLeft - number of available uses (null for no limit)
      type - The type of token. Mandatory but can be anything you want between 1 to 32 characters. Such as "Cookie".
      comment - An optional token comment to remember the reason of its creation
      Returns:
      The token
      Throws:
      RuntimeException - If the user is null or if there is a database error or if duration is negative

    • generateToken

      public String generateToken(UserIdentity user, long duration, boolean autoRenewDuration, Integer nbUsesLeft, Set<String> contexts, String type, String comment) throws RuntimeException
      Generates a new token
      Parameters:
      user - The user that will be authenticated with the token
      duration - The time the token is valid in seconds. 0 means for ever and moreover the ticket will be reusable
      autoRenewDuration - true to automatically renew token if used before it's expiration
      nbUsesLeft - number of available uses (null for no limit)
      contexts - contexts where the token can be used
      type - The type of token. Mandatory but can be anything you want between 1 to 32 characters. Such as "Cookie".
      comment - An optional token comment to remember the reason of its creation
      Returns:
      The token
      Throws:
      RuntimeException - If the user is null or if there is a database error or if duration is negative

    • validateToken

      public UserIdentity validateToken(String token, String context)
      Check if a token is valid and return the user
      Parameters:
      token - The token to validate
      context - context to validate the token with
      Returns:
      The user associated to the valid token, null otherwise

    • validateToken

      public UserIdentity validateToken(String token, String context, boolean acceptTokenWithUnrestrictedContext)
      Check if a token is valid and return the user
      Parameters:
      token - The token to validate
      context - The non null nor empty context to validate the token with
      acceptTokenWithUnrestrictedContext - true if a token with no specific context should be considered valid, false otherwise
      Returns:
      The user associated to the valid token, null otherwise

    • deleteTokenByValue

      public void deleteTokenByValue(String token, String context)
      Destroy the given token
      Parameters:
      token - The token to remove
      context - context of the token (null for no context)

    • deleteTokenByValue

      public void deleteTokenByValue(String token, String context, boolean acceptTokenWithUnrestrictedContext)
      Destroy the given token
      Parameters:
      token - The token to remove
      context - context of the token (null for no context)
      acceptTokenWithUnrestrictedContext - true if a token with no specific context should be considered valid, false otherwise

    • deleteTokenById

      public void deleteTokenById(Integer tokenId)
      Destroy the given token
      Parameters:
      tokenId - The token identifier to remove

    • generateAuthenticationToken

      public String generateAuthenticationToken(Map<String,Object> parameters)
      Generate a new authentication token
      Parameters:
      parameters - a map of the following parameters for the authentication token : description
      Returns:
      The generated token

    • deleteAuthenticationToken

      public void deleteAuthenticationToken(List<Integer> ids)
      Delete one or multiples authentication token
      Parameters:
      ids - a list of authentication token ids