com.okta.sdk.impl.client

Class BaseClient

java.lang.Object

com.okta.sdk.impl.client.BaseClient

All Implemented Interfaces:

DataStore

Direct Known Subclasses:

DefaultClient, OAuth2TokenClient

public abstract class BaseClient
extends java.lang.Object
implements DataStore

The base client class.

Since:

1.1.0

Constructor Summary

Constructors

Constructor and Description
BaseClient(ClientConfiguration clientConfiguration, CacheManager cacheManager)
BaseClient(ClientConfiguration clientConfiguration, CacheManager cacheManager, com.okta.commons.http.RequestExecutor requestExecutor)

Method Summary

Modifier and Type	Method and Description
<T extends Resource> T	create(java.lang.String parentHref, T resource)
protected InternalDataStore	createDataStore(com.okta.commons.http.RequestExecutor requestExecutor, com.okta.commons.http.config.BaseUrlResolver baseUrlResolver, ClientCredentialsResolver clientCredentialsResolver, CacheManager cacheManager)
protected com.okta.commons.http.RequestExecutor	createRequestExecutor(ClientConfiguration clientConfiguration)
<T extends Resource> void	delete(java.lang.String href, T resource)
CacheManager	getCacheManager()
ClientCredentials	getClientCredentials()
InternalDataStore	getDataStore()
<T extends Resource> T	getResource(java.lang.String href, java.lang.Class<T> clazz) Delegates to the internal dataStore instance.
RequestBuilder	http()
<T extends Resource> T	instantiate(java.lang.Class<T> clazz) Delegates to the internal dataStore instance.
boolean	isReady(java.util.function.Supplier<? extends Resource> methodReference)
<T extends Resource> void	save(java.lang.String href, T resource)

Methods inherited from class java.lang.Object

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

Constructor Detail

BaseClient

public BaseClient(ClientConfiguration clientConfiguration,
                  CacheManager cacheManager)

BaseClient

public BaseClient(ClientConfiguration clientConfiguration,
                  CacheManager cacheManager,
                  com.okta.commons.http.RequestExecutor requestExecutor)

Method Detail

createDataStore

protected InternalDataStore createDataStore(com.okta.commons.http.RequestExecutor requestExecutor,
                                            com.okta.commons.http.config.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()

createRequestExecutor

protected com.okta.commons.http.RequestExecutor createRequestExecutor(ClientConfiguration clientConfiguration)

instantiate

public <T extends Resource> T instantiate(java.lang.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(java.lang.String href,
                                          java.lang.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.

create

public <T extends Resource> T create(java.lang.String parentHref,
                                     T resource)

Specified by:

create in interface DataStore

save

public <T extends Resource> void save(java.lang.String href,
                                      T resource)

Specified by:

save in interface DataStore

delete

public <T extends Resource> void delete(java.lang.String href,
                                        T resource)

Specified by:

delete in interface DataStore

http

public RequestBuilder http()

Specified by:

http in interface DataStore

isReady

public boolean isReady(java.util.function.Supplier<? extends Resource> methodReference)

Specified by:

isReady in interface DataStore