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.annotation;
018
019import java.lang.annotation.ElementType;
020import java.lang.annotation.Retention;
021import java.lang.annotation.RetentionPolicy;
022import java.lang.annotation.Target;
023
024/**
025 * Apply to <em>Resource Method</em> parameters to enable HTTP request body injection.
026 * <p>
027 * Refer to documentation at <a href="https://www.soklet.com/docs/request-handling#request-body">https://www.soklet.com/docs/request-handling#request-body</a> for details.
028 *
029 * @author <a href="https://www.revetkn.com">Mark Allen</a>
030 */
031@Target(ElementType.PARAMETER)
032@Retention(RetentionPolicy.RUNTIME)
033public @interface RequestBody {
034        /**
035         * Is this HTTP request body optional or required?
036         *
037         * @return {@code true} if optional, {@code false} if required
038         */
039        boolean optional() default false;
040}