Uses of Interface
io.helidon.integrations.common.rest.ApiRequest

Packages that use ApiRequest

Package	Description
io.helidon.integrations.common.rest	Common classes for accessing JSON based REST APIs of third party systems.
io.helidon.integrations.oci.atp	OCI ATP integration.
io.helidon.integrations.oci.connect	Classes needed for OCI to connect to service API.
io.helidon.integrations.oci.objectstorage	OCI Object Storage integration.
io.helidon.integrations.oci.telemetry	Integration with OCI Telemetry.
io.helidon.integrations.oci.vault	Integration with OCI Vault REST API including the KMS encryption and digest support.
io.helidon.integrations.vault	Vault integration.
io.helidon.integrations.vault.auths.approle	AppRole authentication method for Vault.
io.helidon.integrations.vault.auths.common	Common classes for Vault integration.
io.helidon.integrations.vault.auths.k8s	Vault authentication method for Kubernetes.
io.helidon.integrations.vault.auths.token	Token authentication method for Vault.
io.helidon.integrations.vault.secrets.cubbyhole	Cubbyhole secret engine support for Vault.
io.helidon.integrations.vault.secrets.database	Vault's Database Secrets Engine support.
io.helidon.integrations.vault.secrets.kv1	Vault's KV1 Secrets Engine support.
io.helidon.integrations.vault.secrets.kv2	Vault's Key/value version 2 Secrets Engine support.
io.helidon.integrations.vault.secrets.pki	Vault's PKI Secrets Engine support.
io.helidon.integrations.vault.secrets.transit	Vault transit secrets.
io.helidon.integrations.vault.sys	Sys operations for Vault.

Uses of ApiRequest in io.helidon.integrations.common.rest

Classes in io.helidon.integrations.common.rest with type parameters of type ApiRequest

Modifier and Type	Interface	Description
interface	ApiRequest<T extends ApiRequest<T>>	Common base class for REST requests.
class	ApiRestRequest<T extends ApiRequest<T>>	Common base class for REST requests.

Classes in io.helidon.integrations.common.rest that implement ApiRequest

Modifier and Type	Class	Description
class	ApiJsonRequest<T extends ApiJsonRequest<T>>	Common base class for REST requests that have an entity.
class	ApiRestRequest<T extends ApiRequest<T>>	Common base class for REST requests.
final class	JsonRequest	Implementation of a ApiRequest that allows free configuration of the JSON object.
final class	RestRequest	Simple REST request.

Methods in io.helidon.integrations.common.rest with parameters of type ApiRequest

