io.micronaut.views

Class ViewsFilter

java.lang.Object

io.micronaut.views.ViewsFilter

All Implemented Interfaces:

Ordered, HttpFilter, HttpServerFilter

@Requires(beans=ViewsRenderer.class)
 @Filter(value="/**")
public class ViewsFilter
extends Object
implements HttpServerFilter

Templates Filter.

Since:

1.0

Author:

Sergio del Amo

Field Summary

Fields

Modifier and Type	Field and Description
protected BeanLocator	beanLocator
protected Integer	order

Fields inherited from interface io.micronaut.core.order.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor and Description
ViewsFilter(BeanLocator beanLocator, ViewsFilterOrderProvider viewsFilterOrderProvider) Deprecated. Use ViewsFilter(BeanLocator, ViewsFilterOrderProvider, Collection) instead.
ViewsFilter(BeanLocator beanLocator, ViewsFilterOrderProvider viewsFilterOrderProvider, Collection<ViewModelProcessor> viewModelProcessors) Constructor.

Method Summary

Modifier and Type	Method and Description
Publisher<MutableHttpResponse<?>>	doFilter(HttpRequest<?> request, ServerFilterChain chain) Variation of the HttpServerFilter.doFilter(HttpRequest, FilterChain) method that accepts a ServerFilterChain which allows to mutate the outgoing HTTP response.
int	getOrder()
protected Map<String,Object>	populateModel(HttpRequest request, ViewsRenderer viewsRenderer, Object responseBody) Resolves the model for the given response body and enhances the model with instances of ViewModelProcessor.
protected ModelAndView<Map<String,Object>>	processModelAndView(HttpRequest request, String view, Map<String,Object> model)
protected Object	resolveModel(Object responseBody) Resolves the model for the given response body.
protected Optional<String>	resolveView(AnnotationMetadata route, Object responseBody) Resolves the view for the given method and response body.

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.micronaut.http.filter.HttpServerFilter

doFilter

Field Detail

order

protected final Integer order

beanLocator

protected final BeanLocator beanLocator

Constructor Detail

ViewsFilter

public ViewsFilter(BeanLocator beanLocator,
                   @Nullable
                   ViewsFilterOrderProvider viewsFilterOrderProvider,
                   Collection<ViewModelProcessor> viewModelProcessors)

Constructor.

Parameters:

beanLocator - The bean locator

viewsFilterOrderProvider - The order provider

viewModelProcessors - Collection of views model decorator beans

ViewsFilter

@Deprecated
public ViewsFilter(BeanLocator beanLocator,
                               @Nullable
                               ViewsFilterOrderProvider viewsFilterOrderProvider)

Deprecated. Use ViewsFilter(BeanLocator, ViewsFilterOrderProvider, Collection) instead.

Constructor.

Parameters:

beanLocator - The bean locator

viewsFilterOrderProvider - The order provider

Method Detail

getOrder

public int getOrder()

Specified by:

getOrder in interface Ordered

Returns:

The order of the object. Defaults to zero (no order).

doFilter

public final Publisher<MutableHttpResponse<?>> doFilter(HttpRequest<?> request,
                                                        ServerFilterChain chain)

Description copied from interface: HttpServerFilter

Variation of the HttpServerFilter.doFilter(HttpRequest, FilterChain) method that accepts a ServerFilterChain which allows to mutate the outgoing HTTP response.

Specified by:

doFilter in interface HttpServerFilter

Parameters:

request - The request

chain - The chain

Returns:

A Publisher that emits a MutableHttpResponse

See Also:

HttpServerFilter.doFilter(HttpRequest, FilterChain)

processModelAndView

protected ModelAndView<Map<String,Object>> processModelAndView(HttpRequest request,
                                                               String view,
                                                               Map<String,Object> model)

Parameters:

request - The HTTP Request being processed

view - The resolved View.

model - The Model returned

Returns:

A ModelAndView after being processed by the available ViewModelProcessors.

populateModel

protected Map<String,Object> populateModel(HttpRequest request,
                                           ViewsRenderer viewsRenderer,
                                           Object responseBody)

Resolves the model for the given response body and enhances the model with instances of ViewModelProcessor.

Parameters:

request - HttpRequest being processed

viewsRenderer - The Views rendered being used to render the view

responseBody - Response Body

Returns:

A model with the controllers response and enhanced with the decorators.

resolveModel

protected Object resolveModel(Object responseBody)

Resolves the model for the given response body. Subclasses can override to customize.

Parameters:

responseBody - Response body

Returns:

the model to be rendered

resolveView

protected Optional<String> resolveView(AnnotationMetadata route,
                                       Object responseBody)

Resolves the view for the given method and response body. Subclasses can override to customize.

Parameters:

route - Request route

responseBody - Response body

Returns:

view name to be rendered