Package javax.ws.rs

package javax.ws.rs

High-level interfaces and annotations used to create RESTful service resources. For example:

 @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);
     }

     ...
 }
 

Related Packages

Package	Description
javax.ws.rs.client	The JAX-RS client API
javax.ws.rs.container	Container-specific JAX-RS API.
javax.ws.rs.core	Low-level interfaces and annotations used to create RESTful service resources.
javax.ws.rs.ext	APIs that provide extensions to the types supported by the JAX-RS API.

Class	Description
ApplicationPath	Identifies the application path that serves as the base URI for all resource URIs provided by Path.
BadRequestException	A runtime exception indicating a bad client request.
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.
ClientErrorException	A base runtime application exception indicating a client request error (HTTP 4xx status codes).
ConstrainedTo	Indicates the run-time context in which an annotated JAX-RS provider is applicable.
Consumes	Defines the media types that the methods of a resource class or MessageBodyReader 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 meta-data that is bound using one of the following annotations: PathParam, QueryParam, MatrixParam, CookieParam, FormParam, or HeaderParam.
DELETE	Indicates that the annotated method responds to HTTP DELETE requests.
Encoded	Disables automatic decoding of parameter values bound using QueryParam, PathParam, FormParam or MatrixParam.
ForbiddenException	A runtime exception indicating that an access to a resource requested by a client has been forbidden by the server.
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 requests.
HEAD	Indicates that the annotated method responds to HTTP HEAD requests.
HeaderParam	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.
InternalServerErrorException	A runtime exception indicating an internal server error.
MatrixParam	Binds the value(s) of a URI matrix parameter to a resource method parameter, resource class field, or resource class bean property.
NameBinding	Meta-annotation used to create name binding annotations for filters and interceptors.
NotAcceptableException	A runtime exception indicating that a client request is not acceptable by the server.
NotAllowedException	A runtime exception indicating a client requesting a resource method that is not allowed.
NotAuthorizedException	A runtime exception indicating request authorization failure caused by one of the following scenarios: a client did not send the required authorization credentials to access the requested resource, i.e.
NotFoundException	A runtime exception indicating a resource requested by a client was not found on the server.
NotSupportedException	A runtime exception indicating that the client request entity media type is not supported.
OPTIONS	Indicates that the annotated method responds to HTTP OPTIONS requests.
Path	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 requests.
Priorities	A collection of built-in priority constants for the JAX-RS components that are supposed to be ordered based on their javax.annotation.Priority class-level annotation value when used or applied by JAX-RS runtime.
ProcessingException	A base JAX-RS runtime processing exception.
Produces	Defines the media type(s) that the methods of a resource class or MessageBodyWriter can produce.
PUT	Indicates that the annotated method responds to HTTP PUT requests.
QueryParam	Binds the value(s) of a HTTP query parameter to a resource method parameter, resource class field, or resource class bean property.
RedirectionException	A runtime application exception indicating a request redirection (HTTP 3xx status codes).
RuntimeType	Enumeration of JAX-RS runtime types.
ServerErrorException	A base runtime application exception indicating a server error (HTTP 5xx status codes).
ServiceUnavailableException	A runtime exception indicating that the requested resource cannot be served.
WebApplicationException	Runtime exception for applications.