net.eusashead.hateoas.hal.response

Interface HalResponseBuilder

All Superinterfaces:

net.eusashead.hateoas.response.ResponseBuilder<com.theoryinpractise.halbuilder.api.Representation>

All Known Implementing Classes:

HalResponseBuilderImpl

public interface HalResponseBuilder
extends net.eusashead.hateoas.response.ResponseBuilder<com.theoryinpractise.halbuilder.api.Representation>

Create an appropriate response to a HTTP GET or HEAD request. The returned ResponseEntity should have status code 200 and should have a body of type Representation, or a null body for a HEAD. It should have ETags, Last-Modified, Expires and Cache-Control headers.

Author:

patrickvk

Method Summary

Methods

Modifier and Type	Method and Description
HalResponseBuilder	convert(Object bean) Set the underlying Representation by converting the supplied Object into a Representation using the default conversion mechanism.
<T> HalResponseBuilder	convert(T bean, RepresentationWriter<T> writer) Set the underlying Representation by converting the supplied Object into a Representation using the supplied RepresentationWriter in favour of the default conversion mechanism.
HalResponseBuilder	etag() Create ETag header based on the best available ETagStrategy
HalResponseBuilder	etag(Date date) Create a weak ETag based on the supplied date
HalResponseBuilder	etag(net.eusashead.hateoas.header.ETagHeaderStrategy strategy) Create ETag header based on the supplied ETagStrategy
HalResponseBuilder	etag(Integer version) Create a strong ETag based on the supplied version number
HalResponseBuilder	etag(Long version) Create a strong ETag based on the supplied version number
HalResponseBuilder	expireIn(long millis) Set the the Expires and Cache-Control headers based on the supplied number of milliseconds
HalResponseBuilder	lastModified(Date date) Set the Last-Modified header based on the supplied date
HalResponseBuilder	representation(com.theoryinpractise.halbuilder.api.Representation representation) Set the HAL Representation that this response represents
HalResponseBuilder	withBean(Object value) Copy the fields from the supplied Java Bean as properties of the wrapped Representation (entity)
HalResponseBuilder	withBeanBasedRepresentation(String rel, String href, Object o) Add the supplied bean as an embedded Representation within the wrapped Representation with the specified rel and href.
HalResponseBuilder	withLink(String rel, String href) Add a link to the wrapped Representation
HalResponseBuilder	withNamespace(String namespace, String href) Add a namespace to the wrapped Representation
HalResponseBuilder	withProperty(String name, Object value) Add the supplied property to the wrapped Representation
HalResponseBuilder	withRepresentation(String rel, com.theoryinpractise.halbuilder.api.ReadableRepresentation resource) Add the supplied Representation to the wrapped Representation as an embedded resource.

Methods inherited from interface net.eusashead.hateoas.response.ResponseBuilder

addHeader, addHeader, build, getRequest

Method Detail

withProperty

HalResponseBuilder withProperty(String name,
                              Object value)

Add the supplied property to the wrapped Representation

Parameters:

name -

value -

Returns:

this HalResponseBuilder

withRepresentation

HalResponseBuilder withRepresentation(String rel,
                                    com.theoryinpractise.halbuilder.api.ReadableRepresentation resource)

Add the supplied Representation to the wrapped Representation as an embedded resource.

Parameters:

rel -

resource -

Returns:

this HalResponseBuilder

withLink

HalResponseBuilder withLink(String rel,
                          String href)

Add a link to the wrapped Representation

Parameters:

rel -

href -

Returns:

this HalResponseBuilder

withNamespace

HalResponseBuilder withNamespace(String namespace,
                               String href)

Add a namespace to the wrapped Representation

Parameters:

namespace -

href -

Returns:

this HalResponseBuilder

withBean

HalResponseBuilder withBean(Object value)

Copy the fields from the supplied Java Bean as properties of the wrapped Representation (entity)

Parameters:

value -

Returns:

this HalResponseBuilder

withBeanBasedRepresentation

HalResponseBuilder withBeanBasedRepresentation(String rel,
                                             String href,
                                             Object o)

Add the supplied bean as an embedded Representation within the wrapped Representation with the specified rel and href.

Parameters:

rel - the name of the embedded representation

href - the URI of the representation

o - the Java Bean object to create the representation from

Returns:

this HalResponseBuilder

representation

HalResponseBuilder representation(com.theoryinpractise.halbuilder.api.Representation representation)

Set the HAL Representation that this response represents

Parameters:

the - Representation to set

Returns:

this HalResponseBuilder

convert

HalResponseBuilder convert(Object bean)

Set the underlying Representation by converting the supplied Object into a Representation using the default conversion mechanism.

Parameters:

bean - the Object to convert

Returns:

this HalResponseBuilder

convert

<T> HalResponseBuilder convert(T bean,
                             RepresentationWriter<T> writer)

Set the underlying Representation by converting the supplied Object into a Representation using the supplied RepresentationWriter in favour of the default conversion mechanism.

Parameters:

bean - the Object to convert

writer - the RepresentationWriter to perform the conversion

Returns:

this HalResponseBuilder

etag

HalResponseBuilder etag()

Create ETag header based on the best available ETagStrategy

Returns:

this HalResponseBuilder

etag

HalResponseBuilder etag(net.eusashead.hateoas.header.ETagHeaderStrategy strategy)

Create ETag header based on the supplied ETagStrategy

Returns:

this HalResponseBuilder

etag

HalResponseBuilder etag(Date date)

Create a weak ETag based on the supplied date

Parameters:

date - Date of last modification

Returns:

this HalResponseBuilder

etag

HalResponseBuilder etag(Integer version)

Create a strong ETag based on the supplied version number

Parameters:

version - Integer version number

Returns:

this HalResponseBuilder

etag

HalResponseBuilder etag(Long version)

Create a strong ETag based on the supplied version number

Parameters:

version - Long version number

Returns:

this HalResponseBuilder

lastModified

HalResponseBuilder lastModified(Date date)

Set the Last-Modified header based on the supplied date

Parameters:

date - Date of last modification

Returns:

this HalResponseBuilder

expireIn

HalResponseBuilder expireIn(long millis)

Set the the Expires and Cache-Control headers based on the supplied number of milliseconds

Parameters:

millis -

Returns:

this HalResponseBuilder