Package javax.ws.rs
Annotation 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:
- Be a primitive type
- Be
Cookie
- Have a constructor that accepts a single String argument
- Have a static method named
valueOf
orfromString
that accepts a single String argument (see, for example,Integer.valueOf(String)
) - Have a registered implementation of
ParamConverterProvider
JAX-RS extension SPI that returns aParamConverter
instance capable of a "from string" conversion for the type. - Be
List<T>
,Set<T>
orSortedSet<T>
, whereT
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
- See Also:
-
Required Element Summary
-
Element Details
-
value
String valueDefines 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.
-