Modifier and Type	Method	Description
protected void	RestApiBase.addHeaders(WebClientRequestBuilder requestBuilder, String path, ApiRequest<?> request, Http.RequestMethod method, String requestId)	Add HTTP headers.
protected void	RestApiBase.addQueryParams(WebClientRequestBuilder requestBuilder, String path, ApiRequest<?> request, Http.RequestMethod method, String requestId)	Add HTTP query parameters.
default <T extends ApiResponse> Single<T>	RestApi.delete(String path, ApiRequest<?> request, ApiResponse.Builder<?,T> responseBuilder)	Delete without a response entity.
protected <T> Single<T>	RestApiBase.emptyResponse(String path, ApiRequest<?> request, Http.RequestMethod method, String requestId, WebClientResponse response, ResponseBuilder<?,T,?> responseBuilder)	Empty response, may be because of a Http.Status.NOT_FOUND_404, or some other status, such as Http.Status.NOT_MODIFIED_304.
protected <T extends ApiResponse> Single<T>	RestApiBase.errorResponse(String path, ApiRequest<?> request, Http.RequestMethod method, String requestId, WebClientResponse response)	Create an error response.
default <R, T extends ApiOptionalResponse<R>> Single<T>	RestApi.get(String path, ApiRequest<?> request, ApiOptionalResponse.BuilderBase<?,T,JsonObject,R> responseBuilder)	Get with an optional response.
default <R, T extends ApiOptionalResponse<R>> Single<T>	RestApi.getBytes(String path, ApiRequest<?> request, ApiOptionalResponse.BuilderBase<?,T,byte[],R> responseBuilder)	Get bytes with an optional response.
default <R, T extends ApiOptionalResponse<R>> Single<T>	RestApi.getPublisher(String path, ApiRequest<?> request, ApiOptionalResponse.BuilderBase<?,T,Multi<DataChunk>,R> responseBuilder)	Get with a response consisting of a stream.
protected <R, T extends ApiOptionalResponse<R>> Single<T>	RestApiBase.handleBytesResponse(String path, ApiRequest<?> request, Http.RequestMethod method, String requestId, WebClientResponse response, ApiOptionalResponse.BuilderBase<?,T,byte[],R> responseBuilder)	Handle bytes response for optional bytes entity.
protected <T extends ApiEntityResponse> Single<T>	RestApiBase.handleJsonResponse(String path, ApiRequest<?> request, Http.RequestMethod method, String requestId, WebClientResponse response, ApiEntityResponse.Builder<?,T,JsonObject> responseBuilder)	Reads JsonObject from response entity and either calls the jsonOkResponse or errorResponse depending on its success.
protected <R, T extends ApiOptionalResponse<R>> Single<T>	RestApiBase.handleOptionalJsonResponse(String path, ApiRequest<?> request, Http.RequestMethod method, String requestId, WebClientResponse response, ApiOptionalResponse.BuilderBase<?,T,JsonObject,R> responseBuilder)	Handle response for optional JSON entity.
protected <R, T extends ApiOptionalResponse<R>> Single<T>	RestApiBase.handlePublisherResponse(String path, ApiRequest<?> request, Http.RequestMethod method, String requestId, WebClientResponse response, ApiOptionalResponse.BuilderBase<?,T,Multi<DataChunk>,R> responseBuilder)	Handle response for optional publisher entity.
protected <T extends ApiResponse> Single<T>	RestApiBase.handleResponse(String path, ApiRequest<?> request, Http.RequestMethod method, String requestId, WebClientResponse response, ApiResponse.Builder<?,T> responseBuilder)	Handle response for a request not expecting an entity.
<T extends ApiResponse> Single<T>	RestApi.invoke(Http.RequestMethod method, String path, ApiRequest<?> request, ApiResponse.Builder<?,T> responseBuilder)	Invoke a request that is not expected to yield an entity.
<T extends ApiResponse> Single<T>	RestApiBase.invoke(Http.RequestMethod method, String path, ApiRequest<?> request, ApiResponse.Builder<?,T> responseBuilder)
<T extends ApiResponse> Single<T>	RestApi.invokeBytesRequest(Http.RequestMethod method, String path, ApiRequest<?> request, Flow.Publisher<DataChunk> byteRequest, ApiResponse.Builder<?,T> responseBuilder)	The request media type should be provided in request, falls back to MediaType.APPLICATION_OCTET_STREAM.
<T extends ApiResponse> Single<T>	RestApiBase.invokeBytesRequest(Http.RequestMethod method, String path, ApiRequest<?> request, Flow.Publisher<DataChunk> byteRequest, ApiResponse.Builder<?,T> responseBuilder)
<R, T extends ApiOptionalResponse<R>> Single<T>	RestApi.invokeBytesResponse(Http.RequestMethod method, String path, ApiRequest<?> request, ApiOptionalResponse.BuilderBase<?,T,byte[],R> responseBuilder)	Invoke API call that is expected to return bytes.
<R, T extends ApiOptionalResponse<R>> Single<T>	RestApiBase.invokeBytesResponse(Http.RequestMethod method, String path, ApiRequest<?> request, ApiOptionalResponse.BuilderBase<?,T,byte[],R> responseBuilder)
<R, T extends ApiOptionalResponse<R>> Single<T>	RestApi.invokeOptional(Http.RequestMethod method, String path, ApiRequest<?> request, ApiOptionalResponse.BuilderBase<?,T,JsonObject,R> responseBuilder)	Invoke a request that may yield an entity.
<R, T extends ApiOptionalResponse<R>> Single<T>	RestApiBase.invokeOptional(Http.RequestMethod method, String path, ApiRequest<?> request, ApiOptionalResponse.BuilderBase<?,T,JsonObject,R> responseBuilder)
<R, T extends ApiOptionalResponse<R>> Single<T>	RestApi.invokePublisherResponse(Http.RequestMethod method, String path, ApiRequest<?> request, ApiOptionalResponse.BuilderBase<?,T,Multi<DataChunk>,R> responseBuilder)	Invoke API call that is expected to return bytes as a publisher.
<R, T extends ApiOptionalResponse<R>> Single<T>	RestApiBase.invokePublisherResponse(Http.RequestMethod method, String path, ApiRequest<?> request, ApiOptionalResponse.BuilderBase<?,T,Multi<DataChunk>,R> responseBuilder)
<T extends ApiEntityResponse> Single<T>	RestApi.invokeWithResponse(Http.RequestMethod method, String path, ApiRequest<?> request, ApiEntityResponse.Builder<?,T,JsonObject> responseBuilder)	Invoke a request that is expected to yield an entity.
<T extends ApiEntityResponse> Single<T>	RestApiBase.invokeWithResponse(Http.RequestMethod method, String path, ApiRequest<?> request, ApiEntityResponse.Builder<?,T,JsonObject> responseBuilder)
protected boolean	RestApiBase.isEntityExpected(String path, ApiRequest<?> request, Http.RequestMethod method, String requestId, Http.ResponseStatus status)	This method is only called for methods that return an optional entity.
protected boolean	RestApiBase.isSuccess(String path, ApiRequest<?> request, Http.RequestMethod method, String requestId, Http.ResponseStatus status)	Provide information whether the response is a success response for requests with optional entity.
protected <T> T	RestApiBase.jsonOkResponse(String path, ApiRequest<?> request, Http.RequestMethod method, String requestId, WebClientResponse response, JsonObject json, ResponseBuilder<?,T,JsonObject> responseBuilder)	Builds the response using the response builder provided.
protected <T extends ApiResponse> Single<T>	RestApiBase.noEntityOkResponse(String path, ApiRequest<?> request, Http.RequestMethod method, String requestId, WebClientResponse response, ApiResponse.Builder<?,T> responseBuilder)	Create a response for no entity.
default <T extends ApiResponse> Single<T>	RestApi.post(String path, ApiRequest<?> request, ApiResponse.Builder<?,T> responseBuilder)	Post without a response entity.
default <T extends ApiResponse> Single<T>	RestApi.put(String path, ApiRequest<?> request, ApiResponse.Builder<?,T> responseBuilder)	Put without a response entity.
protected Throwable	RestApiBase.readError(String path, ApiRequest<?> request, Http.RequestMethod method, String requestId, WebClientResponse response)	Read error with no entity (content length set to 0).
protected Throwable	RestApiBase.readError(String path, ApiRequest<?> request, Http.RequestMethod method, String requestId, WebClientResponse response, JsonObject errorObject)	Read error with a JSON entity.
protected Throwable	RestApiBase.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	RestApiBase.readErrorFailedEntity(String path, ApiRequest<?> request, Http.RequestMethod method, String requestId, WebClientResponse response, Throwable throwable)	Read error information when we failed to read resposen entity.
protected Supplier<Single<WebClientResponse>>	RestApiBase.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 String	RestApiBase.requestId(ApiRequest<?> restRequest)	Attempts to find a good request id.
protected Supplier<Single<WebClientResponse>>	RestApiBase.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>>	RestApiBase.requestPayload(String path, ApiRequest<?> request, Http.RequestMethod method, String requestId, WebClientRequestBuilder requestBuilder)	Create a supplier for a response.
protected Supplier<Single<WebClientResponse>>	RestApiBase.responseSupplier(Http.RequestMethod method, String path, ApiRequest<?> request, String requestId)	Create a response supplier from the request.
protected Single<WebClientRequestBuilder>	RestApiBase.updateRequestBuilder(WebClientRequestBuilder requestBuilder, String path, ApiRequest<?> request, Http.RequestMethod method, String requestId)	Update request builder with no request payload.
protected Single<WebClientRequestBuilder>	RestApiBase.updateRequestBuilder(WebClientRequestBuilder requestBuilder, String path, ApiRequest<?> request, Http.RequestMethod method, String requestId, JsonObject jsonObject)	Update request builder with no request payload.
protected Single<WebClientRequestBuilder>	RestApiBase.updateRequestBuilderBytesPayload(WebClientRequestBuilder requestBuilder, String path, ApiRequest<?> request, Http.RequestMethod method, String requestId)	Update request builder with publisher request payload.
protected Single<WebClientRequestBuilder>	RestApiBase.updateRequestBuilderCommon(WebClientRequestBuilder requestBuilder, String path, ApiRequest<?> request, Http.RequestMethod method, String requestId)	Update request builder used by all default implementation in RestApiBase.

