Package com.github.scribejava.core.builder

Interface ServiceBuilderOAuth20

All Superinterfaces:

ServiceBuilderCommon

All Known Implementing Classes:

ServiceBuilder

public interface ServiceBuilderOAuth20
extends ServiceBuilderCommon

Method Summary

Modifier and Type	Method	Description
ServiceBuilderOAuth20	apiKey(java.lang.String apiKey)	Configures the api key
ServiceBuilderOAuth20	apiSecret(java.lang.String apiSecret)	Configures the api secret
ServiceBuilderOAuth20	apiSecretIsEmptyStringUnsafe()	Configures the api secret as "" (empty string).
OAuth20Service	build(DefaultApi20 api)
ServiceBuilderOAuth20	callback(java.lang.String callback)	Adds an OAuth callback url
ServiceBuilderOAuth20	debug()
ServiceBuilderOAuth20	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.
ServiceBuilderOAuth20	httpClient(HttpClient httpClient)	takes precedence over httpClientConfig
ServiceBuilderOAuth20	httpClientConfig(HttpClientConfig httpClientConfig)
ServiceBuilderOAuth20	responseType(java.lang.String responseType)
ServiceBuilderOAuth20	userAgent(java.lang.String userAgent)

Method Details

callback

ServiceBuilderOAuth20 callback(java.lang.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(java.lang.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(java.lang.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

apiSecretIsEmptyStringUnsafe

ServiceBuilderOAuth20 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

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(java.lang.String userAgent)

Specified by:

userAgent in interface ServiceBuilderCommon

debugStream

ServiceBuilderOAuth20 debugStream(java.io.OutputStream debugStream)

Specified by:

debugStream in interface ServiceBuilderCommon

debug

ServiceBuilderOAuth20 debug()

Specified by:

debug in interface ServiceBuilderCommon

responseType

ServiceBuilderOAuth20 responseType(java.lang.String responseType)

defaultScope

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.

Parameters:

defaultScope - The OAuth scope, used as deafult

Returns:

the ServiceBuilder instance for method chaining

defaultScope

ServiceBuilderOAuth20 defaultScope(ScopeBuilder scopeBuilder)

build

OAuth20Service build(DefaultApi20 api)