Module io.inverno.mod.http.base

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

Class QueryParametersRoutingLink<A,B,C extends QueryParametersRoute<A>,D extends QueryParametersRoute.Extractor<A,C,D>>

java.lang.Object

io.inverno.mod.http.base.router.RoutingLink<A,B,C,D>

io.inverno.mod.http.base.router.link.QueryParametersRoutingLink<A,B,C,D>

Type Parameters:

A - the resource type

B - the input type

C - the query parameters route type

D - the query parameters route extractor type

public abstract class QueryParametersRoutingLink<A,B,C extends QueryParametersRoute<A>,D extends QueryParametersRoute.Extractor<A,C,D>>
extends RoutingLink<A,B,C,D>

A RoutingLink implementation resolving resources by matching query parameters in an input.

Since:

1.12

Author:

Jeremy Kuhn

See Also:

• QueryParametersRoute

Nested Class Summary

Nested classes/interfaces inherited from class io.inverno.mod.http.base.router.RoutingLink

RoutingLink.ChainBuilder<A,B,C extends Route<A>,D extends RouteExtractor<A,C>>

Constructor Summary

Constructors

Constructor	Description
QueryParametersRoutingLink()	Creates a terminal query parameters routing link.
QueryParametersRoutingLink(Supplier<RoutingLink<A,B,C,D>> nextLinkFactory)	Creates a query parameters routing link in a routing chain.

Method Summary

Modifier and Type	Method	Description
protected boolean	canLink(C route)	Determines whether the link can link the specified route.
protected void	extractLinks(D routeExtractor)	Populates the specified route extractor with the criteria managed by the link.
protected RoutingLink<A,B,C,D>	getLink(C route)	Returns the next link in the routing chain that is matching the specified route.
protected Collection<RoutingLink<A,B,C,D>>	getLinks()	Returns all links bound to the link.
protected RoutingLink<A,B,C,D>	getOrSetLink(C route)	Returns or sets the next link in the routing chain that is matching the specified route.
protected abstract QueryParameters	getQueryParameters(B input)	Extracts the query parameters from the input.
protected void	refreshEnabled()	Refreshes enabled links.
protected void	removeLink(C route)	Removes the link matching the specified route.
protected List<RoutingLink<A,B,C,D>>	resolveAllLink(B input)	Resolves all links matching the specified input.
protected RoutingLink<A,B,C,D>	resolveLink(B input)	Resolves the link best matching the specified input.

Methods inherited from class io.inverno.mod.http.base.router.RoutingLink

bestMatchingRoutingLink, createLink, currentOrErrorRoutingLink, disableRoute, enableRoute, extractRoutes, isEnabled, link, removeRoute, resolve, resolveAll, setRoute

Methods inherited from class java.lang.Object

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

Constructor Details

QueryParametersRoutingLink

public QueryParametersRoutingLink()

Creates a terminal query parameters routing link.

QueryParametersRoutingLink

public QueryParametersRoutingLink(Supplier<RoutingLink<A,B,C,D>> nextLinkFactory)

Creates a query parameters routing link in a routing chain.

Parameters:

nextLinkFactory - the next routing link factory

Method Details

getQueryParameters

protected abstract QueryParameters getQueryParameters(B input)

Extracts the query parameters from the input.

Parameters:

input - an input

Returns:

query parameters

canLink

protected boolean canLink(C route)

Description copied from class: RoutingLink

Determines whether the link can link the specified route.

A route is linkable by a link when it defines a criteria handled by the link so basically when the link is able to route an input based on that particular criteria (e.g. a path, an HTTP method...).

Specified by:

canLink in class RoutingLink<A,B,C extends QueryParametersRoute<A>,D extends QueryParametersRoute.Extractor<A,C,D>>

Parameters:

route - a route

Returns:

true if the link can

getLink

protected RoutingLink<A,B,C,D> getLink(C route)

Description copied from class: RoutingLink

Returns the next link in the routing chain that is matching the specified route.

Specified by:

getLink in class RoutingLink<A,B,C extends QueryParametersRoute<A>,D extends QueryParametersRoute.Extractor<A,C,D>>

Parameters:

route - a route

Returns:

the next routing link in the routing chain or null if there is no link matching the route

getOrSetLink

protected RoutingLink<A,B,C,D> getOrSetLink(C route)

Description copied from class: RoutingLink

Returns or sets the next link in the routing chain that is matching the specified route.

If there is no link matching the route, a new link shall be created and set in the routing chain.

Specified by:

getOrSetLink in class RoutingLink<A,B,C extends QueryParametersRoute<A>,D extends QueryParametersRoute.Extractor<A,C,D>>

Parameters:

route - a route

Returns:

the next routing link in the routing chain

getLinks

protected Collection<RoutingLink<A,B,C,D>> getLinks()

Description copied from class: RoutingLink

Returns all links bound to the link.

Specified by:

getLinks in class RoutingLink<A,B,C extends QueryParametersRoute<A>,D extends QueryParametersRoute.Extractor<A,C,D>>

Returns:

the list of links bound to the link

removeLink

protected void removeLink(C route)

Description copied from class: RoutingLink

Removes the link matching the specified route.

Specified by:

removeLink in class RoutingLink<A,B,C extends QueryParametersRoute<A>,D extends QueryParametersRoute.Extractor<A,C,D>>

Parameters:

route - a route

refreshEnabled

protected void refreshEnabled()

Description copied from class: RoutingLink

Refreshes enabled links.

This method is invoked after a change in the routing chain in order to optimize the resource resolution process by identifying disabled links as close as possible from the beginning of the chain.

Specified by:

refreshEnabled in class RoutingLink<A,B,C extends QueryParametersRoute<A>,D extends QueryParametersRoute.Extractor<A,C,D>>

extractLinks

protected void extractLinks(D routeExtractor)

Description copied from class: RoutingLink

Populates the specified route extractor with the criteria managed by the link.

This basically comes down to extracting the links managed by the link.

Specified by:

extractLinks in class RoutingLink<A,B,C extends QueryParametersRoute<A>,D extends QueryParametersRoute.Extractor<A,C,D>>

Parameters:

routeExtractor - a route extractor

resolveLink

protected RoutingLink<A,B,C,D> resolveLink(B input)

Description copied from class: RoutingLink

Resolves the link best matching the specified input.

The link is resolved by comparing the criteria coming from the routes to the criteria defined in the input.

Specified by:

resolveLink in class RoutingLink<A,B,C extends QueryParametersRoute<A>,D extends QueryParametersRoute.Extractor<A,C,D>>

Parameters:

input - an input

Returns:

the matching link or null if no route matching the input was defined in the link

resolveAllLink

protected List<RoutingLink<A,B,C,D>> resolveAllLink(B input)

Description copied from class: RoutingLink

Resolves all links matching the specified input.

Links are resolved by comparing the criteria coming from the routes to the criteria defined in the input.

Specified by:

resolveAllLink in class RoutingLink<A,B,C extends QueryParametersRoute<A>,D extends QueryParametersRoute.Extractor<A,C,D>>

Parameters:

input - an input

Returns:

a list of links sorted from the best matching to the least matching or an empty list if no route matching the input was defined in the link