com.okta.sdk.impl.ds

Class DefaultDataStore

java.lang.Object

com.okta.sdk.impl.ds.DefaultDataStore

All Implemented Interfaces:

DataStore, InternalDataStore

public class DefaultDataStore
extends Object
implements InternalDataStore

Since:

0.5.0

Constructor Summary

Constructors

Constructor and Description
DefaultDataStore(com.okta.commons.http.RequestExecutor requestExecutor, com.okta.commons.http.config.BaseUrlResolver baseUrlResolver, ClientCredentialsResolver clientCredentialsResolver, CacheManager cacheManager)
DefaultDataStore(com.okta.commons.http.RequestExecutor requestExecutor, String baseUrl, ClientCredentialsResolver clientCredentialsResolver)

Method Summary

Modifier and Type	Method and Description
protected void	applyDefaultRequestHeaders(com.okta.commons.http.Request request)
<T extends Resource> T	create(String parentHref, T resource, T parentResource)
<T extends Resource,R extends Resource> R	create(String parentHref, T resource, T parentResource, Class<? extends R> returnType)
<T extends Resource,R extends Resource> R	create(String parentHref, T resource, T parentResource, Class<? extends R> returnType, Map<String,Object> queryParameters)
<T extends Resource,R extends Resource> R	create(String parentHref, T resource, T parentResource, Class<? extends R> returnType, Map<String,Object> queryParameters, Map<String,List<String>> headerParameters)
void	delete(String href)
void	delete(String href, Map<String,Object> queryParameters)
void	delete(String href, Map<String,Object> queryParameters, Map<String,List<String>> headerParameters)
<T extends Resource> void	delete(String href, T resource) Deleted a resource on the remote server.
<T extends Resource> void	delete(String href, T resource, Map<String,Object> queryParameters, Map<String,List<String>> headerParameters)
<T extends Resource> void	delete(T resource)
String	getBaseUrl()
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.
InputStream	getRawResponse(String href, Map<String,Object> queryParameters, Map<String,List<String>> headerParameters)
<T extends Resource> T	getResource(String href, Class<T> clazz) Looks up (retrieves) the resource at the specified href URL and returns the resource as an instance of the specified class.
<T extends Resource> T	getResource(String href, Class<T> clazz, Map<String,Object> queryParameters)
<T extends Resource> T	getResource(String href, Class<T> clazz, Map<String,Object> queryParameters, Map<String,List<String>> headerParameters)
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) Instantiates and returns a new instance of the specified Resource type.
<T extends Resource> T	instantiate(Class<T> clazz, Map<String,Object> properties)
protected boolean	isCachingEnabled()
boolean	isReady(Supplier<? extends Resource> methodReference) Check if Datastore is configured correctly and able to execute requests.
<T extends Resource,R extends Resource> R	save(String parentHref, T resource, Class<? extends R> returnType, boolean create)
<T extends Resource> void	save(String href, T resource, T parentResource)
<T extends Resource> void	save(String href, T resource, T parentResource, Map<String,Object> queryParameters)
<T extends Resource> void	save(String href, T resource, T parentResource, Map<String,Object> queryParameters, Map<String,List<String>> headerParameters)
<T extends Resource> void	save(T resource)

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.impl.ds.InternalDataStore

create, create, save

Constructor Detail

DefaultDataStore

public DefaultDataStore(com.okta.commons.http.RequestExecutor requestExecutor,
                        String baseUrl,
                        ClientCredentialsResolver clientCredentialsResolver)

DefaultDataStore

public DefaultDataStore(com.okta.commons.http.RequestExecutor requestExecutor,
                        com.okta.commons.http.config.BaseUrlResolver baseUrlResolver,
                        ClientCredentialsResolver clientCredentialsResolver,
                        CacheManager cacheManager)

Method Detail

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.

instantiate

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

Description copied from interface: DataStore

