Index (org.refcodes:refcodes-rest 1.1.7 API)

A B C D F G H I L O P R S T U W _

A

AbstractRestClient - Class in org.refcodes.rest.impls: Abstract base implementation of the RestClient interface being the foundation for various RestClient implementations such as HttpRestClientImpl or LoopbackRestClientImpl.
AbstractRestClient(ExecutorService) - Constructor for class org.refcodes.rest.impls.AbstractRestClient: Instantiates a new abstract rest client.
AbstractRestClient() - Constructor for class org.refcodes.rest.impls.AbstractRestClient: Instantiates a new abstract rest client.
AbstractRestServer - Class in org.refcodes.rest.impls: 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.
AbstractRestServer() - Constructor for class org.refcodes.rest.impls.AbstractRestServer: Constructs a AbstractRestServer pre-configured with MediaTypeFactory instances for JSON and REST.
AbstractRestServer(ExecutorService) - Constructor for class org.refcodes.rest.impls.AbstractRestServer: CConstructs a AbstractRestServer pre-configured with MediaTypeFactory instances for JSON and REST.
addMediaTypeFactory(MediaTypeFactory) - Method in class org.refcodes.rest.impls.AbstractRestClient
addMediaTypeFactory(MediaTypeFactory) - Method in class org.refcodes.rest.impls.AbstractRestServer

B

C

close() - Static method in class org.refcodes.rest.HttpRestServerSugar: See Closable.close()
close() - Method in class org.refcodes.rest.impls.HttpRestClientImpl
close() - Method in class org.refcodes.rest.impls.HttpRestServerImpl
close() - Method in class org.refcodes.rest.impls.RestCallerBuilderImpl
close() - Method in class org.refcodes.rest.impls.RestEndpointBuilderImpl
closeIn(int) - Static method in class org.refcodes.rest.HttpRestServerSugar: See Closable.closeIn(int)
closeQuietly() - Static method in class org.refcodes.rest.HttpRestServerSugar: See Closable.closeQuietly()
CONTEXT_PATH - Static variable in class org.refcodes.rest.impls.HttpRestServerImpl

D

F

G

getAction() - Method in interface org.refcodes.rest.RestRequestEvent: Gets the action.
getAction() - Method in interface org.refcodes.rest.RestResponseEvent: Gets the action.
getBaseLocator() - Method in class org.refcodes.rest.impls.AbstractRestServer
getBaseUrl() - Method in class org.refcodes.rest.impls.HttpRestClientImpl
getConnectionStatus() - Method in class org.refcodes.rest.impls.RestCallerBuilderImpl
getConnectionStatus() - Method in class org.refcodes.rest.impls.RestEndpointBuilderImpl
getFactoryMediaTypes() - Method in class org.refcodes.rest.impls.AbstractRestClient
getFactoryMediaTypes() - Method in class org.refcodes.rest.impls.AbstractRestServer
getHttpMethod() - Method in class org.refcodes.rest.impls.RestCallerBuilderImpl
getHttpMethod() - Method in class org.refcodes.rest.impls.RestEndpointBuilderImpl
getHttpMethod() - Method in class org.refcodes.rest.impls.RestRequestBuilderImpl
getHttpServer() - Method in class org.refcodes.rest.impls.HttpRestServerImpl: Gets the http server.
getInstance() - Static method in class org.refcodes.rest.impls.HttpRestClientSingleton: Returns the singleton's instance as fabricated by this HttpRestClientSingleton.
getInstance() - Static method in class org.refcodes.rest.impls.HttpRestServerSingleton: Returns the singleton's instance as fabricated by this HttpRestServerSingleton.
getInstance() - Static method in class org.refcodes.rest.impls.LoopbackRestClientSingleton: Returns the singleton's instance as fabricated by this LoopbackRestClientSingleton.
getInstance() - Static method in class org.refcodes.rest.impls.LoopbackRestServerSingleton: Returns the singleton's instance as fabricated by this LoopbackRestServerSingleton.
getLocalAddress() - Method in class org.refcodes.rest.impls.RestRequestEventImpl
getLocalAddress() - Method in class org.refcodes.rest.impls.RestResponseImpl
getLocator() - Method in class org.refcodes.rest.impls.RestCallerBuilderImpl
getLocator() - Method in class org.refcodes.rest.impls.RestRequestBuilderImpl
getLocatorPattern() - Method in class org.refcodes.rest.impls.RestEndpointBuilderImpl
getLocatorPattern() - Method in interface org.refcodes.rest.RestEndpoint: Retrieves the resource Locator-Pattern this endpoint has been registered to.
getRealm() - Method in class org.refcodes.rest.impls.AbstractRestServer
getRealm() - Method in class org.refcodes.rest.impls.RestRequestEventImpl
getRemoteAddress() - Method in class org.refcodes.rest.impls.RestRequestEventImpl
getRemoteAddress() - Method in class org.refcodes.rest.impls.RestResponseImpl
getRequestObserver() - Method in class org.refcodes.rest.impls.RestEndpointBuilderImpl
getRequestObserver() - Method in interface org.refcodes.rest.RestEndpointBuilder: Retrieves the RestRequestObserver to which any requests are delegated upon invocation of the RestRequestObserver.onRequest(RestRequestEvent, org.refcodes.net.HttpServerResponse) method.
getResponseObserver() - Method in class org.refcodes.rest.impls.RestCallerBuilderImpl
getResponseObserver() - Method in interface org.refcodes.rest.RestCallerBuilder: Retrieves the RestResponseObserver to which any responses are delegated upon invocation of the RestResponseObserver.onResponse(RestResponseEvent) method.
getSource() - Method in class org.refcodes.rest.impls.RestRequestEventImpl
getSource() - Method in class org.refcodes.rest.impls.RestResponseEventImpl
getUserAgent() - Method in class org.refcodes.rest.impls.AbstractRestClient
getWildcardReplacement(String) - Method in class org.refcodes.rest.impls.RestRequestEventImpl
getWildcardReplacementAt(int) - Method in class org.refcodes.rest.impls.RestRequestEventImpl
getWildcardReplacements() - Method in class org.refcodes.rest.impls.RestRequestEventImpl
getWildcardReplacements(String...) - Method in class org.refcodes.rest.impls.RestRequestEventImpl
getWildcardReplacementsAt(int...) - Method in class org.refcodes.rest.impls.RestRequestEventImpl

