Package javax.ws.rs

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

See:
          Description

Exception Summary
ValidationException Exception class used by JAX-RS implementations to report constraint validations.
WebApplicationException Runtime exception for applications.
 

Annotation Types Summary
ApplicationPath Identifies the application path that serves as the base URI for all resource URIs provided by Path.
BindingPriority Filters and interceptors are grouped in chains for each of the extension points: Pre, PreMatch, Post as well as ReadFrom and WriteTo.
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 metadata 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.
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.
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.
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.
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.
Suspend Marks a request processed by the @Suspend-annotated JAX-RS resource method for suspending.
Uri Injects a resource target pointing at a resource identified by the resolved URI into a method parameter, class field or a bean property.
 

Package javax.ws.rs Description

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

  ...
}



Copyright © 2007-2012 Oracle Corporation. All Rights Reserved. Use is subject to license terms.