A B C E G H L M N R S U W

A

AbstractHalResponseBuilder - Class in net.eusashead.hateoas.hal.response.impl

Abstract class from which HAL Representation ResponseEntity can be constructed using HALBuilder

AbstractHalResponseBuilder(RepresentationFactory, HttpServletRequest) - Constructor for class net.eusashead.hateoas.hal.response.impl.AbstractHalResponseBuilder

Construct a ResponseBuilder with the supplied RepresentationFactory and HttpServletRequest

addModule(HalHttpMessageConverterModule) - Method in class net.eusashead.hateoas.hal.http.converter.HalHttpMessageConverter

Add a HalHttpMessageConverterModule to handle a conversion

AnnotationAdapterModuleImpl - Class in net.eusashead.hateoas.hal.http.converter.module.impl

Implementation of HalHttpMessageConverterModule that allows manual registration of RepresentationWriter and RepresentationReader for a given Class

AnnotationAdapterModuleImpl() - Constructor for class net.eusashead.hateoas.hal.http.converter.module.impl.AnnotationAdapterModuleImpl

assertVerb() - Method in class net.eusashead.hateoas.hal.response.impl.AbstractHalResponseBuilder

B

build() - Method in class net.eusashead.hateoas.hal.response.impl.HalResponseBuilderImpl

C

canRead(Class<?>, MediaType) - Method in class net.eusashead.hateoas.hal.http.converter.HalHttpMessageConverter

canRead(Class<?>) - Method in interface net.eusashead.hateoas.hal.http.converter.module.HalHttpMessageConverterModule

Can this module read the supplied type?

canRead(Class<?>) - Method in class net.eusashead.hateoas.hal.http.converter.module.impl.AnnotationAdapterModuleImpl

canRead(Class<?>) - Method in class net.eusashead.hateoas.hal.http.converter.module.impl.ManualAdapterModuleImpl

canWrite(Class<?>, MediaType) - Method in class net.eusashead.hateoas.hal.http.converter.HalHttpMessageConverter

canWrite(Class<?>) - Method in interface net.eusashead.hateoas.hal.http.converter.module.HalHttpMessageConverterModule

Can this module write the supplied type?

canWrite(Class<?>) - Method in class net.eusashead.hateoas.hal.http.converter.module.impl.AnnotationAdapterModuleImpl

canWrite(Class<?>) - Method in class net.eusashead.hateoas.hal.http.converter.module.impl.ManualAdapterModuleImpl

CHARSET - Static variable in class net.eusashead.hateoas.hal.http.converter.HalHttpMessageConverter

convert(Object) - Method in interface net.eusashead.hateoas.hal.response.HalResponseBuilder

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

convert(T, RepresentationWriter<T>) - Method in interface net.eusashead.hateoas.hal.response.HalResponseBuilder

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

convert(Object) - Method in class net.eusashead.hateoas.hal.response.impl.HalResponseBuilderImpl

convert(T, RepresentationWriter<T>) - Method in class net.eusashead.hateoas.hal.response.impl.HalResponseBuilderImpl

E

etag() - Method in interface net.eusashead.hateoas.hal.response.HalResponseBuilder

Create ETag header based on the best available ETagStrategy

etag(ETagHeaderStrategy) - Method in interface net.eusashead.hateoas.hal.response.HalResponseBuilder

Create ETag header based on the supplied ETagStrategy

etag(Date) - Method in interface net.eusashead.hateoas.hal.response.HalResponseBuilder

Create a weak ETag based on the supplied date

etag(Integer) - Method in interface net.eusashead.hateoas.hal.response.HalResponseBuilder

Create a strong ETag based on the supplied version number

etag(Long) - Method in interface net.eusashead.hateoas.hal.response.HalResponseBuilder

Create a strong ETag based on the supplied version number

etag() - Method in class net.eusashead.hateoas.hal.response.impl.HalResponseBuilderImpl

etag(ETagHeaderStrategy) - Method in class net.eusashead.hateoas.hal.response.impl.HalResponseBuilderImpl

etag(Date) - Method in class net.eusashead.hateoas.hal.response.impl.HalResponseBuilderImpl

etag(Integer) - Method in class net.eusashead.hateoas.hal.response.impl.HalResponseBuilderImpl

etag(Long) - Method in class net.eusashead.hateoas.hal.response.impl.HalResponseBuilderImpl

expireIn(long) - Method in interface net.eusashead.hateoas.hal.response.HalResponseBuilder

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

expireIn(long) - Method in class net.eusashead.hateoas.hal.response.impl.HalResponseBuilderImpl

