net.eusashead.parquet.http.response.impl

Class ResponseBuilderImpl

java.lang.Object

net.eusashead.parquet.http.response.impl.ResponseBuilderImpl

All Implemented Interfaces:

net.eusashead.parquet.entity.MutableEntity, DeleteResponseBuilder, ErrorResponseBuilder, ETagResponseBuilder, GetResponseBuilder, OptionsResponseBuilder, PatchResponseBuilder, PostResponseBuilder, PutResponseBuilder, ResponseBuilder

Direct Known Subclasses:

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

public abstract class ResponseBuilderImpl
extends java.lang.Object
implements ResponseBuilder, OptionsResponseBuilder, GetResponseBuilder, PutResponseBuilder, PatchResponseBuilder, PostResponseBuilder, DeleteResponseBuilder, ErrorResponseBuilder

Field Summary

Fields

Modifier and Type	Field and Description
protected net.eusashead.parquet.entity.EntityBuilder	entityBuilder
protected net.eusashead.parquet.entity.EntityFactory	entityFactory
protected HashStrategy	hashStrategy
protected org.vertx.java.core.logging.Logger	logger
protected Request	request
protected Response	response
protected Serializer	serializer

Constructor Summary

Constructors

Constructor and Description
ResponseBuilderImpl(Request request, Response response, net.eusashead.parquet.entity.EntityFactory entityFactory, Serializer serializer, HashStrategy hashStrategy, org.vertx.java.core.logging.Logger logger)

Method Summary

Methods

Modifier and Type	Method and Description
protected void	addVaryHeader() Add the Vary header
OptionsResponseBuilder	allow(HttpMethod... methods) Add the supplied methods to the Allow header
ResponseBuilderImpl	body(net.eusashead.parquet.entity.Entity entity) Set the body to the supplied Entity
<T> ResponseBuilderImpl	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.
void	checkPrecondition(net.eusashead.parquet.util.Option<ETag> eTag, net.eusashead.parquet.util.Option<HttpDate> lastModified, PreconditionSuccessHandler handler, boolean require)
ResponseBuilderImpl	embed(java.lang.String rel, net.eusashead.parquet.entity.Entity entity)
<T> ResponseBuilderImpl	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
ResponseBuilderImpl	eTag() Set a weak validating ETag using a hash of the embedded entity.
ResponseBuilderImpl	eTag(ETag eTag) Set the ETag header
ResponseBuilderImpl	expires(java.lang.Long millis) Set the expiry time in milliseconds that this resource should be cached for Sets Date, CacheControl and Expires headers
<T> ResponseBuilderImpl	forEach(java.lang.String rel, java.lang.Iterable<T> target, net.eusashead.parquet.entity.EntityConverter<T> converter)
ResponseBuilderImpl	lastModified(HttpDate lastModified) Set the Last-Modified header to the specified Date
ResponseBuilderImpl	link(net.eusashead.parquet.entity.Link link)
ResponseBuilderImpl	location(java.net.URI location) Add the supplied methods to the Allow header
ResponseBuilderImpl	message(java.lang.String message)
ResponseBuilderImpl	property(java.lang.String name, java.lang.Object value)
ResponseBuilderImpl	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.
protected Body	serialize()
ResponseBuilderImpl	status(HttpStatus status) HTTP status code to send

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface net.eusashead.parquet.http.response.ResponseBuilder

send

Field Detail

request

protected final Request request

response

protected final Response response

serializer

protected final Serializer serializer

entityFactory

protected final net.eusashead.parquet.entity.EntityFactory entityFactory

entityBuilder

protected final net.eusashead.parquet.entity.EntityBuilder entityBuilder

logger

protected final org.vertx.java.core.logging.Logger logger

hashStrategy

protected final HashStrategy hashStrategy

Constructor Detail

ResponseBuilderImpl

public ResponseBuilderImpl(Request request,
                   Response response,
                   net.eusashead.parquet.entity.EntityFactory entityFactory,
                   Serializer serializer,
                   HashStrategy hashStrategy,
                   org.vertx.java.core.logging.Logger logger)

Method Detail

request

public Request request()

