Start line:  
End line:  

Snippet Preview

Snippet HTML Code

Stack Overflow Questions
 /*
  * The contents of this file are subject to the terms
  * of the Common Development and Distribution License
  * (the "License").  You may not use this file except
  * in compliance with the License.
  * 
  * You can obtain a copy of the license at
  * http://www.opensource.org/licenses/cddl1.php
  * See the License for the specific language governing
 * permissions and limitations under the License.
 */
/*
 * CookieParam.java
 *
 * Created on November 16, 2006, 2:04 PM
 *
 */
package javax.ws.rs;
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 javax.ws.rs.core.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
javax.ws.rs.core.Cookie
javax.ws.rs.core.HttpHeaders.getCookies
public @interface CookieParam
{
   
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.
   String value();
New to GrepCode? Check out our FAQ X