G

getModules() - Method in class net.eusashead.hateoas.hal.http.converter.HalHttpMessageConverter

Get the HalHttpMessageConverterModule modules registered with this converter.

H

HAL_JSON - Static variable in class net.eusashead.hateoas.hal.http.converter.HalHttpMessageConverter

HAL_XML - Static variable in class net.eusashead.hateoas.hal.http.converter.HalHttpMessageConverter

HalHttpMessageConverter - Class in net.eusashead.hateoas.hal.http.converter

HttpMessageConverter implementation that handles HAL representations (application/hal+json and (application/hal+xml) using the HALBuilder Representation

HalHttpMessageConverter(RepresentationFactory) - Constructor for class net.eusashead.hateoas.hal.http.converter.HalHttpMessageConverter

HalHttpMessageConverterModule - Interface in net.eusashead.hateoas.hal.http.converter.module

Extends the functionality of the HalHttpMessageConverter by adding modules to handle specific Java types

HalResponseBuilder - Interface in net.eusashead.hateoas.hal.response

Create an appropriate response to a HTTP GET or HEAD request.

HalResponseBuilderHandlerMethodArgumentResolver - Class in net.eusashead.hateoas.hal.response.impl

Enables a HalGetResponseEntityBuilder to be injected as a method parameter in a Spring MVC controller, pre-populated with the HTTP request and other variables

HalResponseBuilderHandlerMethodArgumentResolver(RepresentationFactory) - Constructor for class net.eusashead.hateoas.hal.response.impl.HalResponseBuilderHandlerMethodArgumentResolver

Supply a RepresentationFactory and the name of the HTTP request variable that users can use to specify the included fields in a request

HalResponseBuilderImpl - Class in net.eusashead.hateoas.hal.response.impl

ResponseBuilder that enables a HAL Representation to be constructed for the response.

HalResponseBuilderImpl(RepresentationFactory, HttpServletRequest) - Constructor for class net.eusashead.hateoas.hal.response.impl.HalResponseBuilderImpl

L

lastModified(Date) - Method in interface net.eusashead.hateoas.hal.response.HalResponseBuilder

Set the Last-Modified header based on the supplied date

lastModified(Date) - Method in class net.eusashead.hateoas.hal.response.impl.HalResponseBuilderImpl

M

ManualAdapterModuleImpl - Class in net.eusashead.hateoas.hal.http.converter.module.impl

Implementation of HalHttpMessageConverterModule that allows manual registration of RepresentationWriter and RepresentationReader for a given Class

ManualAdapterModuleImpl() - Constructor for class net.eusashead.hateoas.hal.http.converter.module.impl.ManualAdapterModuleImpl

N

net.eusashead.hateoas.hal.adapter - package net.eusashead.hateoas.hal.adapter

net.eusashead.hateoas.hal.adapter.annotation - package net.eusashead.hateoas.hal.adapter.annotation

net.eusashead.hateoas.hal.http.converter - package net.eusashead.hateoas.hal.http.converter

net.eusashead.hateoas.hal.http.converter.module - package net.eusashead.hateoas.hal.http.converter.module

net.eusashead.hateoas.hal.http.converter.module.impl - package net.eusashead.hateoas.hal.http.converter.module.impl

net.eusashead.hateoas.hal.response - package net.eusashead.hateoas.hal.response

net.eusashead.hateoas.hal.response.impl - package net.eusashead.hateoas.hal.response.impl

R

read(ReadableRepresentation, Class<? extends T>) - Method in interface net.eusashead.hateoas.hal.adapter.RepresentationReader

Convert a HAL ReadableRepresentation to an object of type T

read(ReadableRepresentation, Class<?>) - Method in interface net.eusashead.hateoas.hal.http.converter.module.HalHttpMessageConverterModule

Convert a HAL ReadableRepresentation to an object

read(ReadableRepresentation, Class<?>) - Method in class net.eusashead.hateoas.hal.http.converter.module.impl.AnnotationAdapterModuleImpl

read(ReadableRepresentation, Class<?>) - Method in class net.eusashead.hateoas.hal.http.converter.module.impl.ManualAdapterModuleImpl

readInternal(Class<? extends Object>, HttpInputMessage) - Method in class net.eusashead.hateoas.hal.http.converter.HalHttpMessageConverter

registerReader(RepresentationReader<?>) - Method in class net.eusashead.hateoas.hal.http.converter.module.impl.ManualAdapterModuleImpl

Register a RepresentationReader Note: uses a bit of reflection magic that I feel occasionally a bit nervous about due to type erasure but it seems to work.

registerWriter(RepresentationWriter<?>) - Method in class net.eusashead.hateoas.hal.http.converter.module.impl.ManualAdapterModuleImpl

Register a RepresentationWriter Note: uses a bit of reflection magic that I feel occasionally a bit nervous about due to type erasure but it seems to work.

representation(Representation) - Method in interface net.eusashead.hateoas.hal.response.HalResponseBuilder

Set the HAL Representation that this response represents

representation(Representation) - Method in class net.eusashead.hateoas.hal.response.impl.HalResponseBuilderImpl

representationFactory - Variable in class net.eusashead.hateoas.hal.response.impl.AbstractHalResponseBuilder

RepresentationFactor to create HAL Representations

RepresentationReader<T> - Interface in net.eusashead.hateoas.hal.adapter

Implementations of this class retrieve an object from a HAL ReadableRepresentation

RepresentationReaderAdapter - Annotation Type in net.eusashead.hateoas.hal.adapter.annotation

Specifies the HalReader that can retrieve an object from a HAL ReadableRepresentation

RepresentationWriter<T> - Interface in net.eusashead.hateoas.hal.adapter

Implementations of this class convert Java objects into HAL ReadableRepresentation

RepresentationWriterAdapter - Annotation Type in net.eusashead.hateoas.hal.adapter.annotation

Specifies the HalReader that can write an object to a HAL ReadableRepresentation

resolveArgument(MethodParameter, ModelAndViewContainer, NativeWebRequest, WebDataBinderFactory) - Method in class net.eusashead.hateoas.hal.response.impl.HalResponseBuilderHandlerMethodArgumentResolver

S

supports(Class<?>) - Method in class net.eusashead.hateoas.hal.http.converter.HalHttpMessageConverter

supportsParameter(MethodParameter) - Method in class net.eusashead.hateoas.hal.response.impl.HalResponseBuilderHandlerMethodArgumentResolver

U

uri - Variable in class net.eusashead.hateoas.hal.response.impl.AbstractHalResponseBuilder

URI of the response entity

W

withBean(Object) - Method in interface net.eusashead.hateoas.hal.response.HalResponseBuilder

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

withBean(Object) - Method in class net.eusashead.hateoas.hal.response.impl.HalResponseBuilderImpl

withBeanBasedRepresentation(String, String, Object) - Method in interface net.eusashead.hateoas.hal.response.HalResponseBuilder

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

withBeanBasedRepresentation(String, String, Object) - Method in class net.eusashead.hateoas.hal.response.impl.HalResponseBuilderImpl

withLink(String, String) - Method in interface net.eusashead.hateoas.hal.response.HalResponseBuilder

Add a link to the wrapped Representation

withLink(String, String) - Method in class net.eusashead.hateoas.hal.response.impl.HalResponseBuilderImpl

withNamespace(String, String) - Method in interface net.eusashead.hateoas.hal.response.HalResponseBuilder

Add a namespace to the wrapped Representation

withNamespace(String, String) - Method in class net.eusashead.hateoas.hal.response.impl.HalResponseBuilderImpl

withProperty(String, Object) - Method in interface net.eusashead.hateoas.hal.response.HalResponseBuilder

Add the supplied property to the wrapped Representation

withProperty(String, Object) - Method in class net.eusashead.hateoas.hal.response.impl.HalResponseBuilderImpl

withRepresentation(String, ReadableRepresentation) - Method in interface net.eusashead.hateoas.hal.response.HalResponseBuilder

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

withRepresentation(String, ReadableRepresentation) - Method in class net.eusashead.hateoas.hal.response.impl.HalResponseBuilderImpl

write(T, RepresentationFactory) - Method in interface net.eusashead.hateoas.hal.adapter.RepresentationWriter

Convert an object to a ReadableRepresentation using the supplied RepresentationFactory

write(Object, RepresentationFactory) - Method in interface net.eusashead.hateoas.hal.http.converter.module.HalHttpMessageConverterModule

Convert an object to a ReadableRepresentation using the supplied RepresentationFactory

write(Object, RepresentationFactory) - Method in class net.eusashead.hateoas.hal.http.converter.module.impl.AnnotationAdapterModuleImpl

write(Object, RepresentationFactory) - Method in class net.eusashead.hateoas.hal.http.converter.module.impl.ManualAdapterModuleImpl

writeInternal(Object, HttpOutputMessage) - Method in class net.eusashead.hateoas.hal.http.converter.HalHttpMessageConverter

A B C E G H L M N R S U W