Uses of ApiRequest in io.helidon.integrations.oci.atp

Classes in io.helidon.integrations.oci.atp that implement ApiRequest

Modifier and Type	Class	Description
static class	GenerateAutonomousDatabaseWallet.Request	Request object.

Uses of ApiRequest in io.helidon.integrations.oci.connect

Classes in io.helidon.integrations.oci.connect that implement ApiRequest

Modifier and Type	Class	Description
class	OciRequestBase<T extends OciRequestBase<T>>	A base for OCI requests that acts as a builder.

Methods in io.helidon.integrations.oci.connect with parameters of type ApiRequest

Modifier and Type	Method	Description
protected Throwable	OciRestApi.readError(String path, ApiRequest<?> request, Http.RequestMethod method, String requestId, WebClientResponse response)
protected Throwable	OciRestApi.readError(String path, ApiRequest<?> request, Http.RequestMethod method, String requestId, WebClientResponse response, JsonObject json)
protected Throwable	OciRestApi.readError(String path, ApiRequest<?> request, Http.RequestMethod method, String requestId, WebClientResponse response, String entity)
protected Throwable	OciRestApi.readErrorFailedEntity(String path, ApiRequest<?> request, Http.RequestMethod method, String requestId, WebClientResponse response, Throwable it)
protected Supplier<Single<WebClientResponse>>	OciRestApi.requestBytesPayload(String path, ApiRequest<?> request, Http.RequestMethod method, String requestId, WebClientRequestBuilder requestBuilder, Flow.Publisher<DataChunk> publisher)
protected Supplier<Single<WebClientResponse>>	OciRestApi.requestJsonPayload(String path, ApiRequest<?> request, Http.RequestMethod method, String requestId, WebClientRequestBuilder requestBuilder, JsonObject jsonObject)
protected Supplier<Single<WebClientResponse>>	OciRestApi.responseSupplier(Http.RequestMethod method, String path, ApiRequest<?> request, String requestId)
protected Single<WebClientRequestBuilder>	OciRestApi.updateRequestBuilder(WebClientRequestBuilder requestBuilder, String path, ApiRequest<?> request, Http.RequestMethod method, String requestId)
protected Single<WebClientRequestBuilder>	OciRestApi.updateRequestBuilderBytesPayload(WebClientRequestBuilder requestBuilder, String path, ApiRequest<?> request, Http.RequestMethod method, String requestId)
protected Single<WebClientRequestBuilder>	OciRestApi.updateRequestBuilderCommon(WebClientRequestBuilder requestBuilder, String path, ApiRequest<?> request, Http.RequestMethod method, String requestId)

