Module io.helidon.integrations.oci.connect

Package io.helidon.integrations.oci.connect

Class OciRestApi

java.lang.Object

io.helidon.integrations.common.rest.RestApiBase

io.helidon.integrations.oci.connect.OciRestApi

All Implemented Interfaces:

RestApi

public class OciRestApi
extends RestApiBase

OCI specific REST API. This class uses HTTP Signatures to sign requests.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	OciRestApi.Builder	Fluent API builder for OciRestApi.
static enum	OciRestApi.ConfigType	How to connect to OCI.

Method Summary

Modifier and Type	Method	Description
static OciRestApi.Builder	builder()	A new builder to configure instances.
static OciRestApi	create()	Create API with default configuration.
static OciRestApi	create(Config config)	Create OCI REST API from configuration.
protected Throwable	readError(String path, ApiRequest<?> request, Http.RequestMethod method, String requestId, WebClientResponse response)	Read error with no entity (content length set to 0).
protected Throwable	readError(String path, ApiRequest<?> request, Http.RequestMethod method, String requestId, WebClientResponse response, JsonObject json)	Read error with a JSON entity.
protected Throwable	readError(String path, ApiRequest<?> request, Http.RequestMethod method, String requestId, WebClientResponse response, String entity)	Read error with an entity that failed to be parsed into a JSON object.
protected Throwable	readErrorFailedEntity(String path, ApiRequest<?> request, Http.RequestMethod method, String requestId, WebClientResponse response, Throwable it)	Read error information when we failed to read resposen entity.
protected Supplier<Single<WebClientResponse>>	requestBytesPayload(String path, ApiRequest<?> request, Http.RequestMethod method, String requestId, WebClientRequestBuilder requestBuilder, Flow.Publisher<DataChunk> publisher)	Create a supplier for a response with publisher request.
protected Supplier<Single<WebClientResponse>>	requestJsonPayload(String path, ApiRequest<?> request, Http.RequestMethod method, String requestId, WebClientRequestBuilder requestBuilder, JsonObject jsonObject)	Create a supplier for a response with JSON request.
protected Supplier<Single<WebClientResponse>>	responseSupplier(Http.RequestMethod method, String path, ApiRequest<?> request, String requestId)	Create a response supplier from the request.
protected Single<WebClientRequestBuilder>	updateRequestBuilder(WebClientRequestBuilder requestBuilder, String path, ApiRequest<?> request, Http.RequestMethod method, String requestId)	Update request builder with no request payload.
protected Single<WebClientRequestBuilder>	updateRequestBuilderBytesPayload(WebClientRequestBuilder requestBuilder, String path, ApiRequest<?> request, Http.RequestMethod method, String requestId)	Update request builder with publisher request payload.
protected Single<WebClientRequestBuilder>	updateRequestBuilderCommon(WebClientRequestBuilder requestBuilder, String path, ApiRequest<?> request, Http.RequestMethod method, String requestId)	Update request builder used by all default implementation in RestApiBase.

Methods inherited from class io.helidon.integrations.common.rest.RestApiBase

addHeaders, addQueryParams, emptyResponse, errorResponse, ftHandler, handleBytesResponse, handleJsonResponse, handleOptionalJsonResponse, handlePublisherResponse, handleResponse, invoke, invokeBytesRequest, invokeBytesResponse, invokeOptional, invokePublisherResponse, invokeWithResponse, isEntityExpected, isSuccess, jsonBuilderFactory, jsonOkResponse, jsonReaderFactory, jsonWriterFactory, noEntityOkResponse, requestId, requestPayload, updateRequestBuilder, webClient

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.helidon.integrations.common.rest.RestApi

delete, get, getBytes, getPublisher, post, put

Method Details

builder

public static OciRestApi.Builder builder()

A new builder to configure instances.

Returns:

a new builder

create

public static OciRestApi create()

Create API with default configuration.

Returns:

a new REST API with default configuration

create

public static OciRestApi create(Config config)

Create OCI REST API from configuration.

Parameters:

config - configuration

Returns:

a new REST API configured from config

responseSupplier

protected Supplier<Single<WebClientResponse>> responseSupplier(Http.RequestMethod method,
 String path,
 ApiRequest<?> request,
 String requestId)

Description copied from class: RestApiBase

Create a response supplier from the request. This method checks if there is a payload, and prepares the supplier based on this information.

Overrides:

responseSupplier in class RestApiBase

Parameters:

method - HTTP method to invoke

path - path to invoke

request - request that may contain a JSON entity

requestId - request ID to use for this request

Returns:

supplier of response that is used with fault tolerance

requestBytesPayload

protected Supplier<Single<WebClientResponse>> requestBytesPayload(String path,
 ApiRequest<?> request,
 Http.RequestMethod method,
 String requestId,
 WebClientRequestBuilder requestBuilder,
 Flow.Publisher<DataChunk> publisher)

