org.nuxeo.ecm.platform.oauth.tokens

Interface OAuthTokenStore

All Known Implementing Classes:

OAuthTokenStoreImpl

public interface OAuthTokenStore

Service interface for managing OAuthToken used both : - in the OAuth the Filter (Server side Tokens) : where Nuxeo is the provider - in Shindig (Client side Tokens) ; where Nuxeo is the consumer This service provides a center access point for all Token related actions.

Author:

tiry

Method Summary

Methods

Modifier and Type	Method and Description
OAuthToken	addVerifierToRequestToken(String token, Long duration) Generates a verification code and attache it to the REQUEST Token.
OAuthToken	createAccessTokenFromRequestToken(OAuthToken requestToken) Exchanges the REQUEST Token witha Real ACCESS Token (persistent) Token/TocketSecret Strings are regerated during the exchange.
OAuthToken	createRequestToken(String consumerKey, String callBack) Creates a new REQUEST Token (transient)
OAuthToken	getAccessToken(String token) Retrieves an ACCESS from the store.
NuxeoOAuthToken	getClientAccessToken(String appId, String owner) Get a Access token for the Shindig Client.
OAuthToken	getRequestToken(String token) Retrieves a REQUEST Token given a Token string (extracted from the Request).
List<OAuthToken>	listAccessTokenForConsumer(String consumerKey) Lists ACCESS Token associated to a Consumer application.
List<OAuthToken>	listAccessTokenForUser(String login) Lists ACCESS Token associated to a User.
void	removeAccessToken(String token) Deletes an ACCESS Token from the storage.
void	removeClientAccessToken(String appId, String owner) Deletes a Client side Access Token.
void	removeRequestToken(String token) Deletes a REQUEST Token.
void	storeClientAccessToken(String consumerKey, String callBack, String token, String tokenSecret, String appId, String owner) Stores a Access token generated fro Shindig client.

Method Detail

createRequestToken

OAuthToken createRequestToken(String consumerKey,
                            String callBack)

Creates a new REQUEST Token (transient)

addVerifierToRequestToken

OAuthToken addVerifierToRequestToken(String token,
                                   Long duration)

Generates a verification code and attache it to the REQUEST Token.

getRequestToken

OAuthToken getRequestToken(String token)

Retrieves a REQUEST Token given a Token string (extracted from the Request).

removeRequestToken

void removeRequestToken(String token)

Deletes a REQUEST Token.

createAccessTokenFromRequestToken

OAuthToken createAccessTokenFromRequestToken(OAuthToken requestToken)

Exchanges the REQUEST Token witha Real ACCESS Token (persistent) Token/TocketSecret Strings are regerated during the exchange.

getAccessToken

OAuthToken getAccessToken(String token)

Retrieves an ACCESS from the store.

removeAccessToken

void removeAccessToken(String token)
                       throws ClientException

Deletes an ACCESS Token from the storage.

Throws:

ClientException

listAccessTokenForUser

List<OAuthToken> listAccessTokenForUser(String login)

Lists ACCESS Token associated to a User.

listAccessTokenForConsumer

List<OAuthToken> listAccessTokenForConsumer(String consumerKey)

Lists ACCESS Token associated to a Consumer application.

storeClientAccessToken

void storeClientAccessToken(String consumerKey,
                          String callBack,
                          String token,
                          String tokenSecret,
                          String appId,
                          String owner)

Stores a Access token generated fro Shindig client.

getClientAccessToken

NuxeoOAuthToken getClientAccessToken(String appId,
                                   String owner)
                                     throws ClientException

Get a Access token for the Shindig Client.

Throws:

ClientException

removeClientAccessToken

void removeClientAccessToken(String appId,
                           String owner)
                             throws ClientException

Deletes a Client side Access Token.

Throws:

ClientException