jakarta.ws.rs.HeaderParam Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of jaxrs-ri Show documentation

A bundle project producing JAX-RS RI bundles. The primary artifact is an "all-in-one" OSGi-fied JAX-RS RI bundle (jaxrs-ri.jar). Attached to that are two compressed JAX-RS RI archives. The first archive (jaxrs-ri.zip) consists of binary RI bits and contains the API jar (under "api" directory), RI libraries (under "lib" directory) as well as all external RI dependencies (under "ext" directory). The secondary archive (jaxrs-ri-src.zip) contains buildable JAX-RS RI source bundle and contains the API jar (under "api" directory), RI sources (under "src" directory) as well as all external RI dependencies (under "ext" directory). The second archive also contains "build.xml" ANT script that builds the RI sources. To build the JAX-RS RI simply unzip the archive, cd to the created jaxrs-ri directory and invoke "ant" from the command line.

There is a newer version: 3.1.9

Show newest version

/*
 * Copyright (c) 2010, 2020 Oracle and/or its affiliates. All rights reserved.
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License v. 2.0, which is available at
 * http://www.eclipse.org/legal/epl-2.0.
 *
 * This Source Code may also be made available under the following Secondary
 * Licenses when the conditions for such availability set forth in the
 * Eclipse Public License v. 2.0 are satisfied: GNU General Public License,
 * version 2 with the GNU Classpath Exception, which is available at
 * https://www.gnu.org/software/classpath/license.html.
 *
 * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
 */

package jakarta.ws.rs;

import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * Binds the value(s) of a HTTP header to a resource method parameter, resource class field, or resource class bean
 * property. A default value can be specified using the {@link DefaultValue} annotation.
 *
 * The type {@code T} of the annotated parameter, field or property must either:
 * 
 * Be a primitive type
 * Have a constructor that accepts a single {@code String} argument
 * Have a static method named {@code valueOf} or {@code fromString} that accepts a single {@code String} argument
 * (see, for example, {@link Integer#valueOf(String)})
 * Have a registered implementation of {@link jakarta.ws.rs.ext.ParamConverterProvider} JAX-RS extension SPI that
 * returns a {@link jakarta.ws.rs.ext.ParamConverter} instance capable of a "from string" conversion for the type.
 * Be {@code List}, {@code Set}, {@code SortedSet} or {@code T[]} array, where {@code T} satisfies 2, 3 or
 * 4 above. The resulting collection is read-only.
 * 
 *
 * 
 * If the type is not one of the collection types listed in 5 above and the header parameter is represented by multiple
 * values then the first value (lexically) of the parameter is used.
 * 
 *
 * 
 * Because injection occurs at object creation time, use of this annotation on resource class fields and bean properties
 * is only supported for the default per-request resource class lifecycle. Resource classes using other lifecycles
 * should only use this annotation on resource method parameters.
 * 
 *
 * @author Paul Sandoz
 * @author Marc Hadley
 * @see DefaultValue
 * @see jakarta.ws.rs.core.HttpHeaders
 * @since 1.0
 */
@Target({ ElementType.PARAMETER, ElementType.METHOD, ElementType.FIELD })
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface HeaderParam {

    /**
     * Defines the name of the HTTP header whose value will be used to initialize the value of the annotated method
     * argument, class field or bean property. Case insensitive.
     *
     * @return HTTP header name.
     */
    String value();
}