com.github.scribejava.core.oauth

Class OAuth10aService

java.lang.Object

com.github.scribejava.core.oauth.OAuthService<OAuth1AccessToken>

com.github.scribejava.core.oauth.OAuth10aService

All Implemented Interfaces:

AutoCloseable

public class OAuth10aService
extends OAuthService<OAuth1AccessToken>

OAuth 1.0a implementation of OAuthService

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
protected void	addOAuthParams(OAuthRequest request, String tokenSecret)
protected void	appendSignature(OAuthRequest request)
OAuth1AccessToken	getAccessToken(OAuth1RequestToken requestToken, String oauthVerifier)
Future<OAuth1AccessToken>	getAccessTokenAsync(OAuth1RequestToken requestToken, String oauthVerifier)
Future<OAuth1AccessToken>	getAccessTokenAsync(OAuth1RequestToken requestToken, String oauthVerifier, OAuthAsyncRequestCallback<OAuth1AccessToken> callback) Start the request to retrieve the access token.
DefaultApi10a	getApi()
String	getAuthorizationUrl(OAuth1RequestToken requestToken) Returns the URL where you should redirect your users to authenticate your application.
OAuth1RequestToken	getRequestToken()
Future<OAuth1RequestToken>	getRequestTokenAsync()
Future<OAuth1RequestToken>	getRequestTokenAsync(OAuthAsyncRequestCallback<OAuth1RequestToken> callback)
String	getVersion() Returns the OAuth version of the service.
protected OAuthRequest	prepareAccessTokenRequest(OAuth1RequestToken requestToken, String oauthVerifier)
protected OAuthRequest	prepareRequestTokenRequest()
void	signRequest(OAuth1AccessToken token, OAuthRequest request)

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

close, execute, execute, execute, executeAsync, 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 final OAuth1RequestToken getRequestToken()
                                         throws IOException,
                                                InterruptedException,
                                                ExecutionException

Throws:

IOException

InterruptedException

ExecutionException

getRequestTokenAsync

public final Future<OAuth1RequestToken> getRequestTokenAsync()

getRequestTokenAsync

public final Future<OAuth1RequestToken> getRequestTokenAsync(OAuthAsyncRequestCallback<OAuth1RequestToken> callback)

prepareRequestTokenRequest

protected OAuthRequest prepareRequestTokenRequest()

addOAuthParams

protected void addOAuthParams(OAuthRequest request,
                              String tokenSecret)

getAccessToken

public final OAuth1AccessToken getAccessToken(OAuth1RequestToken requestToken,
                                              String oauthVerifier)
                                       throws IOException,
                                              InterruptedException,
                                              ExecutionException

Throws:

IOException

InterruptedException

ExecutionException

getAccessTokenAsync

public final Future<OAuth1AccessToken> getAccessTokenAsync(OAuth1RequestToken requestToken,
                                                           String oauthVerifier)

getAccessTokenAsync

public final Future<OAuth1AccessToken> getAccessTokenAsync(OAuth1RequestToken requestToken,
                                                           String oauthVerifier,
                                                           OAuthAsyncRequestCallback<OAuth1AccessToken> 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)

oauthVerifier - oauth_verifier

callback - optional callback

Returns:

Future

prepareAccessTokenRequest

protected OAuthRequest prepareAccessTokenRequest(OAuth1RequestToken requestToken,
                                                 String oauthVerifier)

signRequest

public void signRequest(OAuth1AccessToken token,
                        OAuthRequest request)

Specified by:

signRequest in class OAuthService<OAuth1AccessToken>

getVersion

public String getVersion()

Description copied from class: OAuthService

Returns the OAuth version of the service.

Specified by:

getVersion in class OAuthService<OAuth1AccessToken>

Returns:

OAuth version as string

getAuthorizationUrl

public String getAuthorizationUrl(OAuth1RequestToken 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

appendSignature

protected void appendSignature(OAuthRequest request)

getApi

public DefaultApi10a getApi()