All Downloads are FREE. Search and download functionalities are using the official Maven repository.

keycloakjar.org.springframework.util.RouteMatcher Maven / Gradle / Ivy

There is a newer version: 2.2.3
Show newest version
/*
 * Copyright 2002-2019 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.springframework.util;

import java.util.Comparator;
import java.util.Map;

import org.springframework.lang.Nullable;

/**
 * Contract for matching routes to patterns.
 *
 * 

Equivalent to {@link PathMatcher}, but enables use of parsed representations * of routes and patterns for efficiency reasons in scenarios where routes from * incoming messages are continuously matched against a large number of message * handler patterns. * * @author Rossen Stoyanchev * @since 5.2 * @see PathMatcher */ public interface RouteMatcher { /** * Return a parsed representation of the given route. * @param routeValue the route to parse * @return the parsed representation of the route */ Route parseRoute(String routeValue); /** * Whether the given {@code route} contains pattern syntax which requires * the {@link #match(String, Route)} method, or if it is a regular String * that could be compared directly to others. * @param route the route to check * @return {@code true} if the given {@code route} represents a pattern */ boolean isPattern(String route); /** * Combines two patterns into a single pattern. * @param pattern1 the first pattern * @param pattern2 the second pattern * @return the combination of the two patterns * @throws IllegalArgumentException when the two patterns cannot be combined */ String combine(String pattern1, String pattern2); /** * Match the given route against the given pattern. * @param pattern the pattern to try to match * @param route the route to test against * @return {@code true} if there is a match, {@code false} otherwise */ boolean match(String pattern, Route route); /** * Match the pattern to the route and extract template variables. * @param pattern the pattern, possibly containing templates variables * @param route the route to extract template variables from * @return a map with template variables and values */ @Nullable Map matchAndExtract(String pattern, Route route); /** * Given a route, return a {@link Comparator} suitable for sorting patterns * in order of explicitness for that route, so that more specific patterns * come before more generic ones. * @param route the full path to use for comparison * @return a comparator capable of sorting patterns in order of explicitness */ Comparator getPatternComparator(Route route); /** * A parsed representation of a route. */ interface Route { /** * The original route value. */ String value(); } }





© 2015 - 2024 Weber Informatics LLC | Privacy Policy