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 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(String parentHref, T resource) Creates a new resource and returns the instance as represented by the server.
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(String href, T resource) Deleted a resource on the remote server.
CacheManager	getCacheManager() Returns the CacheManager used to improve data store performance.
ClientCredentials	getClientCredentials() Returns the ClientCredentials used to authenticate HTTPS requests sent to the Okta API server.
InternalDataStore	getDataStore()
<T extends Resource> T	getResource(String href, Class<T> clazz) Delegates to the internal dataStore instance.
RequestBuilder	http() Returns an http request builder to help make requests to Okta endpoints that are NOT implemented by this SDK.
<T extends Resource> T	instantiate(Class<T> clazz) Delegates to the internal dataStore instance.
boolean	isReady(Supplier<? extends Resource> methodReference) Check if Datastore is configured correctly and able to execute requests.
<T extends Resource> void	save(String href, T resource) Saves an exiting resource to the remote server.

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()

Description copied from interface: DataStore

Returns the ClientCredentials used to authenticate HTTPS requests sent to the Okta API server.

Specified by:

getClientCredentials in interface DataStore

Returns:

the ClientCredentials used to authenticate HTTPS requests sent to the Okta API server.

getCacheManager

public CacheManager getCacheManager()

Description copied from interface: DataStore

Returns the CacheManager used to improve data store performance.

Specified by:

getCacheManager in interface DataStore

Returns:

the CacheManager used to improve data store performance.

getDataStore

public InternalDataStore getDataStore()

createRequestExecutor

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

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.

create

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

Description copied from interface: DataStore

Creates a new resource and returns the instance as represented by the server. This could mean default values have been set, modification dates changed, etc.

Specified by:

create in interface DataStore

Type Parameters:

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

Parameters:

parentHref - the resource URL of the resource to retrieve

resource - the object payload to to send to the server

Returns:

an updated resource as represented by the server.

save

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

Description copied from interface: DataStore

Saves an exiting resource to the remote server.

NOTE: this is typically done by using resource.save() instead of this method.

Specified by:

save in interface DataStore

Type Parameters:

T - type parameter indicating the type of Resource instance.

Parameters:

href - the resource URL of the resource to updated

resource - the object payload to to send to the server

delete

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

Description copied from interface: DataStore

Deleted a resource on the remote server.

NOTE: this is typically done by using resource.delete() instead of this method.

Specified by:

delete in interface DataStore

Type Parameters:

T - type parameter indicating the type of Resource instance.

Parameters:

href - the resource URL of the resource to deleted

resource - the object payload to to send to the server

http

public RequestBuilder http()

Description copied from interface: DataStore

Returns an http request builder to help make requests to Okta endpoints that are NOT implemented by this SDK.

Specified by:

http in interface DataStore

Returns:

an http request builder to help make requests to Okta endpoints that are NOT implemented by this SDK.

isReady

public boolean isReady(Supplier<? extends Resource> methodReference)

Description copied from interface: DataStore

Check if Datastore is configured correctly and able to execute requests.

Specified by:

isReady in interface DataStore

Parameters:

methodReference - a reference to the method based on which the ready state will be checked

Returns:

true if orgUrl and token are correct and Okta Core is available, otherwise false.