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 keyServiceBuilderOAuth20
apiSecret(java.lang.String apiSecret)
Configures the api secretOAuth20Service
build(DefaultApi20 api)
ServiceBuilderOAuth20
callback(java.lang.String callback)
Adds an OAuth callback urlServiceBuilderOAuth20
debug()
ServiceBuilderOAuth20
debugStream(java.io.OutputStream debugStream)
ServiceBuilderOAuth20
defaultScope(java.lang.String defaultScope)
Configures the default OAuth 2.0 scope.
You can request any uniq scope per each access token request usingAuthorizationUrlBuilder.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 httpClientConfigServiceBuilderOAuth20
httpClientConfig(HttpClientConfig httpClientConfig)
ServiceBuilderOAuth20
responseType(java.lang.String responseType)
ServiceBuilderOAuth20
userAgent(java.lang.String userAgent)
-
Method Details
-
callback
Description copied from interface:ServiceBuilderCommon
Adds an OAuth callback url- Specified by:
callback
in interfaceServiceBuilderCommon
- 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
Description copied from interface:ServiceBuilderCommon
Configures the api key- Specified by:
apiKey
in interfaceServiceBuilderCommon
- Parameters:
apiKey
- The api key for your application- Returns:
- the
ServiceBuilder
instance for method chaining
-
apiSecret
Description copied from interface:ServiceBuilderCommon
Configures the api secret- Specified by:
apiSecret
in interfaceServiceBuilderCommon
- Parameters:
apiSecret
- The api secret for your application- Returns:
- the
ServiceBuilder
instance for method chaining
-
httpClientConfig
- Specified by:
httpClientConfig
in interfaceServiceBuilderCommon
-
httpClient
Description copied from interface:ServiceBuilderCommon
takes precedence over httpClientConfig- Specified by:
httpClient
in interfaceServiceBuilderCommon
- Parameters:
httpClient
- externally created HTTP client- Returns:
- the
ServiceBuilder
instance for method chaining
-
userAgent
- Specified by:
userAgent
in interfaceServiceBuilderCommon
-
debugStream
- Specified by:
debugStream
in interfaceServiceBuilderCommon
-
debug
ServiceBuilderOAuth20 debug()- Specified by:
debug
in interfaceServiceBuilderCommon
-
responseType
-
defaultScope
Configures the default OAuth 2.0 scope.
You can request any uniq scope per each access token request usingAuthorizationUrlBuilder.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
-
build
-