org.craftercms.profile.api.services.AccessTokenService Maven / Gradle / Ivy

Go to download
package org.craftercms.profile.api.services;

import java.util.List;

import org.craftercms.profile.api.AccessToken;
import org.craftercms.profile.api.exceptions.ProfileException;

/**
 * Service for managing access tokens. In order to call any method of this API, a client must use a master access
 * token.
 *
 * @author avasquez
 */
public interface AccessTokenService {

    /**
     * Creates a new access token.
     *
     * @param token the token to create
     *
     * @return the created token
     */
    AccessToken createToken(AccessToken token) throws ProfileException;

    /**
     * Returns the token for the given ID.
     *
     * @param id the ID of the token
     *
     * @return the token, or null if not found
     */
    AccessToken getToken(String id) throws ProfileException;

    /**
     * Returns all the access tokens in the DB.
     *
     * @return all the access tokens
     */
    List getAllTokens() throws ProfileException;

    /**
     * Deletes the token with the given ID.
     *
     * @param id the ID of the token
     */
    void deleteToken(String id) throws ProfileException;

}