Module io.inverno.mod.http.base

Package io.inverno.mod.http.base.router

Interface QueryParametersRoute<A>

All Superinterfaces:

Route<A>

public interface QueryParametersRoute<A>
extends Route<A>

A query parameters route.

This is used to define route based on the query parameters specified in an input. For instance, in order to resolve a handler for an HTTP request with customer=abc query parameter, a query parameters route must be defined with a parameter matcher for customer parameter targeting the abc customer handler.

Since:

1.12

Author:

Jeremy Kuhn

See Also:

• QueryParametersRoutingLink

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	QueryParametersRoute.Extractor<A,B extends QueryParametersRoute<A>,C extends QueryParametersRoute.Extractor<A,B,C>>	A query parameters route extractor.
static interface	QueryParametersRoute.Manager<A,B,C extends QueryParametersRoute<A>,D extends QueryParametersRoute.Manager<A,B,C,D,E>,E extends Router<A,B,C,D,E>>	A query parameters route manager.
static final class	QueryParametersRoute.ParameterMatcher	A parameter matcher used to match a parameter against a list of static values or or a list of patterns.

Method Summary

Modifier and Type	Method	Description
Map<String,QueryParametersRoute.ParameterMatcher>	getQueryParameterMatchers()	Returns the parameter matchers for each parameter matched by the route.

Methods inherited from interface io.inverno.mod.http.base.router.Route

disable, enable, get, get, isDisabled, remove

Method Details

getQueryParameterMatchers

Map<String,QueryParametersRoute.ParameterMatcher> getQueryParameterMatchers()

Returns the parameter matchers for each parameter matched by the route.

Returns:

a map of parameter matchers