com.okta.sdk.impl.ds

Interface InternalDataStore

All Superinterfaces:

DataStore

All Known Implementing Classes:

DefaultDataStore

public interface InternalDataStore
extends DataStore

Internal DataStore used for implementation purposes only. Not intended to be called by SDK end users!

WARNING: This API CAN CHANGE AT ANY TIME, WITHOUT NOTICE. DO NOT DEPEND ON IT.

Since:

0.5.0

Method Summary

Modifier and Type	Method and Description
default <T extends Resource> T	create(String parentHref, T resource) Creates a new resource and returns the instance as represented by the server.
default <T extends Resource,R extends Resource> R	create(String parentHref, T resource, Class<? extends R> returnType)
<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()
InputStream	getRawResponse(String href, Map<String,Object> queryParameters, Map<String,List<String>> headerParameters)
<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)
<T extends Resource> T	instantiate(Class<T> clazz, Map<String,Object> properties)
default <T extends Resource> void	save(String href, T resource) Saves an exiting resource to the remote server.
<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 interface com.okta.sdk.ds.DataStore

getCacheManager, getClientCredentials, getResource, http, instantiate, isReady

Method Detail

instantiate

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

create

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

create

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

create

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

Since:

1.2.0

create

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

Since:

1.5.0

save

<T extends Resource> void save(T resource)

save

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

save

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

Since:

1.2.0

save

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

Since:

1.5.0

delete

<T extends Resource> void delete(T resource)

delete

<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

delete

void delete(String href)

delete

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

Since:

1.2.0

delete

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

Since:

1.5.0

delete

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

Since:

1.6.0

getResource

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

getResource

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

Since:

1.5.0

getBaseUrl

String getBaseUrl()

create

default <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.

create

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

save

default <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

getRawResponse

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

save

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