com.github.scribejava.core.oauth

Class OAuthService<T extends Token>

java.lang.Object

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

Type Parameters:

T - type of token used to sign the request

Direct Known Subclasses:

OAuth10aService, OAuth20Service

public abstract class OAuthService<T extends Token>
extends Object

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

Constructor Summary

Constructors

Constructor and Description
OAuthService(OAuthConfig config)

Method Summary

Modifier and Type	Method and Description
void	closeAsyncClient()
Response	execute(OAuthRequest request) the same as OAuthRequest.send()
Future<Response>	execute(OAuthRequestAsync request, OAuthAsyncRequestCallback<Response> callback)
<T> Future<T>	execute(OAuthRequestAsync request, OAuthAsyncRequestCallback<T> callback, OAuthRequestAsync.ResponseConverter<T> converter)
<T> Future<T>	executeAsync(Map<String,String> headers, Verb httpVerb, String completeUrl, String bodyContents, OAuthAsyncRequestCallback<T> callback, OAuthRequestAsync.ResponseConverter<T> converter) Deprecated. use execute(com.github.scribejava.core.model.OAuthRequestAsync, com.github.scribejava.core.model.OAuthAsyncRequestCallback, com.github.scribejava.core.model.OAuthRequestAsync.ResponseConverter) or execute(com.github.scribejava.core.model.OAuthRequestAsync, com.github.scribejava.core.model.OAuthAsyncRequestCallback)
OAuthConfig	getConfig()
abstract String	getVersion() Returns the OAuth version of the service.
abstract void	signRequest(T token, AbstractRequest 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

closeAsyncClient

public void closeAsyncClient()
                      throws IOException

Throws:

IOException

getConfig

public OAuthConfig getConfig()

getVersion

public abstract String getVersion()

Returns the OAuth version of the service.

Returns:

OAuth version as string

signRequest

public abstract void signRequest(T token,
                                 AbstractRequest request)

executeAsync

@Deprecated
public <T> Future<T> executeAsync(Map<String,String> headers,
                                              Verb httpVerb,
                                              String completeUrl,
                                              String bodyContents,
                                              OAuthAsyncRequestCallback<T> callback,
                                              OAuthRequestAsync.ResponseConverter<T> converter)

Deprecated. use execute(com.github.scribejava.core.model.OAuthRequestAsync, com.github.scribejava.core.model.OAuthAsyncRequestCallback, com.github.scribejava.core.model.OAuthRequestAsync.ResponseConverter)
or
execute(com.github.scribejava.core.model.OAuthRequestAsync, com.github.scribejava.core.model.OAuthAsyncRequestCallback)

Type Parameters:

T - T

Parameters:

headers - headers

httpVerb - httpVerb

completeUrl - completeUrl

bodyContents - bodyContents

callback - callback

converter - converter

Returns:

Future

execute

public <T> Future<T> execute(OAuthRequestAsync request,
                             OAuthAsyncRequestCallback<T> callback,
                             OAuthRequestAsync.ResponseConverter<T> converter)

execute

public Future<Response> execute(OAuthRequestAsync request,
                                OAuthAsyncRequestCallback<Response> callback)

execute

public Response execute(OAuthRequest request)

the same as OAuthRequest.send()

Parameters:

request - request

Returns:

Response