javax.ws.rs

Annotation Type BeanParam


  • @Target(value={PARAMETER,METHOD,FIELD})
     @Retention(value=RUNTIME)
     @Documented
    public @interface BeanParam
    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 @XxxParam annotation (@PathParam, @FormParam ...) or the @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.

    Since:
    2.0
    Author:
    Marek Potociar

Document created the 11/06/2005, last modified the 18/08/2025
Source of the printed document:https://www.gaudry.be/en/java-api-javaee-rf-javax/ws/rs/BeanParam.html

The infobrol is a personal site whose content is my sole responsibility. The text is available under CreativeCommons license (BY-NC-SA). More info on the terms of use and the author.

References

  1. View the html document Language of the document:fr Manuel PHP : https://docs.oracle.com, BeanParam (Java(TM) EE 7 Specification APIs)

These references and links indicate documents consulted during the writing of this page, or which may provide additional information, but the authors of these sources can not be held responsible for the content of this page.
The author of this site is solely responsible for the way in which the various concepts, and the freedoms that are taken with the reference works, are presented here. Remember that you must cross multiple source information to reduce the risk of errors.