Description copied from interface: ResponseBuilder

Get the underlying Request

Specified by:

request in interface ResponseBuilder

Returns:

the current Request

status

public ResponseBuilderImpl status(HttpStatus status)

Description copied from interface: ResponseBuilder

HTTP status code to send

Specified by:

status in interface DeleteResponseBuilder

Specified by:

status in interface ErrorResponseBuilder

Specified by:

status in interface GetResponseBuilder

Specified by:

status in interface OptionsResponseBuilder

Specified by:

status in interface PatchResponseBuilder

Specified by:

status in interface PostResponseBuilder

Specified by:

status in interface PutResponseBuilder

Specified by:

status in interface ResponseBuilder

Parameters:

status - HttpStatus to use

Returns:

this ResponseBuilder

message

public ResponseBuilderImpl message(java.lang.String message)

Specified by:

message in interface ErrorResponseBuilder

eTag

public ResponseBuilderImpl eTag()

Description copied from interface: ETagResponseBuilder

Set a weak validating ETag using a hash of the embedded entity. The hash is created using the HashStrategy specified for this ResponseBuilder on the string returned from the Entity toString() method. Note: If the Entity state is modified after the ETag is created it will not be valid

Specified by:

eTag in interface ETagResponseBuilder

Specified by:

eTag in interface GetResponseBuilder

Specified by:

eTag in interface PatchResponseBuilder

Specified by:

eTag in interface PostResponseBuilder

Specified by:

eTag in interface PutResponseBuilder

Returns:

this ETagResponseBuilder

eTag

public ResponseBuilderImpl eTag(ETag eTag)

Description copied from interface: ETagResponseBuilder

Set the ETag header

Specified by:

eTag in interface ETagResponseBuilder

Specified by:

eTag in interface GetResponseBuilder

Specified by:

eTag in interface PatchResponseBuilder

Specified by:

eTag in interface PostResponseBuilder

Specified by:

eTag in interface PutResponseBuilder

Parameters:

eTag - ETag

Returns:

this ETagResponseBuilder

lastModified

public ResponseBuilderImpl lastModified(HttpDate lastModified)

Description copied from interface: ETagResponseBuilder

Set the Last-Modified header to the specified Date

Specified by:

lastModified in interface ETagResponseBuilder

Specified by:

lastModified in interface GetResponseBuilder

Specified by:

lastModified in interface PatchResponseBuilder

Specified by:

lastModified in interface PostResponseBuilder

Specified by:

lastModified in interface PutResponseBuilder

Parameters:

lastModified - Date this entity last changed

Returns:

this ETagResponseBuilder

expires

public ResponseBuilderImpl expires(java.lang.Long millis)

Description copied from interface: GetResponseBuilder

Set the expiry time in milliseconds that this resource should be cached for Sets Date, CacheControl and Expires headers

Specified by:

expires in interface GetResponseBuilder

Parameters:

millis - Long expiry time in milliseconds

Returns:

this GetResponseBuilder

location

public ResponseBuilderImpl location(java.net.URI location)

Description copied from interface: PostResponseBuilder

Add the supplied methods to the Allow header

Specified by:

location in interface PostResponseBuilder

allow

public OptionsResponseBuilder allow(HttpMethod... methods)

Description copied from interface: OptionsResponseBuilder

Add the supplied methods to the Allow header

Specified by:

allow in interface OptionsResponseBuilder

property

public ResponseBuilderImpl property(java.lang.String name,
                           java.lang.Object value)

Specified by:

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

Specified by:

property in interface DeleteResponseBuilder

Specified by:

property in interface ErrorResponseBuilder

Specified by:

property in interface GetResponseBuilder

Specified by:

property in interface OptionsResponseBuilder

Specified by:

property in interface PatchResponseBuilder

Specified by:

property in interface PostResponseBuilder

Specified by:

property in interface PutResponseBuilder

Specified by:

property in interface ResponseBuilder

property

public ResponseBuilderImpl 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

Specified by:

property in interface DeleteResponseBuilder

Specified by:

property in interface ErrorResponseBuilder

Specified by:

property in interface GetResponseBuilder

Specified by:

property in interface OptionsResponseBuilder

