All Classes
Class | Description |
---|---|
AbstractMultivaluedMap<K,V> |
Abstract skeleton implementation of a
MultivaluedMap that is backed by a [key, multi-value] store represented
as a Map<K, List<V>> . |
Application |
Defines the components of a JAX-RS application and supplies additional meta-data.
|
ApplicationPath |
Identifies the application path that serves as the base URI for all resource URIs provided by
Path . |
AsyncInvoker |
Uniform interface for asynchronous invocation of HTTP methods.
|
AsyncResponse |
An injectable JAX-RS asynchronous response that provides means for asynchronous server side response processing.
|
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.
|
CacheControl |
An abstraction for the value of a HTTP Cache-Control response header.
|
Client |
Client is the main entry point to the fluent API used to build and execute client requests in order to consume
responses returned.
|
ClientBuilder |
Main entry point to the client API used to bootstrap
Client instances. |
ClientErrorException |
A base runtime application exception indicating a client request error (HTTP
4xx status codes). |
ClientRequestContext |
Client request filter context.
|
ClientRequestFilter |
An extension interface implemented by client request filters.
|
ClientResponseContext |
Client response filter context.
|
ClientResponseFilter |
An extension interface implemented by client response filters.
|
CompletionCallback |
A request processing callback that receives request processing completion events.
|
CompletionStageRxInvoker |
Reactive invoker based
CompletionStage . |
Configurable<C extends Configurable> |
Represents a client or server-side configurable context in JAX-RS.
|
Configuration |
A configuration state associated with a
configurable JAX-RS context. |
ConnectionCallback |
Asynchronous request processing lifecycle callback that receives connection related
asynchronous
response lifecycle events. |
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. |
ContainerRequestContext |
Container request filter context.
|
ContainerRequestFilter |
An extension interface implemented by container request filters.
|
ContainerResponseContext |
Container response filter context.
|
ContainerResponseFilter |
An extension interface implemented by container response filters.
|
Context |
This annotation is used to inject information into a class field, bean property or method parameter.
|
ContextResolver<T> |
Contract for a provider that supplies context information to resource classes and other providers.
|
Cookie |
Represents the value of a HTTP cookie, transferred in a request.
|
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.
|
DynamicFeature |
A JAX-RS meta-provider for dynamic registration of post-matching providers during a JAX-RS application setup
at deployment time.
|
Encoded |
Disables automatic decoding of parameter values bound using
QueryParam , PathParam , FormParam
or MatrixParam . |
Entity<T> |
Encapsulates message entity including the associated variant information.
|
EntityTag |
An abstraction for the value of a HTTP Entity Tag, used as the value of an ETag response header.
|
ExceptionMapper<E extends Throwable> |
Contract for a provider that maps Java exceptions to
Response . |
Feature |
A feature extension contract.
|
FeatureContext |
A configurable context passed to
Feature and DynamicFeature instances by JAX-RS
runtime during the phase of their configuration. |
ForbiddenException |
A runtime exception indicating that an access to a resource requested by a client has been
forbidden by the server. |
Form |
Represents the the HTML form data request entity encoded using the
"application/x-www-form-urlencoded"
content type. |
FormParam |
Binds the value(s) of a form parameter contained within a request entity body to a resource method parameter.
|
GenericEntity<T> |
Represents a message entity of a generic type
T . |
GenericType<T> |
Represents a generic message entity type
T . |
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.
|
HttpHeaders |
An injectable interface that provides access to HTTP header information.
|
HttpMethod |
Associates the name of a HTTP method with an annotation.
|
InboundSseEvent |
Inbound Server-sent event.
|
InterceptorContext |
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) . |
InternalServerErrorException |
A runtime exception indicating an
internal server
error . |
Invocation |
A client request invocation.
|
Invocation.Builder |
A client request invocation builder.
|
InvocationCallback<RESPONSE> |
Callback that can be implemented to receive the asynchronous processing events from the invocation processing.
|
Link |
Class representing hypermedia links.
|
Link.Builder |
Builder class for hypermedia links.
|
Link.JaxbAdapter |
An implementation of JAXB
XmlAdapter that maps the JAX-RS
Link type to a value that can be marshalled and unmarshalled by JAXB. |
Link.JaxbLink |
Value type for
Link that can be marshalled and
unmarshalled by JAXB. |
MatrixParam |
Binds the value(s) of a URI matrix parameter to a resource method parameter, resource class field, or resource class
bean property.
|
MediaType |
An abstraction for a media type.
|
MessageBodyReader<T> |
Contract for a provider that supports the conversion of a stream to a Java type.
|
MessageBodyWriter<T> |
Contract for a provider that supports the conversion of a Java type to a stream.
|
MultivaluedHashMap<K,V> |
A hash table based implementation of
MultivaluedMap interface. |
MultivaluedMap<K,V> |
A map of key-values pairs.
|
NameBinding |
Meta-annotation used to create name binding annotations for filters and interceptors.
|
NewCookie |
Used to create a new HTTP cookie, transferred in a response.
|
NoContentException |
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. |
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.
|
OutboundSseEvent |
Representation of a single outbound Server-sent event.
|
OutboundSseEvent.Builder |
A builder class used for creating
OutboundSseEvent instances. |
ParamConverter<T> |
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 . |
ParamConverter.Lazy |
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. |
ParamConverterProvider |
Contract for a provider of
ParamConverter instances. |
PATCH |
Indicates that the annotated method responds to HTTP PATCH 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.
|
PathSegment |
Represents a URI path segment and any associated matrix parameters.
|
POST |
Indicates that the annotated method responds to HTTP POST requests.
|
PreMatching |
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. |
Priorities |
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. |
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. |
Provider |
Marks an implementation of an extension interface that should be discoverable by JAX-RS runtime during a provider
scanning phase.
|
Providers |
An injectable interface providing runtime lookup of provider instances.
|
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.
|
ReaderInterceptor |
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) . |
ReaderInterceptorContext |
Context class used by
ReaderInterceptor to intercept calls to (@link
jakarta.ws.rs.ext.MessageBodyReader#readFrom}. |
RedirectionException |
A runtime application exception indicating a request redirection (HTTP
3xx status codes). |
Request |
An injectable helper for request processing, all methods throw an
IllegalStateException if called outside the
scope of a request (e.g. |
ResourceContext |
The resource context provides access to instances of resource classes.
|
ResourceInfo |
An injectable class to access the resource class and resource method matched by the current request.
|
Response |
Defines the contract between a returned instance and the runtime when an application needs to provide meta-data to
the runtime.
|
Response.ResponseBuilder |
A class used to build Response instances that contain metadata instead of or in addition to an entity.
|
Response.Status |
Commonly used status codes defined by HTTP, see
HTTP/1.1 documentation for the complete
list.
|
Response.Status.Family |
An enumeration representing the class of status code.
|
Response.StatusType |
Base interface for statuses used in responses.
|
ResponseProcessingException |
JAX-RS client-side runtime processing exception thrown to indicate that response processing has failed (e.g.
|
RuntimeDelegate |
Implementations of JAX-RS provide a concrete subclass of RuntimeDelegate and various JAX-RS API methods defer to
methods of RuntimeDelegate for their functionality.
|
RuntimeDelegate.HeaderDelegate<T> |
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 . |
RuntimeType |
Enumeration of JAX-RS runtime types.
|
RxInvoker<T> |
Uniform interface for reactive invocation of HTTP methods.
|
RxInvokerProvider<T extends RxInvoker> |
RxInvoker provider. |
SecurityContext |
An injectable interface that provides access to security related information.
|
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 . |
Sse |
Server-side entry point for creating
OutboundSseEvent and SseBroadcaster . |
SseBroadcaster |
Server-Sent events broadcasting facility.
|
SseEvent |
Base Server Sent Event definition.
|
SseEventSink |
Outbound Server-Sent Events stream.
|
SseEventSource |
Client for reading and processing
incoming Server-Sent Events . |
SseEventSource.Builder |
JAX-RS
SseEventSource builder class. |
StreamingOutput |
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. |
Suspended |
Inject a suspended
AsyncResponse into a parameter of an invoked JAX-RS resource
or sub-resource method . |
SyncInvoker |
Uniform interface for synchronous invocation of HTTP methods.
|
TimeoutHandler |
Asynchronous response suspend time-out handler.
|
UriBuilder |
URI template-aware utility class for building URIs from their components.
|
UriBuilderException |
A runtime exception thrown by
UriBuilder.build(Object...) methods when a URI cannot be
constructed based on the current state of the builder. |
UriInfo |
An injectable interface that provides access to application and request URI information.
|
Variant |
Abstraction for a resource representation variant.
|
Variant.VariantListBuilder |
A builder for a list of representation variants.
|
WebApplicationException |
Runtime exception for applications.
|
WebTarget |
A resource target identified by the resource URI.
|
WriterInterceptor |
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) . |
WriterInterceptorContext |