Package com.github.scribejava.core.builder

Class ServiceBuilder

java.lang.Object

com.github.scribejava.core.builder.ServiceBuilder

All Implemented Interfaces:

ServiceBuilderCommon, ServiceBuilderOAuth10a, ServiceBuilderOAuth20

public class ServiceBuilder
extends java.lang.Object
implements ServiceBuilderOAuth10a, ServiceBuilderOAuth20

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

Field Summary

Fields

Modifier and Type	Field	Description
private java.lang.String	apiKey
private java.lang.String	apiSecret
private java.lang.String	callback
private java.io.OutputStream	debugStream
private HttpClient	httpClient
private HttpClientConfig	httpClientConfig
private java.lang.String	responseType
private java.lang.String	scope
private java.lang.String	userAgent

Constructor Summary

Constructors

Constructor	Description
ServiceBuilder(java.lang.String apiKey)

Method Summary

Modifier and Type	Method	Description
ServiceBuilder	apiKey(java.lang.String apiKey)	Configures the api key
ServiceBuilder	apiSecret(java.lang.String apiSecret)	Configures the api secret
ServiceBuilder	apiSecretIsEmptyStringUnsafe()	Configures the api secret as "" (empty string).
OAuth10aService	build(DefaultApi10a api)
OAuth20Service	build(DefaultApi20 api)
ServiceBuilder	callback(java.lang.String callback)	Adds an OAuth callback url
ServiceBuilder	debug()
ServiceBuilder	debugStream(java.io.OutputStream debugStream)
ServiceBuilderOAuth20	defaultScope(ScopeBuilder scopeBuilder)
ServiceBuilderOAuth20	defaultScope(java.lang.String defaultScope)	Configures the default OAuth 2.0 scope. You can request any uniq scope per each access token request using AuthorizationUrlBuilder.scope(java.lang.String). In case you're requesting always the same scope, you can just set it here and do not provide scope param nowhere more.
ServiceBuilder	httpClient(HttpClient httpClient)	takes precedence over httpClientConfig
ServiceBuilder	httpClientConfig(HttpClientConfig httpClientConfig)
ServiceBuilderOAuth20	responseType(java.lang.String responseType)
private ServiceBuilder	setScope(java.lang.String scope)
ServiceBuilder	userAgent(java.lang.String userAgent)
ServiceBuilderOAuth10a	withScope(java.lang.String scope)	Configures the OAuth 1.0a scope.

Methods inherited from class java.lang.Object

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

Field Detail

callback

private java.lang.String callback

apiKey

private java.lang.String apiKey

apiSecret

private java.lang.String apiSecret

scope

private java.lang.String scope

debugStream

private java.io.OutputStream debugStream

responseType

private java.lang.String responseType

userAgent

private java.lang.String userAgent

httpClientConfig

private HttpClientConfig httpClientConfig

httpClient

private HttpClient httpClient

Constructor Detail

ServiceBuilder

public ServiceBuilder(java.lang.String apiKey)

Method Detail

callback

public ServiceBuilder callback(java.lang.String callback)

Description copied from interface: ServiceBuilderCommon

Adds an OAuth callback url

Specified by:

callback in interface ServiceBuilderCommon

Specified by:

callback in interface ServiceBuilderOAuth10a

Specified by:

callback in interface ServiceBuilderOAuth20

Parameters:

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

Returns:

the ServiceBuilder instance for method chaining

apiKey

public final ServiceBuilder apiKey(java.lang.String apiKey)

Description copied from interface: ServiceBuilderCommon

Configures the api key

Specified by:

apiKey in interface ServiceBuilderCommon

Specified by:

apiKey in interface ServiceBuilderOAuth10a

Specified by:

apiKey in interface ServiceBuilderOAuth20

Parameters:

apiKey - The api key for your application

Returns:

the ServiceBuilder instance for method chaining

apiSecret

public ServiceBuilder apiSecret(java.lang.String apiSecret)

Description copied from interface: ServiceBuilderCommon

Configures the api secret

Specified by:

apiSecret in interface ServiceBuilderCommon

Specified by:

