com.github.scribejava.core.builder

Class ServiceBuilder

java.lang.Object

com.github.scribejava.core.builder.ServiceBuilder

public class ServiceBuilder
extends Object

Implementation of the Builder pattern, with a fluent interface that creates a OAuthService

Author:

Pablo Fernandez

Constructor Summary

Constructors

Constructor and Description
ServiceBuilder()

Method Summary

Modifier and Type	Method and Description
T	apiKey(String apiKey) Configures the api key
T	apiSecret(String apiSecret) Configures the api secret
OAuthService	build() Returns the fully configured OAuthService
T	callback(String callback) Adds an OAuth callback url
void	checkPreconditions()
ServiceBuilder	connectTimeout(Integer connectTimeout)
T	debug()
T	debugStream(OutputStream stream)
Api	getApi()
String	getApiKey()
String	getApiSecret()
String	getCallback()
OutputStream	getDebugStream()
String	getGrantType()
String	getScope()
SignatureType	getSignatureType()
String	getState()
T	grantType(String grantType)
T	provider(Api api) Configures the Api Overloaded version.
T	provider(Class<? extends Api> apiClass) Configures the Api
ServiceBuilder	readTimeout(Integer readTimeout)
T	scope(String scope) Configures the OAuth scope.
T	signatureType(SignatureType type) Configures the signature type, choose between header, querystring, etc.
T	state(String state) Configures the anti forgery session state.

Methods inherited from class java.lang.Object

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

Constructor Detail

ServiceBuilder

public ServiceBuilder()

Method Detail

connectTimeout

public ServiceBuilder connectTimeout(Integer connectTimeout)

readTimeout

public ServiceBuilder readTimeout(Integer readTimeout)

build

public OAuthService build()

Returns the fully configured OAuthService

Returns:

fully configured OAuthService

provider

public T provider(Class<? extends Api> apiClass)

Configures the Api

Parameters:

apiClass - the class of one of the existent Apis on org.scribe.api package

Returns:

the ServiceBuilder instance for method chaining

provider

public T provider(Api api)

Configures the Api Overloaded version. Let's you use an instance instead of a class.

Parameters:

api - instance of Apis

Returns:

the ServiceBuilder instance for method chaining

callback

public T callback(String callback)

Adds an OAuth callback url

Parameters:

callback - callback url. Must be a valid url or 'oob' for out of band OAuth

Returns:

the ServiceBuilder instance for method chaining

apiKey

public T apiKey(String apiKey)

Configures the api key

Parameters:

apiKey - The api key for your application

Returns:

the ServiceBuilder instance for method chaining

apiSecret

public T apiSecret(String apiSecret)

Configures the api secret

Parameters:

apiSecret - The api secret for your application

Returns:

the ServiceBuilder instance for method chaining

scope

public T scope(String scope)

Configures the OAuth scope. This is only necessary in some APIs (like Google's).

Parameters:

scope - The OAuth scope

Returns:

the ServiceBuilder instance for method chaining

state

public T state(String state)

Configures the anti forgery session state. This is available in some APIs (like Google's).

Parameters:

state - The OAuth state

Returns:

the ServiceBuilder instance for method chaining

signatureType

public T signatureType(SignatureType type)

Configures the signature type, choose between header, querystring, etc. Defaults to Header

Parameters:

type - SignatureType

Returns:

the ServiceBuilder instance for method chaining

debugStream

public T debugStream(OutputStream stream)

grantType

public T grantType(String grantType)

debug

public T debug()

checkPreconditions

public void checkPreconditions()

getApi

public Api getApi()

getCallback

public String getCallback()

getApiKey

public String getApiKey()

getApiSecret

public String getApiSecret()

getScope

public String getScope()

getState

public String getState()

getSignatureType

public SignatureType getSignatureType()

getDebugStream

public OutputStream getDebugStream()

getGrantType

public String getGrantType()