javax.ws.rs

## Annotation Type CookieParam

-     @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()`

- - ### Required Element Summary

    Required Elements
    Modifier and Type | Required Element and Description
    --- | ---
    `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.

- - ### 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.

Copyright © 1996-2013, Oracle and/or its affiliates. All Rights Reserved. Use is subject to license terms.