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

     ...
 }
 
  • Class
    Description
    Identifies the application path that serves as the base URI for all resource URIs provided by Path.
    A runtime exception indicating a bad client request.
    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.
    A base runtime application exception indicating a client request error (HTTP 4xx status codes).
    Indicates the run-time context in which an annotated JAX-RS provider is applicable.
    Defines the media types that the methods of a resource class or MessageBodyReader can accept.
    Binds the value of a HTTP cookie to a resource method parameter, resource class field, or resource class bean property.
    Defines the default value of request meta-data that is bound using one of the following annotations: PathParam, QueryParam, MatrixParam, CookieParam, FormParam, or HeaderParam.
    Indicates that the annotated method responds to HTTP DELETE requests.
    Disables automatic decoding of parameter values bound using QueryParam, PathParam, FormParam or MatrixParam.
    A runtime exception indicating that an access to a resource requested by a client has been forbidden by the server.
    Binds the value(s) of a form parameter contained within a request entity body to a resource method parameter.
    Indicates that the annotated method responds to HTTP GET requests.
    Indicates that the annotated method responds to HTTP HEAD requests.
    Binds the value(s) of a HTTP header to a resource method parameter, resource class field, or resource class bean property.
    Associates the name of a HTTP method with an annotation.
    A runtime exception indicating an internal server error.
    Binds the value(s) of a URI matrix parameter to a resource method parameter, resource class field, or resource class bean property.
    Meta-annotation used to create name binding annotations for filters and interceptors.
    A runtime exception indicating that a client request is not acceptable by the server.
    A runtime exception indicating a client requesting a resource method that is not allowed.
    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.
    A runtime exception indicating a resource requested by a client was not found on the server.
    A runtime exception indicating that the client request entity media type is not supported.
    Indicates that the annotated method responds to HTTP OPTIONS requests.
    Identifies the URI path that a resource class or class method will serve requests for.
    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.
    Indicates that the annotated method responds to HTTP POST requests.
    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.
    A base JAX-RS runtime processing exception.
    Defines the media type(s) that the methods of a resource class or MessageBodyWriter can produce.
    Indicates that the annotated method responds to HTTP PUT requests.
    Binds the value(s) of a HTTP query parameter to a resource method parameter, resource class field, or resource class bean property.
    A runtime application exception indicating a request redirection (HTTP 3xx status codes).
    Enumeration of JAX-RS runtime types.
    A base runtime application exception indicating a server error (HTTP 5xx status codes).
    A runtime exception indicating that the requested resource cannot be served.
    Runtime exception for applications.