Module org.refcodes.rest

Package org.refcodes.rest

package org.refcodes.rest

With this artifact you easily create your serverless RESTful services and REST clients. It lets you do it the Bare-Metal way or the syntactic sugar (see HttpRestClientSugar or HttpRestServerSugar) way (being the use of statically imported methods).

Please refer to the refcodes-rest: RESTful services using lambdas documentation for an up-to-date and detailed description on the usage of this artifact.

Class	Description
AbstractHttpDiscoveryRestClientDecorator<B extends HttpDiscoveryRestClient<B>>	Abstract class for easily decorating a HttpDiscoveryRestClient.
AbstractHttpDiscoverySidecar<B extends HttpDiscoverySidecar<B>>	Abstract class for easily decorating a HttpRegistrySidecar.
AbstractHttpRegistryContextBuilder<DESC extends HttpServerDescriptor>
AbstractHttpRegistryRestServerDecorator<DESC extends HttpServerDescriptor,B extends HttpRegistryRestServer<DESC,B>>	Abstract class for easily decorating a HttpRegistryRestServer.
AbstractHttpRegistrySidecar<DESC extends HttpServerDescriptor,B extends HttpRegistrySidecar<DESC,B>>	Abstract class for easily decorating a HttpRegistrySidecar.
AbstractHttpRestClientDecorator<B extends HttpRestClient>	Abstract class for easily decorating a HttpRestClient.
AbstractHttpRestServerDecorator<B extends HttpRestServer>	Abstract class for easily decorating a HttpRestServer.
AbstractRestClient	Abstract base implementation of the RestClient interface being the foundation for various RestClient implementations such as HttpRestClientImpl or LoopbackRestClientImpl.
AbstractRestServer	Implementation of the base functionality of the RestServer interface omitting the HTTP handling part being the foundation for various RestServer implementations such as HttpRestServerImpl or LoopbackRestServerImpl.
BasicAuthEndpoint	A BasicAuthEndpoint subscribes to a RestServer ( HttpRestServer) and defines the target for a Basic-Auth request.
BasicAuthEndpointBuilder	A BasicAuthEndpointBuilder extends an BasicAuthEndpoint with builder functionality and adds lambda support for handling the requests addressed to this BasicAuthEndpoint.
BasicAuthEvent	The BasicAuthEvent describes a BasicAuthRequest being the request as consumed by a RestEndpoint.
HomePathAccessor	Provides an accessor for a home path property.
HomePathAccessor.HomePathBuilder<B extends HomePathAccessor.HomePathBuilder<?>>	Provides a mutator for an home path property.
HomePathAccessor.HomePathMutator	Provides a mutator for a home path property.
HomePathAccessor.HomePathProperty	Provides a home path property.
HomeRequestObserver	Mixin to register a RestRequestConsumer upon "home" requests.
HomeRequestObserverAccessor	Provides an accessor for a home RestRequestConsumer property.
HomeRequestObserverAccessor.HomeRequestObserverBuilder<B extends HomeRequestObserverAccessor.HomeRequestObserverBuilder<B>>	Provides a builder method for a home RestRequestConsumer property returning the builder for applying multiple build operations.
HomeRequestObserverAccessor.HomeRequestObserverMutator	Provides a mutator for a home RestRequestConsumer property.
HomeRequestObserverAccessor.HomeRequestObserverProperty	Provides a home RestRequestConsumer property.
HomeUrlAccessor	Provides an accessor for a home Url property.
HomeUrlAccessor.HomeUrlBuilder<B extends HomeUrlAccessor.HomeUrlBuilder<?>>	Provides a mutator for an home Url property.
HomeUrlAccessor.HomeUrlMutator	Provides a mutator for a home Url property.
HomeUrlAccessor.HomeUrlProperty	Provides a home Url property.
HttpDiscovery<B extends HttpDiscovery<B>>	The HttpDiscovery describes the functionality required in order to discover a service at a service discovery and discovery service.
HttpDiscoveryContext	This context describes all information required to register a server ("service") at a service discovery registry.
HttpDiscoveryContextBuilder	The HttpDiscoveryContextBuilder implements the HttpDiscoveryContext with builder functionality as of the builder pattern.
HttpDiscoveryRestClient<B extends HttpDiscoveryRestClient<B>>	The HttpDiscoveryRestClient provides additional functionality for registering at and signing off from a service discovery service in order to resolve URLs to or from other services.
HttpDiscoverySidecar<B extends HttpDiscoverySidecar<B>>	The HttpDiscoverySidecar describes the functionality required in order to discover a service at a service discovery and discovery service.
HttpDiscoveryUrlAccessor	Provides an accessor for a service discovery discovery Url property.
HttpDiscoveryUrlAccessor.HttpDiscoveryUrlBuilder<B extends HttpDiscoveryUrlAccessor.HttpDiscoveryUrlBuilder<B>>	Provides a builder method for a service discovery discovery URL property returning the builder for applying multiple build operations.
HttpDiscoveryUrlAccessor.HttpDiscoveryUrlMutator	Provides a mutator for a service discovery discovery URL property.
HttpDiscoveryUrlAccessor.HttpDiscoveryUrlProperty	Provides a service discovery discovery URL property.
HttpExceptionHandler	A lambda "catch-all" for handling exceptions during HTTP-Request processing.
HttpExceptionHandlerAccessor	Provides access to a HttpExceptionHandler property.
HttpExceptionHandlerAccessor.HttpExceptionHandlerBuilder<B extends HttpExceptionHandlerAccessor.HttpExceptionHandlerBuilder<B>>	Provides a builder method for a HttpExceptionHandler property returning the builder for applying multiple build operations.
HttpExceptionHandlerAccessor.HttpExceptionHandlerMutator	Extends the HttpExceptionHandlerAccessor with a setter method.
HttpExceptionHandlerAccessor.HttpExceptionHandlerProperty	Extends the HttpExceptionHandlerAccessor with a setter method.
HttpExceptionHandling	Defines how errors affect the HTTP-Body whilst processing a HttpRequest or a HttpResponse along with the according sub-classes.
HttpExceptionHandlingAccessor	Provides access to a HttpExceptionHandling property.
HttpExceptionHandlingAccessor.HttpExceptionHandlingBuilder<B extends HttpExceptionHandlingAccessor.HttpExceptionHandlingBuilder<B>>	Provides a builder method for a HttpExceptionHandling property returning the builder for applying multiple build operations.
HttpExceptionHandlingAccessor.HttpExceptionHandlingMutator	Extends the HttpExceptionHandlingAccessor with a setter method.
HttpExceptionHandlingAccessor.HttpExceptionHandlingProperty	Extends the HttpExceptionHandlingAccessor with a setter method.
HttpRegistry<DESC extends HttpServerDescriptor,B extends HttpRegistry<DESC,B>>	The HttpRegistry describes the functionality required in order to register a service at a service registry and discovery service.
HttpRegistryContext<DESC extends HttpServerDescriptor>	This context describes all information required to register a server ("service") at a service discovery registry.
HttpRegistryContext.HttpRegistryContextBuilder<DESC extends HttpServerDescriptor>	The HttpRegistryContext.HttpRegistryContextBuilder interface extends the HttpRegistryContext with builder functionality as of the builder pattern.
HttpRegistryRestServer<DESC extends HttpServerDescriptor,B extends HttpRegistryRestServer<DESC,B>>	The HttpRegistryRestServer provides additional functionality for registering at and signing off from a service discovery service in order to resolve URLs to or from other services.
HttpRegistrySidecar<DESC extends HttpServerDescriptor,B extends HttpRegistrySidecar<DESC,B>>	The HttpRegistrySidecar describes the functionality required in order to register a service at a service registry and discovery service.
HttpRegistryUrlAccessor	Provides an accessor for a service registry registry Url property.
HttpRegistryUrlAccessor.HttpRegistryUrlBuilder<B extends HttpRegistryUrlAccessor.HttpRegistryUrlBuilder<B>>	Provides a builder method for a service registry registry URL property returning the builder for applying multiple build operations.
HttpRegistryUrlAccessor.HttpRegistryUrlMutator	Provides a mutator for a service registry registry URL property.
HttpRegistryUrlAccessor.HttpRegistryUrlProperty	Provides a service registry registry URL property.
HttpRestClient	Extends a RestClient to be capable of providing a User-Agent with UserAgentAccessor.UserAgentMutator.setUserAgent(String) (HttpRestClient.withUserAgent(String)) and to be capable of using base URLs to be set with BaseUrlAccessor.BaseUrlMutator.setBaseUrl(String) ( HttpRestClient.withBaseUrl(String)).
HttpRestClientImpl	The HttpRestClientImpl implements the HttpRestClient interface.
HttpRestClientSingleton	The singleton of the HttpRestClientImpl for easy HttpRestClient access.
HttpRestClientSugar	Declarative syntactic sugar which may be statically imported in order to allow declarative definitions of REST client functionality: import static org.refcodes.rest.HttpRestClientSugar.*;
HttpRestServer	Extends a RestServer to be capable of opening a server socket on the local host with the provided port number via ConnectionOpenable.open(Object) or with an additional maximum number of connections via HttpRestServer.open(int, int).
HttpRestServerImpl	Implementation of the HttpRestServer interface using the HttpServer defined in the com.sun.net.httpserver package.
HttpRestServerSingleton	The singleton of the HttpRestServerImpl for easy HttpRestServer access.
HttpRestServerSugar	Declarative syntactic sugar which may be statically imported in order to allow declarative definitions of RESTful server functionality: import static org.refcodes.rest.HttpRestServerSugar