Package javax.ws.rs
High-level interfaces and annotations used to create RESTful service
resources. E.g.:
@Path("widgets/{widgetid}") @Consumes("application/widgets+xml") @Produces("application/widgets+xml") public class WidgetResource { @GET public String getWidget(@PathParam("widgetid") String id) { return getWidgetAsXml(id); } @PUT public void updateWidget(@PathParam("widgetid") String id, Source update) { updateWidgetFromXml(id, update); } ... }
-
Exception Summary Exception Description WebApplicationException Runtime exception for applications. -
Annotation Types Summary Annotation Type Description ApplicationPath Identifies the application path that serves as the base URI for all resource URIs provided byPath
.Consumes Defines the media types that the methods of a resource class orMessageBodyReader
can accept.CookieParam Binds the value of a HTTP cookie to a resource method parameter, resource class field, or resource class bean property.DefaultValue Defines the default value of request metadata that is bound using one of the following annotations:PathParam
,QueryParam
,MatrixParam
,CookieParam
,FormParam
, orHeaderParam
.DELETE Indicates that the annotated method responds to HTTP DELETE requestsEncoded Disables automatic decoding of parameter values bound usingQueryParam
,PathParam
,FormParam
orMatrixParam
.FormParam Binds the value(s) of a form parameter contained within a request entity body to a resource method parameter.GET Indicates that the annotated method responds to HTTP GET requestsHEAD Indicates that the annotated method responds to HTTP HEAD requestsHeaderParam Binds the value(s) of a HTTP header to a resource method parameter, resource class field, or resource class bean property.HttpMethod Associates the name of a HTTP method with an annotation.MatrixParam Binds the value(s) of a URI matrix parameter to a resource method parameter, resource class field, or resource class bean property.OPTIONS Indicates that the annotated method responds to HTTP OPTIONS requestsPath Identifies the URI path that a resource class or class method will serve requests for.PathParam Binds the value of a URI template parameter or a path segment containing the template parameter to a resource method parameter, resource class field, or resource class bean property.POST Indicates that the annotated method responds to HTTP POST requestsProduces Defines the media type(s) that the methods of a resource class orMessageBodyWriter
can produce.PUT Indicates that the annotated method responds to HTTP PUT requestsQueryParam Binds the value(s) of a HTTP query parameter to a resource method parameter, resource class field, or resource class bean property.