H

hasRequestCorrelation() - Method in class org.refcodes.rest.impls.AbstractRestClient
hasRequestCorrelation() - Method in class org.refcodes.rest.impls.AbstractRestServer
hasSessionCorrelation() - Method in class org.refcodes.rest.impls.AbstractRestClient
hasSessionCorrelation() - Method in class org.refcodes.rest.impls.AbstractRestServer
HttpRestClient - Interface in org.refcodes.rest: 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) ( BaseUrlAccessor.BaseUrlBuilder.withBaseUrl(String)).
HttpRestClientImpl - Class in org.refcodes.rest.impls: The HttpRestClientImpl implements the HttpRestClient interface.
HttpRestClientImpl() - Constructor for class org.refcodes.rest.impls.HttpRestClientImpl: Instantiates a new http rest client impl.
HttpRestClientImpl(ExecutorService) - Constructor for class org.refcodes.rest.impls.HttpRestClientImpl: Instantiates a new http rest client impl.
HttpRestClientSingleton - Class in org.refcodes.rest.impls: The singleton of the HttpRestClientImpl for easy HttpRestClient access.
HttpRestClientSingleton() - Constructor for class org.refcodes.rest.impls.HttpRestClientSingleton: Instantiates a new http rest client singleton.
HttpRestClientSugar - Class in org.refcodes.rest: Declarative syntactic sugar which may be statically imported in order to allow declarative definitions of REST client functionality: import static org.refcodes.rest.HttpRestClientSugar.*;
HttpRestClientSugar() - Constructor for class org.refcodes.rest.HttpRestClientSugar
HttpRestServer - Interface in org.refcodes.rest: 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(Integer, int).
HttpRestServerImpl - Class in org.refcodes.rest.impls: Implementation of the HttpRestServer interface using the HttpServer defined in the com.sun.net.httpserver package.
HttpRestServerImpl() - Constructor for class org.refcodes.rest.impls.HttpRestServerImpl: Constructs a HttpRestServerImpl listening to the given localhost's port for HTTP-Requests.
HttpRestServerImpl(ExecutorService) - Constructor for class org.refcodes.rest.impls.HttpRestServerImpl: Constructs a HttpRestServerImpl listening to the given localhost's port for HTTP-Requests.
HttpRestServerSingleton - Class in org.refcodes.rest.impls: The singleton of the HttpRestServerImpl for easy HttpRestServer access.
HttpRestServerSingleton() - Constructor for class org.refcodes.rest.impls.HttpRestServerSingleton: Instantiates a new http rest server singleton.
HttpRestServerSugar - Class in org.refcodes.rest: Declarative syntactic sugar which may be statically imported in order to allow declarative definitions of RESTful server functionality: import static org.refcodes.rest.HttpRestServerSugar.
HttpRestServerSugar() - Constructor for class org.refcodes.rest.HttpRestServerSugar





I

initMedaTypeFactories() - Method in class org.refcodes.rest.impls.AbstractRestClient

Adds the default MediaTypeFactory instances.

initMedaTypeFactories() - Method in class org.refcodes.rest.impls.AbstractRestServer

Adds the default MediaTypeFactory instances.





L

LoopbackRestClient - Interface in org.refcodes.rest

Extends a RestClient to be used as loopback device e.g. for testing
 purposes such as testing your RestResponseObserver implementations.

LoopbackRestClientImpl - Class in org.refcodes.rest.impls

Implementation if the LoopbackRestClient for easy testing of your
 requests being issued with a RestClient (HttpRestClient) and
 the according response lambda expressions.

LoopbackRestClientImpl() - Constructor for class org.refcodes.rest.impls.LoopbackRestClientImpl
 
LoopbackRestClientSingleton - Class in org.refcodes.rest.impls

The singleton of the LoopbackRestClientImpl for easy
 LoopbackRestClientImpl access.

LoopbackRestClientSingleton() - Constructor for class org.refcodes.rest.impls.LoopbackRestClientSingleton

Instantiates a new loopback rest client singleton.

LoopbackRestServer - Interface in org.refcodes.rest

Extends a RestServer to be used as loopback device e.g. for testing
 purposes such as testing your RestRequestObserver implementations.

LoopbackRestServerImpl - Class in org.refcodes.rest.impls

