Module io.helidon.integrations.common.rest

Package io.helidon.integrations.common.rest

Common classes for accessing JSON based REST APIs of third party systems.

See Also:

RestApi, ApiRequest, ApiJsonRequest, ApiEntityResponse, ApiResponse

Interface Summary

Interface	Description
ApiRequest<T extends ApiRequest<T>>	Common base class for REST requests.
ResponseBuilder<B extends ResponseBuilder<B,T,X>,T,X>	Response builder extracted as an interface, to work around the restriction that we cannot have multiple inheritance in Java.
RestApi	JSON based REST API operations.

Class Summary

Class	Description
ApiEntityResponse	Response from a remote server with an entity.
ApiEntityResponse.Builder<B extends ApiEntityResponse.Builder<B,T,X>,T extends ApiEntityResponse,X>	Fluent API builder base to build subclasses of ApiEntityResponse.
ApiJsonBuilder<T extends ApiJsonBuilder<T>>	Common base class for builders that construct a JSON object.
ApiJsonParser	Helper methods to process a returned JSON.
ApiJsonRequest<T extends ApiJsonRequest<T>>	Common base class for REST requests that have an entity.
ApiOptionalResponse<R>	A response for requests that may or may not return an entity, such as GET requests that may have a 404 response code.
ApiOptionalResponse.Builder<X,R>	Fluent API builder for ApiOptionalResponse.
ApiOptionalResponse.BuilderBase<B extends ApiOptionalResponse.BuilderBase<B,T,X,R>,T extends ApiOptionalResponse<R>,X,R>	Fluent API builder base for subclasses of ApiOptionalResponse.
ApiResponse	A base for responses without an entity.
ApiResponse.Builder<B extends ApiResponse.Builder<B,T>,T extends ApiResponse>	Abstract fluent API builder to build subclasses of ApiResponse.
ApiRestException.BaseBuilder<B extends ApiRestException.BaseBuilder<B>>	Base builder extended by specific builder class.
ApiRestRequest<T extends ApiRequest<T>>	Common base class for REST requests.
JsonRequest	Implementation of a ApiRequest that allows free configuration of the JSON object.
RestApi.Builder<B extends RestApi.Builder<B,T>,T extends RestApi>	Base builder for REST APIs.
RestApiBase	Base REST API implementation.
RestException.Builder	Fluent API builder for RestException.
RestRequest	Simple REST request.

Exception Summary

Exception	Description
ApiException	API exception that is not related to processing of a response.
ApiRestException	Exception when invoking remote REST API caused by wrong response from the API call.
RestException	Implementation of the ApiRestException.