Package com.github.scribejava.core.builder

Interface ServiceBuilderOAuth10a

All Superinterfaces:

ServiceBuilderCommon

All Known Implementing Classes:

ServiceBuilder

public interface ServiceBuilderOAuth10a
extends ServiceBuilderCommon

Method Summary

Modifier and Type	Method	Description
ServiceBuilderOAuth20	apiKey(String apiKey)	Configures the api key
ServiceBuilderOAuth20	apiSecret(String apiSecret)	Configures the api secret
OAuth10aService	build(DefaultApi10a api)
ServiceBuilderOAuth20	callback(String callback)	Adds an OAuth callback url
ServiceBuilderOAuth10a	debug()
ServiceBuilderOAuth10a	debugStream(OutputStream debugStream)
ServiceBuilderOAuth20	httpClient(HttpClient httpClient)	takes precedence over httpClientConfig
ServiceBuilderOAuth20	httpClientConfig(HttpClientConfig httpClientConfig)
ServiceBuilderOAuth20	userAgent(String userAgent)
ServiceBuilderOAuth10a	withScope(String scope)	Configures the OAuth 1.0a scope.

Method Detail

callback

ServiceBuilderOAuth20 callback(String callback)

Description copied from interface: ServiceBuilderCommon

Adds an OAuth callback url

Specified by:

callback in interface ServiceBuilderCommon

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

ServiceBuilderOAuth20 apiKey(String apiKey)

Description copied from interface: ServiceBuilderCommon

Configures the api key

Specified by:

apiKey in interface ServiceBuilderCommon

Parameters:

apiKey - The api key for your application

Returns:

the ServiceBuilder instance for method chaining

apiSecret

ServiceBuilderOAuth20 apiSecret(String apiSecret)

Description copied from interface: ServiceBuilderCommon

Configures the api secret

Specified by:

apiSecret in interface ServiceBuilderCommon

Parameters:

apiSecret - The api secret for your application

Returns:

the ServiceBuilder instance for method chaining

httpClientConfig

ServiceBuilderOAuth20 httpClientConfig(HttpClientConfig httpClientConfig)

Specified by:

httpClientConfig in interface ServiceBuilderCommon

httpClient

ServiceBuilderOAuth20 httpClient(HttpClient httpClient)

Description copied from interface: ServiceBuilderCommon

takes precedence over httpClientConfig

Specified by:

httpClient in interface ServiceBuilderCommon

Parameters:

httpClient - externally created HTTP client

Returns:

the ServiceBuilder instance for method chaining

userAgent

ServiceBuilderOAuth20 userAgent(String userAgent)

Specified by:

userAgent in interface ServiceBuilderCommon

debugStream

ServiceBuilderOAuth10a debugStream(OutputStream debugStream)

debug

ServiceBuilderOAuth10a debug()

withScope

ServiceBuilderOAuth10a withScope(String scope)

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

Parameters:

scope - The OAuth scope

Returns:

the ServiceBuilder instance for method chaining

build

OAuth10aService build(DefaultApi10a api)