Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: REQUIRED | OPTIONAL | DETAIL: ELEMENT

## javax.ws.rs
Annotation Type CookieParam

    @Target(value={PARAMETER,METHOD,FIELD})
    @Retention(value=RUNTIME)
    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. Be `List<T>`, `Set<T>` or `SortedSet<T>`, where `T` satisfies 2, 3 or 4 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.

See Also:
  `DefaultValue`, `Cookie`, `HttpHeaders.getCookies()`

Required Element Summary
`java.lang.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 java.lang.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.

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: REQUIRED | OPTIONAL | DETAIL: ELEMENT

Copyright © 2011 Oracle Corporation. All Rights Reserved.