All Classes and Interfaces
Class
Description
Abstract skeleton implementation of a
MultivaluedMap that is backed by a [key, multi-value] store represented
as a Map<K, List<V>>.Defines the components of a JAX-RS application and supplies additional meta-data.
Identifies the application path that serves as the base URI for all resource URIs provided by
Path.Uniform interface for asynchronous invocation of HTTP methods.
An injectable JAX-RS asynchronous response that provides means for asynchronous server side response processing.
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.
An abstraction for the value of a HTTP Cache-Control response header.
Client is the main entry point to the fluent API used to build and execute client requests in order to consume
responses returned.
Main entry point to the client API used to bootstrap
Client instances.A base runtime application exception indicating a client request error (HTTP
4xx status codes).Client request filter context.
An extension interface implemented by client request filters.
Client response filter context.
An extension interface implemented by client response filters.
A request processing callback that receives request processing completion events.
Reactive invoker based
CompletionStage.Represents a client or server-side configurable context in JAX-RS.
A configuration state associated with a
configurable JAX-RS context.Asynchronous request processing lifecycle callback that receives connection related
asynchronous
response lifecycle events.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.Container request filter context.
An extension interface implemented by container request filters.
Container response filter context.
An extension interface implemented by container response filters.
This annotation is used to inject information into a class field, bean property or method parameter.
Contract for a provider that supplies context information to resource classes and other providers.
Represents the value of a HTTP cookie, transferred in a request.
JAX-RS abstract
Cookie builder class.JAX-RS
Cookie builder class.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.
A JAX-RS meta-provider for dynamic registration of post-matching providers during a JAX-RS application setup
at deployment time.
Disables automatic decoding of parameter values bound using
QueryParam, PathParam, FormParam
or MatrixParam.Encapsulates message entity including the associated variant information.
A
EntityPart is one part of a multipart entity.Builder for
EntityPart instances.An abstraction for the value of a HTTP Entity Tag, used as the value of an ETag response header.
Contract for a provider that maps Java exceptions to
Response.A feature extension contract.
A configurable context passed to
Feature and DynamicFeature instances by JAX-RS
runtime during the phase of their configuration.A runtime exception indicating that an access to a resource requested by a client has been
forbidden by the server.Represents the the HTML form data request entity encoded using the
"application/x-www-form-urlencoded"
content type.Binds the value(s) of a form parameter contained within a request entity body to a resource method parameter.
Represents a message entity of a generic type
T.Represents a generic message entity type
T.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.
An injectable interface that provides access to HTTP header information.
Associates the name of a HTTP method with an annotation.
Inbound Server-sent event.
Context shared by message body interceptors that can be used to wrap calls to
MessageBodyReader.readFrom(java.lang.Class<T>, java.lang.reflect.Type, java.lang.annotation.Annotation[], jakarta.ws.rs.core.MediaType, jakarta.ws.rs.core.MultivaluedMap<java.lang.String, java.lang.String>, java.io.InputStream) and MessageBodyWriter.writeTo(T, java.lang.Class<?>, java.lang.reflect.Type, java.lang.annotation.Annotation[], jakarta.ws.rs.core.MediaType, jakarta.ws.rs.core.MultivaluedMap<java.lang.String, java.lang.Object>, java.io.OutputStream).A runtime exception indicating an
internal server
error.A client request invocation.
A client request invocation builder.
Callback that can be implemented to receive the asynchronous processing events from the invocation processing.
Class representing hypermedia links.
Builder class for hypermedia links.
Deprecated.
Deprecated.
Binds the value(s) of a URI matrix parameter to a resource method parameter, resource class field, or resource class
bean property.
An abstraction for a media type.
Contract for a provider that supports the conversion of a stream to a Java type.
Contract for a provider that supports the conversion of a Java type to a stream.
A hash table based implementation of
MultivaluedMap interface.A map of key-values pairs.
Meta-annotation used to create name binding annotations for filters and interceptors.
Used to create a new HTTP cookie, transferred in a response.
JAX-RS abstract
NewCookie builder class.JAX-RS
NewCookie builder class.The available values for the
SameSite cookie attribute.An I/O exception thrown by
MessageBodyReader implementations when reading a zero-length
message content to indicate that the message body reader is not able to produce an instance representing an
zero-length message content.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.
Representation of a single outbound Server-sent event.
A builder class used for creating
OutboundSseEvent instances.Defines a contract for a delegate responsible for converting between a
String form of a message parameter
value and the corresponding custom Java type T.Mandates that a conversion of any
default value delegated to a parameter
converter annotated with @Lazy annotation SHOULD occur only once the value is actually required (e.g.Contract for a provider of
ParamConverter instances.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.
Represents a URI path segment and any associated matrix parameters.
Indicates that the annotated method responds to HTTP POST requests.
Global binding annotation that can be applied to a
container request filter to
indicate that such filter should be applied globally on all resources in the application before the actual resource
matching occurs.A collection of built-in priority constants for the JAX-RS components that are supposed to be ordered based on their
jakarta.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.Marks an implementation of an extension interface that should be discoverable by JAX-RS runtime during a provider
scanning phase.
An injectable interface providing runtime lookup of provider instances.
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.
Interface for message body reader interceptors that wrap around calls to
MessageBodyReader.readFrom(java.lang.Class<T>, java.lang.reflect.Type, java.lang.annotation.Annotation[], jakarta.ws.rs.core.MediaType, jakarta.ws.rs.core.MultivaluedMap<java.lang.String, java.lang.String>, java.io.InputStream).Context class used by
ReaderInterceptor to intercept calls to (@link
jakarta.ws.rs.ext.MessageBodyReader#readFrom}.A runtime application exception indicating a request redirection (HTTP
3xx status codes).An injectable helper for request processing, all methods throw an
IllegalStateException if called outside the
scope of a request (e.g.The resource context provides access to instances of resource classes.
An injectable class to access the resource class and resource method matched by the current request.
Defines the contract between a returned instance and the runtime when an application needs to provide meta-data to
the runtime.
A class used to build Response instances that contain metadata instead of or in addition to an entity.
Commonly used status codes defined by HTTP, see
HTTP/1.1 documentation for the complete
list.
An enumeration representing the class of status code.
Base interface for statuses used in responses.
JAX-RS client-side runtime processing exception thrown to indicate that response processing has failed (e.g.
Implementations of JAX-RS provide a concrete subclass of RuntimeDelegate and various JAX-RS API methods defer to
methods of RuntimeDelegate for their functionality.
Defines the contract for a delegate that is responsible for converting between the String form of a HTTP header and
the corresponding JAX-RS type
T.Enumeration of JAX-RS runtime types.
Uniform interface for reactive invocation of HTTP methods.
RxInvoker provider.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 bootstrap
SeBootstrap.Configuration.Secure socket client authentication policy
Handle of the running application instance.
Result of stopping the application instance.
An injectable interface that provides access to security related information.
A base runtime application exception indicating a server error (HTTP
5xx status codes).A runtime exception indicating that the requested resource
cannot be served.Server-side entry point for creating
OutboundSseEvent and SseBroadcaster.Server-Sent events broadcasting facility.
Base Server Sent Event definition.
Outbound Server-Sent Events stream.
Client for reading and processing
incoming Server-Sent Events.JAX-RS
SseEventSource builder class.A type that may be used as a resource method return value or as the entity in a
Response when the application
wishes to stream the output.Inject a suspended
AsyncResponse into a parameter of an invoked JAX-RS resource
or sub-resource method.Uniform interface for synchronous invocation of HTTP methods.
Asynchronous response suspend time-out handler.
URI template-aware utility class for building URIs from their components.
A runtime exception thrown by
UriBuilder.build(Object...) methods when a URI cannot be
constructed based on the current state of the builder.An injectable interface that provides access to application and request URI information.
Abstraction for a resource representation variant.
A builder for a list of representation variants.
Runtime exception for applications.
A resource target identified by the resource URI.
Interface for message body writer interceptors that wrap around calls to
MessageBodyWriter.writeTo(T, java.lang.Class<?>, java.lang.reflect.Type, java.lang.annotation.Annotation[], jakarta.ws.rs.core.MediaType, jakarta.ws.rs.core.MultivaluedMap<java.lang.String, java.lang.Object>, java.io.OutputStream).