javax.ws.rs.BeanParam Maven / Gradle / Ivy
Show all versions of javax.ws.rs-api Show documentation
/*
* Copyright (c) 2012, 2017 Oracle and/or its affiliates. All rights reserved.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License v. 2.0, which is available at
* http://www.eclipse.org/legal/epl-2.0.
*
* This Source Code may also be made available under the following Secondary
* Licenses when the conditions for such availability set forth in the
* Eclipse Public License v. 2.0 are satisfied: GNU General Public License,
* version 2 with the GNU Classpath Exception, which is available at
* https://www.gnu.org/software/classpath/license.html.
*
* SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
*/
package javax.ws.rs;
import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/**
* The annotation that may be used to inject custom JAX-RS "parameter aggregator" value object
* into a resource class field, property or resource method parameter.
*
* The JAX-RS runtime will instantiate the object and inject all it's fields and properties annotated
* with either one of the {@code @XxxParam} annotation ({@link PathParam @PathParam},
* {@link FormParam @FormParam} ...) or the {@link javax.ws.rs.core.Context @Context}
* annotation. For the POJO classes same instantiation and injection rules apply as in case of instantiation
* and injection of request-scoped root resource classes.
*
*
* For example:
*
* public class MyBean {
* @FormParam("myData")
* private String data;
*
* @HeaderParam("myHeader")
* private String header;
*
* @PathParam("id")
* public void setResourceId(String id) {...}
*
* ...
* }
*
* @Path("myresources")
* public class MyResources {
* @POST
* @Path("{id}")
* public void post(@BeanParam MyBean myBean) {...}
*
* ...
* }
*
*
*
* 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.
*
*
* @author Marek Potociar
* @since 2.0
*/
@Target({ElementType.PARAMETER, ElementType.METHOD, ElementType.FIELD})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface BeanParam {
}