001/* 002 * The contents of this file are subject to the terms of the Common Development and 003 * Distribution License (the License). You may not use this file except in compliance with the 004 * License. 005 * 006 * You can obtain a copy of the License at legal/CDDLv1.0.txt. See the License for the 007 * specific language governing permission and limitations under the License. 008 * 009 * When distributing Covered Software, include this CDDL Header Notice in each file and include 010 * the License file at legal/CDDLv1.0.txt. If applicable, add the following below the CDDL 011 * Header, with the fields enclosed by brackets [] replaced by your own identifying 012 * information: "Portions copyright [year] [name of copyright owner]". 013 * 014 * Copyright 2015 ForgeRock AS. 015 */ 016 017package org.forgerock.services.routing; 018 019import org.forgerock.services.context.Context; 020 021/** 022 * Contains the result of routing to a particular route. 023 */ 024public interface RouteMatch { 025 026 /** 027 * Determines whether this route match is better than the given rout match. 028 * 029 * <p>Implementation should check that the {@code RouteMatch} can be 030 * compared to this instance.</p> 031 * 032 * @param result The other route match to compare to. 033 * @return {@code true} if this route match is the better, {@code false} otherwise. 034 * @throws IncomparableRouteMatchException If the provided {@code RouteMatch} 035 * could not be compared this {@code RouteMatch} instance. 036 */ 037 boolean isBetterMatchThan(RouteMatch result) throws IncomparableRouteMatchException; 038 039 /** 040 * Decorates the given context with any routing information for the route. 041 * 042 * @param context The original context to decorate. 043 * @return The decorated context. 044 */ 045 Context decorateContext(Context context); 046}