Package com.github.scribejava.core.oauth

Class OAuthService

java.lang.Object

com.github.scribejava.core.oauth.OAuthService

All Implemented Interfaces:

Closeable, AutoCloseable

Direct Known Subclasses:

OAuth10aService, OAuth20Service

public abstract class OAuthService
extends Object
implements Closeable

Constructor Summary

Constructors

Constructor	Description
OAuthService(String apiKey, String apiSecret, String callback, OutputStream debugStream, String userAgent, HttpClientConfig httpClientConfig, HttpClient httpClient)
OAuthService(String apiKey, String apiSecret, String callback, String userAgent, HttpClientConfig httpClientConfig, HttpClient httpClient)	Deprecated. use OAuthService(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

Modifier and Type	Method	Description
void	close()
Response	execute(OAuthRequest request)
Future<Response>	execute(OAuthRequest request, OAuthAsyncRequestCallback<Response> callback)
<R> Future<R>	execute(OAuthRequest request, OAuthAsyncRequestCallback<R> callback, OAuthRequest.ResponseConverter<R> converter)
Future<Response>	executeAsync(OAuthRequest request)
String	getApiKey()
String	getApiSecret()
String	getCallback()
abstract String	getVersion()	Returns the OAuth version of the service.
protected boolean	isDebug()
void	log(String message)	No need to wrap usages in isDebug().
void	log(String messagePattern, Object... params)	Wrap usages in isDebug().

Methods inherited from class java.lang.Object

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

Constructor Detail

OAuthService

@Deprecated
public OAuthService(String apiKey,
                    String apiSecret,
                    String callback,
                    String userAgent,
                    HttpClientConfig httpClientConfig,
                    HttpClient httpClient)

Deprecated.

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

Parameters:

apiKey - apiKey

apiSecret - apiSecret

callback - callback

userAgent - userAgent

httpClientConfig - httpClientConfig

httpClient - httpClient

OAuthService

public OAuthService(String apiKey,
                    String apiSecret,
                    String callback,
                    OutputStream debugStream,
                    String userAgent,
                    HttpClientConfig httpClientConfig,
                    HttpClient httpClient)

Method Detail

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Throws:

IOException

getApiKey

public String getApiKey()

getApiSecret

public String getApiSecret()

getCallback

public String getCallback()

getVersion

public abstract String getVersion()

Returns the OAuth version of the service.

Returns:

OAuth version as string

executeAsync

public Future<Response> executeAsync(OAuthRequest request)

execute

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

execute

public <R> Future<R> execute(OAuthRequest request,
                             OAuthAsyncRequestCallback<R> callback,
                             OAuthRequest.ResponseConverter<R> converter)

execute

public Response execute(OAuthRequest request)
                 throws InterruptedException,
                        ExecutionException,
                        IOException

Throws:

InterruptedException

ExecutionException

IOException

log

public void log(String message)

No need to wrap usages in isDebug().

Parameters:

message - message to log

log

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

Wrap usages in isDebug(). It was made for optimization - to not calculate "params" in production mode.

Parameters:

messagePattern - messagePattern

params - params

isDebug

protected boolean isDebug()