Package io.micronaut.views

Class ViewsFilter

java.lang.Object

io.micronaut.views.ViewsFilter

All Implemented Interfaces:

io.micronaut.core.order.Ordered, io.micronaut.http.filter.HttpFilter, io.micronaut.http.filter.HttpServerFilter

@Requires(beans=ViewsResolver.class)
@Filter("/**")
public class ViewsFilter
extends Object
implements io.micronaut.http.filter.HttpServerFilter

Templates Filter.

Since:

1.0

Author:

Sergio del Amo

Field Summary

Fields

Modifier and Type	Field	Description
protected final TurboFrameRenderer	turboFrameRenderer	Turbo Stream Renderer.
protected final TurboStreamRenderer	turboStreamRenderer	Turbo Stream Renderer.
protected final ViewsModelDecorator	viewsModelDecorator	Views Model Decorator.
protected final ViewsRendererLocator	viewsRendererLocator	Views Render Locator.
protected final ViewsResolver	viewsResolver	Views Resolver.

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

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor	Description
ViewsFilter(ViewsResolver viewsResolver, ViewsRendererLocator viewsRendererLocator, ViewsModelDecorator viewsModelDecorator, TurboFrameRenderer turboFrameRenderer)	Constructor.
ViewsFilter(ViewsResolver viewsResolver, ViewsRendererLocator viewsRendererLocator, ViewsModelDecorator viewsModelDecorator, TurboStreamRenderer turboStreamRenderer, TurboFrameRenderer turboFrameRenderer)	Deprecated, for removal: This API element is subject to removal in a future version. Use ViewsFilter(io.micronaut.views.ViewsResolver,io.micronaut.views.ViewsRendererLocator,io.micronaut.views.ViewsModelDecorator,io.micronaut.views.turbo.TurboFrameRenderer) instead.

Method Summary

Modifier and Type	Method	Description
final org.reactivestreams.Publisher<io.micronaut.http.MutableHttpResponse<?>>	doFilter(io.micronaut.http.HttpRequest<?> request, io.micronaut.http.filter.ServerFilterChain chain)
int	getOrder()
protected io.micronaut.http.MediaType	resolveMediaType(@NonNull io.micronaut.http.HttpResponse<?> response, @Nullable Object responseBody)	Deprecated, for removal: This API element is subject to removal in a future version. Use resolveMediaType(HttpRequest, HttpResponse, Object) instead.
protected @NonNull io.micronaut.http.MediaType	resolveMediaType(@Nullable io.micronaut.http.HttpRequest<?> request, @NonNull io.micronaut.http.HttpResponse<?> response, @Nullable Object responseBody)	Resolves the response content type for the matched route.

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 Details

viewsResolver

protected final ViewsResolver viewsResolver

Views Resolver.

viewsRendererLocator

protected final ViewsRendererLocator viewsRendererLocator

Views Render Locator.

viewsModelDecorator

protected final ViewsModelDecorator viewsModelDecorator

Views Model Decorator.

turboStreamRenderer

protected final TurboStreamRenderer turboStreamRenderer

Turbo Stream Renderer.

turboFrameRenderer

protected final TurboFrameRenderer turboFrameRenderer

Turbo Stream Renderer.

Constructor Details

ViewsFilter

@Inject
public ViewsFilter(ViewsResolver viewsResolver,
 ViewsRendererLocator viewsRendererLocator,
 ViewsModelDecorator viewsModelDecorator,
 TurboFrameRenderer turboFrameRenderer)

Constructor.

Parameters:

viewsResolver - Views Resolver

viewsRendererLocator - ViewRendererLocator

viewsModelDecorator - Views Model Decorator

turboFrameRenderer - Turbo Frame renderer

ViewsFilter

@Deprecated(forRemoval=true,
            since="4.1.0")
public ViewsFilter(ViewsResolver viewsResolver,
 ViewsRendererLocator viewsRendererLocator,
 ViewsModelDecorator viewsModelDecorator,
 TurboStreamRenderer turboStreamRenderer,
 TurboFrameRenderer turboFrameRenderer)

Deprecated, for removal: This API element is subject to removal in a future version.

Use ViewsFilter(io.micronaut.views.ViewsResolver,io.micronaut.views.ViewsRendererLocator,io.micronaut.views.ViewsModelDecorator,io.micronaut.views.turbo.TurboFrameRenderer) instead.

Constructor.

Parameters:

viewsResolver - Views Resolver

viewsRendererLocator - ViewRendererLocator

viewsModelDecorator - Views Model Decorator

turboStreamRenderer - Turbo Stream renderer

turboFrameRenderer - Turbo Frame renderer

Method Details

getOrder

public int getOrder()

Specified by:

getOrder in interface io.micronaut.core.order.Ordered

doFilter

public final org.reactivestreams.Publisher<io.micronaut.http.MutableHttpResponse<?>> doFilter(io.micronaut.http.HttpRequest<?> request,
 io.micronaut.http.filter.ServerFilterChain chain)

Specified by:

doFilter in interface io.micronaut.http.filter.HttpServerFilter

resolveMediaType

@NonNull
protected @NonNull io.micronaut.http.MediaType resolveMediaType(@Nullable
 @Nullable io.micronaut.http.HttpRequest<?> request,
 @NonNull
 @NonNull io.micronaut.http.HttpResponse<?> response,
 @Nullable
 @Nullable Object responseBody)

Resolves the response content type for the matched route.

Parameters:

request - HTTP Request

response - HTTP response

responseBody - HTTP Response body

Returns:

The resolved content type

resolveMediaType

@Deprecated(forRemoval=true,
            since="4.1.0")
protected io.micronaut.http.MediaType resolveMediaType(@NonNull
 @NonNull io.micronaut.http.HttpResponse<?> response,
 @Nullable
 @Nullable Object responseBody)

Deprecated, for removal: This API element is subject to removal in a future version.

Use resolveMediaType(HttpRequest, HttpResponse, Object) instead.

Resolves the response content type for the matched route.

Parameters:

response - HTTP response

responseBody - HTTP Response body

Returns:

The resolved content type