Package org.refcodes.rest

Interface RestCallerBuilder

All Superinterfaces:

org.refcodes.component.Closable, org.refcodes.component.Closable.CloseBuilder<org.refcodes.net.RequestHeaderFields>, org.refcodes.component.ConnectionStatusAccessor, org.refcodes.net.HeaderFieldsAccessor<org.refcodes.net.RequestHeaderFields>, org.refcodes.net.HeaderFieldsAccessor.HeaderFieldsBuilder<org.refcodes.net.RequestHeaderFields,RestCallerBuilder>, org.refcodes.net.HeaderFieldsAccessor.HeaderFieldsMutator<org.refcodes.net.RequestHeaderFields>, org.refcodes.net.HeaderFieldsAccessor.HeaderFieldsProperty<org.refcodes.net.RequestHeaderFields>, org.refcodes.net.HttpBodyAccessor.HttpBodyProvider<org.refcodes.net.RequestHeaderFields>, org.refcodes.net.HttpClientRequest, org.refcodes.net.HttpClientRequest.HttpClientRequestBuilder, org.refcodes.net.HttpMethodAccessor, org.refcodes.net.HttpMethodAccessor.HttpMethodBuilder<RestCallerBuilder>, org.refcodes.net.HttpMethodAccessor.HttpMethodMutator, org.refcodes.net.HttpMethodAccessor.HttpMethodProperty, org.refcodes.net.HttpRequest, org.refcodes.net.HttpRequestBuilder<RestCallerBuilder>, org.refcodes.component.LinkComponent, org.refcodes.component.LinkComponent.LinkComponentBuilder<RestCallerBuilder>, org.refcodes.component.Openable, org.refcodes.component.Openable.OpenBuilder<org.refcodes.net.RequestHeaderFields>, org.refcodes.net.QueryFieldsAccessor, org.refcodes.net.QueryFieldsAccessor.QueryFieldsMutator, org.refcodes.net.QueryFieldsAccessor.QueryFieldsProperty, org.refcodes.net.RedirectDepthAccessor, org.refcodes.net.RedirectDepthAccessor.RedirectDepthBuilder<org.refcodes.net.RequestHeaderFields>, org.refcodes.net.RedirectDepthAccessor.RedirectDepthMutator, org.refcodes.net.RedirectDepthAccessor.RedirectDepthProperty, RestCaller, RestResponseObserver, org.refcodes.net.UrlAccessor, org.refcodes.net.UrlAccessor.UrlBuilder, org.refcodes.net.UrlAccessor.UrlMutator

All Known Implementing Classes:

RestCallerBuilderImpl

public interface RestCallerBuilder
extends RestCaller, org.refcodes.net.HttpClientRequest.HttpClientRequestBuilder, org.refcodes.net.HttpRequestBuilder<RestCallerBuilder>, org.refcodes.net.HttpMethodAccessor.HttpMethodProperty, org.refcodes.net.HttpMethodAccessor.HttpMethodBuilder<RestCallerBuilder>, org.refcodes.component.LinkComponent.LinkComponentBuilder<RestCallerBuilder>, org.refcodes.component.ConnectionStatusAccessor, org.refcodes.net.HeaderFieldsAccessor.HeaderFieldsBuilder<org.refcodes.net.RequestHeaderFields,RestCallerBuilder>

An RestCallerBuilder extends an RestCaller with builder functionality and adds lambda support for handling the responses addressed to this RestCaller. The lambda defined as RestResponseObserver acts as the single listener to this RestCaller responsible for handling the responses for which this RestCaller is responsible. The locator to which a RestCallerBuilder targets for is defined by the UrlAccessor.getUrl() property.

Nested Class Summary

Nested classes/interfaces inherited from interface org.refcodes.component.Closable

org.refcodes.component.Closable.CloseAutomaton, org.refcodes.component.Closable.CloseBuilder<B extends org.refcodes.component.Closable.CloseBuilder<B>>

Nested classes/interfaces inherited from interface org.refcodes.component.ConnectionStatusAccessor

org.refcodes.component.ConnectionStatusAccessor.ConnectionStatusMutator, org.refcodes.component.ConnectionStatusAccessor.ConnectionStatusProperty

Nested classes/interfaces inherited from interface org.refcodes.net.HttpClientRequest

