com.github.scribejava.core.oauth

Class OAuth10aService

java.lang.Object

com.github.scribejava.core.oauth.OAuthService

com.github.scribejava.core.oauth.OAuth10aService

All Implemented Interfaces:

Closeable, AutoCloseable

public class OAuth10aService
extends OAuthService

OAuth 1.0a implementation of OAuthService

Constructor Summary

Constructors

Constructor and Description
OAuth10aService(DefaultApi10a api, String apiKey, String apiSecret, String callback, String scope, OutputStream debugStream, String userAgent, HttpClientConfig httpClientConfig, HttpClient httpClient)
OAuth10aService(DefaultApi10a api, String apiKey, String apiSecret, String callback, String scope, OutputStream debugStream, String state, String responseType, String userAgent, HttpClientConfig httpClientConfig, HttpClient httpClient) Deprecated. use OAuth10aService(com.github.scribejava.core.builder.api.DefaultApi10a, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.io.OutputStream, java.lang.String, com.github.scribejava.core.httpclient.HttpClientConfig, com.github.scribejava.core.httpclient.HttpClient)

Method Summary

Methods

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.
void	log(String messagePattern, Object... params)
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, getApiKey, getApiSecret, getCallback, getScope

Methods inherited from class java.lang.Object

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

Constructor Detail

OAuth10aService

@Deprecated
public OAuth10aService(DefaultApi10a api,
                          String apiKey,
                          String apiSecret,
                          String callback,
                          String scope,
                          OutputStream debugStream,
                          String state,
                          String responseType,
                          String userAgent,
                          HttpClientConfig httpClientConfig,
                          HttpClient httpClient)

Deprecated. use OAuth10aService(com.github.scribejava.core.builder.api.DefaultApi10a, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.io.OutputStream, java.lang.String, com.github.scribejava.core.httpclient.HttpClientConfig, com.github.scribejava.core.httpclient.HttpClient)

OAuth10aService

public OAuth10aService(DefaultApi10a api,
               String apiKey,
               String apiSecret,
               String callback,
               String scope,
               OutputStream debugStream,
               String userAgent,
               HttpClientConfig httpClientConfig,
               HttpClient httpClient)

Method Detail

getRequestToken

public OAuth1RequestToken getRequestToken()
                                   throws IOException,
                                          InterruptedException,
                                          ExecutionException

Throws:

IOException

InterruptedException

ExecutionException

getRequestTokenAsync

public Future<OAuth1RequestToken> getRequestTokenAsync()

getRequestTokenAsync

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

prepareRequestTokenRequest

protected OAuthRequest prepareRequestTokenRequest()

addOAuthParams

protected void addOAuthParams(OAuthRequest request,
                  String tokenSecret)

getAccessToken

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

Throws:

IOException

InterruptedException

ExecutionException

getAccessTokenAsync

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

getAccessTokenAsync

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

getVersion

public String getVersion()

Description copied from class: OAuthService

Returns the OAuth version of the service.

Specified by:

getVersion in class OAuthService

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()

log

public void log(String messagePattern,
       Object... params)