Description copied from class: RestApiBase

Create a supplier for a response with publisher request. Defaults to "() -> clientRequest.submit(publisher)". Also configures content type and accept headers.

Overrides:

requestBytesPayload in class RestApiBase

Parameters:

path - path requested

request - API request

method - HTTP method

requestId - ID of this request

requestBuilder - WebClient request builder

publisher - publisher to be used as request entity

Returns:

supplier of a web client response

readErrorFailedEntity

protected Throwable readErrorFailedEntity(String path,
 ApiRequest<?> request,
 Http.RequestMethod method,
 String requestId,
 WebClientResponse response,
 Throwable it)

Description copied from class: RestApiBase

Read error information when we failed to read resposen entity.

Overrides:

readErrorFailedEntity in class RestApiBase

Parameters:

path - requested path

request - original request

method - HTTP method

requestId - ID of the request

response - actual response where we do not expect an entity

it - throwable that caused this problem (such as parsing exception)

Returns:

throwable to be used in response

readError

protected Throwable readError(String path,
 ApiRequest<?> request,
 Http.RequestMethod method,
 String requestId,
 WebClientResponse response)

Description copied from class: RestApiBase

Read error with no entity (content length set to 0).

Overrides:

readError in class RestApiBase

Parameters:

path - requested path

request - original API request

method - HTTP method

requestId - request ID

response - web client response with entity consumed

Returns:

a throwable to be used in response

readError

protected Throwable readError(String path,
 ApiRequest<?> request,
 Http.RequestMethod method,
 String requestId,
 WebClientResponse response,
 String entity)

Description copied from class: RestApiBase

Read error with an entity that failed to be parsed into a JSON object.

Overrides:

readError in class RestApiBase

Parameters:

path - requested path

request - original API request

method - HTTP method

requestId - request ID

response - web client response with entity consumed

entity - entity as a string

Returns:

a throwable to be used in response

readError

protected Throwable readError(String path,
 ApiRequest<?> request,
 Http.RequestMethod method,
 String requestId,
 WebClientResponse response,
 JsonObject json)

Description copied from class: RestApiBase

Read error with a JSON entity.

Overrides:

readError in class RestApiBase

Parameters:

path - requested path

request - original API request

method - HTTP method

requestId - request ID

response - web client response with entity consumed

json - entity as a JSON object

Returns:

a throwable to be used in response

updateRequestBuilder

protected Single<WebClientRequestBuilder> updateRequestBuilder(WebClientRequestBuilder requestBuilder,
 String path,
 ApiRequest<?> request,
 Http.RequestMethod method,
 String requestId)

Description copied from class: RestApiBase

Update request builder with no request payload. Default implementation does nothing.

Overrides:

updateRequestBuilder in class RestApiBase

Parameters:

requestBuilder - current request builder

path - path to be executed

request - API request

method - method

requestId - request ID

Returns:

updated builder

updateRequestBuilderBytesPayload

protected Single<WebClientRequestBuilder> updateRequestBuilderBytesPayload(WebClientRequestBuilder requestBuilder,
 String path,
 ApiRequest<?> request,
 Http.RequestMethod method,
 String requestId)

Description copied from class: RestApiBase

Update request builder with publisher request payload. Default implementation does nothing.

Overrides:

updateRequestBuilderBytesPayload in class RestApiBase

Parameters:

requestBuilder - current request builder

path - path to be executed

request - API request

method - method

requestId - request ID

Returns:

updated builder

requestJsonPayload

protected Supplier<Single<WebClientResponse>> requestJsonPayload(String path,
 ApiRequest<?> request,
 Http.RequestMethod method,
 String requestId,
 WebClientRequestBuilder requestBuilder,
 JsonObject jsonObject)

Description copied from class: RestApiBase

Create a supplier for a response with JSON request. Defaults to "() -> clientRequest.submit(jsonObject)". Also configures content type and accept headers.

Overrides:

requestJsonPayload in class RestApiBase

Parameters:

path - path requested

request - API request

method - HTTP method

requestId - ID of this request

requestBuilder - WebClient request builder

jsonObject - JSON object that should be sent as a request entity

Returns:

supplier of a web client response

updateRequestBuilderCommon

protected Single<WebClientRequestBuilder> updateRequestBuilderCommon(WebClientRequestBuilder requestBuilder,
 String path,
 ApiRequest<?> request,
 Http.RequestMethod method,
 String requestId)

Description copied from class: RestApiBase

Update request builder used by all default implementation in RestApiBase.

Overrides:

updateRequestBuilderCommon in class RestApiBase

Parameters:

requestBuilder - current request builder

path - path to be executed

request - API request

method - method

requestId - request ID

Returns:

updated builder