Package org.forgerock.services.routing

Interface RouteMatch

public interface RouteMatch

Contains the result of routing to a particular route.

Method Summary

Modifier and Type	Method	Description
Context	decorateContext(Context context)	Decorates the given context with any routing information for the route.
boolean	isBetterMatchThan(RouteMatch result)	Determines whether this route match is better than the given rout match.

Method Details

isBetterMatchThan

boolean isBetterMatchThan(RouteMatch result)
                   throws IncomparableRouteMatchException

Determines whether this route match is better than the given rout match.

Implementation should check that the RouteMatch can be compared to this instance.

Parameters:

result - The other route match to compare to.

Returns:

true if this route match is the better, false otherwise.

Throws:

IncomparableRouteMatchException - If the provided RouteMatch could not be compared this RouteMatch instance.

decorateContext

Context decorateContext(Context context)

Decorates the given context with any routing information for the route.

Parameters:

context - The original context to decorate.

Returns:

The decorated context.