TokenManager.java

/**
 * Copyright 2005-2014 Restlet
 * 
 * The contents of this file are subject to the terms of one of the following
 * open source licenses: Apache 2.0 or or EPL 1.0 (the "Licenses"). You can
 * select the license that you prefer but you may not use this file except in
 * compliance with one of these Licenses.
 * 
 * You can obtain a copy of the Apache 2.0 license at
 * http://www.opensource.org/licenses/apache-2.0
 * 
 * You can obtain a copy of the EPL 1.0 license at
 * http://www.opensource.org/licenses/eclipse-1.0
 * 
 * See the Licenses for the specific language governing permissions and
 * limitations under the Licenses.
 * 
 * Alternatively, you can obtain a royalty free commercial license with less
 * limitations, transferable or non-transferable, directly at
 * http://restlet.com/products/restlet-framework
 * 
 * Restlet is a registered trademark of Restlet S.A.S.
 */

package org.restlet.ext.oauth.internal;

import org.restlet.ext.oauth.OAuthException;

/**
 * 
 * @author Shotaro Uchida <fantom@xmaker.mx>
 */
public interface TokenManager {

    /**
     * Call
     * {@link #findToken(org.restlet.ext.oauth.internal.Client, java.lang.String)}
     * with username=null.
     * 
     * @param client
     *            the client that bound to token.
     * @return null if not found.
     */
    Token findToken(Client client);

    /**
     * Find a token issued for the client and the username. For those tokens
     * issued for 'client_credentials' grant type, username must be null.
     * 
     * @param client
     *            the client that bound to token.
     * @param username
     *            the username that bound to token. null if the token was issued
     *            for the client itself.
     * @return null if not found.
     */
    Token findToken(Client client, String username);

    /**
     * Find all tokens bound to the client.
     * 
     * @param client
     *            the client that bound to tokens.
     * @return 0 length if not found.
     */
    Token[] findTokens(Client client);

    /**
     * Find all tokens bound to the username.
     * 
     * @param username
     *            the username that bound to tokens.
     * @return 0 length if not found.
     */
    Token[] findTokens(String username);

    /**
     * Generate a new token for the client and the username. If the token has
     * already issued for the client and the username, the token will be
     * replaced or updated. If username is null, token will issued for the
     * client itself.
     * 
     * @param client
     * @param username
     * @param scope
     * @return
     * @throws OAuthException
     */
    Token generateToken(Client client, String username, String[] scope)
            throws OAuthException;

    /**
     * Call
     * {@link #generateToken(org.restlet.ext.oauth.internal.Client, java.lang.String, java.lang.String[])}
     * with username=null.
     * 
     * @param client
     * @param scope
     * @return
     * @throws OAuthException
     */
    Token generateToken(Client client, String[] scope) throws OAuthException;

    Token refreshToken(Client client, String refreshToken, String[] scope)
            throws OAuthException;

    AuthSession restoreSession(String code) throws OAuthException;

    /**
     * Revoke all tokens bound to the client.
     * 
     * @param client
     *            the client that bound to tokens.
     * @return 0 length if not found.
     */
    void revokeAllTokens(Client client);

    /**
     * Revoke all tokens bound to the username.
     * 
     * @param username
     *            the username that bound to tokens.
     * @return 0 length if not found.
     */
    void revokeAllTokens(String username);

    /**
     * Call
     * {@link #revokeToken(org.restlet.ext.oauth.internal.Client, java.lang.String)}
     * with username=null.
     * 
     * @param client
     *            the client that bound to token.
     */
    void revokeToken(Client client);

    /**
     * Revoke a token issued for the client and the username. For those tokens
     * issued for 'client_credentials' grant type, username must be null.
     * 
     * @param client
     *            the client that bound to token.
     * @param username
     *            the username that bound to token. null if the token was issued
     *            for the client itself.
     */
    void revokeToken(Client client, String username);

    String storeSession(AuthSession session) throws OAuthException;

    Token validateToken(String accessToken) throws OAuthException;
}