net.eusashead.parquet.http.response

Interface ResponseBuilder

All Superinterfaces:

net.eusashead.parquet.entity.MutableEntity

All Known Subinterfaces:

DeleteResponseBuilder, ErrorResponseBuilder, ETagResponseBuilder, GetResponseBuilder, OptionsResponseBuilder, PatchResponseBuilder, PostResponseBuilder, PutResponseBuilder

All Known Implementing Classes:

DeleteResponseBuilderImpl, ErrorResponseBuilderImpl, GetResponseBuilderImpl, OptionsResponseBuilderImpl, PatchResponseBuilderImpl, PostResponseBuilderImpl, PutResponseBuilderImpl, ResponseBuilderImpl

public interface ResponseBuilder
extends net.eusashead.parquet.entity.MutableEntity

Method Summary

Methods

Modifier and Type	Method and Description
ResponseBuilder	body(net.eusashead.parquet.entity.Entity entity) Set the body to the supplied Entity
<T> ResponseBuilder	body(T target, net.eusashead.parquet.entity.EntityConverter<T> converter)
Response	build() Return the built Response
void	checkPrecondition(net.eusashead.parquet.util.Option<ETag> eTag, net.eusashead.parquet.util.Option<HttpDate> lastModified, PreconditionSuccessHandler handler) Check precondition before executing the PreconditionSuccessHandler Check value of If-Match, If-Unmodified-Since If-None-Match and If-Modified-Since and return either 412 or 304 (for GET or HEAD only) if the precondition fails.
ResponseBuilder	embed(java.lang.String rel, net.eusashead.parquet.entity.Entity entity)
<T> ResponseBuilder	embed(java.lang.String rel, T target, net.eusashead.parquet.entity.EntityConverter<T> converter)
net.eusashead.parquet.entity.EntityFactory	entityFactory() Get the EntityFactory used to build the body of this response
<T> ResponseBuilder	forEach(java.lang.String rel, java.lang.Iterable<T> target, net.eusashead.parquet.entity.EntityConverter<T> converter)
ResponseBuilder	link(net.eusashead.parquet.entity.Link link)
ResponseBuilder	property(java.lang.String name, java.lang.Object value)
ResponseBuilder	property(java.lang.String name, java.lang.Object value, net.eusashead.parquet.entity.PropertyConverter<?,java.lang.Object> converter)
Request	request() Get the underlying Request
void	requirePrecondition(net.eusashead.parquet.util.Option<ETag> eTag, net.eusashead.parquet.util.Option<HttpDate> lastModified, PreconditionSuccessHandler handler) Require a precondition check before executing the PreconditionSuccessHandler returning an error if the check fails or if the precondition headers are absent Check value of If-Match, If-Unmodified-Since If-None-Match and If-Modified-Since and return either 412 or 304 (for GET or HEAD only) if the precondition fails.
void	send() Send the response
ResponseBuilder	status(HttpStatus status) HTTP status code to send

Method Detail

request

Request request()

Get the underlying Request

Returns:

the current Request

status

ResponseBuilder status(HttpStatus status)

HTTP status code to send

Parameters:

status - HttpStatus to use

Returns:

this ResponseBuilder

send

void send()

Send the response

build

Response build()

Return the built Response

Returns:

the Response object

entityFactory

net.eusashead.parquet.entity.EntityFactory entityFactory()

Get the EntityFactory used to build the body of this response

Returns:

the EntityFactory for this ResponseBuilder

body

ResponseBuilder body(net.eusashead.parquet.entity.Entity entity)

Set the body to the supplied Entity

Parameters:

entity -

Returns:

this ResponseBuilder

body

<T> ResponseBuilder body(T target,
                       net.eusashead.parquet.entity.EntityConverter<T> converter)

Parameters:

target -

converter -

Returns:

checkPrecondition

void checkPrecondition(net.eusashead.parquet.util.Option<ETag> eTag,
                     net.eusashead.parquet.util.Option<HttpDate> lastModified,
                     PreconditionSuccessHandler handler)

Check precondition before executing the PreconditionSuccessHandler Check value of If-Match, If-Unmodified-Since If-None-Match and If-Modified-Since and return either 412 or 304 (for GET or HEAD only) if the precondition fails.

Parameters:

eTag - ETag value for current resource

lastModified - Last-Modified date for current resource

handler - PreconditionSuccessHandler action to execute if precondition succeeds

requirePrecondition

void requirePrecondition(net.eusashead.parquet.util.Option<ETag> eTag,
                       net.eusashead.parquet.util.Option<HttpDate> lastModified,
                       PreconditionSuccessHandler handler)

Require a precondition check before executing the PreconditionSuccessHandler returning an error if the check fails or if the precondition headers are absent Check value of If-Match, If-Unmodified-Since If-None-Match and If-Modified-Since and return either 412 or 304 (for GET or HEAD only) if the precondition fails. If none of the headers above are supplied return a 428 error.

Parameters:

eTag - ETag value for current resource

lastModified - Last-Modified date for current resource

handler - PreconditionSuccessHandler action to execute if precondition succeeds

property

ResponseBuilder property(java.lang.String name,
                       java.lang.Object value)

Specified by:

property in interface net.eusashead.parquet.entity.MutableEntity

property

ResponseBuilder property(java.lang.String name,
                       java.lang.Object value,
                       net.eusashead.parquet.entity.PropertyConverter<?,java.lang.Object> converter)

Specified by:

property in interface net.eusashead.parquet.entity.MutableEntity

embed

ResponseBuilder embed(java.lang.String rel,
                    net.eusashead.parquet.entity.Entity entity)

Specified by:

embed in interface net.eusashead.parquet.entity.MutableEntity

embed

<T> ResponseBuilder embed(java.lang.String rel,
                        T target,
                        net.eusashead.parquet.entity.EntityConverter<T> converter)

Specified by:

embed in interface net.eusashead.parquet.entity.MutableEntity

forEach

<T> ResponseBuilder forEach(java.lang.String rel,
                          java.lang.Iterable<T> target,
                          net.eusashead.parquet.entity.EntityConverter<T> converter)

Specified by:

forEach in interface net.eusashead.parquet.entity.MutableEntity

link

ResponseBuilder link(net.eusashead.parquet.entity.Link link)

Specified by:

link in interface net.eusashead.parquet.entity.MutableEntity