001/*
002 * Copyright 2022-2026 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;
018
019import org.jspecify.annotations.NonNull;
020
021import javax.annotation.concurrent.ThreadSafe;
022import java.util.Optional;
023
024/**
025 * Context supplied to programmatic MCP resource handlers.
026 *
027 * @author <a href="https://www.revetkn.com">Mark Allen</a>
028 */
029@ThreadSafe
030public interface McpResourceHandlerContext {
031        /**
032         * Provides the underlying request context.
033         *
034         * @return the request context
035         */
036        @NonNull
037        McpRequestContext getRequestContext();
038
039        /**
040         * Provides the current session context.
041         *
042         * @return the session context
043         */
044        @NonNull
045        McpSessionContext getSessionContext();
046
047        /**
048         * Provides the concrete resource URI requested by the client.
049         *
050         * @return the requested resource URI
051         */
052        @NonNull
053        String getRequestedUri();
054
055        /**
056         * Retrieves a URI-template parameter as a string.
057         *
058         * @param name the URI parameter name
059         * @return the parameter value, if present
060         */
061        @NonNull
062        Optional<String> getUriParameter(@NonNull String name);
063
064        /**
065         * Retrieves a URI-template parameter using a Soklet value conversion.
066         *
067         * @param name the URI parameter name
068         * @param type the desired converted type
069         * @param <T> the converted type
070         * @return the converted parameter value, if present
071         */
072        @NonNull
073        <T> Optional<T> getUriParameter(@NonNull String name,
074                                                                                                                                        @NonNull Class<T> type);
075
076        /**
077         * Retrieves an endpoint path parameter as a string.
078         *
079         * @param name the endpoint path parameter name
080         * @return the parameter value, if present
081         */
082        @NonNull
083        Optional<String> getEndpointPathParameter(@NonNull String name);
084
085        /**
086         * Retrieves an endpoint path parameter using a Soklet value conversion.
087         *
088         * @param name the endpoint path parameter name
089         * @param type the desired converted type
090         * @param <T> the converted type
091         * @return the converted parameter value, if present
092         */
093        @NonNull
094        <T> Optional<T> getEndpointPathParameter(@NonNull String name,
095                                                                                                                                                                         @NonNull Class<T> type);
096}