Implementation if the LoopbackRestServer for easy testing of your
 requests being received by a RestServer (HttpRestServer) and
 the according response lambda expressions.

LoopbackRestServerImpl() - Constructor for class org.refcodes.rest.impls.LoopbackRestServerImpl
 
LoopbackRestServerSingleton - Class in org.refcodes.rest.impls

The singleton of the LoopbackRestServerImpl for easy
 RestServer access.

LoopbackRestServerSingleton() - Constructor for class org.refcodes.rest.impls.LoopbackRestServerSingleton

Instantiates a new loopback rest server singleton.





O

onBasicAuthRequest(BasicAuthObserver) - Static method in class org.refcodes.rest.HttpRestServerSugar

See BasicAuthObservable.onBasicAuthRequest(BasicAuthObserver)

onBasicAuthRequest(BasicAuthObserver) - Method in class org.refcodes.rest.impls.HttpRestServerImpl
 
onConnectionRequest(HttpsConnectionRequestObserver) - Method in class org.refcodes.rest.impls.HttpRestServerImpl
 
onDelete(String, RestRequestObserver) - Static method in class org.refcodes.rest.HttpRestServerSugar

See RestServer.onDelete(String, RestRequestObserver)

onDelete(String, RestRequestObserver) - Method in interface org.refcodes.rest.RestServer

Even more convenient: Everything done here can also be done using
 RestServer.onRequest(HttpMethod, String, RestRequestObserver):
 
 Registers a RestRequestObserver with the given Locator-Pattern to
 incoming DELETE methods.

onGet(String, RestRequestObserver) - Static method in class org.refcodes.rest.HttpRestServerSugar

See RestServer.onGet(String, RestRequestObserver)

onGet(String, RestRequestObserver) - Method in interface org.refcodes.rest.RestServer

Even more convenient: Everything done here can also be done using
 RestServer.onRequest(HttpMethod, String, RestRequestObserver):
 
 Registers a RestRequestObserver with the given Locator-Pattern to
 incoming GET methods.

onHttpRequest(InetSocketAddress, InetSocketAddress, HttpMethod, String, String, RequestHeaderFields, InputStream) - Method in class org.refcodes.rest.impls.AbstractRestServer

Extensions of this class disect an incoming request and pass it to this
 method for doing the actual invocation of the registered
 RestEndpoint instances.

onHttpRequest(InetSocketAddress, InetSocketAddress, HttpMethod, String, String, RequestHeaderFields, InputStream) - Method in class org.refcodes.rest.impls.LoopbackRestServerImpl
 
onHttpRequest(InetSocketAddress, InetSocketAddress, HttpMethod, String, String, RequestHeaderFields, String) - Method in class org.refcodes.rest.impls.LoopbackRestServerImpl
 
onHttpRequest(InetSocketAddress, InetSocketAddress, HttpMethod, String, String, RequestHeaderFields, String) - Method in interface org.refcodes.rest.LoopbackRestServer

Invoke this method to simulate a REST request to be handled by the
 according registered Endpoint instances:.

onHttpRequest(InetSocketAddress, InetSocketAddress, HttpMethod, String, String, RequestHeaderFields, InputStream) - Method in interface org.refcodes.rest.LoopbackRestServer

Invoke this method to simulate a REST request to be handled by the
 according registered Endpoint instances:.

onPost(String, RestRequestObserver) - Static method in class org.refcodes.rest.HttpRestServerSugar

See RestServer.onPost(String, RestRequestObserver)

onPost(String, RestRequestObserver) - Method in interface org.refcodes.rest.RestServer

Even more convenient: Everything done here can also be done using
 RestServer.onRequest(HttpMethod, String, RestRequestObserver):
 
 Registers a RestRequestObserver with the given Locator-Pattern to
 incoming POST methods.

onPut(String, RestRequestObserver) - Static method in class org.refcodes.rest.HttpRestServerSugar

See RestServer.onPut(String, RestRequestObserver)

onPut(String, RestRequestObserver) - Method in interface org.refcodes.rest.RestServer

Even more convenient: Everything done here can also be done using
 RestServer.onRequest(HttpMethod, String, RestRequestObserver):
 
 Registers a RestRequestObserver with the given Locator-Pattern to
 incoming PUT methods.

onRequest(String, RestRequestObserver) - Static method in class org.refcodes.rest.HttpRestServerSugar

See RestServer.onRequest(String, RestRequestObserver)

onRequest(HttpMethod, String, RestRequestObserver) - Static method in class org.refcodes.rest.HttpRestServerSugar

See
 RestServer.onRequest(HttpMethod, String, RestRequestObserver)

onRequest(HttpMethod, String, RestRequestObserver) - Method in class org.refcodes.rest.impls.AbstractRestServer
 
onRequest(RestRequestEvent, HttpServerResponse) - Method in class org.refcodes.rest.impls.RestEndpointBuilderImpl
 
onRequest(RestRequestEvent, HttpServerResponse) - Method in interface org.refcodes.rest.RestRequestObserver

The invoker provides a request context being a RestRequestEvent)
 describing the request and a response being a HttpServerResponse
 to be processed upon by your lambda's code.

onRequest(RestEndpoint) - Method in interface org.refcodes.rest.RestServer

For the sake of unified naming, this method just delegates to
 Observable.subscribeObserver(Object).

onRequest(String, RestRequestObserver) - Method in interface org.refcodes.rest.RestServer

