com.github.scribejava.core.oauth

Class OAuth10aService

java.lang.Object

com.github.scribejava.core.oauth.OAuthService

com.github.scribejava.core.oauth.OAuth10aService

public class OAuth10aService
extends OAuthService

OAuth 1.0a implementation of OAuthService

Author:

Pablo Fernandez

Constructor Summary

Constructors

Constructor and Description
OAuth10aService(DefaultApi10a api, OAuthConfig config) Default constructor

Method Summary

Modifier and Type	Method and Description
Token	getAccessToken(Token requestToken, Verifier verifier)
Future<Token>	getAccessTokenAsync(Token requestToken, Verifier verifier, OAuthAsyncRequestCallback<Token> callback) Start the request to retrieve the access token.
Future<Token>	getAccessTokenAsync(Token requestToken, Verifier verifier, OAuthAsyncRequestCallback<Token> callback, com.ning.http.client.ProxyServer proxyServer)
DefaultApi10a	getApi()
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.
protected void	prepareAccessTokenRequest(AbstractRequest request, Token requestToken, Verifier verifier)
void	signRequest(Token token, AbstractRequest request) Signs am OAuth request

Methods inherited from class com.github.scribejava.core.oauth.OAuthService

closeAsyncClient, getAsyncHttpClient, getConfig

Methods inherited from class java.lang.Object

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

Constructor Detail

OAuth10aService

public OAuth10aService(DefaultApi10a api,
                       OAuthConfig config)

Default constructor

Parameters:

api - OAuth1.0a api information

config - OAuth 1.0a configuration param object

Method Detail

getRequestToken

public Token getRequestToken()

Retrieve the request token.

Returns:

request token

getAccessToken

public final Token getAccessToken(Token requestToken,
                                  Verifier verifier)

getAccessTokenAsync

public final 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 final Future<Token> getAccessTokenAsync(Token requestToken,
                                               Verifier verifier,
                                               OAuthAsyncRequestCallback<Token> callback,
                                               com.ning.http.client.ProxyServer proxyServer)

prepareAccessTokenRequest

protected void prepareAccessTokenRequest(AbstractRequest request,
                                         Token requestToken,
                                         Verifier verifier)

signRequest

public void signRequest(Token token,
                        AbstractRequest request)

Signs am OAuth request

Specified by:

signRequest in class OAuthService

Parameters:

token - access token (obtained previously)

request - request to sign

getVersion

public String getVersion()

Returns the OAuth version of the service.

Specified by:

getVersion in class OAuthService

Returns:

oauth version as string

getAuthorizationUrl

public 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

getApi

public DefaultApi10a getApi()