Package com.helixframework.okhttp.oauth

Class ClientCredentialsOAuthInterceptor.Builder

java.lang.Object

com.helixframework.okhttp.oauth.ClientCredentialsOAuthInterceptor.Builder

Enclosing class:

ClientCredentialsOAuthInterceptor

public static class ClientCredentialsOAuthInterceptor.Builder
extends Object

Builder for creating new instances of ClientCredentialsOAuthInterceptor.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ClientCredentialsOAuthInterceptor	build()	Creates a new instance of ClientCredentialsOAuthInterceptor.
ClientCredentialsOAuthInterceptor.Builder	credentials(String clientId, String clientSecret)	Sets the `client_id` and `client_secret` that will be used for authenticating with the authorization server.
ClientCredentialsOAuthInterceptor.Builder	disableAuthorizationHeader()	Disables sending the client credentials in the Authorization header; instead sending them as form url-encoded parameters.
ClientCredentialsOAuthInterceptor.Builder	disableStrictMode()	Disables strict response code checking from the downstream service.
ClientCredentialsOAuthInterceptor.Builder	httpClient(okhttp3.OkHttpClient httpClient)	Custom http client to use for refreshing the auth token.
ClientCredentialsOAuthInterceptor.Builder	scope(String scope)	Sets the 'scope' to use for the client credentials grant.
ClientCredentialsOAuthInterceptor.Builder	tokenEndpoint(String url)	Sets the token endpoint url of the authorization server that will issue the access tokens.
ClientCredentialsOAuthInterceptor.Builder	tokenStore(TokenStore tokenStore)	Sets the token storage mechanism to use.

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

tokenEndpoint

public ClientCredentialsOAuthInterceptor.Builder tokenEndpoint(String url)

Sets the token endpoint url of the authorization server that will issue the access tokens.

This setting is required.

Parameters:

url - token endpoint url

Returns:

ClientCredentialsOAuthInterceptor.Builder

credentials

public ClientCredentialsOAuthInterceptor.Builder credentials(String clientId,
 String clientSecret)

Sets the `client_id` and `client_secret` that will be used for authenticating with the authorization server.

This setting is required.

Parameters:

clientId - oauth client id

clientSecret - oauth client secret

Returns:

ClientCredentialsOAuthInterceptor.Builder

scope

public ClientCredentialsOAuthInterceptor.Builder scope(String scope)

Sets the 'scope' to use for the client credentials grant.

This is an optional setting.

Parameters:

scope - oauth client credentials scope

Returns:

ClientCredentialsOAuthInterceptor.Builder

tokenStore

public ClientCredentialsOAuthInterceptor.Builder tokenStore(TokenStore tokenStore)

Sets the token storage mechanism to use. If not set, the default in-memory token storage will be used.

This is an optional setting.

Parameters:

tokenStore - token store

Returns:

ClientCredentialsOAuthInterceptor.Builder

disableStrictMode

public ClientCredentialsOAuthInterceptor.Builder disableStrictMode()

Disables strict response code checking from the downstream service. When disabled, the interceptor will attempt to reauthenticate in the event of both 401 and 403 response codes. If left enabled (default), the interceptor will only attempt to reauthenticate in the event it receives a 401 response code from the downstream system.

This is an optional setting.

Returns:

ClientCredentialsOAuthInterceptor.Builder

disableAuthorizationHeader

public ClientCredentialsOAuthInterceptor.Builder disableAuthorizationHeader()

Disables sending the client credentials in the Authorization header; instead sending them as form url-encoded parameters.

Returns:

ClientCredentialsOAuthInterceptor.Builder

httpClient

public ClientCredentialsOAuthInterceptor.Builder httpClient(okhttp3.OkHttpClient httpClient)

Custom http client to use for refreshing the auth token. This is useful when you need to configure a corporate proxy or other such custom scenario.

This is an optional setting.

Parameters:

httpClient - http client

Returns:

ClientCredentialsOAuthInterceptor.Builder

build

public ClientCredentialsOAuthInterceptor build()

Creates a new instance of ClientCredentialsOAuthInterceptor.

Returns:

a ClientCredentialsOAuthInterceptor

Throws:

IllegalArgumentException - when validation of the builder parameters fails