org.springframework.data.rest.webmvc

Class ResourceProcessorHandlerMethodReturnValueHandler

java.lang.Object

org.springframework.data.rest.webmvc.ResourceProcessorHandlerMethodReturnValueHandler

All Implemented Interfaces:

HandlerMethodReturnValueHandler

public class ResourceProcessorHandlerMethodReturnValueHandler
extends Object
implements HandlerMethodReturnValueHandler

HandlerMethodReturnValueHandler to post-process the objects returned from controller methods using the configured ResourceProcessors.

Author:

Oliver Gierke

Constructor Summary

Constructors

Constructor and Description
ResourceProcessorHandlerMethodReturnValueHandler(HandlerMethodReturnValueHandler delegate, List<org.springframework.hateoas.ResourceProcessor<?>> processors) Creates a new ResourceProcessorHandlerMethodReturnValueHandler using the given delegate to eventually delegate calls to handleReturnValue(Object, MethodParameter, ModelAndViewContainer, NativeWebRequest) to.

Method Summary

Modifier and Type	Method and Description
void	handleReturnValue(Object returnValue, MethodParameter returnType, ModelAndViewContainer mavContainer, NativeWebRequest webRequest)
void	setRootLinksAsHeaders(boolean rootLinksAsHeaders)
boolean	supportsReturnType(MethodParameter returnType)

Methods inherited from class java.lang.Object

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

Constructor Detail

ResourceProcessorHandlerMethodReturnValueHandler

public ResourceProcessorHandlerMethodReturnValueHandler(HandlerMethodReturnValueHandler delegate,
                                                        List<org.springframework.hateoas.ResourceProcessor<?>> processors)

Creates a new ResourceProcessorHandlerMethodReturnValueHandler using the given delegate to eventually delegate calls to handleReturnValue(Object, MethodParameter, ModelAndViewContainer, NativeWebRequest) to. Will consider the given ResourceProcessor to post-process the controller methods return value to before invoking the delegate.

Parameters:

delegate - the HandlerMethodReturnValueHandler to evenually delegate calls to, must not be null.

processors - the ResourceProcessors to be considered, must not be null.

Method Detail

setRootLinksAsHeaders

public void setRootLinksAsHeaders(boolean rootLinksAsHeaders)

Parameters:

rootLinksAsHeaders - the rootLinksAsHeaders to set

supportsReturnType

public boolean supportsReturnType(MethodParameter returnType)

Specified by:

supportsReturnType in interface HandlerMethodReturnValueHandler

handleReturnValue

public void handleReturnValue(Object returnValue,
                              MethodParameter returnType,
                              ModelAndViewContainer mavContainer,
                              NativeWebRequest webRequest)
                       throws Exception

Specified by:

handleReturnValue in interface HandlerMethodReturnValueHandler

Throws:

Exception