io.helidon.http.PathMatcher Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of helidon-http Show documentation

HTTP primitives for client and server

The newest version!

/*
 * Copyright (c) 2022, 2023 Oracle and/or its affiliates.
 *
 * 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
 *
 *     http://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 io.helidon.http;

import io.helidon.common.uri.UriPath;

/**
 * Matches HTTP path against configured path of a route.
 */
public interface PathMatcher {
    /**
     * Match the provided path against the configured path.
     * Must do a full match on the whole path.
     *
     * @param path HTTP path that was requested by user
     * @return match result
     */
    PathMatchers.MatchResult match(UriPath path);

    /**
     * Match the provided path against the configured path as a prefix match.
     * This is used to handle service routing, where service path pattern may match only a subset of segments.
     * The matching MUST always match exact segments.
     *
     * @param uriPath path that was requested by user
     * @return match result
     */
    PathMatchers.PrefixMatchResult prefixMatch(UriPath uriPath);
}