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_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 and Description
DefaultClientBuilder()

Method Summary

Modifier and Type	Method and Description
ApiClient	build()
ClientConfiguration	getClientConfiguration()
ClientBuilder	setAuthorizationMode(AuthorizationMode authorizationMode)
ClientBuilder	setCacheManager(CacheManager cacheManager)
ClientBuilder	setClientCredentials(ClientCredentials clientCredentials)
ClientBuilder	setClientId(String clientId)
ClientBuilder	setConnectionTimeout(int timeout)
ClientBuilder	setKid(String kid)
ClientBuilder	setOrgUrl(String baseUrl)
ClientBuilder	setPrivateKey(InputStream privateKeyStream)
ClientBuilder	setPrivateKey(Path privateKeyPath)
ClientBuilder	setPrivateKey(PrivateKey privateKey)
ClientBuilder	setPrivateKey(String 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 Detail

DefaultClientBuilder

public DefaultClientBuilder()

Method Detail

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

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

setClientId

public ClientBuilder setClientId(String clientId)

Specified by:

setClientId in interface ClientBuilder

setKid

public ClientBuilder setKid(String kid)

Specified by:

setKid in interface ClientBuilder

getClientConfiguration

public ClientConfiguration getClientConfiguration()