Package com.github.scribejava.core.builder

Interface ServiceBuilderCommon

All Known Subinterfaces:

ServiceBuilderOAuth10a, ServiceBuilderOAuth20

All Known Implementing Classes:

ServiceBuilder

public interface ServiceBuilderCommon

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

Method Summary

Modifier and Type	Method	Description
ServiceBuilderCommon	apiKey(String apiKey)	Configures the api key
ServiceBuilderCommon	apiSecret(String apiSecret)	Configures the api secret
ServiceBuilderCommon	apiSecretIsEmptyStringUnsafe()	Configures the api secret as "" (empty string).
ServiceBuilderCommon	callback(String callback)	Adds an OAuth callback url
ServiceBuilderCommon	debug()
ServiceBuilderCommon	debugStream(OutputStream debugStream)
ServiceBuilderCommon	httpClient(HttpClient httpClient)	takes precedence over httpClientConfig
ServiceBuilderCommon	httpClientConfig(HttpClientConfig httpClientConfig)
ServiceBuilderCommon	userAgent(String userAgent)

Method Details

callback

ServiceBuilderCommon callback(String callback)

Adds an OAuth callback url

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

ServiceBuilderCommon apiKey(String apiKey)

Configures the api key

Parameters:

apiKey - The api key for your application

Returns:

the ServiceBuilder instance for method chaining

apiSecret

ServiceBuilderCommon apiSecret(String apiSecret)

Configures the api secret

Parameters:

apiSecret - The api secret for your application

Returns:

the ServiceBuilder instance for method chaining

apiSecretIsEmptyStringUnsafe

ServiceBuilderCommon apiSecretIsEmptyStringUnsafe()

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.

Returns:

the ServiceBuilder instance for method chaining

httpClientConfig

ServiceBuilderCommon httpClientConfig(HttpClientConfig httpClientConfig)

httpClient

ServiceBuilderCommon httpClient(HttpClient httpClient)

takes precedence over httpClientConfig

Parameters:

httpClient - externally created HTTP client

Returns:

the ServiceBuilder instance for method chaining

userAgent

ServiceBuilderCommon userAgent(String userAgent)

debugStream

ServiceBuilderCommon debugStream(OutputStream debugStream)

debug

ServiceBuilderCommon debug()