001/*
002 * Copyright 2022-2025 Revetware LLC.
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 * http://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 */
016
017package com.soklet.core;
018
019import javax.annotation.Nonnull;
020import java.util.Optional;
021import java.util.Set;
022
023/**
024 * Contract for matching incoming HTTP requests with appropriate <em>Resource Methods</em> (Java methods to invoke to handle requests).
025 * <p>
026 * Soklet's default implementation of this type, {@link com.soklet.core.impl.DefaultResourceMethodResolver}, is sufficient for most applications.
027 * <p>
028 * However, should a custom implementation be necessary for your application, documentation is available at <a href="https://www.soklet.com/docs/request-handling#resource-method-resolution">https://www.soklet.com/docs/request-handling#resource-method-resolution</a>.
029 *
030 * @author <a href="https://www.revetkn.com">Mark Allen</a>
031 */
032public interface ResourceMethodResolver {
033        /**
034         * Given an HTTP request, provide a matching <em>Resource Method</em> to invoke.
035         * <p>
036         * An unmatched <em>Resource Method</em> generally indicates an {@code HTTP 404}.
037         *
038         * @param request the HTTP request
039         * @return the matching <em>Resource Method</em>, or {@link Optional#empty()} if no match was found
040         */
041        @Nonnull
042        Optional<ResourceMethod> resourceMethodForRequest(@Nonnull Request request);
043
044        /**
045         * Vends the set of all <em>Resource Methods</em> registered in the system.
046         *
047         * @return the set of all <em>Resource Methods</em> in the system
048         */
049        @Nonnull
050        Set<ResourceMethod> getResourceMethods();
051}