org.refcodes.net.HttpClientRequest.HttpClientRequestBuilder

Nested classes/interfaces inherited from interface org.refcodes.net.HttpMethodAccessor

org.refcodes.net.HttpMethodAccessor.HttpMethodBuilder<B extends org.refcodes.net.HttpMethodAccessor.HttpMethodBuilder<B>>, org.refcodes.net.HttpMethodAccessor.HttpMethodMutator, org.refcodes.net.HttpMethodAccessor.HttpMethodProperty

Nested classes/interfaces inherited from interface org.refcodes.component.LinkComponent

org.refcodes.component.LinkComponent.LinkAutomaton, org.refcodes.component.LinkComponent.LinkComponentBuilder<B extends org.refcodes.component.LinkComponent.LinkComponentBuilder<B>>

Nested classes/interfaces inherited from interface org.refcodes.component.Openable

org.refcodes.component.Openable.OpenAutomaton, org.refcodes.component.Openable.OpenBuilder<B extends org.refcodes.component.Openable.OpenBuilder<B>>

Nested classes/interfaces inherited from interface org.refcodes.net.QueryFieldsAccessor

org.refcodes.net.QueryFieldsAccessor.QueryFieldsBuilder<B extends org.refcodes.net.QueryFieldsAccessor.QueryFieldsBuilder<?>>, org.refcodes.net.QueryFieldsAccessor.QueryFieldsMutator, org.refcodes.net.QueryFieldsAccessor.QueryFieldsProperty

Nested classes/interfaces inherited from interface org.refcodes.net.RedirectDepthAccessor

org.refcodes.net.RedirectDepthAccessor.RedirectDepthBuilder<B extends org.refcodes.net.RedirectDepthAccessor.RedirectDepthBuilder<B>>, org.refcodes.net.RedirectDepthAccessor.RedirectDepthMutator, org.refcodes.net.RedirectDepthAccessor.RedirectDepthProperty

Nested classes/interfaces inherited from interface org.refcodes.net.UrlAccessor

org.refcodes.net.UrlAccessor.UrlBuilder, org.refcodes.net.UrlAccessor.UrlMutator, org.refcodes.net.UrlAccessor.UrlProperty

Field Summary

Fields inherited from interface org.refcodes.net.HttpClientRequest

DEFAULT_REDIRECT_DEPTH

Method Summary

Modifier and Type	Method	Description
default org.refcodes.net.FormFields	getQueryFields()
RestResponseObserver	getResponseObserver()	Retrieves the RestResponseObserver to which any responses are delegated upon invocation of the RestResponseObserver.onResponse(RestResponseEvent) method.
default void	setQueryFields(org.refcodes.net.FormFields aQueryFields)
void	setResponseObserver(RestResponseObserver aLambda)	Sets the RestResponseObserver to which any responses are delegated upon invocation of the RestResponseObserver.onResponse(RestResponseEvent) method.
default RestCallerBuilder	withClose()
default RestCallerBuilder	withCloseIn(int aCloseInMillis)
default RestCallerBuilder	withCloseQuietly()
default RestCallerBuilder	withHeaderFields(org.refcodes.net.RequestHeaderFields aRequestHeaderFields)
default RestCallerBuilder	withHttpMethod(org.refcodes.net.HttpMethod aHttpMethod)
default RestCallerBuilder	withOpen()
default <REQ> RestCallerBuilder	withRequest(REQ aRequest)
default RestCallerBuilder	withResponseObserver(RestResponseObserver aLambda)	Builder method for setting the RestResponseObserver.
default RestCallerBuilder	withUrl(org.refcodes.net.Url aUrl)

Methods inherited from interface org.refcodes.component.Closable

close, closeIn, closeQuietly, closeUnchecked

Methods inherited from interface org.refcodes.component.Closable.CloseBuilder

withCloseUnchecked

Methods inherited from interface org.refcodes.component.ConnectionStatusAccessor

getConnectionStatus, isConnectionOpened

Methods inherited from interface org.refcodes.net.HeaderFieldsAccessor.HeaderFieldsMutator

setHeaderFields

Methods inherited from interface org.refcodes.net.HttpClientRequest

getRequest, setRequest, toHttpBody

Methods inherited from interface org.refcodes.net.HttpClientRequest.HttpClientRequestBuilder