Instantiates and returns a new instance of the specified Resource type. The instance is merely instantiated and is not saved/synchronized with the server in any way.

This method effectively replaces the new keyword that would have been used otherwise if the concrete implementation was known (Resource implementation classes are intentionally not exposed to SDK end-users).

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.

instantiate

public <T extends Resource> T instantiate(Class<T> clazz,
                                          Map<String,Object> properties)

Specified by:

instantiate in interface InternalDataStore

getResource

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

Description copied from interface: DataStore

Looks up (retrieves) the resource at the specified href URL and returns the resource as an instance of the specified class.

The Class argument must represent an interface that is a sub-interface of 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.

getResource

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

Specified by:

getResource in interface InternalDataStore

getResource

public <T extends Resource> T getResource(String href,
                                          Class<T> clazz,
                                          Map<String,Object> queryParameters,
                                          Map<String,List<String>> headerParameters)

Specified by:

getResource in interface InternalDataStore

getRawResponse

public InputStream getRawResponse(String href,
                                  Map<String,Object> queryParameters,
                                  Map<String,List<String>> headerParameters)

Specified by:

getRawResponse in interface InternalDataStore

create

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

Specified by:

create in interface InternalDataStore

create

public <T extends Resource,R extends Resource> R create(String parentHref,
                                                        T resource,
                                                        T parentResource,
                                                        Class<? extends R> returnType)

Specified by:

create in interface InternalDataStore

create

public <T extends Resource,R extends Resource> R create(String parentHref,
                                                        T resource,
                                                        T parentResource,
                                                        Class<? extends R> returnType,
                                                        Map<String,Object> queryParameters)

Specified by:

create in interface InternalDataStore

create

public <T extends Resource,R extends Resource> R create(String parentHref,
                                                        T resource,
                                                        T parentResource,
                                                        Class<? extends R> returnType,
                                                        Map<String,Object> queryParameters,
                                                        Map<String,List<String>> headerParameters)

Specified by:

create in interface InternalDataStore

save

public <T extends Resource,R extends Resource> R save(String parentHref,
                                                      T resource,
                                                      Class<? extends R> returnType,
                                                      boolean create)

Specified by:

save in interface InternalDataStore

save

public <T extends Resource> void save(T resource)

Specified by:

save in interface InternalDataStore

save

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

Specified by:

save in interface InternalDataStore

save

public <T extends Resource> void save(String href,
                                      T resource,
                                      T parentResource,
                                      Map<String,Object> queryParameters)

Specified by:

save in interface InternalDataStore

save

public <T extends Resource> void save(String href,
                                      T resource,
                                      T parentResource,
                                      Map<String,Object> queryParameters,
                                      Map<String,List<String>> headerParameters)

Specified by:

save in interface InternalDataStore

delete

public void delete(String href)

Specified by:

delete in interface InternalDataStore

delete

public void delete(String href,
                   Map<String,Object> queryParameters)

Specified by:

delete in interface InternalDataStore

delete

public void delete(String href,
                   Map<String,Object> queryParameters,
                   Map<String,List<String>> headerParameters)

Specified by:

delete in interface InternalDataStore

delete

public <T extends Resource> void delete(String href,
                                        T resource,
                                        Map<String,Object> queryParameters,
                                        Map<String,List<String>> headerParameters)

Specified by:

delete in interface InternalDataStore

delete

public <T extends Resource> void delete(T resource)

Specified by:

delete in interface InternalDataStore

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

Specified by:

delete in interface InternalDataStore

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

isCachingEnabled

protected boolean isCachingEnabled()

getBaseUrl

public String getBaseUrl()

Specified by:

getBaseUrl in interface InternalDataStore

Returns:

the Base URL (i.e. https://api.stormpaht.com/v1) at which the current SDK instance is connected to.

applyDefaultRequestHeaders

protected void applyDefaultRequestHeaders(com.okta.commons.http.Request request)

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.