Java API for RESTful Web Services
JAX-RS: Java API for RESTful Web Services is a Java programming language API that provides support in creating web services according to the Representational State Transfer (REST) architectural pattern.[1] JAX-RS uses annotations, introduced in Java SE 5, to simplify the development and deployment of web service clients and endpoints.
From version 1.1 on, JAX-RS is an official part of Java EE 6. A notable feature of being an official part of Java EE is that no configuration is necessary to start using JAX-RS. For non-Java EE 6 environments a (small) entry in the web.xml deployment descriptor is required.
Contents |
Specification [edit]
JAX-RS provides some annotations to aid in mapping a resource class (a POJO) as a web resource. The annotations include:
- @Path specifies the relative path for a resource class or method.
- @GET, @PUT, @POST, @DELETE and @HEAD specify the HTTP request type of a resource.
- @Produces specifies the response Internet media types (used for content negotiation).
- @Consumes specifies the accepted request Internet media types.
In addition, it provides further annotations to method parameters to pull information out of the request. All the @*Param annotations take a key of some form which is used to look up the value required.
- @PathParam binds the method parameter to a path segment.
- @QueryParam binds the method parameter to the value of an HTTP query parameter.
- @MatrixParam binds the method parameter to the value of an HTTP matrix parameter.
- @HeaderParam binds the method parameter to an HTTP header value.
- @CookieParam binds the method parameter to a cookie value.
- @FormParam binds the method parameter to a form value.
- @DefaultValue specifies a default value for the above bindings when the key is not found.
- @Context returns the entire context of the object.(for example
@Context HttpServletRequest request)
JAX-RS 2.0 [edit]
In January 2011 the JCP formed the JSR 339 expert group to work on JAX-RS 2.0.[2] The main targets are (among others) a common client API and support for Hypermedia following the HATEOAS-principle of REST. As of March 2013, it has reached proposed final draft stage.[3] Public release (GA) will follow.
Implementation [edit]
Implementations of JAX-RS include:[4]
- Apache CXF, an open source Web service framework.
- Jersey, the reference implementation from Sun (now Oracle).
- RESTeasy, JBoss's implementation.
- Restlet, created by Jerome Louvel, a pioneer in REST frameworks[citation needed].
- Apache Wink, Apache Software Foundation Incubator project, the server module implements JAX-RS.
- WebSphere Application Server from IBM via the "Feature Pack for Communications Enabled Applications"
- WebLogic Application Server from Oracle, see notes
Jersey [edit]
According to the Java EE 6 Tutorial, Volume 1: Jersey is Sun's production quality reference implementation for JSR 311: JAX-RS: The Java API for RESTful Web Services. Jersey implements support for the annotations defined in JSR-311, making it easy for developers to build RESTful web services with Java and the Java JVM. Jersey also adds additional features not specified by the JSR.[5]
See also [edit]
Notes [edit]
References [edit]
- Hadley, Marc and Paul Sandoz, eds. (September 17, 2009). JAX-RS: Java API for RESTful WebServices (version 1.1), Java Community Process
|
|||||||||||||||||||||||||
|
|||||