Module io.inverno.mod.http.base

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

Interface HeadersRoute<A>

All Superinterfaces:

Route<A>

public interface HeadersRoute<A>
extends Route<A>

A headers route.

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

Since:

1.12

Author:

Jeremy Kuhn

See Also:

• HeadersRoutingLink

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
Map<String,HeadersRoute.HeaderMatcher>	getHeadersMatchers()	Returns the headers matchers for each header matched by the route.

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

disable, enable, get, get, isDisabled, remove

Method Details

getHeadersMatchers

Map<String,HeadersRoute.HeaderMatcher> getHeadersMatchers()

Returns the headers matchers for each header matched by the route.

Returns:

a map of header matchers