org.restlet.ext.oauth
Class UserStore

java.lang.Object
  extended by org.restlet.ext.oauth.UserStore
Direct Known Subclasses:
Client

public abstract class UserStore
extends Object

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

Constructor Summary
UserStore()
           
 
Method Summary
abstract  boolean containsUser(String id)
          Indicates of the OAuth server contains a given user.
abstract  AuthenticatedUser createUser(String id)
          Creates a user and return it.
abstract  AuthenticatedUser findUser(String id)
          Retrieves a given user according to the given identifier.
abstract  void revokeUser(String id)
          Revoke/delete a user according to its id.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

UserStore

public UserStore()
Method Detail

containsUser

public abstract boolean containsUser(String id)
Indicates of the OAuth server contains a given user.

Parameters:
id - The identifier of the user.
Returns:
true if the OAuth server contains a given user.

createUser

public abstract AuthenticatedUser createUser(String id)
Creates a user and return it.

Parameters:
id - The user id.
Returns:
The created instance of AuthenticatedUser.

findUser

public abstract AuthenticatedUser findUser(String id)
Retrieves a given user according to the given identifier.

Parameters:
id - The user's identifier.
Returns:
The given user according to the given identifier.

revokeUser

public abstract void revokeUser(String id)
Revoke/delete a user according to its id.

Parameters:
id - The identifier of the user to revoke/delete.


Copyright © 2005-2013 Restlet.