Module io.inverno.mod.http.base

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

Interface AuthorityRoute<A>

Type Parameters:

A - the resource type

All Superinterfaces:

Route<A>

public interface AuthorityRoute<A>
extends Route<A>

An authority route.

This is used to define route based on the authority specified in an input. For instance, in order to resolve a handler for an HTTP request with host: example.org header, an authority route must be defined with authority example.org targeting a handler producing example.org content.

Since:

1.12

Author:

Jeremy Kuhn

See Also:

• AuthorityRoutingLink

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	AuthorityRoute.Extractor<A,B extends AuthorityRoute<A>,C extends AuthorityRoute.Extractor<A,B,C>>	An authority route extractor.
static interface	AuthorityRoute.Manager<A,B,C extends AuthorityRoute<A>,D extends AuthorityRoute.Manager<A,B,C,D,E>,E extends Router<A,B,C,D,E>>	An authority route manager.

Method Summary

Modifier and Type	Method	Description
String	getAuthority()	Returns an authority.
Pattern	getAuthorityPattern()	Returns a pattern for authority matching.

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

disable, enable, get, get, isDisabled, remove

Method Details

getAuthority

String getAuthority()

Returns an authority.

Returns:

an authority

getAuthorityPattern

Pattern getAuthorityPattern()

Returns a pattern for authority matching.

Returns:

an authority pattern