/**
 * Copyright 2005-2013 Restlet S.A.S.
 * 
 * The contents of this file are subject to the terms of one of the following
 * open source licenses: Apache 2.0 or LGPL 3.0 or LGPL 2.1 or CDDL 1.0 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 LGPL 3.0 license at
 * http://www.opensource.org/licenses/lgpl-3.0
 * 
 * You can obtain a copy of the LGPL 2.1 license at
 * http://www.opensource.org/licenses/lgpl-2.1
 * 
 * You can obtain a copy of the CDDL 1.0 license at
 * http://www.opensource.org/licenses/cddl1
 * 
 * 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://www.restlet.com/products/restlet-framework
 * 
 * Restlet is a registered trademark of Restlet S.A.S.
 */

package org.restlet.ext.oauth;

/**
 * The user store interface represents the entry point where user requests are
 * created, searched and removed. It is an excellent indicator where to modify
 * when implementing another persistence model.
 * 
 * @author Kristoffer Gronowski
 */
public abstract class UserStore {

    /**
     * Indicates of the OAuth server contains a given user.
     * 
     * @param id
     *            The identifier of the user.
     * @return true if the OAuth server contains a given user.
     */
    public abstract boolean containsUser(String id);

    /**
     * Creates a user and return it.
     * 
     * @param id
     *            The user id.
     * @return The created instance of {@link AuthenticatedUser}.
     */
    public abstract AuthenticatedUser createUser(String id);

    /**
     * Retrieves a given user according to the given identifier.
     * 
     * @param id
     *            The user's identifier.
     * @return The given user according to the given identifier.
     */
    public abstract AuthenticatedUser findUser(String id);

    /**
     * Revoke/delete a user according to its id.
     * 
     * @param id
     *            The identifier of the user to revoke/delete.
     */
    public abstract void revokeUser(String id); // Same as delete a user.

}