com.okta.sdk.impl.client

Class AbstractClient

java.lang.Object

com.okta.sdk.impl.client.AbstractClient

All Implemented Interfaces:

Client, DataStore

Direct Known Subclasses:

DefaultClient

public abstract class AbstractClient
extends Object
implements Client

The default Client implementation. This is a convenience mechanism to eliminate the constant need to call client.getDataStore() every time one needs to instantiate or look up a Resource.

Since:

0.5.0

See Also:

Communicating with Okta: Get your API Key

Constructor Summary

Constructors

Constructor and Description
AbstractClient(ClientCredentialsResolver clientCredentialsResolver, BaseUrlResolver baseUrlResolver, Proxy proxy, CacheManager cacheManager, AuthenticationScheme authenticationScheme, RequestAuthenticatorFactory requestAuthenticatorFactory, int connectionTimeout) Instantiates a new Client instance that will communicate with the Okta REST API.

Method Summary

Modifier and Type	Method and Description
protected InternalDataStore	createDataStore(RequestExecutor requestExecutor, BaseUrlResolver baseUrlResolver, ClientCredentialsResolver clientCredentialsResolver, CacheManager cacheManager)
protected RequestExecutor	createRequestExecutor(ClientCredentials clientCredentials, Proxy proxy, AuthenticationScheme authenticationScheme, RequestAuthenticatorFactory requestAuthenticatorFactory, int connectionTimeout)
CacheManager	getCacheManager()
ClientCredentials	getClientCredentials()
InternalDataStore	getDataStore()
<T extends Resource> T	getResource(String href, Class<T> clazz) Delegates to the internal dataStore instance.
<T extends Resource> T	instantiate(Class<T> clazz) Delegates to the internal dataStore instance.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.okta.sdk.client.Client

createApplication, createApplication, createGroup, createRule, createSession, createUser, createUser, getApplication, getApplication, getGroup, getGroup, getLogs, getLogs, getRule, getSession, getUser, listApplications, listApplications, listGroups, listGroups, listRules, listUsers, listUsers

Constructor Detail

AbstractClient

public AbstractClient(ClientCredentialsResolver clientCredentialsResolver,
                      BaseUrlResolver baseUrlResolver,
                      Proxy proxy,
                      CacheManager cacheManager,
                      AuthenticationScheme authenticationScheme,
                      RequestAuthenticatorFactory requestAuthenticatorFactory,
                      int connectionTimeout)

Instantiates a new Client instance that will communicate with the Okta REST API. See the class-level JavaDoc for a usage example.

Parameters:

clientCredentialsResolver - Okta API Key resolver

baseUrlResolver - Okta base URL resolver

proxy - the HTTP proxy to be used when communicating with the Okta API server (can be null)

cacheManager - the CacheManager that should be used to cache Okta REST resources (can be null)

authenticationScheme - the HTTP authentication scheme to be used when communicating with the Okta API server (can be null)

requestAuthenticatorFactory - factory used to handle creating autentication requests

connectionTimeout - connection timeout in seconds

Method Detail

createDataStore

protected InternalDataStore createDataStore(RequestExecutor requestExecutor,
                                            BaseUrlResolver baseUrlResolver,
                                            ClientCredentialsResolver clientCredentialsResolver,
                                            CacheManager cacheManager)

getClientCredentials

public ClientCredentials getClientCredentials()

Specified by:

getClientCredentials in interface DataStore

getCacheManager

public CacheManager getCacheManager()

Specified by:

getCacheManager in interface DataStore

getDataStore

public InternalDataStore getDataStore()

Specified by:

getDataStore in interface Client

createRequestExecutor

protected RequestExecutor createRequestExecutor(ClientCredentials clientCredentials,
                                                Proxy proxy,
                                                AuthenticationScheme authenticationScheme,
                                                RequestAuthenticatorFactory requestAuthenticatorFactory,
                                                int connectionTimeout)

instantiate

public <T extends Resource> T instantiate(Class<T> clazz)

Delegates to the internal dataStore instance. This is a convenience mechanism to eliminate the constant need to call client.getDataStore() every time one needs to instantiate Resource.

Specified by:

instantiate in interface DataStore

Type Parameters:

T - the Resource sub-type

Parameters:

clazz - the Resource class to instantiate.

Returns:

a new instance of the specified Resource.

getResource

public <T extends Resource> T getResource(String href,
                                          Class<T> clazz)

Delegates to the internal dataStore instance. This is a convenience mechanism to eliminate the constant need to call client.getDataStore() every time one needs to look up a Resource.

Specified by:

getResource in interface DataStore

Type Parameters:

T - type parameter indicating the returned value is a Resource instance.

Parameters:

href - the resource URL of the resource to retrieve

clazz - the Resource sub-interface to instantiate

Returns:

an instance of the specified class based on the data returned from the specified href URL.