Package com.okta.sdk.impl.client

Class DefaultClientBuilder

java.lang.Object

com.okta.sdk.impl.client.DefaultClientBuilder

All Implemented Interfaces:

ClientBuilder

public class DefaultClientBuilder
extends Object
implements ClientBuilder

The default ClientBuilder implementation. This looks for configuration files in the following locations and order of precedence (last one wins).

• classpath:com/okta/sdk/config/okta.properties
• classpath:com/okta/sdk/config/okta.yaml
• classpath:okta.properties
• classpath:okta.yaml
• ~/.okta/okta.yaml
• Environment Variables (with dot notation converted to uppercase + underscores)
• System Properties
• Programmatically

Please be aware that, in general, loading secrets (such as api-keys or PEM-content) from environment variables or system properties can lead to those secrets being leaked.

Since:

0.5.0

Field Summary

Fields inherited from interface com.okta.sdk.client.ClientBuilder

DEFAULT_CLIENT_API_TOKEN_PROPERTY_NAME, DEFAULT_CLIENT_AUTHENTICATION_SCHEME_PROPERTY_NAME, DEFAULT_CLIENT_AUTHORIZATION_MODE_PROPERTY_NAME, DEFAULT_CLIENT_CACHE_CACHES_PROPERTY_NAME, DEFAULT_CLIENT_CACHE_ENABLED_PROPERTY_NAME, DEFAULT_CLIENT_CACHE_TTI_PROPERTY_NAME, DEFAULT_CLIENT_CACHE_TTL_PROPERTY_NAME, DEFAULT_CLIENT_CONNECTION_TIMEOUT_PROPERTY_NAME, DEFAULT_CLIENT_ID_PROPERTY_NAME, DEFAULT_CLIENT_KID_PROPERTY_NAME, DEFAULT_CLIENT_OAUTH2_ACCESS_TOKEN_PROPERTY_NAME, DEFAULT_CLIENT_ORG_URL_PROPERTY_NAME, DEFAULT_CLIENT_PRIVATE_KEY_PROPERTY_NAME, DEFAULT_CLIENT_PROXY_HOST_PROPERTY_NAME, DEFAULT_CLIENT_PROXY_PASSWORD_PROPERTY_NAME, DEFAULT_CLIENT_PROXY_PORT_PROPERTY_NAME, DEFAULT_CLIENT_PROXY_USERNAME_PROPERTY_NAME, DEFAULT_CLIENT_REQUEST_TIMEOUT_PROPERTY_NAME, DEFAULT_CLIENT_RETRY_MAX_ATTEMPTS_PROPERTY_NAME, DEFAULT_CLIENT_SCOPES_PROPERTY_NAME, DEFAULT_CLIENT_TESTING_DISABLE_HTTPS_CHECK_PROPERTY_NAME

Constructor Summary

Constructors

Constructor	Description
DefaultClientBuilder()

Method Summary

Modifier and Type	Method	Description
ApiClient	build()
protected org.apache.hc.client5.http.impl.classic.HttpClientBuilder	createHttpClientBuilder(ClientConfiguration clientConfig)	Override to customize the client, allowing one to add additional interceptors.
protected org.apache.hc.client5.http.impl.io.PoolingHttpClientConnectionManagerBuilder	createHttpClientConnectionManagerBuilder(ClientConfiguration clientConfig)	Override to customize the connection manager, allowing the increase of max connections
protected org.apache.hc.client5.http.config.RequestConfig.Builder	createHttpRequestConfigBuilder(ClientConfiguration clientConfig)	Override to customize the request config
ClientConfiguration	getClientConfiguration()
ClientBuilder	setAuthorizationMode(AuthorizationMode authorizationMode)
ClientBuilder	setCacheManager(CacheManager cacheManager)
ClientBuilder	setClientCredentials(ClientCredentials clientCredentials)
ClientBuilder	setClientId(String clientId)
ClientBuilder	setConnectionTimeout(int timeout)
ClientBuilder	setCustomJwtSigner(UnaryOperator<byte[]> jwtSigner, String algorithm)
ClientBuilder	setKid(String kid)
ClientBuilder	setOAuth2AccessToken(String oAuth2AccessToken)
ClientBuilder	setOrgUrl(String baseUrl)
ClientBuilder	setPrivateKey(InputStream privateKeyStream)
ClientBuilder	setPrivateKey(String privateKey)
ClientBuilder	setPrivateKey(Path privateKeyPath)
ClientBuilder	setPrivateKey(PrivateKey privateKey)
ClientBuilder	setProxy(com.okta.commons.http.config.Proxy proxy)
ClientBuilder	setRetryMaxAttempts(int maxAttempts)
ClientBuilder	setRetryMaxElapsed(int maxElapsed)
ClientBuilder	setScopes(Set<String> scopes)

