New in JAX-RS 2.0 – @BeanParam Annotation
New in JAX-RS 2.0 – @BeanParam Annotation
JAX-RS 2.0 is the latest version of the JSR 311 specification and it was released along with Java EE 7.
Join the DZone community and get the full member experience.
Join For FreeVerify, standardize, and correct the Big 4 + more– name, email, phone and global addresses – try our Data Quality APIs now at Melissa Developer Portal!
JAX-RS is awesome to say the least and one of my favorites! Why?
- Feature rich
- Intuitive (hence the learning curve is not as steep)
- Easy-to-use and develop with
- Has great RIs – Jersey, RestEasy etc
There are enough JAX-RS fans out there who can add to this! ;-)
JAX-RS 2.0 is the latest version of the JSR 311 specification and it was released along with Java EE 7.
Life without @BeanParam
Before JAX-RS 2.0, in order to pass/inject information from an HTTP request into JAX-RS resource implementation methods, one could
1. Include multiple method arguments annotated with @FormParam, @PathParam,@QueryParam etc
2. Or, have a model class backed by JAXB/JSON or a custom MessageBodyReaderimplementation for JAX-RS Provider to be able to unmarshall the HTTP message body to a Java object – read more about this in one of my previous posts
This means that something like a HTML5 based client would need to extract the FORM input, convert it into JSON or XML payload and then POST it over the wire.
Simplification in JAX-RS 2.0
This process has been simplified by introduction of the @BeanParam annotation. It helps inject custom value/domain/model objects into fields or method parameters of JAX-RS resource classes.
In case you want to refer to the code (pretty simple) or download the example/run it yourself, here is the GitHub link
All we need to do is, annotate the fields of the model (POJO) class with the injection annotations that already exist i.e. @PathParam, @QueryParam, @HeaderParam, @MatrixParam etc – basically any of the @xxxParam metadata types and
Make sure that we include the @BeanParam annotation while injecting a reference variable of this POJO (only on METHOD, PARAMETER or FIELD).
JAX-RS provider automatically constructs and injects an instance of your domain object which you can now use within your methods.
Just fill in the form information and POST it !
That’s it. . . Short and Sweet :-)
Developers! Quickly and easily gain access to the tools and information you need! Explore, test and combine our data quality APIs at Melissa Developer Portal – home to tools that save time and boost revenue. Our APIs verify, standardize, and correct the Big 4 + more – name, email, phone and global addresses – to ensure accurate delivery, prevent blacklisting and identify risks in real-time.
Like This Article? Read More From DZone
Published at DZone with permission of Abhishek Gupta , DZone MVB. See the original article here.
Opinions expressed by DZone contributors are their own.
{{ parent.title || parent.header.title}}
{{ parent.tldr }}
{{ parent.linkDescription }}
{{ parent.urlSource.name }}