001/*
002 * #%L
003 * HAPI FHIR - Core Library
004 * %%
005 * Copyright (C) 2014 - 2024 Smile CDR, Inc.
006 * %%
007 * Licensed under the Apache License, Version 2.0 (the "License");
008 * you may not use this file except in compliance with the License.
009 * You may obtain a copy of the License at
010 *
011 *      http://www.apache.org/licenses/LICENSE-2.0
012 *
013 * Unless required by applicable law or agreed to in writing, software
014 * distributed under the License is distributed on an "AS IS" BASIS,
015 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
016 * See the License for the specific language governing permissions and
017 * limitations under the License.
018 * #L%
019 */
020package ca.uhn.fhir.rest.annotation;
021
022import java.lang.annotation.ElementType;
023import java.lang.annotation.Retention;
024import java.lang.annotation.RetentionPolicy;
025import java.lang.annotation.Target;
026
027/**
028 * Denotes a parameter for a REST method which will contain the resource actually
029 * being created/updated/etc in an operation which contains a resource in the HTTP request.
030 * <p>
031 * For example, in a {@link Create} operation the method parameter annotated with this
032 * annotation will contain the actual resource being created.
033 * </p>
034 * <p>
035 * Parameters with this annotation should typically be of the type of resource being
036 * operated on (see below for an exception when raw data is required). For example, in a
037 * IResourceProvider for Patient resources, the parameter annotated with this
038 * annotation should be of type Patient.
039 * </p>
040 * <p>
041 * Note that in servers it is also acceptable to have parameters with this annotation
042 * which are of type {@link String} or of type <code>byte[]</code>. Parameters of
043 * these types will contain the raw/unparsed HTTP request body. It is fine to
044 * have multiple parameters with this annotation, so you can have one parameter
045 * which accepts the parsed resource, and another which accepts the raw request.
046 * </p>
047 * <p>
048 * Also note that this parameter may be null if a client does not supply a body.
049 * </p>
050 */
051@Target(value = ElementType.PARAMETER)
052@Retention(RetentionPolicy.RUNTIME)
053public @interface ResourceParam {}