apiSecret in interface ServiceBuilderOAuth10a

Specified by:

apiSecret in interface ServiceBuilderOAuth20

Parameters:

apiSecret - The api secret for your application

Returns:

the ServiceBuilder instance for method chaining

apiSecretIsEmptyStringUnsafe

public ServiceBuilder apiSecretIsEmptyStringUnsafe()

Description copied from interface: ServiceBuilderCommon

Configures the api secret as "" (empty string). Used usually for a test environments or another strange cases. Not all providers support empty string as api key and will throw an Exception in such cases.

Specified by:

apiSecretIsEmptyStringUnsafe in interface ServiceBuilderCommon

Specified by:

apiSecretIsEmptyStringUnsafe in interface ServiceBuilderOAuth10a

Specified by:

apiSecretIsEmptyStringUnsafe in interface ServiceBuilderOAuth20

Returns:

the ServiceBuilder instance for method chaining

setScope

private ServiceBuilder setScope(java.lang.String scope)

defaultScope

public ServiceBuilderOAuth20 defaultScope(java.lang.String defaultScope)

Description copied from interface: ServiceBuilderOAuth20

Configures the default OAuth 2.0 scope.
You can request any uniq scope per each access token request using AuthorizationUrlBuilder.scope(java.lang.String).

In case you're requesting always the same scope,
you can just set it here and do not provide scope param nowhere more.

Specified by:

defaultScope in interface ServiceBuilderOAuth20

Parameters:

defaultScope - The OAuth scope, used as deafult

Returns:

the ServiceBuilder instance for method chaining

defaultScope

public ServiceBuilderOAuth20 defaultScope(ScopeBuilder scopeBuilder)

Specified by:

defaultScope in interface ServiceBuilderOAuth20

withScope

public ServiceBuilderOAuth10a withScope(java.lang.String scope)

Description copied from interface: ServiceBuilderOAuth10a

Configures the OAuth 1.0a scope. This is only necessary in some APIs

Specified by:

withScope in interface ServiceBuilderOAuth10a

Parameters:

scope - The OAuth scope

Returns:

the ServiceBuilder instance for method chaining

debugStream

public ServiceBuilder debugStream(java.io.OutputStream debugStream)

Specified by:

debugStream in interface ServiceBuilderCommon

Specified by:

debugStream in interface ServiceBuilderOAuth10a

Specified by:

debugStream in interface ServiceBuilderOAuth20

responseType

public ServiceBuilderOAuth20 responseType(java.lang.String responseType)

Specified by:

responseType in interface ServiceBuilderOAuth20

httpClientConfig

public ServiceBuilder httpClientConfig(HttpClientConfig httpClientConfig)

Specified by:

httpClientConfig in interface ServiceBuilderCommon

Specified by:

httpClientConfig in interface ServiceBuilderOAuth10a

Specified by:

httpClientConfig in interface ServiceBuilderOAuth20

httpClient

public ServiceBuilder httpClient(HttpClient httpClient)

Description copied from interface: ServiceBuilderCommon

takes precedence over httpClientConfig

Specified by:

httpClient in interface ServiceBuilderCommon

Specified by:

httpClient in interface ServiceBuilderOAuth10a

Specified by:

httpClient in interface ServiceBuilderOAuth20

Parameters:

httpClient - externally created HTTP client

Returns:

the ServiceBuilder instance for method chaining

userAgent

public ServiceBuilder userAgent(java.lang.String userAgent)

Specified by:

userAgent in interface ServiceBuilderCommon

Specified by:

userAgent in interface ServiceBuilderOAuth10a

Specified by:

userAgent in interface ServiceBuilderOAuth20

debug

public ServiceBuilder debug()

Specified by:

debug in interface ServiceBuilderCommon

Specified by:

debug in interface ServiceBuilderOAuth10a

Specified by:

debug in interface ServiceBuilderOAuth20

build

public OAuth10aService build(DefaultApi10a api)

Specified by:

build in interface ServiceBuilderOAuth10a

build

public OAuth20Service build(DefaultApi20 api)

Specified by:

build in interface ServiceBuilderOAuth20