withRedirectDepth

Methods inherited from interface org.refcodes.net.HttpMethodAccessor

getHttpMethod

Methods inherited from interface org.refcodes.net.HttpMethodAccessor.HttpMethodMutator

setHttpMethod

Methods inherited from interface org.refcodes.net.HttpRequestBuilder

withAddToHeaderFields, withAddToHeaderFields, withAddToHeaderFields, withAddToHeaderFields, withAddToHeaderFields, withAddToQueryFields, withAddToQueryFields, withAddToQueryFields

Methods inherited from interface org.refcodes.component.Openable

open, openUnchecked

Methods inherited from interface org.refcodes.component.Openable.OpenBuilder

withOpenUnchecked

Methods inherited from interface org.refcodes.net.RedirectDepthAccessor

getRedirectDepth

Methods inherited from interface org.refcodes.net.RedirectDepthAccessor.RedirectDepthMutator

setRedirectDepth

Methods inherited from interface org.refcodes.rest.RestResponseObserver

onResponse

Methods inherited from interface org.refcodes.net.UrlAccessor

getUrl

Methods inherited from interface org.refcodes.net.UrlAccessor.UrlMutator

setUrl

Method Detail

setQueryFields

default void setQueryFields(org.refcodes.net.FormFields aQueryFields)

Specified by:

setQueryFields in interface org.refcodes.net.QueryFieldsAccessor.QueryFieldsMutator

getQueryFields

default org.refcodes.net.FormFields getQueryFields()

Specified by:

getQueryFields in interface org.refcodes.net.QueryFieldsAccessor

withUrl

default RestCallerBuilder withUrl(org.refcodes.net.Url aUrl)

Specified by:

withUrl in interface org.refcodes.net.UrlAccessor.UrlBuilder

withHttpMethod

default RestCallerBuilder withHttpMethod(org.refcodes.net.HttpMethod aHttpMethod)

Specified by:

withHttpMethod in interface org.refcodes.net.HttpMethodAccessor.HttpMethodBuilder<RestCallerBuilder>

withRequest

default <REQ> RestCallerBuilder withRequest(REQ aRequest)

Specified by:

withRequest in interface org.refcodes.net.HttpClientRequest.HttpClientRequestBuilder

getResponseObserver

RestResponseObserver getResponseObserver()

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

Returns:

The (user defined) RestResponseObserver to handle responses.

setResponseObserver

void setResponseObserver(RestResponseObserver aLambda)

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

Parameters:

aLambda - The (user defined) RestResponseObserver to handle responses, feel free to code it as lambda expression!

withResponseObserver

default RestCallerBuilder withResponseObserver(RestResponseObserver aLambda)

Builder method for setting the RestResponseObserver.

Parameters:

aLambda - The (user defined) RestResponseObserver to handle responses, feel free to code it as lambda expression

Returns:

The RestCallerBuilder for the sake of a fluent API.

withHeaderFields

default RestCallerBuilder withHeaderFields(org.refcodes.net.RequestHeaderFields aRequestHeaderFields)

Specified by:

withHeaderFields in interface org.refcodes.net.HeaderFieldsAccessor.HeaderFieldsBuilder<org.refcodes.net.RequestHeaderFields,RestCallerBuilder>

withOpen

default RestCallerBuilder withOpen()
                            throws org.refcodes.component.OpenException

Specified by:

withOpen in interface org.refcodes.component.Openable.OpenBuilder<org.refcodes.net.RequestHeaderFields>

Throws:

org.refcodes.component.OpenException

withClose

default RestCallerBuilder withClose()
                             throws org.refcodes.component.CloseException

Specified by:

withClose in interface org.refcodes.component.Closable.CloseBuilder<org.refcodes.net.RequestHeaderFields>

Throws:

org.refcodes.component.CloseException

withCloseQuietly

default RestCallerBuilder withCloseQuietly()

Specified by:

withCloseQuietly in interface org.refcodes.component.Closable.CloseBuilder<org.refcodes.net.RequestHeaderFields>

withCloseIn

default RestCallerBuilder withCloseIn(int aCloseInMillis)

Specified by:

withCloseIn in interface org.refcodes.component.Closable.CloseBuilder<org.refcodes.net.RequestHeaderFields>