Methods inherited from class java.lang.Object

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

Constructor Details

DefaultClientBuilder

public DefaultClientBuilder()

Method Details

setProxy

public ClientBuilder setProxy(com.okta.commons.http.config.Proxy proxy)

Specified by:

setProxy in interface ClientBuilder

setCacheManager

public ClientBuilder setCacheManager(CacheManager cacheManager)

Specified by:

setCacheManager in interface ClientBuilder

setConnectionTimeout

public ClientBuilder setConnectionTimeout(int timeout)

Specified by:

setConnectionTimeout in interface ClientBuilder

setClientCredentials

public ClientBuilder setClientCredentials(ClientCredentials clientCredentials)

Specified by:

setClientCredentials in interface ClientBuilder

setRetryMaxElapsed

public ClientBuilder setRetryMaxElapsed(int maxElapsed)

Specified by:

setRetryMaxElapsed in interface ClientBuilder

setRetryMaxAttempts

public ClientBuilder setRetryMaxAttempts(int maxAttempts)

Specified by:

setRetryMaxAttempts in interface ClientBuilder

build

public ApiClient build()

Specified by:

build in interface ClientBuilder

createHttpClientBuilder

protected org.apache.hc.client5.http.impl.classic.HttpClientBuilder createHttpClientBuilder(ClientConfiguration clientConfig)

Override to customize the client, allowing one to add additional interceptors.

Parameters:

clientConfig - the current ClientConfiguration

Returns:

an HttpClientBuilder initialized with default configuration

createHttpRequestConfigBuilder

protected org.apache.hc.client5.http.config.RequestConfig.Builder createHttpRequestConfigBuilder(ClientConfiguration clientConfig)

Override to customize the request config

Parameters:

clientConfig - the current clientConfig

Returns:

a RequestConfig.Builder initialized with default configuration

createHttpClientConnectionManagerBuilder

protected org.apache.hc.client5.http.impl.io.PoolingHttpClientConnectionManagerBuilder createHttpClientConnectionManagerBuilder(ClientConfiguration clientConfig)

Override to customize the connection manager, allowing the increase of max connections

Parameters:

clientConfig - the current clientConfig

Returns:

a PoolingHttpClientConnectionManagerBuilder initialized with default configuration

setOrgUrl

public ClientBuilder setOrgUrl(String baseUrl)

Specified by:

setOrgUrl in interface ClientBuilder

setAuthorizationMode

public ClientBuilder setAuthorizationMode(AuthorizationMode authorizationMode)

Specified by:

setAuthorizationMode in interface ClientBuilder

setScopes

public ClientBuilder setScopes(Set<String> scopes)

Specified by:

setScopes in interface ClientBuilder

setPrivateKey

public ClientBuilder setPrivateKey(String privateKey)

Specified by:

setPrivateKey in interface ClientBuilder

setPrivateKey

public ClientBuilder setPrivateKey(Path privateKeyPath)

Specified by:

setPrivateKey in interface ClientBuilder

setPrivateKey

public ClientBuilder setPrivateKey(InputStream privateKeyStream)

Specified by:

setPrivateKey in interface ClientBuilder

setPrivateKey

public ClientBuilder setPrivateKey(PrivateKey privateKey)

Specified by:

setPrivateKey in interface ClientBuilder

setCustomJwtSigner

public ClientBuilder setCustomJwtSigner(UnaryOperator<byte[]> jwtSigner,
 String algorithm)

Specified by:

setCustomJwtSigner in interface ClientBuilder

setClientId

public ClientBuilder setClientId(String clientId)

Specified by:

setClientId in interface ClientBuilder

setOAuth2AccessToken

public ClientBuilder setOAuth2AccessToken(String oAuth2AccessToken)

Specified by:

setOAuth2AccessToken in interface ClientBuilder

setKid

public ClientBuilder setKid(String kid)

Specified by:

setKid in interface ClientBuilder

getClientConfiguration

public ClientConfiguration getClientConfiguration()