Registers a pre-configured RestEndpoint, triggerd by any HTTP
 method, and returns its instance.

onRequest(HttpMethod, String, RestRequestObserver) - Method in interface org.refcodes.rest.RestServer

Registers a pre-configured RestEndpoint with the least required
 attributes and returns its instance.

onResponse(RestResponseEvent) - Method in class org.refcodes.rest.impls.RestCallerBuilderImpl
 
onResponse(RestResponseEvent) - Method in interface org.refcodes.rest.RestResponseObserver

The invoker provides a response context being a RestResponseEvent
 describing the response being processed upon by your
 lambda's code.

onRestRequest(RestRequestHandler) - Method in class org.refcodes.rest.impls.AbstractRestClient

Sets the hook receiving a prepared RestCallerBuilder instance to
 be used to do the technical request with the technology chosen by the
 implementing sub-class.

onRestRequest(RestRequestHandler) - Method in class org.refcodes.rest.impls.LoopbackRestClientImpl
 
onRestRequest(RestRequestHandler) - Method in interface org.refcodes.rest.LoopbackRestClient

Registers a RestRequestHandler to simulate a REST response: The
 RestRequestHandler.onRestRequest(org.refcodes.net.HttpClientRequest)
 method is invoked with a prepared RestCallerBuilder instance
 representing the request being sent and produces an according
 RestResponseEvent to be passed back to the issuer of the request.

onRestRequest(HttpClientRequest) - Method in interface org.refcodes.rest.RestRequestHandler

Hook receiving a prepared RestCallerBuilder instance to be used
 to do the technical request with the technology chosen by the
 implementing sub-class.

open(File, String, String) - Method in interface org.refcodes.rest.HttpRestClient

Configures the HTTPS client connection with the provided HTTPS
 configuration parameters.

open(File, String) - Method in interface org.refcodes.rest.HttpRestClient

Same as HttpRestClient.open(File, String, String) but:
 
 
 Type the type of KeyStore is set to "JKS".

open() - Static method in class org.refcodes.rest.HttpRestClientSugar

See also Openable.open()

open(File, String) - Static method in class org.refcodes.rest.HttpRestClientSugar

See also HttpRestClient.open(File, String)

open(File, String, String) - Static method in class org.refcodes.rest.HttpRestClientSugar

See also HttpRestClient.open(File, String, String)

open(Integer, int) - Method in interface org.refcodes.rest.HttpRestServer

Opens the HTTP sever connection (socket) at the given port allowing the
 given number of maximum connections at the same time.

open(String, File, String, String, String, Integer, int) - Method in interface org.refcodes.rest.HttpRestServer

Opens the HTTPS sever connection (socket) at the given port allowing the
 given number of maximum connections at the same time using the provided
 HTTPS configuration parameters.

open(String, File, String, String, String, Integer) - Method in interface org.refcodes.rest.HttpRestServer

Same as HttpRestServer.open(String, File, String, String, String, Integer, int)
 but:
 
 
 The number of maximum connections at the same time is decided upon by
 the implementations's default value.

open(String, File, String, Integer, int) - Method in interface org.refcodes.rest.HttpRestServer

Same as HttpRestServer.open(String, File, String, String, String, Integer, int)
 but:
 
 
 The type of KeyStore is set to "JKS".

open(String, File, String, Integer) - Method in interface org.refcodes.rest.HttpRestServer

Same as HttpRestServer.open(String, File, String, String, String, Integer, int)
 but:
 
 
 The type of KeyStore is set to "JKS".

open(File, String, Integer, int) - Method in interface org.refcodes.rest.HttpRestServer

Same as HttpRestServer.open(String, File, String, String, String, Integer, int)
 but:
 
 
 The protocol fore the underlying SSLContext used is set to
 "TLS".

open(File, String, String, Integer) - Method in interface org.refcodes.rest.HttpRestServer

Same as HttpRestServer.open(String, File, String, String, String, Integer, int)
 but:
 
 
 The protocol fore the underlying SSLContext used is set to
 "TLS".

open(File, String, String, Integer, int) - Method in interface org.refcodes.rest.HttpRestServer

Same as HttpRestServer.open(String, File, String, String, String, Integer, int)
 but:
 
 
 The protocol fore the underlying SSLContext used is set to
 "TLS".

open(File, String, Integer) - Method in interface org.refcodes.rest.HttpRestServer

Same as HttpRestServer.open(String, File, String, String, String, Integer, int)
 but:
 
 
 The protocol fore the underlying SSLContext used is set to
 "TLS".

open(int) - Static method in class org.refcodes.rest.HttpRestServerSugar

See ConnectionOpenable.open(Object)

open(int, int) - Static method in class org.refcodes.rest.HttpRestServerSugar

See HttpRestServer.open(Integer, int)

open(String, File, String, String, String, Integer, int) - Static method in class org.refcodes.rest.HttpRestServerSugar

See
 HttpRestServer.open(String, File, String, String, String, Integer, int)

open(String, File, String, String, String, Integer) - Static method in class org.refcodes.rest.HttpRestServerSugar

See
 HttpRestServer.open(String, File, String, String, String, Integer)

open(String, File, String, Integer, int) - Static method in class org.refcodes.rest.HttpRestServerSugar

See HttpRestServer.open(String, File, String, Integer, int )

