net.eusashead.hateoas.hal.response.impl

Class HalResponseBuilderImpl

java.lang.Object

net.eusashead.hateoas.response.impl.AbstractResponseBuilder<T>

net.eusashead.hateoas.response.impl.AbstractEntityResponseBuilder<com.theoryinpractise.halbuilder.api.Representation,com.theoryinpractise.halbuilder.api.Representation>

net.eusashead.hateoas.hal.response.impl.AbstractHalResponseBuilder

net.eusashead.hateoas.hal.response.impl.HalResponseBuilderImpl

All Implemented Interfaces:

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

public class HalResponseBuilderImpl
extends AbstractHalResponseBuilder
implements HalResponseBuilder

ResponseBuilder that enables a HAL Representation to be constructed for the response. It exposes a similar API to the HALBuilder Representation but automates the URI for the "self" link to be that of the incoming request (which is probably what you would want). It also contains the methods for adding ETag, Last-Modified, Date, Cache-Control and Expires headers to help with caching and bandwidth conservation.

Author:

patrickvk

Field Summary

Fields inherited from class net.eusashead.hateoas.hal.response.impl.AbstractHalResponseBuilder

representationFactory, uri

Fields inherited from class net.eusashead.hateoas.response.impl.AbstractEntityResponseBuilder

entity

Fields inherited from class net.eusashead.hateoas.response.impl.AbstractResponseBuilder

headers, request

Constructor Summary

Constructors

Constructor and Description
HalResponseBuilderImpl(com.theoryinpractise.halbuilder.api.RepresentationFactory representationFactory, javax.servlet.http.HttpServletRequest request)

Method Summary

Methods

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

Methods inherited from class net.eusashead.hateoas.hal.response.impl.AbstractHalResponseBuilder

assertVerb

Methods inherited from class net.eusashead.hateoas.response.impl.AbstractEntityResponseBuilder

assertEntity, buildResponseEntity, setEntity, setEtagHeader, setEtagHeader

Methods inherited from class net.eusashead.hateoas.response.impl.AbstractResponseBuilder

addHeader, addHeader, compareEtagWithIfNoneMatch, getRequest, setEtagHeader, setEtagHeader, setEtagHeader, setExpiryHeaders, setLastModifiedHeader

Methods inherited from class java.lang.Object

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

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

addHeader, addHeader, getRequest

Constructor Detail

HalResponseBuilderImpl

public HalResponseBuilderImpl(com.theoryinpractise.halbuilder.api.RepresentationFactory representationFactory,
                      javax.servlet.http.HttpServletRequest request)

Method Detail

withProperty

public HalResponseBuilderImpl withProperty(String name,
                                  Object value)

Description copied from interface: HalResponseBuilder

Add the supplied property to the wrapped Representation

Specified by:

withProperty in interface HalResponseBuilder

Returns:

this HalResponseBuilder

withRepresentation

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

Description copied from interface: HalResponseBuilder

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

Specified by:

withRepresentation in interface HalResponseBuilder

Returns:

this HalResponseBuilder

withLink

public HalResponseBuilderImpl withLink(String rel,
                              String href)

Description copied from interface: HalResponseBuilder

Add a link to the wrapped Representation

Specified by:

withLink in interface HalResponseBuilder

Returns:

this HalResponseBuilder

withNamespace

public HalResponseBuilderImpl withNamespace(String namespace,
                                   String href)

Description copied from interface: HalResponseBuilder

Add a namespace to the wrapped Representation

Specified by:

withNamespace in interface HalResponseBuilder

Returns:

this HalResponseBuilder

withBean

public HalResponseBuilderImpl withBean(Object value)

Description copied from interface: HalResponseBuilder

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

Specified by:

withBean in interface HalResponseBuilder

Returns:

this HalResponseBuilder

withBeanBasedRepresentation

public HalResponseBuilderImpl withBeanBasedRepresentation(String rel,
                                                 String href,
                                                 Object o)

Description copied from interface: HalResponseBuilder

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

Specified by:

withBeanBasedRepresentation in interface HalResponseBuilder

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

public HalResponseBuilderImpl representation(com.theoryinpractise.halbuilder.api.Representation representation)

Description copied from interface: HalResponseBuilder

Set the HAL Representation that this response represents

Specified by:

representation in interface HalResponseBuilder

Returns:

this HalResponseBuilder

convert

public HalResponseBuilderImpl convert(Object bean)

Description copied from interface: HalResponseBuilder

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

Specified by:

convert in interface HalResponseBuilder

Parameters:

bean - the Object to convert

Returns:

this HalResponseBuilder

convert

public <T> HalResponseBuilderImpl convert(T bean,
                                 RepresentationWriter<T> writer)

Description copied from interface: HalResponseBuilder

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

Specified by:

convert in interface HalResponseBuilder

Parameters:

bean - the Object to convert

writer - the RepresentationWriter to perform the conversion

Returns:

this HalResponseBuilder

etag

public HalResponseBuilderImpl etag()

Description copied from interface: HalResponseBuilder

Create ETag header based on the best available ETagStrategy

Specified by:

etag in interface HalResponseBuilder

Returns:

this HalResponseBuilder

etag

public HalResponseBuilderImpl etag(net.eusashead.hateoas.header.ETagHeaderStrategy strategy)

Description copied from interface: HalResponseBuilder

Create ETag header based on the supplied ETagStrategy

Specified by:

etag in interface HalResponseBuilder

Returns:

this HalResponseBuilder

etag

public HalResponseBuilderImpl etag(Date date)

Description copied from interface: HalResponseBuilder

Create a weak ETag based on the supplied date

Specified by:

etag in interface HalResponseBuilder

Parameters:

date - Date of last modification

Returns:

this HalResponseBuilder

etag

public HalResponseBuilderImpl etag(Integer version)

Description copied from interface: HalResponseBuilder

Create a strong ETag based on the supplied version number

Specified by:

etag in interface HalResponseBuilder

Parameters:

version - Integer version number

Returns:

this HalResponseBuilder

etag

public HalResponseBuilderImpl etag(Long version)

Description copied from interface: HalResponseBuilder

Create a strong ETag based on the supplied version number

Specified by:

etag in interface HalResponseBuilder

Parameters:

version - Long version number

Returns:

this HalResponseBuilder

lastModified

public HalResponseBuilderImpl lastModified(Date date)

Description copied from interface: HalResponseBuilder

Set the Last-Modified header based on the supplied date

Specified by:

lastModified in interface HalResponseBuilder

Parameters:

date - Date of last modification

Returns:

this HalResponseBuilder

expireIn

public HalResponseBuilderImpl expireIn(long millis)

Description copied from interface: HalResponseBuilder

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

Specified by:

expireIn in interface HalResponseBuilder

Returns:

this HalResponseBuilder

build

public org.springframework.http.ResponseEntity<com.theoryinpractise.halbuilder.api.Representation> build()

Specified by:

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