Package io.quarkus.vertx.http.deployment

Class FilterBuildItem

java.lang.Object

io.quarkus.builder.item.BuildItem

io.quarkus.builder.item.MultiBuildItem

io.quarkus.vertx.http.deployment.FilterBuildItem

public final class FilterBuildItem
extends io.quarkus.builder.item.MultiBuildItem

A handler that is applied to every route

Field Summary

Fields

Modifier and Type	Field	Description
static final int	AUTHENTICATION
static final int	AUTHORIZATION
static final int	CORS

Constructor Summary

Constructors

Constructor	Description
FilterBuildItem(io.vertx.core.Handler<io.vertx.ext.web.RoutingContext> handler, int priority)	Creates a new instance of FilterBuildItem.

Method Summary

Modifier and Type	Method	Description
io.vertx.core.Handler<io.vertx.ext.web.RoutingContext>	getHandler()
int	getPriority()
boolean	isFailureHandler()
static FilterBuildItem	ofAuthenticationFailureHandler(io.vertx.core.Handler<io.vertx.ext.web.RoutingContext> authFailureHandler)	Creates a new instance of FilterBuildItem with an authentication failure handler.
static FilterBuildItem	ofPreAuthenticationFailureHandler(io.vertx.core.Handler<io.vertx.ext.web.RoutingContext> authFailureHandler)	Creates a new instance of FilterBuildItem with an authentication failure handler.
Filter	toFilter()

Methods inherited from class java.lang.Object

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

Field Details

CORS

public static final int CORS

See Also:

• Constant Field Values

AUTHENTICATION

public static final int AUTHENTICATION

See Also:

• Constant Field Values

AUTHORIZATION

public static final int AUTHORIZATION

See Also:

• Constant Field Values

Constructor Details

FilterBuildItem

public FilterBuildItem(io.vertx.core.Handler<io.vertx.ext.web.RoutingContext> handler,
 int priority)

Creates a new instance of FilterBuildItem.

Parameters:

handler - the handler, if null the filter won't be used.

priority - the priority, higher priority gets invoked first. Priority is only used to sort filters, user routes are called afterwards. Must be positive.

Method Details

ofAuthenticationFailureHandler

public static FilterBuildItem ofAuthenticationFailureHandler(io.vertx.core.Handler<io.vertx.ext.web.RoutingContext> authFailureHandler)

Creates a new instance of FilterBuildItem with an authentication failure handler. The handler will be added as next to last, right before QuarkusErrorHandler.

ofPreAuthenticationFailureHandler

public static FilterBuildItem ofPreAuthenticationFailureHandler(io.vertx.core.Handler<io.vertx.ext.web.RoutingContext> authFailureHandler)

Creates a new instance of FilterBuildItem with an authentication failure handler. The handler will be added right before any handlers added by ofAuthenticationFailureHandler(Handler)

getHandler

public io.vertx.core.Handler<io.vertx.ext.web.RoutingContext> getHandler()

getPriority

public int getPriority()

isFailureHandler

public boolean isFailureHandler()

toFilter

public Filter toFilter()

Returns:

a filter object wrapping the handler and priority.