open(String, File, String, Integer) - Static method in class org.refcodes.rest.HttpRestServerSugar

See HttpRestServer.open(String, File, String, Integer )

open(File, String, Integer, int) - Static method in class org.refcodes.rest.HttpRestServerSugar

See HttpRestServer.open(File, String, Integer, int )

open(File, String, Integer) - Static method in class org.refcodes.rest.HttpRestServerSugar

See HttpRestServer.open(File, String, Integer )

open(File, String, String, Integer, int) - Static method in class org.refcodes.rest.HttpRestServerSugar

See HttpRestServer.open(File, String, String, Integer, int)

open(File, String, String, Integer) - Static method in class org.refcodes.rest.HttpRestServerSugar

See HttpRestServer.open(File, String, String, Integer, int)

open() - Method in class org.refcodes.rest.impls.HttpRestClientImpl
 
open(File, String, String) - Method in class org.refcodes.rest.impls.HttpRestClientImpl
 
open(Integer) - Method in class org.refcodes.rest.impls.HttpRestServerImpl
 
open(Integer, int) - Method in class org.refcodes.rest.impls.HttpRestServerImpl
 
open(String, File, String, String, String, Integer, int) - Method in class org.refcodes.rest.impls.HttpRestServerImpl
 
open(HttpServer) - Method in class org.refcodes.rest.impls.HttpRestServerImpl

A hook to be used when using custom HttpServer (
 HttpsServer) by custom open(...) methods of sub-classes of this
 HttpRestServerImpl.

open() - Method in class org.refcodes.rest.impls.RestCallerBuilderImpl
 
open() - Method in class org.refcodes.rest.impls.RestEndpointBuilderImpl
 
org.refcodes.rest - package org.refcodes.rest

What is this package for?

org.refcodes.rest.impls - package org.refcodes.rest.impls
 




P

pipe(InputStream, OutputStream) - Static method in class org.refcodes.rest.impls.HttpRestClientImpl

Pipe.





R

RestCaller - Interface in org.refcodes.rest

A RestCaller describes a REST request and the
 RestResponseObserver in charge for handling the response.

RestCallerBuilder - Interface in org.refcodes.rest

An RestCallerBuilder extends an RestCaller with builder
 functionality and adds lambda support for handling the responses
 addressed to this RestCaller.

RestCallerBuilderImpl - Class in org.refcodes.rest.impls

The implementation of the RestCallerBuilder interface as good old
 POJO for use by different RestClient implementations.

RestCallerBuilderImpl(HttpMethod, String, FormFields, RequestHeaderFields, Object, RestResponseObserver, MediaTypeFactoryLookup) - Constructor for class org.refcodes.rest.impls.RestCallerBuilderImpl

Instantiates a new rest caller builder impl.

RestCallerBuilderImpl(HttpMethod, String, FormFields, RestResponseObserver, MediaTypeFactoryLookup) - Constructor for class org.refcodes.rest.impls.RestCallerBuilderImpl

Instantiates a new rest caller builder impl.

RestCallerBuilderImpl(HttpMethod, String, Object, RestResponseObserver, MediaTypeFactoryLookup) - Constructor for class org.refcodes.rest.impls.RestCallerBuilderImpl

Instantiates a new rest caller builder impl.

RestCallerBuilderImpl(HttpMethod, String, FormFields, Object, RestResponseObserver, MediaTypeFactoryLookup) - Constructor for class org.refcodes.rest.impls.RestCallerBuilderImpl

Instantiates a new rest caller builder impl.

RestClient - Interface in org.refcodes.rest

A client to send requests for communicating with a RESTful server such as the
 HttpRestServer.

RestEndpoint - Interface in org.refcodes.rest

An RestEndpoint subscribes to a RestServer (
 HttpRestServer) and defines the target for a REST request.

RestEndpointBuilder - Interface in org.refcodes.rest

An RestEndpointBuilder extends an RestEndpoint with builder
 functionality and adds lambda support for handling the requests
 addressed to this RestEndpoint.

RestEndpointBuilderImpl - Class in org.refcodes.rest.impls

The implementation of the RestEndpointBuilder interface as good old
 POJO for use by different RestServer implementations.

RestEndpointBuilderImpl() - Constructor for class org.refcodes.rest.impls.RestEndpointBuilderImpl

Constructs a plain RestEndpointBuilder, make sure to provide the
 least required attributes as demonstrated by the constructor
 RestEndpointBuilderImpl.RestEndpointBuilderImpl(HttpMethod, String, RestRequestObserver).

RestEndpointBuilderImpl(HttpMethod, String, RestRequestObserver) - Constructor for class org.refcodes.rest.impls.RestEndpointBuilderImpl

Constructs an RestEndpointBuilder with the least required
 attributes.

RestRequest - Interface in org.refcodes.rest

A RestRequest describes a REST request and the RestResponse
 providing the response.

RestRequestBuilder - Interface in org.refcodes.rest

An RestRequestBuilder extends an RestCaller with builder
 functionality and adds lambda support for handling the responses
 addressed to this RestCaller.

RestRequestBuilderImpl - Class in org.refcodes.rest.impls

The implementation of the RestCallerBuilder interface as good old
 POJO for use by different RestClient implementations.

RestRequestBuilderImpl(HttpMethod, String, FormFields, RequestHeaderFields, Object, RestClient) - Constructor for class org.refcodes.rest.impls.RestRequestBuilderImpl

