org.springframework.hateoas.server.core

Class HeaderLinksResponseEntity<T extends RepresentationModel<?>>

java.lang.Object

org.springframework.http.HttpEntity<T>

org.springframework.http.ResponseEntity<T>

org.springframework.hateoas.server.core.HeaderLinksResponseEntity<T>

public class HeaderLinksResponseEntity<T extends RepresentationModel<?>>
extends ResponseEntity<T>

Special ResponseEntity that exposes Link instances in the contained RepresentationModel as link headers instead of in the body. Note, that this class is not intended to be used directly from user code but by support code that will transparently invoke the header exposure. If you use this class from a controller directly, the Links will not be present in the RepresentationModel instance anymore when RepresentationModelProcessors kick in.

Author:

Oliver Gierke

Nested Class Summary

Nested classes/interfaces inherited from class org.springframework.http.ResponseEntity

ResponseEntity.BodyBuilder, ResponseEntity.HeadersBuilder<B extends ResponseEntity.HeadersBuilder<B>>

Field Summary

Fields inherited from class org.springframework.http.HttpEntity

EMPTY

Method Summary

Modifier and Type	Method and Description
static <S extends RepresentationModel<?>> HeaderLinksResponseEntity<S>	wrap(HttpEntity<S> entity) Wraps the given HttpEntity into a HeaderLinksResponseEntity.
static <S extends RepresentationModel<?>> HeaderLinksResponseEntity<S>	wrap(S entity) Wraps the given RepresentationModel into a HeaderLinksResponseEntity.

Methods inherited from class org.springframework.http.ResponseEntity

accepted, badRequest, created, equals, getStatusCode, getStatusCodeValue, hashCode, noContent, notFound, of, ok, ok, status, status, toString, unprocessableEntity

Methods inherited from class org.springframework.http.HttpEntity

getBody, getHeaders, hasBody

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

wrap

public static <S extends RepresentationModel<?>> HeaderLinksResponseEntity<S> wrap(HttpEntity<S> entity)

Wraps the given HttpEntity into a HeaderLinksResponseEntity. Will default the status code to HttpStatus.OK if the given value is not a ResponseEntity.

Parameters:

entity - must not be null.

Returns:

wrap

public static <S extends RepresentationModel<?>> HeaderLinksResponseEntity<S> wrap(S entity)

Wraps the given RepresentationModel into a HeaderLinksResponseEntity. Will default the status code to HttpStatus.OK.

Parameters:

entity - must not be null.

Returns: