Skip navigation links

oracle.security.idaas.rest.jaxrs.client.sdk.authentication
Interface RequestHelperInterface

All Known Implementing Classes:

RequestHelper

public interface RequestHelperInterface

This is NOT part of the public API.

Method Summary

<T> T	createResource(java.lang.String url, java.lang.Object requestEntity, java.util.Map<java.lang.String,java.lang.String> headers, java.lang.Class<T> classForResponseJSON) Executes a POST request to create a resource AND return a payload.
<T> boolean	deleteResource(java.lang.String url, java.lang.Object requestEntity, java.util.Map<java.lang.String,java.lang.String> headers, java.lang.Class<T> classForResponseJSON) Used by Tokens service (or any other service that doesnt have uri identifiers for resource so needs to pass that info in a json message within request entity.
<T> T	readResource(java.lang.String url, java.util.Map<java.lang.String,java.lang.String> headers, java.util.Map<java.lang.String,java.lang.String> queryParams, java.lang.Class<T> classForResponseJSON) Executes a GET request to read an instance of a resource.
<T> T	updateResource(java.lang.String url, java.lang.Object requestEntity, java.util.Map<java.lang.String,java.lang.String> headers, java.lang.Class<T> classForResponseJSON) Executes a PUT request to update a resource

Method Detail

createResource

<T> T createResource(java.lang.String url,
                     java.lang.Object requestEntity,
                     java.util.Map<java.lang.String,java.lang.String> headers,
                     java.lang.Class<T> classForResponseJSON)
                 throws OICClientException

Executes a POST request to create a resource AND return a payload.

Throws:

OICClientException

readResource

<T> T readResource(java.lang.String url,
                   java.util.Map<java.lang.String,java.lang.String> headers,
                   java.util.Map<java.lang.String,java.lang.String> queryParams,
                   java.lang.Class<T> classForResponseJSON)
               throws OICClientException

Executes a GET request to read an instance of a resource.

Throws:

OICClientException

updateResource

<T> T updateResource(java.lang.String url,
                     java.lang.Object requestEntity,
                     java.util.Map<java.lang.String,java.lang.String> headers,
                     java.lang.Class<T> classForResponseJSON)
                 throws OICClientException

Executes a PUT request to update a resource

Parameters:

url - contains the url of the existing user whose attributes will be updated, for example http;//...people/sean123

requestEntity - contains the payload of the attributes to update, for example for user it might be a String of JSON or it copuld be a Java Bean that JAX-RS can serialize to json. It is the set of attributes and their values that will be updated.

headers - contains authorization headers for the request

Returns:

the updated person representation.

Throws:

OICClientException

deleteResource

<T> boolean deleteResource(java.lang.String url,
                           java.lang.Object requestEntity,
                           java.util.Map<java.lang.String,java.lang.String> headers,
                           java.lang.Class<T> classForResponseJSON)
                       throws OICClientException

Used by Tokens service (or any other service that doesnt have uri identifiers for resource so needs to pass that info in a json message within request entity.

Parameters:

requestEntity - contains the attributes of the json token to delete.

Throws:

OICClientException

Skip navigation links