Instantiates a new rest request builder impl.

RestRequestBuilderImpl(HttpMethod, String, FormFields, RestClient) - Constructor for class org.refcodes.rest.impls.RestRequestBuilderImpl

Instantiates a new rest request builder impl.

RestRequestBuilderImpl(HttpMethod, String, Object, RestClient) - Constructor for class org.refcodes.rest.impls.RestRequestBuilderImpl

Instantiates a new rest request builder impl.

RestRequestBuilderImpl(HttpMethod, String, FormFields, Object, RestClient) - Constructor for class org.refcodes.rest.impls.RestRequestBuilderImpl

Instantiates a new rest request builder impl.

RestRequestEvent - Interface in org.refcodes.rest

Defines a RestRequestEvent being the request as consumed by a
 RestEndpoint.

RestRequestEventImpl - Class in org.refcodes.rest.impls

Implementation of the RestRequestEvent interface as good old POJO for
 use by different RestServer implementations.

RestRequestEventImpl(InetSocketAddress, InetSocketAddress, HttpMethod, String, WildcardSubstitutes, FormFields, RequestHeaderFields, InputStream, RestServer) - Constructor for class org.refcodes.rest.impls.RestRequestEventImpl

Constructs a RestRequestEvent with all required attributes.

RestRequestHandler - Interface in org.refcodes.rest

A RestRequestHandler handles a REST request on the RestClient
 instance's side to do the actual technical implementation of sending that
 request (or mocking the send-out of a request).

RestRequestObserver - Interface in org.refcodes.rest

The RestRequestObserver can be coded using the lambda
 syntax and processes a request for a given locator and for a given
 HttpMethod.

RestResponse - Interface in org.refcodes.rest

Defines a RestResponse being the base definition of a response as
 returned as of a request issued by a RestClient (
 HttpRestClient).

RestResponseEvent - Interface in org.refcodes.rest

Defines a RestResponseEvent being the response as consumed by a
 RestCaller's RestResponseObserver.

RestResponseEventImpl - Class in org.refcodes.rest.impls

Implementation of the RestResponseEvent interface as good old POJO
 for use by different RestClient implementations.

RestResponseEventImpl(RestResponse, RestClient) - Constructor for class org.refcodes.rest.impls.RestResponseEventImpl

Constructs a RestResponseEvent with all required attributes.

RestResponseEventImpl(InetSocketAddress, InetSocketAddress, HttpStatusCode, ResponseHeaderFields, InputStream, RestClient) - Constructor for class org.refcodes.rest.impls.RestResponseEventImpl

Constructs a RestResponseEvent with all required attributes.

RestResponseImpl - Class in org.refcodes.rest.impls

Implementation of the RestResponseEvent interface as good old POJO
 for use by different RestClient implementations.

RestResponseImpl(InetSocketAddress, InetSocketAddress, HttpStatusCode, ResponseHeaderFields, InputStream, MediaTypeFactoryLookup) - Constructor for class org.refcodes.rest.impls.RestResponseImpl

Constructs a RestResponseEvent with all required attributes.

RestResponseObserver - Interface in org.refcodes.rest

The RestResponseObserver can be coded using the lambda
 syntax and processes a response from a server.

RestServer - Interface in org.refcodes.rest

The RestServer acts as the target for clients issuing REST requests.





S

setBaseLocator(String) - Method in class org.refcodes.rest.impls.AbstractRestServer
 
setBaseUrl(URL) - Method in class org.refcodes.rest.impls.HttpRestClientImpl
 
setHeaderFields(RequestHeaderFields) - Method in class org.refcodes.rest.impls.RestCallerBuilderImpl
 
setHeaderFields(RequestHeaderFields) - Method in class org.refcodes.rest.impls.RestRequestBuilderImpl
 
setHttpMethod(HttpMethod) - Method in class org.refcodes.rest.impls.RestCallerBuilderImpl
 
setHttpMethod(HttpMethod) - Method in class org.refcodes.rest.impls.RestEndpointBuilderImpl
 
setHttpMethod(HttpMethod) - Method in class org.refcodes.rest.impls.RestRequestBuilderImpl
 
setLocator(String) - Method in class org.refcodes.rest.impls.RestCallerBuilderImpl
 
setLocator(String) - Method in class org.refcodes.rest.impls.RestRequestBuilderImpl
 
setLocatorPattern(String) - Method in class org.refcodes.rest.impls.RestEndpointBuilderImpl
 
setLocatorPattern(String) - Method in interface org.refcodes.rest.RestEndpointBuilder

Sets the resource locator.

setQueryFields(FormFields) - Method in class org.refcodes.rest.impls.RestCallerBuilderImpl
 
setQueryFields(FormFields) - Method in class org.refcodes.rest.impls.RestRequestBuilderImpl
 
setRealm(String) - Method in class org.refcodes.rest.impls.AbstractRestServer
 
setRequestCorrelation(boolean) - Method in class org.refcodes.rest.impls.AbstractRestClient
 
setRequestCorrelation(boolean) - Method in class org.refcodes.rest.impls.AbstractRestServer
 
setRequestObserver(RestRequestObserver) - Method in class org.refcodes.rest.impls.RestEndpointBuilderImpl
 
setRequestObserver(RestRequestObserver) - Method in interface org.refcodes.rest.RestEndpointBuilder

