Package jakarta.ws.rs
package jakarta.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);
}
...
}
-
ClassDescriptionIdentifies the application path that serves as the base URI for all resource URIs provided by
Path.A runtime exception indicating abad 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 (HTTP4xxstatus 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 orMessageBodyReadercan 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, orHeaderParam.Indicates that the annotated method responds to HTTP DELETE requests.Disables automatic decoding of parameter values bound usingQueryParam,PathParam,FormParamorMatrixParam.A runtime exception indicating that an access to a resource requested by a client has beenforbiddenby 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 aninternal 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 isnot acceptableby the server.A runtime exception indicating a client requesting a resource method that isnot 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 wasnot foundon the server.A runtime exception indicating that the client request entity media type isnot supported.Indicates that the annotated method responds to HTTP OPTIONS requests.Indicates that the annotated method responds to HTTP PATCH 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 theirjakarta.annotation.Priorityclass-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 orMessageBodyWritercan 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 (HTTP3xxstatus codes).Enumeration of JAX-RS runtime types.Bootstrap class used to startup a JAX-RS application in Java SE environments.Provides information needed by the JAX-RS implementation for bootstrapping an application.Builder for bootstrapSeBootstrap.Configuration.Secure socket client authentication policyHandle of the running application instance.Result of stopping the application instance.A base runtime application exception indicating a server error (HTTP5xxstatus codes).A runtime exception indicating that the requested resourcecannot be served.Runtime exception for applications.