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.annotation;
018
019import org.jspecify.annotations.Nullable;
020
021import java.lang.annotation.ElementType;
022import java.lang.annotation.Retention;
023import java.lang.annotation.RetentionPolicy;
024import java.lang.annotation.Target;
025
026/**
027 * Apply to <em>Resource Method</em> parameters to enable HTTP request header injection.
028 * <p>
029 * Refer to documentation at <a href="https://www.soklet.com/docs/request-handling#headers">https://www.soklet.com/docs/request-handling#headers</a> for details.
030 *
031 * @author <a href="https://www.revetkn.com">Mark Allen</a>
032 */
033@Target(ElementType.PARAMETER)
034@Retention(RetentionPolicy.RUNTIME)
035public @interface RequestHeader {
036        /**
037         * The name of the HTTP request header.
038         * <p>
039         * If {@code null} or blank, defaults to the name of the Java method parameter if your application is built with the {@code -parameters} compiler option.
040         *
041         * @return the name of the HTTP request header to inject into this <em>Resource Method</em> parameter
042         */
043        @Nullable
044        String name() default "";
045
046        /**
047         * Is this HTTP request header optional or required?
048         *
049         * @return {@code true} if optional, {@code false} if required
050         */
051        boolean optional() default false;
052}