javax.ws.rs

Annotation Type CookieParam

Contents

  • @Target(value={PARAMETER,METHOD,FIELD})
 @Retention(value=RUNTIME)
 @Documented
public @interface CookieParam
    Binds the value of a HTTP cookie to a resource method parameter, resource class field, or resource class bean property. A default value can be specified using the DefaultValue annotation. The type T of the annotated parameter, field or property must either:
    1. Be a primitive type
    2. Be Cookie
    3. Have a constructor that accepts a single String argument
    4. Have a static method named valueOf or fromString that accepts a single String argument (see, for example, Integer.valueOf(String))
    5. Have a registered implementation of ParamConverterProvider JAX-RS extension SPI that returns a ParamConverter instance capable of a "from string" conversion for the type.
    6. Be List<T>, Set<T> or SortedSet<T>, where T satisfies 2, 3, 4 or 5 above. The resulting collection is read-only.

    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.

    Since:
    1.0
    Author:
    Paul Sandoz, Marc Hadley
    See Also:
    DefaultValue, Cookie, HttpHeaders.getCookies()

    • Element Detail

      • value

        public abstract String value
        Defines the name of the HTTP cookie whose value will be used to initialize the value of the annotated method argument, class field or bean property.

Document created the 11/06/2005, last modified the 18/08/2025
Source of the printed document:https://www.gaudry.be/en/java-api-javaee-rf-javax/ws/rs/CookieParam.html

The infobrol is a personal site whose content is my sole responsibility. The text is available under CreativeCommons license (BY-NC-SA). More info on the terms of use and the author.

References

  1. View the html document Language of the document:fr Manuel PHP : https://docs.oracle.com, CookieParam (Java(TM) EE 7 Specification APIs)

These references and links indicate documents consulted during the writing of this page, or which may provide additional information, but the authors of these sources can not be held responsible for the content of this page.
The author of this site is solely responsible for the way in which the various concepts, and the freedoms that are taken with the reference works, are presented here. Remember that you must cross multiple source information to reduce the risk of errors.