Sets the RestRequestObserver to which any requests are delegated
 upon invocation of the
 RestRequestObserver.onRequest(RestRequestEvent, org.refcodes.net.HttpServerResponse)
 method.

setResponseObserver(RestResponseObserver) - Method in class org.refcodes.rest.impls.RestCallerBuilderImpl
 
setResponseObserver(RestResponseObserver) - Method in interface org.refcodes.rest.RestCallerBuilder

Sets the RestResponseObserver to which any responses are
 delegated upon invocation of the RestResponseObserver.onResponse(RestResponseEvent)
 method.

setSessionCorrelation(boolean) - Method in class org.refcodes.rest.impls.AbstractRestClient
 
setSessionCorrelation(boolean) - Method in class org.refcodes.rest.impls.AbstractRestServer
 
setUserAgent(String) - Method in class org.refcodes.rest.impls.AbstractRestClient
 
subscribeObserver(RestEndpoint) - Method in class org.refcodes.rest.impls.AbstractRestServer
 




T

toMediaTypeFactory(MediaType) - Method in class org.refcodes.rest.impls.AbstractRestClient
 
toMediaTypeFactory(MediaType) - Method in class org.refcodes.rest.impls.AbstractRestServer
 
toNegotiatedContenType(RequestHeaderFields) - Method in class org.refcodes.rest.impls.AbstractRestServer

Determines the best fitting respone's ContentType.

toResponseBody(Object, RequestHeaderFields, ResponseHeaderFields) - Method in class org.refcodes.rest.impls.AbstractRestServer

Creates a String MediaType encoded as of the
 HeaderField.CONTENT_TYPE from the response header or if not set
 as of the HeaderField.ACCEPT from the request header or if not
 set as of the HeaderField.CONTENT_TYPE from the request header.

toRestResponse() - Method in class org.refcodes.rest.impls.RestRequestBuilderImpl
 
toRestResponse() - Method in interface org.refcodes.rest.RestRequestBuilder

Sends the request and returns synchronously the according
 RestResponse.

toString() - Method in class org.refcodes.rest.impls.RestCallerBuilderImpl
 
toString() - Method in class org.refcodes.rest.impls.RestRequestBuilderImpl
 




U

unsubscribeObserver(RestEndpoint) - Static method in class org.refcodes.rest.HttpRestServerSugar

See Observable.unsubscribeObserver(Object)

unsubscribeObserver(RestEndpoint) - Method in class org.refcodes.rest.impls.AbstractRestServer
 




W

withBaseLocator(String) - Method in interface org.refcodes.rest.HttpRestServer

With base locator.

withBaseLocator(String) - Static method in class org.refcodes.rest.HttpRestServerSugar

See HttpRestServer.withBaseLocator(String).

withBaseLocator(String) - Method in interface org.refcodes.rest.LoopbackRestServer

With base locator.

withBaseLocator(String) - Method in interface org.refcodes.rest.RestServer

With base locator.

withBaseUrl(URL) - Method in interface org.refcodes.rest.HttpRestClient

With base url.

withBaseUrl(String) - Static method in class org.refcodes.rest.HttpRestClientSugar

See also BaseUrlAccessor.BaseUrlBuilder.withBaseUrl(String)

withBaseUrl(URL) - Static method in class org.refcodes.rest.HttpRestClientSugar

See also HttpRestClient.withBaseUrl(URL)

withClose() - Method in interface org.refcodes.rest.HttpRestServer

With close.

withClose() - Method in interface org.refcodes.rest.RestCallerBuilder

With close.

withClose() - Method in interface org.refcodes.rest.RestEndpointBuilder

With close.

withCloseIn(int) - Method in interface org.refcodes.rest.HttpRestServer

With close in.

withCloseIn(int) - Method in interface org.refcodes.rest.RestCallerBuilder

With close in.

withCloseIn(int) - Method in interface org.refcodes.rest.RestEndpointBuilder

With close in.

withCloseQuietly() - Method in interface org.refcodes.rest.HttpRestServer

With close quietly.

withCloseQuietly() - Method in interface org.refcodes.rest.RestCallerBuilder

With close quietly.

withCloseQuietly() - Method in interface org.refcodes.rest.RestEndpointBuilder

With close quietly.

withDisableRequestCorrelation() - Method in interface org.refcodes.rest.HttpRestClient

With disable request correlation.

withDisableRequestCorrelation() - Method in interface org.refcodes.rest.HttpRestServer

With disable request correlation.

withDisableRequestCorrelation() - Method in interface org.refcodes.rest.RestClient

With disable request correlation.

withDisableRequestCorrelation() - Method in interface org.refcodes.rest.RestServer

With disable request correlation.

withDisableSessionCorrelation() - Method in interface org.refcodes.rest.HttpRestClient

With disable session correlation.

withDisableSessionCorrelation() - Method in interface org.refcodes.rest.HttpRestServer

With disable session correlation.

withDisableSessionCorrelation() - Method in interface org.refcodes.rest.RestClient

With disable session correlation.

withDisableSessionCorrelation() - Method in interface org.refcodes.rest.RestServer

With disable session correlation.

withEnableRequestCorrelation() - Method in interface org.refcodes.rest.HttpRestClient

With enable request correlation.

withEnableRequestCorrelation() - Method in interface org.refcodes.rest.HttpRestServer

