com.github.scribejava.core.oauth

Class OAuthService

java.lang.Object

com.github.scribejava.core.oauth.OAuthService

Direct Known Subclasses:

OAuth10aServiceImpl, OAuth20ServiceImpl

public abstract class OAuthService
extends Object

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

Author:

Pablo Fernandez

Constructor Summary

Constructors

Constructor and Description
OAuthService(OAuthConfig config)

Method Summary

Modifier and Type	Method and Description
void	closeAsyncClient()
abstract Token	getAccessToken(Token requestToken, Verifier verifier)
abstract Future<Token>	getAccessTokenAsync(Token requestToken, Verifier verifier, OAuthAsyncRequestCallback<Token> callback) Start the request to retrieve the access token.
abstract Future<Token>	getAccessTokenAsync(Token requestToken, Verifier verifier, OAuthAsyncRequestCallback<Token> callback, com.ning.http.client.ProxyServer proxyServer)
com.ning.http.client.AsyncHttpClient	getAsyncHttpClient()
abstract String	getAuthorizationUrl(Token requestToken) Returns the URL where you should redirect your users to authenticate your application.
OAuthConfig	getConfig()
abstract Token	getRequestToken() Retrieve the request token.
abstract String	getVersion() Returns the OAuth version of the service.
abstract void	signRequest(Token accessToken, AbstractRequest request) Signs am OAuth request

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

OAuthService

public OAuthService(OAuthConfig config)

Method Detail

getAsyncHttpClient

public com.ning.http.client.AsyncHttpClient getAsyncHttpClient()

closeAsyncClient

public void closeAsyncClient()

getConfig

public OAuthConfig getConfig()

getRequestToken

public abstract Token getRequestToken()

Retrieve the request token.

Returns:

request token

getAccessToken

public abstract Token getAccessToken(Token requestToken,
                                     Verifier verifier)

signRequest

public abstract void signRequest(Token accessToken,
                                 AbstractRequest request)

Signs am OAuth request

Parameters:

accessToken - access token (obtained previously)

request - request to sign

getAccessTokenAsync

public abstract Future<Token> getAccessTokenAsync(Token requestToken,
                                                  Verifier verifier,
                                                  OAuthAsyncRequestCallback<Token> callback)

Start the request to retrieve the access token. The optionally provided callback will be called with the Token when it is available.

Parameters:

requestToken - request token (obtained previously or null)

verifier - verifier code

callback - optional callback

Returns:

Future

getAccessTokenAsync

public abstract Future<Token> getAccessTokenAsync(Token requestToken,
                                                  Verifier verifier,
                                                  OAuthAsyncRequestCallback<Token> callback,
                                                  com.ning.http.client.ProxyServer proxyServer)

getVersion

public abstract String getVersion()

Returns the OAuth version of the service.

Returns:

oauth version as string

getAuthorizationUrl

public abstract 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