Specified by:

property in interface PatchResponseBuilder

Specified by:

property in interface PostResponseBuilder

Specified by:

property in interface PutResponseBuilder

Specified by:

property in interface ResponseBuilder

embed

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

Specified by:

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

Specified by:

embed in interface DeleteResponseBuilder

Specified by:

embed in interface ErrorResponseBuilder

Specified by:

embed in interface GetResponseBuilder

Specified by:

embed in interface OptionsResponseBuilder

Specified by:

embed in interface PatchResponseBuilder

Specified by:

embed in interface PostResponseBuilder

Specified by:

embed in interface PutResponseBuilder

Specified by:

embed in interface ResponseBuilder

embed

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

Specified by:

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

Specified by:

embed in interface DeleteResponseBuilder

Specified by:

embed in interface ErrorResponseBuilder

Specified by:

embed in interface GetResponseBuilder

Specified by:

embed in interface OptionsResponseBuilder

Specified by:

embed in interface PatchResponseBuilder

Specified by:

embed in interface PostResponseBuilder

Specified by:

embed in interface PutResponseBuilder

Specified by:

embed in interface ResponseBuilder

forEach

public <T> ResponseBuilderImpl 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

Specified by:

forEach in interface DeleteResponseBuilder

Specified by:

forEach in interface ErrorResponseBuilder

Specified by:

forEach in interface GetResponseBuilder

Specified by:

forEach in interface OptionsResponseBuilder

Specified by:

forEach in interface PatchResponseBuilder

Specified by:

forEach in interface PostResponseBuilder

Specified by:

forEach in interface PutResponseBuilder

Specified by:

forEach in interface ResponseBuilder

link

public ResponseBuilderImpl link(net.eusashead.parquet.entity.Link link)

Specified by:

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

Specified by:

link in interface DeleteResponseBuilder

Specified by:

link in interface ErrorResponseBuilder

Specified by:

link in interface GetResponseBuilder

Specified by:

link in interface OptionsResponseBuilder

Specified by:

link in interface PatchResponseBuilder

Specified by:

link in interface PostResponseBuilder

Specified by:

link in interface PutResponseBuilder

Specified by:

link in interface ResponseBuilder

body

public ResponseBuilderImpl body(net.eusashead.parquet.entity.Entity entity)

Description copied from interface: ResponseBuilder

Set the body to the supplied Entity

Specified by:

body in interface DeleteResponseBuilder

Specified by:

body in interface ErrorResponseBuilder

Specified by:

body in interface GetResponseBuilder

Specified by:

body in interface OptionsResponseBuilder

Specified by:

body in interface PatchResponseBuilder

Specified by:

body in interface PostResponseBuilder

Specified by:

body in interface PutResponseBuilder

Specified by:

body in interface ResponseBuilder

Returns:

this ResponseBuilder

body

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

Specified by:

body in interface ErrorResponseBuilder

Specified by:

body in interface GetResponseBuilder

Specified by:

body in interface ResponseBuilder

Returns:

entityFactory

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

Description copied from interface: ResponseBuilder

Get the EntityFactory used to build the body of this response

Specified by:

entityFactory in interface ResponseBuilder

Returns:

the EntityFactory for this ResponseBuilder

build

public Response build()

Description copied from interface: ResponseBuilder

Return the built Response

Specified by:

build in interface ResponseBuilder

Returns:

the Response object

serialize

protected Body serialize()

checkPrecondition

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

Description copied from interface: ResponseBuilder

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.

Specified by:

checkPrecondition in interface ResponseBuilder

Parameters:

eTag - ETag value for current resource

lastModified - Last-Modified date for current resource

handler - PreconditionSuccessHandler action to execute if precondition succeeds

requirePrecondition

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

Description copied from interface: ResponseBuilder

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.

Specified by:

requirePrecondition in interface ResponseBuilder

Parameters:

eTag - ETag value for current resource

lastModified - Last-Modified date for current resource

handler - PreconditionSuccessHandler action to execute if precondition succeeds

checkPrecondition

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

addVaryHeader

protected void addVaryHeader()

Add the Vary header

Parameters:

request -