Uses of ApiRequest in io.helidon.integrations.oci.objectstorage

Classes in io.helidon.integrations.oci.objectstorage that implement ApiRequest

Modifier and Type	Class	Description
static class	DeleteObject.Request	Request object.
static class	GetBucket.Request	Request object.
static class	GetObject.Request	Request object.
class	ObjectRequest<T extends ObjectRequest<T>>	Object store base request class.
static class	PutObject.Request	Request object.
static class	RenameObject.Request	Rename Object request.

Uses of ApiRequest in io.helidon.integrations.oci.telemetry

Classes in io.helidon.integrations.oci.telemetry that implement ApiRequest

Modifier and Type	Class	Description
static class	PostMetricData.Request	Post metric data request.

Uses of ApiRequest in io.helidon.integrations.oci.vault

Classes in io.helidon.integrations.oci.vault that implement ApiRequest

Modifier and Type	Class	Description
static final class	CreateSecret.Request	Request object.
static final class	Decrypt.Request	Request object.
static final class	DeleteSecret.Request	Request object.
static final class	Encrypt.Request	Request object.
static class	GetKey.Request	Request object.
static class	GetSecret.Request	Request object.
static class	GetSecretBundle.Request	Request object.
static class	GetVault.Request	Request object.
static final class	Sign.Request	Request object.
static final class	Verify.Request	Request object.

Uses of ApiRequest in io.helidon.integrations.vault

Classes in io.helidon.integrations.vault that implement ApiRequest

Modifier and Type	Class	Description
static class	ListSecrets.Request	Request object.
class	VaultRequest<T extends VaultRequest<T>>	Common helper methods for Vault Requests.

Uses of ApiRequest in io.helidon.integrations.vault.auths.approle

Classes in io.helidon.integrations.vault.auths.approle that implement ApiRequest

Modifier and Type	Class	Description
static class	CreateAppRole.Request	Request object.
static class	DeleteAppRole.Request	Request object.
static class	DestroySecretId.Request	Request object.
static class	GenerateSecretId.Request	Request object.
static class	Login.Request	Request object.
static class	ReadRoleId.Request	Request object.

Uses of ApiRequest in io.helidon.integrations.vault.auths.common

Methods in io.helidon.integrations.vault.auths.common with parameters of type ApiRequest

Modifier and Type	Method	Description
protected <T> Single<T>	VaultRestApi.emptyResponse(String path, ApiRequest<?> request, Http.RequestMethod method, String requestId, WebClientResponse response, ResponseBuilder<?,T,?> responseBuilder)
protected Throwable	VaultRestApi.readError(String path, ApiRequest<?> request, Http.RequestMethod method, String requestId, WebClientResponse response, JsonObject entity)