With enable request correlation.

withEnableRequestCorrelation() - Method in interface org.refcodes.rest.RestClient

With enable request correlation.

withEnableRequestCorrelation() - Method in interface org.refcodes.rest.RestServer

With enable request correlation.

withEnableSessionCorrelation() - Method in interface org.refcodes.rest.HttpRestClient

With enable session correlation.

withEnableSessionCorrelation() - Method in interface org.refcodes.rest.HttpRestServer

With enable session correlation.

withEnableSessionCorrelation() - Method in interface org.refcodes.rest.RestClient

With enable session correlation.

withEnableSessionCorrelation() - Method in interface org.refcodes.rest.RestServer

With enable session correlation.

withHeaderFields(RequestHeaderFields) - Method in interface org.refcodes.rest.RestCallerBuilder

With Header-Fields.

withHeaderFields(RequestHeaderFields) - Method in interface org.refcodes.rest.RestRequestBuilder

With Header-Fields.

withHttpMethod(HttpMethod) - Method in interface org.refcodes.rest.RestCallerBuilder

With http method.

withHttpMethod(HttpMethod) - Method in interface org.refcodes.rest.RestEndpointBuilder

With http method.

withHttpMethod(HttpMethod) - Method in interface org.refcodes.rest.RestRequestBuilder

With http method.

withLocator(String) - Method in interface org.refcodes.rest.RestCallerBuilder

With locator.

withLocator(String) - Method in interface org.refcodes.rest.RestRequestBuilder

With locator.

withLocatorPattern(String) - Method in interface org.refcodes.rest.RestEndpointBuilder

Sets the resource locator as of the Builder-Pattern.

withOpen(Integer) - Method in interface org.refcodes.rest.HttpRestServer

With open.

withOpen() - Method in interface org.refcodes.rest.RestCallerBuilder

With open.

withOpen() - Method in interface org.refcodes.rest.RestEndpointBuilder

With open.

withQueryFields(FormFields) - Method in interface org.refcodes.rest.RestCallerBuilder

With query fields.

withQueryFields(FormFields) - Method in interface org.refcodes.rest.RestRequestBuilder

With query fields.

withRealm(String) - Method in interface org.refcodes.rest.HttpRestServer

With realm.

withRealm(String) - Static method in class org.refcodes.rest.HttpRestServerSugar

See HttpRestServer.withRealm(String)

withRealm(String) - Method in class org.refcodes.rest.impls.HttpRestServerImpl
 
withRealm(String) - Method in interface org.refcodes.rest.LoopbackRestServer

With realm.

withRealm(String) - Method in interface org.refcodes.rest.RestServer

With realm.

withRequest(REQ) - Method in interface org.refcodes.rest.RestCallerBuilder

With request.

withRequest(REQ) - Method in interface org.refcodes.rest.RestRequestBuilder

With request.

withRequestCorrelation(boolean) - Method in interface org.refcodes.rest.HttpRestClient

With request correlation.

withRequestCorrelation(boolean) - Method in interface org.refcodes.rest.HttpRestServer

With request correlation.

withRequestCorrelation(boolean) - Method in interface org.refcodes.rest.RestClient

With request correlation.

withRequestCorrelation(boolean) - Method in interface org.refcodes.rest.RestServer

With request correlation.

withRequestObserver(RestRequestObserver) - Method in interface org.refcodes.rest.RestEndpointBuilder

Builder method for setting the RestRequestObserver.

withResponseObserver(RestResponseObserver) - Method in interface org.refcodes.rest.RestCallerBuilder

Builder method for setting the RestResponseObserver.

withSessionCorrelation(boolean) - Method in interface org.refcodes.rest.HttpRestClient

With session correlation.

withSessionCorrelation(boolean) - Method in interface org.refcodes.rest.HttpRestServer

With session correlation.

withSessionCorrelation(boolean) - Method in interface org.refcodes.rest.RestClient

With session correlation.

withSessionCorrelation(boolean) - Method in interface org.refcodes.rest.RestServer

With session correlation.

withUserAgent(String) - Method in interface org.refcodes.rest.HttpRestClient

With user agent.

withUserAgent(String) - Static method in class org.refcodes.rest.HttpRestClientSugar

See also HttpRestClient.withUserAgent(String)

withUserAgent(String) - Method in interface org.refcodes.rest.LoopbackRestClient

With user agent.

withUserAgent(String) - Method in interface org.refcodes.rest.RestClient

With user agent.





_

_connectionStatus - Variable in class org.refcodes.rest.impls.RestEndpointBuilderImpl
 
_hasRequestCorrelation - Variable in class org.refcodes.rest.impls.AbstractRestClient
 
_hasRequestCorrelation - Variable in class org.refcodes.rest.impls.AbstractRestServer
 
_hasSessionCorrelation - Variable in class org.refcodes.rest.impls.AbstractRestClient
 
_hasSessionCorrelation - Variable in class org.refcodes.rest.impls.AbstractRestServer
 
_httpMethod - Variable in class org.refcodes.rest.impls.RestEndpointBuilderImpl
 
_locatorPattern - Variable in class org.refcodes.rest.impls.RestEndpointBuilderImpl
 
_requestObserver - Variable in class org.refcodes.rest.impls.RestEndpointBuilderImpl
 

A B C D F G H I L O P R S T U W _