oauthP5.oauth
Interface OAuthService

All Known Implementing Classes:
OAuth10aServiceImpl, OAuth20ServiceImpl

public interface OAuthService

The main Scribe object. A facade responsible for the retrieval of request and access tokens and for the signing of HTTP requests.

Author:
Pablo Fernandez

Method Summary
 Token getAccessToken(Token requestToken, Verifier verifier)
          Retrieve the access token
 String getAuthorizationUrl(Token requestToken)
          Returns the URL where you should redirect your users to authenticate your application.
 Token getRequestToken()
          Retrieve the request token.
 String getVersion()
          Returns the OAuth version of the service.
 void signRequest(Token accessToken, OAuthRequest request)
          Signs am OAuth request
 

Method Detail

getRequestToken

Token getRequestToken()
Retrieve the request token.

Returns:
request token

getAccessToken

Token getAccessToken(Token requestToken,
                     Verifier verifier)
Retrieve the access token

Parameters:
requestToken - request token (obtained previously)
verifier - verifier code
Returns:
access token

signRequest

void signRequest(Token accessToken,
                 OAuthRequest request)
Signs am OAuth request

Parameters:
accessToken - access token (obtained previously)
request - request to sign

getVersion

String getVersion()
Returns the OAuth version of the service.

Returns:
oauth version as string

getAuthorizationUrl

String getAuthorizationUrl(Token requestToken)
Returns the URL where you should redirect your users to authenticate your application.

Parameters:
requestToken - the request token you need to authorize
Returns:
the URL where you should redirect your users


Processing library oauthP5 by New York Times R&D Lab. (c) 2012