Uses of ApiRequest in io.helidon.integrations.vault.auths.k8s

Classes in io.helidon.integrations.vault.auths.k8s that implement ApiRequest

Modifier and Type	Class	Description
static class	ConfigureK8s.Request	Request object.
static class	CreateRole.Request	Request object.
static class	DeleteRole.Request	Request object.
static class	Login.Request	Request object.

Uses of ApiRequest in io.helidon.integrations.vault.auths.token

Classes in io.helidon.integrations.vault.auths.token that implement ApiRequest

Modifier and Type	Class	Description
static class	CreateToken.Request	Request object.
static class	CreateTokenRole.Request	Request object.
static class	DeleteTokenRole.Request	Request object.
static final class	RenewToken.Request	Request object.
static final class	RevokeAndOrphanToken.Request	Request object.
static final class	RevokeToken.Request	Request object.

Uses of ApiRequest in io.helidon.integrations.vault.secrets.cubbyhole

Classes in io.helidon.integrations.vault.secrets.cubbyhole that implement ApiRequest

Modifier and Type	Class	Description
static class	CreateCubbyhole.Request	Request object.
static class	DeleteCubbyhole.Request	Request object.
static class	GetCubbyhole.Request	Request object.
static class	UpdateCubbyhole.Request	Request object.

Uses of ApiRequest in io.helidon.integrations.vault.secrets.database

Classes in io.helidon.integrations.vault.secrets.database that implement ApiRequest

Modifier and Type	Class	Description
static class	DbConfigure.Request<T extends DbConfigure.Request<T>>	Request object.
static final class	DbCreateRole.Request	Request object.
static final class	DbDelete.Request	Request object.
static final class	DbDeleteRole.Request	Request object.
static final class	DbGet.Request	Request object.
class	MySqlConfigureRequest	Request to configure MySQL database.
class	OracleConfigureRequest	Request to configure Oracle database.

Uses of ApiRequest in io.helidon.integrations.vault.secrets.kv1

Classes in io.helidon.integrations.vault.secrets.kv1 that implement ApiRequest

Modifier and Type	Class	Description
static final class	CreateKv1.Request	Request object.
static final class	DeleteKv1.Request	Request object.
static final class	GetKv1.Request	Request object.
static final class	UpdateKv1.Request	Request object.

Uses of ApiRequest in io.helidon.integrations.vault.secrets.kv2

Classes in io.helidon.integrations.vault.secrets.kv2 that implement ApiRequest

Modifier and Type	Class	Description
static final class	CreateKv2.Request	Request object.
static final class	DeleteAllKv2.Request	Request object.
static final class	DeleteKv2.Request	Request object.
static final class	DestroyKv2.Request	Request object.
static final class	GetKv2.Request	Request object.
static final class	UndeleteKv2.Request	Request object.
static final class	UpdateKv2.Request	Request object.

Uses of ApiRequest in io.helidon.integrations.vault.secrets.pki

Classes in io.helidon.integrations.vault.secrets.pki that implement ApiRequest

Modifier and Type	Class	Description
static final class	CaCertificateGet.Request	Request object.
static final class	CertificateGet.Request	Request object.
static final class	CrlGet.Request	Request object.
static final class	GenerateSelfSignedRoot.Request	Request object.
static final class	IssueCertificate.Request	Request object.
static final class	PkiRole.Request	Request object.
static final class	RevokeCertificate.Request	Request object.
static final class	SignCsr.Request	Request object.

Uses of ApiRequest in io.helidon.integrations.vault.secrets.transit

Classes in io.helidon.integrations.vault.secrets.transit that implement ApiRequest

Modifier and Type	Class	Description
static final class	CreateKey.Request	Request object.
static class	Decrypt.Request	Request object.
static class	DecryptBatch.Request	Request object.
static final class	DeleteKey.Request	Request object.
static class	Encrypt.Request	Request object.
static class	EncryptBatch.Request	Request object.
static class	Hmac.Request	Request object.
static class	Sign.Request	Request object.
static final class	UpdateKeyConfig.Request	Request object.
static class	Verify.Request	Request object.

Uses of ApiRequest in io.helidon.integrations.vault.sys

Classes in io.helidon.integrations.vault.sys that implement ApiRequest

Modifier and Type	Class	Description
static final class	CreatePolicy.Request	Request object.
static final class	DeletePolicy.Request	Request object.
static final class	DisableAuth.Request	Request object.
static final class	DisableEngine.Request	Request object.
static final class	EnableAuth.Request	Request object.
static final class	EnableEngine.Request	Request object.