Index

A B C D E F G H I J K L M N O P Q R S T U V W X
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

A

abortWith(Response) - Method in interface jakarta.ws.rs.client.ClientRequestContext

Abort the filter chain with a response.

abortWith(Response) - Method in interface jakarta.ws.rs.container.ContainerRequestContext

Abort the filter chain with a response.

AbstractCookieBuilder(String) - Constructor for class jakarta.ws.rs.core.Cookie.AbstractCookieBuilder

Create a new instance.

AbstractMultivaluedMap<K,V> - Class in jakarta.ws.rs.core

Abstract skeleton implementation of a MultivaluedMap that is backed by a [key, multi-value] store represented as a Map<K, List<V>>.

AbstractMultivaluedMap(Map<K, List<V>>) - Constructor for class jakarta.ws.rs.core.AbstractMultivaluedMap

Initialize the backing store in the abstract parent multivalued map implementation.

AbstractNewCookieBuilder(Cookie) - Constructor for class jakarta.ws.rs.core.NewCookie.AbstractNewCookieBuilder

Create a new instance supplementing the information in the supplied cookie.

AbstractNewCookieBuilder(String) - Constructor for class jakarta.ws.rs.core.NewCookie.AbstractNewCookieBuilder

Create a new instance.

accept(MediaType...) - Method in interface jakarta.ws.rs.client.Invocation.Builder

Add the accepted response media types.

accept(String...) - Method in interface jakarta.ws.rs.client.Invocation.Builder

Add the accepted response media types.

ACCEPT - Static variable in interface jakarta.ws.rs.core.HttpHeaders

See HTTP/1.1 documentation.

ACCEPT_CHARSET - Static variable in interface jakarta.ws.rs.core.HttpHeaders

See HTTP/1.1 documentation.

ACCEPT_ENCODING - Static variable in interface jakarta.ws.rs.core.HttpHeaders

See HTTP/1.1 documentation.

ACCEPT_LANGUAGE - Static variable in interface jakarta.ws.rs.core.HttpHeaders

See HTTP/1.1 documentation.

accepted() - Static method in class jakarta.ws.rs.core.Response

Create a new ResponseBuilder with an ACCEPTED status.

accepted(Object) - Static method in class jakarta.ws.rs.core.Response

Create a new ResponseBuilder with an ACCEPTED status that contains a representation.

ACCEPTED - Enum constant in enum class jakarta.ws.rs.core.Response.Status

202 Accepted, see HTTP/1.1 documentation.

acceptEncoding(String...) - Method in interface jakarta.ws.rs.client.Invocation.Builder

Add acceptable encodings.

acceptLanguage(String...) - Method in interface jakarta.ws.rs.client.Invocation.Builder

Add acceptable languages.

acceptLanguage(Locale...) - Method in interface jakarta.ws.rs.client.Invocation.Builder

Add acceptable languages.

Accessing Web Resources - Search tag in package jakarta.ws.rs.client

Section

add() - Method in class jakarta.ws.rs.core.Variant.VariantListBuilder

Add the current combination of metadata to the list of supported variants, after this method is called the current combination of metadata is emptied.

add(K, V) - Method in class jakarta.ws.rs.core.AbstractMultivaluedMap

Add a value to the current list of values for the supplied key.

add(K, V) - Method in interface jakarta.ws.rs.core.MultivaluedMap

Add a value to the current list of values for the supplied key.

addAll(K, List<V>) - Method in class jakarta.ws.rs.core.AbstractMultivaluedMap

Add all the values from the supplied value list to the current list of values for the supplied key.

addAll(K, List<V>) - Method in interface jakarta.ws.rs.core.MultivaluedMap

Add all the values from the supplied value list to the current list of values for the supplied key.

addAll(K, V...) - Method in class jakarta.ws.rs.core.AbstractMultivaluedMap

Add multiple values to the current list of values for the supplied key.

addAll(K, V...) - Method in interface jakarta.ws.rs.core.MultivaluedMap

Add multiple values to the current list of values for the supplied key.

addFirst(K, V) - Method in class jakarta.ws.rs.core.AbstractMultivaluedMap

Add a value to the first position in the current list of values for the supplied key.

addFirst(K, V) - Method in interface jakarta.ws.rs.core.MultivaluedMap

Add a value to the first position in the current list of values for the supplied key.

addFirstNull(List<V>) - Method in class jakarta.ws.rs.core.AbstractMultivaluedMap

Define the behavior for adding a null values to the first position in the value list.

addNull(List<V>) - Method in class jakarta.ws.rs.core.AbstractMultivaluedMap

Define the behavior for adding a null values to the value list.

allow(String...) - Method in class jakarta.ws.rs.core.Response.ResponseBuilder

Set the list of allowed methods for the resource.

allow(Set<String>) - Method in class jakarta.ws.rs.core.Response.ResponseBuilder

Set the list of allowed methods for the resource.

ALLOW - Static variable in interface jakarta.ws.rs.core.HttpHeaders

See HTTP/1.1 documentation.

Application - Class in jakarta.ws.rs.core

Defines the components of a JAX-RS application and supplies additional meta-data.

Application() - Constructor for class jakarta.ws.rs.core.Application

APPLICATION_ATOM_XML - Static variable in class jakarta.ws.rs.core.MediaType

A String constant representing "application/atom+xml" media type.

APPLICATION_ATOM_XML_TYPE - Static variable in class jakarta.ws.rs.core.MediaType

A MediaType constant representing "application/atom+xml" media type.

APPLICATION_FORM_URLENCODED - Static variable in class jakarta.ws.rs.core.MediaType

A String constant representing "application/x-www-form-urlencoded" media type.

APPLICATION_FORM_URLENCODED_TYPE - Static variable in class jakarta.ws.rs.core.MediaType

A MediaType constant representing "application/x-www-form-urlencoded" media type.

APPLICATION_JSON - Static variable in class jakarta.ws.rs.core.MediaType

A String constant representing "application/json" media type.

APPLICATION_JSON_PATCH_JSON - Static variable in class jakarta.ws.rs.core.MediaType

String representation of "application/json-patch+json" media type..

APPLICATION_JSON_PATCH_JSON_TYPE - Static variable in class jakarta.ws.rs.core.MediaType

A MediaType constant representing "application/json-patch+json" media type.

APPLICATION_JSON_TYPE - Static variable in class jakarta.ws.rs.core.MediaType

A MediaType constant representing "application/json" media type.

APPLICATION_MERGE_PATCH_JSON - Static variable in class jakarta.ws.rs.core.MediaType

String representation of "application/merge-patch+json" media type..

APPLICATION_MERGE_PATCH_JSON_TYPE - Static variable in class jakarta.ws.rs.core.MediaType

A MediaType constant representing "application/merge-patch+json" media type.

APPLICATION_OCTET_STREAM - Static variable in class jakarta.ws.rs.core.MediaType

A String constant representing "application/octet-stream" media type.

APPLICATION_OCTET_STREAM_TYPE - Static variable in class jakarta.ws.rs.core.MediaType

A MediaType constant representing "application/octet-stream" media type.

APPLICATION_SVG_XML - Static variable in class jakarta.ws.rs.core.MediaType

Deprecated, for removal: This API element is subject to removal in a future version.

since 4.0, use a custom string instead. Will be removed in a future release of this API.

APPLICATION_SVG_XML_TYPE - Static variable in class jakarta.ws.rs.core.MediaType

Deprecated, for removal: This API element is subject to removal in a future version.

since 4.0, use a custom MediaType instead. Will be removed in a future release of this API.

APPLICATION_XHTML_XML - Static variable in class jakarta.ws.rs.core.MediaType

A String constant representing "application/xhtml+xml" media type.

APPLICATION_XHTML_XML_TYPE - Static variable in class jakarta.ws.rs.core.MediaType

A MediaType constant representing "application/xhtml+xml" media type.

APPLICATION_XML - Static variable in class jakarta.ws.rs.core.MediaType

A String constant representing "application/xml" media type.

APPLICATION_XML_TYPE - Static variable in class jakarta.ws.rs.core.MediaType

A MediaType constant representing "application/xml" media type.

ApplicationPath - Annotation Interface in jakarta.ws.rs

Identifies the application path that serves as the base URI for all resource URIs provided by Path.

aroundReadFrom(ReaderInterceptorContext) - Method in interface jakarta.ws.rs.ext.ReaderInterceptor

Interceptor method wrapping 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) method.

aroundWriteTo(WriterInterceptorContext) - Method in interface jakarta.ws.rs.ext.WriterInterceptor

Interceptor method wrapping 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) method.

asMap() - Method in class jakarta.ws.rs.core.Form

Returns multivalued map representation of the form.

async() - Method in interface jakarta.ws.rs.client.Invocation.Builder

Access the asynchronous uniform request invocation interface to asynchronously invoke the built request.

AsyncInvoker - Interface in jakarta.ws.rs.client

Uniform interface for asynchronous invocation of HTTP methods.

AsyncResponse - Interface in jakarta.ws.rs.container

An injectable JAX-RS asynchronous response that provides means for asynchronous server side response processing.

AUTHENTICATION - Static variable in class jakarta.ws.rs.Priorities

Security authentication filter/interceptor priority.

AUTHORIZATION - Static variable in interface jakarta.ws.rs.core.HttpHeaders

See HTTP/1.1 documentation.

AUTHORIZATION - Static variable in class jakarta.ws.rs.Priorities

Security authorization filter/interceptor priority.

B

BAD_GATEWAY - Enum constant in enum class jakarta.ws.rs.core.Response.Status

502 Bad Gateway, see HTTP/1.1 documentation.

BAD_REQUEST - Enum constant in enum class jakarta.ws.rs.core.Response.Status

400 Bad Request, see HTTP/1.1 documentation.

BadRequestException - Exception Class in jakarta.ws.rs

A runtime exception indicating a bad client request.

BadRequestException() - Constructor for exception class jakarta.ws.rs.BadRequestException

Construct a new bad client request exception.

BadRequestException(Response) - Constructor for exception class jakarta.ws.rs.BadRequestException

Construct a new bad client request exception.

BadRequestException(Response, Throwable) - Constructor for exception class jakarta.ws.rs.BadRequestException

Construct a new bad client request exception.

BadRequestException(String) - Constructor for exception class jakarta.ws.rs.BadRequestException

Construct a new bad client request exception.

BadRequestException(String, Response) - Constructor for exception class jakarta.ws.rs.BadRequestException

Construct a new bad client request exception.

BadRequestException(String, Response, Throwable) - Constructor for exception class jakarta.ws.rs.BadRequestException

Construct a new bad client request exception.

BadRequestException(String, Throwable) - Constructor for exception class jakarta.ws.rs.BadRequestException

Construct a new bad client request exception.

BadRequestException(Throwable) - Constructor for exception class jakarta.ws.rs.BadRequestException

Construct a new bad client request exception.

baseUri() - Method in interface jakarta.ws.rs.SeBootstrap.Configuration

Convenience method that returns a built the URI for the application.

baseUri(String) - Method in interface jakarta.ws.rs.core.Link.Builder

Set the base URI as a string for resolution of relative URIs.

baseUri(URI) - Method in interface jakarta.ws.rs.core.Link.Builder

Set the base URI for resolution of relative URIs.

baseUriBuilder() - Method in interface jakarta.ws.rs.SeBootstrap.Configuration

Returns a UriBuilder that includes the application root path.

BASIC_AUTH - Static variable in interface jakarta.ws.rs.core.SecurityContext

String identifier for Basic authentication.

BeanParam - Annotation Interface in jakarta.ws.rs

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.

bootstrap(Application, SeBootstrap.Configuration) - Method in class jakarta.ws.rs.ext.RuntimeDelegate

Perform startup of the application in Java SE environments.

bootstrap(Class<? extends Application>, SeBootstrap.Configuration) - Method in class jakarta.ws.rs.ext.RuntimeDelegate

Perform startup of the application in Java SE environments.

broadcast(OutboundSseEvent) - Method in interface jakarta.ws.rs.sse.SseBroadcaster

Publish an SSE event to all registered SseEventSink instances.

bufferEntity() - Method in class jakarta.ws.rs.core.Response

Buffer the message entity data.

build() - Method in class jakarta.ws.rs.client.ClientBuilder

Build a new client instance using all the configuration previously specified in this client builder.

build() - Method in class jakarta.ws.rs.core.Cookie.AbstractCookieBuilder

Build a new Cookie instance using all the configuration previously specified in this builder.

build() - Method in class jakarta.ws.rs.core.Cookie.Builder

build() - Method in interface jakarta.ws.rs.core.EntityPart.Builder

Builds a new EntityPart instance using the provided property values.

build() - Method in class jakarta.ws.rs.core.NewCookie.AbstractNewCookieBuilder

Build a new NewCookie instance using all the configuration previously specified in this builder.

build() - Method in class jakarta.ws.rs.core.NewCookie.Builder

build() - Method in class jakarta.ws.rs.core.Response.ResponseBuilder

Create a Response instance from the current ResponseBuilder.

build() - Method in class jakarta.ws.rs.core.Variant.VariantListBuilder

Add the current combination of metadata to the list of supported variants (provided the current combination of metadata is not empty) and build a list of representation variants from the current state of the builder.

build() - Method in interface jakarta.ws.rs.SeBootstrap.Configuration.Builder

Builds a bootstrap configuration instance from the provided property values.

build() - Method in interface jakarta.ws.rs.sse.OutboundSseEvent.Builder

Build OutboundSseEvent.

build() - Method in class jakarta.ws.rs.sse.SseEventSource.Builder

Build new SSE event source pointing at a SSE streaming web target.

build(Object...) - Method in interface jakarta.ws.rs.core.Link.Builder

Finish building this link using the supplied values as URI parameters.

build(Object...) - Method in class jakarta.ws.rs.core.UriBuilder

Build a URI, using the supplied values in order to replace any URI template parameters.

build(Object[], boolean) - Method in class jakarta.ws.rs.core.UriBuilder

Build a URI, using the supplied values in order to replace any URI template parameters.

build(String) - Method in interface jakarta.ws.rs.client.Invocation.Builder

Build a request invocation using an arbitrary request method name.

build(String, Entity<?>) - Method in interface jakarta.ws.rs.client.Invocation.Builder

Build a request invocation using an arbitrary request method name and request entity.

buildDelete() - Method in interface jakarta.ws.rs.client.Invocation.Builder

Build a DELETE request invocation.

builder() - Static method in interface jakarta.ws.rs.SeBootstrap.Configuration

Creates a new bootstrap configuration builder instance.

Builder() - Constructor for class jakarta.ws.rs.sse.SseEventSource.Builder

Allows custom implementations to extend the SSE event source builder class.

Builder(Cookie) - Constructor for class jakarta.ws.rs.core.NewCookie.Builder

Create a new instance supplementing the information in the supplied cookie.

Builder(String) - Constructor for class jakarta.ws.rs.core.Cookie.Builder

Create a new instance.

Builder(String) - Constructor for class jakarta.ws.rs.core.NewCookie.Builder

Create a new instance.

buildFromEncoded(Object...) - Method in class jakarta.ws.rs.core.UriBuilder

Build a URI.

buildFromEncodedMap(Map<String, ?>) - Method in class jakarta.ws.rs.core.UriBuilder

Build a URI.

buildFromMap(Map<String, ?>) - Method in class jakarta.ws.rs.core.UriBuilder

Build a URI.

buildFromMap(Map<String, ?>, boolean) - Method in class jakarta.ws.rs.core.UriBuilder

Build a URI.

buildGet() - Method in interface jakarta.ws.rs.client.Invocation.Builder

Build a GET request invocation.

buildPost(Entity<?>) - Method in interface jakarta.ws.rs.client.Invocation.Builder

Build a POST request invocation.

buildPut(Entity<?>) - Method in interface jakarta.ws.rs.client.Invocation.Builder

Build a PUT request invocation.

buildRelativized(URI, Object...) - Method in interface jakarta.ws.rs.core.Link.Builder

Finish building this link using the supplied values as URI parameters and relativize the result with respect to the supplied URI.

C

CACHE_CONTROL - Static variable in interface jakarta.ws.rs.core.HttpHeaders

See HTTP/1.1 documentation.

cacheControl(CacheControl) - Method in interface jakarta.ws.rs.client.Invocation.Builder

Set the cache control data of the message.

cacheControl(CacheControl) - Method in class jakarta.ws.rs.core.Response.ResponseBuilder

Set the cache control data of the message.

CacheControl - Class in jakarta.ws.rs.core

An abstraction for the value of a HTTP Cache-Control response header.

CacheControl() - Constructor for class jakarta.ws.rs.core.CacheControl

Create a new instance of CacheControl.

cancel() - Method in interface jakarta.ws.rs.container.AsyncResponse

Cancel the suspended request processing.

cancel(int) - Method in interface jakarta.ws.rs.container.AsyncResponse

Cancel the suspended request processing.

cancel(Date) - Method in interface jakarta.ws.rs.container.AsyncResponse

Cancel the suspended request processing.

CHARSET_PARAMETER - Static variable in class jakarta.ws.rs.core.MediaType

The media type charset parameter name.

clear() - Method in class jakarta.ws.rs.core.AbstractMultivaluedMap

Client - Interface in jakarta.ws.rs.client

Client is the main entry point to the fluent API used to build and execute client requests in order to consume responses returned.

CLIENT - Enum constant in enum class jakarta.ws.rs.RuntimeType

JAX-RS client run-time.

CLIENT_CERT_AUTH - Static variable in interface jakarta.ws.rs.core.SecurityContext

String identifier for Client Certificate authentication.

CLIENT_ERROR - Enum constant in enum class jakarta.ws.rs.core.Response.Status.Family

4xx HTTP status codes.

Client API Bootstrapping and Configuration - Search tag in package jakarta.ws.rs.client

Section

ClientBuilder - Class in jakarta.ws.rs.client

Main entry point to the client API used to bootstrap Client instances.

ClientBuilder() - Constructor for class jakarta.ws.rs.client.ClientBuilder

Allows custom implementations to extend the ClientBuilder class.

ClientErrorException - Exception Class in jakarta.ws.rs

A base runtime application exception indicating a client request error (HTTP 4xx status codes).

ClientErrorException(int) - Constructor for exception class jakarta.ws.rs.ClientErrorException

Construct a new client error exception.

ClientErrorException(int, Throwable) - Constructor for exception class jakarta.ws.rs.ClientErrorException

Construct a new client error exception.

ClientErrorException(Response) - Constructor for exception class jakarta.ws.rs.ClientErrorException

Construct a new client error exception.

ClientErrorException(Response.Status) - Constructor for exception class jakarta.ws.rs.ClientErrorException

Construct a new client error exception.

ClientErrorException(Response.Status, Throwable) - Constructor for exception class jakarta.ws.rs.ClientErrorException

Construct a new client error exception.

ClientErrorException(Response, Throwable) - Constructor for exception class jakarta.ws.rs.ClientErrorException

Construct a new client error exception.

ClientErrorException(String, int) - Constructor for exception class jakarta.ws.rs.ClientErrorException

Construct a new client error exception.

ClientErrorException(String, int, Throwable) - Constructor for exception class jakarta.ws.rs.ClientErrorException

Construct a new client error exception.

ClientErrorException(String, Response) - Constructor for exception class jakarta.ws.rs.ClientErrorException

Construct a new client error exception.

ClientErrorException(String, Response.Status) - Constructor for exception class jakarta.ws.rs.ClientErrorException

Construct a new client error exception.

ClientErrorException(String, Response.Status, Throwable) - Constructor for exception class jakarta.ws.rs.ClientErrorException

Construct a new client error exception.

ClientErrorException(String, Response, Throwable) - Constructor for exception class jakarta.ws.rs.ClientErrorException

Construct a new client error exception.

ClientRequestContext - Interface in jakarta.ws.rs.client

Client request filter context.

ClientRequestFilter - Interface in jakarta.ws.rs.client

An extension interface implemented by client request filters.

ClientResponseContext - Interface in jakarta.ws.rs.client

Client response filter context.

ClientResponseFilter - Interface in jakarta.ws.rs.client

An extension interface implemented by client response filters.

clone() - Method in class jakarta.ws.rs.core.Response.ResponseBuilder

clone() - Method in class jakarta.ws.rs.core.UriBuilder

Create a copy of the UriBuilder preserving its state.

close() - Method in interface jakarta.ws.rs.client.Client

Close client instance and all it's associated resources.

close() - Method in class jakarta.ws.rs.core.Response

Close the underlying message entity input stream (if available and open) as well as releases any other resources associated with the response (e.g.

close() - Method in interface jakarta.ws.rs.sse.SseBroadcaster

Close the broadcaster and all registered SseEventSink instances.

close() - Method in interface jakarta.ws.rs.sse.SseEventSink

Close the SseEventSink instance and release all associated resources.

close() - Method in interface jakarta.ws.rs.sse.SseEventSource

Close this event source.

close(boolean) - Method in interface jakarta.ws.rs.sse.SseBroadcaster

Close the broadcaster and release any resources associated with it.

close(long, TimeUnit) - Method in interface jakarta.ws.rs.sse.SseEventSource

Close this event source and wait for the internal event processing task to complete for up to the specified amount of wait time.

comment(String) - Method in class jakarta.ws.rs.core.NewCookie.AbstractNewCookieBuilder

Set the comment associated with the cookie.

comment(String) - Method in interface jakarta.ws.rs.sse.OutboundSseEvent.Builder

Set comment string associated with the event.

completed(RESPONSE) - Method in interface jakarta.ws.rs.client.InvocationCallback

Called when the invocation was successfully completed.

CompletionCallback - Interface in jakarta.ws.rs.container

A request processing callback that receives request processing completion events.

CompletionStageRxInvoker - Interface in jakarta.ws.rs.client

Reactive invoker based CompletionStage.

Configurable<C> - Interface in jakarta.ws.rs.core

Represents a client or server-side configurable context in JAX-RS.

configuration() - Method in interface jakarta.ws.rs.SeBootstrap.Instance

Provides access to the configuration actually used by the implementation used to create this instance.

Configuration - Interface in jakarta.ws.rs.core

A configuration state associated with a configurable JAX-RS context.

configure(ResourceInfo, FeatureContext) - Method in interface jakarta.ws.rs.container.DynamicFeature

A callback method called by the JAX-RS runtime during the application deployment to register provider instances or classes in a runtime configuration scope of a particular resource or sub-resource method; i.e.

configure(FeatureContext) - Method in interface jakarta.ws.rs.core.Feature

A call-back method called when the feature is to be enabled in a given runtime configuration scope.

CONFLICT - Enum constant in enum class jakarta.ws.rs.core.Response.Status

409 Conflict, see HTTP/1.1 documentation.

ConnectionCallback - Interface in jakarta.ws.rs.container

Asynchronous request processing lifecycle callback that receives connection related asynchronous response lifecycle events.

connectTimeout(long, TimeUnit) - Method in class jakarta.ws.rs.client.ClientBuilder

Set the connect timeout.

ConstrainedTo - Annotation Interface in jakarta.ws.rs

Indicates the run-time context in which an annotated JAX-RS provider is applicable.

Consumes - Annotation Interface in jakarta.ws.rs

Defines the media types that the methods of a resource class or MessageBodyReader can accept.

ContainerRequestContext - Interface in jakarta.ws.rs.container

Container request filter context.

ContainerRequestFilter - Interface in jakarta.ws.rs.container

An extension interface implemented by container request filters.

ContainerResponseContext - Interface in jakarta.ws.rs.container

Container response filter context.

ContainerResponseFilter - Interface in jakarta.ws.rs.container

An extension interface implemented by container response filters.

containsHeaderString(String, String, Predicate<String>) - Method in interface jakarta.ws.rs.client.ClientRequestContext

Checks whether a header with a specific name and value (or item of the token-separated value list) exists.

containsHeaderString(String, String, Predicate<String>) - Method in interface jakarta.ws.rs.client.ClientResponseContext

Checks whether a header with a specific name and value (or item of the token-separated value list) exists.

containsHeaderString(String, String, Predicate<String>) - Method in interface jakarta.ws.rs.container.ContainerRequestContext

Checks whether a header with a specific name and value (or item of the token-separated value list) exists.

containsHeaderString(String, String, Predicate<String>) - Method in interface jakarta.ws.rs.container.ContainerResponseContext

Checks whether a header with a specific name and value (or item of the token-separated value list) exists.

containsHeaderString(String, String, Predicate<String>) - Method in interface jakarta.ws.rs.core.HttpHeaders

Checks whether a header with a specific name and value (or item of the token-separated value list) exists.

containsHeaderString(String, Predicate<String>) - Method in interface jakarta.ws.rs.client.ClientRequestContext

Checks whether a header with a specific name and value (or item of the comma-separated value list) exists.

containsHeaderString(String, Predicate<String>) - Method in interface jakarta.ws.rs.client.ClientResponseContext

Checks whether a header with a specific name and value (or item of the comma-separated value list) exists.

containsHeaderString(String, Predicate<String>) - Method in interface jakarta.ws.rs.container.ContainerRequestContext

Checks whether a header with a specific name and value (or item of the comma-separated value list) exists.

containsHeaderString(String, Predicate<String>) - Method in interface jakarta.ws.rs.container.ContainerResponseContext

Checks whether a header with a specific name and value (or item of the comma-separated value list) exists.

containsHeaderString(String, Predicate<String>) - Method in interface jakarta.ws.rs.core.HttpHeaders

Checks whether a header with a specific name and value (or item of the comma-separated value list) exists.

containsKey(Object) - Method in class jakarta.ws.rs.core.AbstractMultivaluedMap

containsValue(Object) - Method in class jakarta.ws.rs.core.AbstractMultivaluedMap

content(InputStream) - Method in interface jakarta.ws.rs.core.EntityPart.Builder

Sets the content for this part.

content(Object) - Method in interface jakarta.ws.rs.core.EntityPart.Builder

Sets the content for this part.

content(String, InputStream) - Method in interface jakarta.ws.rs.core.EntityPart.Builder

Convenience method, equivalent to calling fileName(fileName).content(content).

content(T, GenericType<T>) - Method in interface jakarta.ws.rs.core.EntityPart.Builder

Sets the content for this part.

content(T, Class<? extends T>) - Method in interface jakarta.ws.rs.core.EntityPart.Builder

Sets the content for this part.

CONTENT_DISPOSITION - Static variable in interface jakarta.ws.rs.core.HttpHeaders

See IETF RFC-2183.

CONTENT_ENCODING - Static variable in interface jakarta.ws.rs.core.HttpHeaders

See HTTP/1.1 documentation.

CONTENT_ID - Static variable in interface jakarta.ws.rs.core.HttpHeaders

See IETF RFC-2392.

CONTENT_LANGUAGE - Static variable in interface jakarta.ws.rs.core.HttpHeaders

See HTTP/1.1 documentation.

CONTENT_LENGTH - Static variable in interface jakarta.ws.rs.core.HttpHeaders

See HTTP/1.1 documentation.

CONTENT_LOCATION - Static variable in interface jakarta.ws.rs.core.HttpHeaders

See HTTP/1.1 documentation.

CONTENT_TYPE - Static variable in interface jakarta.ws.rs.core.HttpHeaders

See HTTP/1.1 documentation.

contentLocation(URI) - Method in class jakarta.ws.rs.core.Response.ResponseBuilder

Set the content location.

Context - Annotation Interface in jakarta.ws.rs.core

This annotation is used to inject information into a class field, bean property or method parameter.

ContextResolver<T> - Interface in jakarta.ws.rs.ext

Contract for a provider that supplies context information to resource classes and other providers.

cookie(Cookie) - Method in interface jakarta.ws.rs.client.Invocation.Builder

Add a cookie to be set.

cookie(NewCookie...) - Method in class jakarta.ws.rs.core.Response.ResponseBuilder

Add cookies to the response message.

cookie(String, String) - Method in interface jakarta.ws.rs.client.Invocation.Builder

Add a cookie to be set.

Cookie - Class in jakarta.ws.rs.core

Represents the value of a HTTP cookie, transferred in a request.

Cookie(Cookie.AbstractCookieBuilder<?>) - Constructor for class jakarta.ws.rs.core.Cookie

Create a new instance from the supplied Cookie.AbstractCookieBuilder instance.

Cookie(String, String) - Constructor for class jakarta.ws.rs.core.Cookie

Deprecated.

This constructor will be removed in a future version. Please use Cookie.Builder instead.

Cookie(String, String, String, String) - Constructor for class jakarta.ws.rs.core.Cookie

Deprecated.

This constructor will be removed in a future version. Please use Cookie.Builder instead.

Cookie(String, String, String, String, int) - Constructor for class jakarta.ws.rs.core.Cookie

Deprecated.

This constructor will be removed in a future version. Please use Cookie.Builder instead.

COOKIE - Static variable in interface jakarta.ws.rs.core.HttpHeaders

See IETF RFC 2109.

Cookie.AbstractCookieBuilder<T> - Class in jakarta.ws.rs.core

JAX-RS abstract Cookie builder class.

Cookie.Builder - Class in jakarta.ws.rs.core

JAX-RS Cookie builder class.

CookieParam - Annotation Interface in jakarta.ws.rs

Binds the value of a HTTP cookie to a resource method parameter, resource class field, or resource class bean property.

createConfigurationBuilder() - Method in class jakarta.ws.rs.ext.RuntimeDelegate

Create a new instance of a SeBootstrap.Configuration.Builder.

created(URI) - Static method in class jakarta.ws.rs.core.Response

Create a new ResponseBuilder for a created resource, set the location header using the supplied value.

CREATED - Enum constant in enum class jakarta.ws.rs.core.Response.Status

201 Created, see HTTP/1.1 documentation.

createEndpoint(Application, Class<T>) - Method in class jakarta.ws.rs.ext.RuntimeDelegate

Create a configured instance of the supplied endpoint type.

createEntityPartBuilder(String) - Method in class jakarta.ws.rs.ext.RuntimeDelegate

Create a new instance of a EntityPart.Builder.

createHeaderDelegate(Class<T>) - Method in class jakarta.ws.rs.ext.RuntimeDelegate

Obtain an instance of a RuntimeDelegate.HeaderDelegate for the supplied class.

createLinkBuilder() - Method in class jakarta.ws.rs.ext.RuntimeDelegate

Create a new instance of a Link.Builder.

createResponseBuilder() - Method in class jakarta.ws.rs.ext.RuntimeDelegate

Create a new instance of a Response.ResponseBuilder.

createUriBuilder() - Method in class jakarta.ws.rs.ext.RuntimeDelegate

Create a new instance of a UriBuilder.

createVariantListBuilder() - Method in class jakarta.ws.rs.ext.RuntimeDelegate

Create a new instance of a Variant.VariantListBuilder.

D

data(GenericType, Object) - Method in interface jakarta.ws.rs.sse.OutboundSseEvent.Builder

Set event data and a generic java type of event data.

data(Class, Object) - Method in interface jakarta.ws.rs.sse.OutboundSseEvent.Builder

Set event data and java type of event data.

data(Object) - Method in interface jakarta.ws.rs.sse.OutboundSseEvent.Builder

Set event data and java type of event data.

DATE - Static variable in interface jakarta.ws.rs.core.HttpHeaders

See HTTP/1.1 documentation.

DEFAULT_MAX_AGE - Static variable in class jakarta.ws.rs.core.NewCookie

Specifies that the cookie expires with the current application/browser session.

DEFAULT_PORT - Static variable in interface jakarta.ws.rs.SeBootstrap.Configuration

Special value for SeBootstrap.Configuration.PORT property indicating that the implementation MUST use its default port.

DEFAULT_VERSION - Static variable in class jakarta.ws.rs.core.Cookie

Cookies using the default version correspond to RFC 2109.

DefaultValue - Annotation Interface in jakarta.ws.rs

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() - Method in interface jakarta.ws.rs.client.AsyncInvoker

Invoke HTTP DELETE method for the current request asynchronously.

delete() - Method in interface jakarta.ws.rs.client.CompletionStageRxInvoker

delete() - Method in interface jakarta.ws.rs.client.RxInvoker

Invoke HTTP DELETE method for the current request.

delete() - Method in interface jakarta.ws.rs.client.SyncInvoker

Invoke HTTP DELETE method for the current request synchronously.

delete(InvocationCallback<T>) - Method in interface jakarta.ws.rs.client.AsyncInvoker

Invoke HTTP DELETE method for the current request asynchronously.

delete(GenericType<R>) - Method in interface jakarta.ws.rs.client.RxInvoker

Invoke HTTP DELETE method for the current request.

delete(GenericType<T>) - Method in interface jakarta.ws.rs.client.AsyncInvoker

Invoke HTTP DELETE method for the current request asynchronously.

delete(GenericType<T>) - Method in interface jakarta.ws.rs.client.CompletionStageRxInvoker

delete(GenericType<T>) - Method in interface jakarta.ws.rs.client.SyncInvoker

Invoke HTTP DELETE method for the current request synchronously.

delete(Class<R>) - Method in interface jakarta.ws.rs.client.RxInvoker

Invoke HTTP DELETE method for the current request.

delete(Class<T>) - Method in interface jakarta.ws.rs.client.AsyncInvoker

Invoke HTTP DELETE method for the current request asynchronously.

delete(Class<T>) - Method in interface jakarta.ws.rs.client.CompletionStageRxInvoker

delete(Class<T>) - Method in interface jakarta.ws.rs.client.SyncInvoker

Invoke HTTP DELETE method for the current request synchronously.

DELETE - Annotation Interface in jakarta.ws.rs

Indicates that the annotated method responds to HTTP DELETE requests.

DELETE - Static variable in annotation interface jakarta.ws.rs.HttpMethod

HTTP DELETE method.

DIGEST_AUTH - Static variable in interface jakarta.ws.rs.core.SecurityContext

String identifier for Digest authentication.

domain(String) - Method in class jakarta.ws.rs.core.Cookie.AbstractCookieBuilder

Set the domain of the cookie.

DynamicFeature - Interface in jakarta.ws.rs.container

A JAX-RS meta-provider for dynamic registration of post-matching providers during a JAX-RS application setup at deployment time.

E

Encoded - Annotation Interface in jakarta.ws.rs

Disables automatic decoding of parameter values bound using QueryParam, PathParam, FormParam or MatrixParam.

encoding(String) - Method in class jakarta.ws.rs.core.Response.ResponseBuilder

Set the message entity content encoding.

encodings(String...) - Static method in class jakarta.ws.rs.core.Variant

Create a Variant.VariantListBuilder initialized with a set of supported encodings.

encodings(String...) - Method in class jakarta.ws.rs.core.Variant.VariantListBuilder

Set the encoding(s) for this variant.

entity(Object) - Method in class jakarta.ws.rs.core.Response.ResponseBuilder

Set the response entity in the builder.

entity(Object, Annotation[]) - Method in class jakarta.ws.rs.core.Response.ResponseBuilder

Set the response entity in the builder.

entity(T, MediaType) - Static method in class jakarta.ws.rs.client.Entity

Create an entity using a supplied content media type.

entity(T, MediaType, Annotation[]) - Static method in class jakarta.ws.rs.client.Entity

Create an entity using a supplied content media type.

entity(T, Variant) - Static method in class jakarta.ws.rs.client.Entity

Create an entity using a supplied content media type.

entity(T, Variant, Annotation[]) - Static method in class jakarta.ws.rs.client.Entity

Create an entity using a supplied content media type.

entity(T, String) - Static method in class jakarta.ws.rs.client.Entity

Create an entity using a supplied content media type.

Entity<T> - Class in jakarta.ws.rs.client

Encapsulates message entity including the associated variant information.

ENTITY_CODER - Static variable in class jakarta.ws.rs.Priorities

Message encoder or decoder filter/interceptor priority.

EntityPart - Interface in jakarta.ws.rs.core

A EntityPart is one part of a multipart entity.

EntityPart.Builder - Interface in jakarta.ws.rs.core

Builder for EntityPart instances.

EntityTag - Class in jakarta.ws.rs.core

An abstraction for the value of a HTTP Entity Tag, used as the value of an ETag response header.

EntityTag(String) - Constructor for class jakarta.ws.rs.core.EntityTag

Creates a new instance of a strong EntityTag.

EntityTag(String, boolean) - Constructor for class jakarta.ws.rs.core.EntityTag

Creates a new instance of an EntityTag.

entrySet() - Method in class jakarta.ws.rs.core.AbstractMultivaluedMap

equals(Object) - Method in class jakarta.ws.rs.client.Entity

equals(Object) - Method in class jakarta.ws.rs.core.AbstractMultivaluedMap

equals(Object) - Method in class jakarta.ws.rs.core.CacheControl

Compares object argument to this cache control to see if they are the same considering all property values.

equals(Object) - Method in class jakarta.ws.rs.core.Cookie

Compare for equality.

equals(Object) - Method in class jakarta.ws.rs.core.EntityTag

Compares obj to this tag to see if they are the same considering weakness and value.

equals(Object) - Method in class jakarta.ws.rs.core.GenericEntity

equals(Object) - Method in class jakarta.ws.rs.core.GenericType

equals(Object) - Method in class jakarta.ws.rs.core.MediaType

Compares obj to this media type to see if they are the same by comparing type, subtype and parameters.

equals(Object) - Method in class jakarta.ws.rs.core.NewCookie

Compare for equality.

equals(Object) - Method in class jakarta.ws.rs.core.Variant

Compares obj to this variant to see if they are the same considering all property values.

equalsIgnoreValueOrder(MultivaluedMap<K, V>) - Method in class jakarta.ws.rs.core.AbstractMultivaluedMap

equalsIgnoreValueOrder(MultivaluedMap<K, V>) - Method in interface jakarta.ws.rs.core.MultivaluedMap

Compare the specified map with this map for equality modulo the order of values for each key.

ETAG - Static variable in interface jakarta.ws.rs.core.HttpHeaders

See HTTP/1.1 documentation.

evaluatePreconditions() - Method in interface jakarta.ws.rs.core.Request

Evaluate request preconditions for a resource that does not currently exist.

evaluatePreconditions(EntityTag) - Method in interface jakarta.ws.rs.core.Request

Evaluate request preconditions based on the passed in value.

evaluatePreconditions(Date) - Method in interface jakarta.ws.rs.core.Request

Evaluate request preconditions based on the passed in value.

evaluatePreconditions(Date, EntityTag) - Method in interface jakarta.ws.rs.core.Request

Evaluate request preconditions based on the passed in value.

ExceptionMapper<E> - Interface in jakarta.ws.rs.ext

Contract for a provider that maps Java exceptions to Response.

executorService(ExecutorService) - Method in class jakarta.ws.rs.client.ClientBuilder

Set the client-side ExecutorService.

EXPECT - Static variable in interface jakarta.ws.rs.core.HttpHeaders

See HTTP/1.1 documentation.

EXPECTATION_FAILED - Enum constant in enum class jakarta.ws.rs.core.Response.Status

417 Expectation Failed, see HTTP/1.1 documentation.

expires(Date) - Method in class jakarta.ws.rs.core.Response.ResponseBuilder

Set the response expiration date.

EXPIRES - Static variable in interface jakarta.ws.rs.core.HttpHeaders

See HTTP/1.1 documentation.

expiry(Date) - Method in class jakarta.ws.rs.core.NewCookie.AbstractNewCookieBuilder

Set the cookie expiry date.

F

failed(Throwable) - Method in interface jakarta.ws.rs.client.InvocationCallback

Called when the invocation has failed for any reason.

familyOf(int) - Static method in enum class jakarta.ws.rs.core.Response.Status.Family

Get the response status family for the status code.

Feature - Interface in jakarta.ws.rs.core

A feature extension contract.

FeatureContext - Interface in jakarta.ws.rs.core

A configurable context passed to Feature and DynamicFeature instances by JAX-RS runtime during the phase of their configuration.

fileName(String) - Method in interface jakarta.ws.rs.core.EntityPart.Builder

Sets the file name for this part.

filter(ClientRequestContext) - Method in interface jakarta.ws.rs.client.ClientRequestFilter

Filter method called before a request has been dispatched to a client transport layer.

filter(ClientRequestContext, ClientResponseContext) - Method in interface jakarta.ws.rs.client.ClientResponseFilter

Filter method called after a response has been provided for a request (either by a request filter or when the HTTP invocation returns).

filter(ContainerRequestContext) - Method in interface jakarta.ws.rs.container.ContainerRequestFilter

Filter method called before a request has been dispatched to a resource.

filter(ContainerRequestContext, ContainerResponseContext) - Method in interface jakarta.ws.rs.container.ContainerResponseFilter

Filter method called after a response has been provided for a request (either by a request filter or by a matched resource method.

FORBIDDEN - Enum constant in enum class jakarta.ws.rs.core.Response.Status

403 Forbidden, see HTTP/1.1 documentation.

ForbiddenException - Exception Class in jakarta.ws.rs

A runtime exception indicating that an access to a resource requested by a client has been forbidden by the server.

ForbiddenException() - Constructor for exception class jakarta.ws.rs.ForbiddenException

Construct a new "forbidden" exception.

ForbiddenException(Response) - Constructor for exception class jakarta.ws.rs.ForbiddenException

Construct a new "forbidden" exception.

ForbiddenException(Response, Throwable) - Constructor for exception class jakarta.ws.rs.ForbiddenException

Construct a new "forbidden" exception.

ForbiddenException(String) - Constructor for exception class jakarta.ws.rs.ForbiddenException

Construct a new "forbidden" exception.

ForbiddenException(String, Response) - Constructor for exception class jakarta.ws.rs.ForbiddenException

Construct a new "forbidden" exception.

ForbiddenException(String, Response, Throwable) - Constructor for exception class jakarta.ws.rs.ForbiddenException

Construct a new "forbidden" exception.

ForbiddenException(String, Throwable) - Constructor for exception class jakarta.ws.rs.ForbiddenException

Construct a new "forbidden" exception.

ForbiddenException(Throwable) - Constructor for exception class jakarta.ws.rs.ForbiddenException

Construct a new "forbidden" exception.

forInstance(Object) - Static method in class jakarta.ws.rs.core.GenericType

Create a generic type from a Java instance.

form(Form) - Static method in class jakarta.ws.rs.client.Entity

Create an "application/x-www-form-urlencoded" form entity.

form(MultivaluedMap<String, String>) - Static method in class jakarta.ws.rs.client.Entity

Create an "application/x-www-form-urlencoded" form entity.

Form - Class in jakarta.ws.rs.core

Represents the the HTML form data request entity encoded using the "application/x-www-form-urlencoded" content type.

Form() - Constructor for class jakarta.ws.rs.core.Form

Create a new form data instance.

Form(MultivaluedMap<String, String>) - Constructor for class jakarta.ws.rs.core.Form

Create a new form data instance and register a custom underlying parameter store.

Form(String, String) - Constructor for class jakarta.ws.rs.core.Form

Create a new form data instance with a single parameter entry.

FORM_AUTH - Static variable in interface jakarta.ws.rs.core.SecurityContext

String identifier for Form authentication.

FormParam - Annotation Interface in jakarta.ws.rs

Binds the value(s) of a form parameter contained within a request entity body to a resource method parameter.

FOUND - Enum constant in enum class jakarta.ws.rs.core.Response.Status

302 Found, see HTTP/1.1 documentation.

fragment(String) - Method in class jakarta.ws.rs.core.UriBuilder

Set the URI fragment.

FREE_PORT - Static variable in interface jakarta.ws.rs.SeBootstrap.Configuration

Special value for SeBootstrap.Configuration.PORT property indicating that the implementation MUST scan for a free port.

from(Object) - Method in interface jakarta.ws.rs.SeBootstrap.Configuration.Builder

Optional convenience method to bulk-load external configuration.

from(BiFunction<String, Class<T>, Optional<T>>) - Method in interface jakarta.ws.rs.SeBootstrap.Configuration.Builder

Convenience method for bulk-loading configuration from a property supplier.

fromLink(Link) - Static method in class jakarta.ws.rs.core.Link

Create a new builder instance initialized from another link.

fromLink(Link) - Static method in class jakarta.ws.rs.core.UriBuilder

Create a new instance initialized from a Link.

fromMethod(Class<?>, String) - Static method in class jakarta.ws.rs.core.Link

Convenience method to build a link from a resource.

fromMethod(Class<?>, String) - Static method in class jakarta.ws.rs.core.UriBuilder

Create a new instance representing a relative URI initialized from a Path-annotated method.

fromPath(String) - Static method in class jakarta.ws.rs.core.Link

Convenience method to build a link from a path.

fromPath(String) - Static method in class jakarta.ws.rs.core.UriBuilder

Create a new instance representing a relative URI initialized from a URI path.

fromResource(Class<?>) - Static method in class jakarta.ws.rs.core.Link

Convenience method to build a link from a resource.

fromResource(Class<?>) - Static method in class jakarta.ws.rs.core.UriBuilder

Create a new instance representing a relative URI initialized from a root resource class.

fromResponse(Response) - Static method in class jakarta.ws.rs.core.Response

Create a new ResponseBuilder by performing a shallow copy of an existing Response.

fromStatusCode(int) - Static method in enum class jakarta.ws.rs.core.Response.Status

Convert a numerical status code into the corresponding Status.

fromString(String) - Method in interface jakarta.ws.rs.ext.ParamConverter

Parse the supplied value and create an instance of T.

fromString(String) - Method in interface jakarta.ws.rs.ext.RuntimeDelegate.HeaderDelegate

Parse the supplied value and create an instance of T.

fromUri(String) - Static method in class jakarta.ws.rs.core.Link

Create a new builder instance initialized from an existing URI represented as a string.

fromUri(String) - Static method in class jakarta.ws.rs.core.UriBuilder

Create a new instance initialized from an existing URI.

fromUri(URI) - Static method in class jakarta.ws.rs.core.Link

Create a new builder instance initialized from an existing URI.

fromUri(URI) - Static method in class jakarta.ws.rs.core.UriBuilder

Create a new instance initialized from an existing URI.

fromUriBuilder(UriBuilder) - Static method in class jakarta.ws.rs.core.Link

Create a new builder instance initialized from a URI builder.

G

GATEWAY_TIMEOUT - Enum constant in enum class jakarta.ws.rs.core.Response.Status

504 Gateway Timeout, see HTTP/1.1 documentation.

GenericEntity<T> - Class in jakarta.ws.rs.core

Represents a message entity of a generic type T.

GenericEntity(T) - Constructor for class jakarta.ws.rs.core.GenericEntity

Constructs a new generic entity.

GenericEntity(T, Type) - Constructor for class jakarta.ws.rs.core.GenericEntity

Create a new instance of GenericEntity, supplying the generic type information.

Generic Invocations - Search tag in package jakarta.ws.rs.client

Section

GenericType<T> - Class in jakarta.ws.rs.core

Represents a generic message entity type T.

GenericType() - Constructor for class jakarta.ws.rs.core.GenericType

Constructs a new generic type, deriving the generic type and class from type parameter.

GenericType(Type) - Constructor for class jakarta.ws.rs.core.GenericType

Constructs a new generic type, supplying the generic type information and deriving the class.

get() - Method in interface jakarta.ws.rs.client.AsyncInvoker

Invoke HTTP GET method for the current request asynchronously.

get() - Method in interface jakarta.ws.rs.client.CompletionStageRxInvoker

get() - Method in interface jakarta.ws.rs.client.RxInvoker

Invoke HTTP GET method for the current request.

get() - Method in interface jakarta.ws.rs.client.SyncInvoker

Invoke HTTP GET method for the current request synchronously.

get(InvocationCallback<T>) - Method in interface jakarta.ws.rs.client.AsyncInvoker

Invoke HTTP GET method for the current request asynchronously.

get(GenericType<R>) - Method in interface jakarta.ws.rs.client.RxInvoker

Invoke HTTP GET method for the current request.

get(GenericType<T>) - Method in interface jakarta.ws.rs.client.AsyncInvoker

Invoke HTTP GET method for the current request asynchronously.

get(GenericType<T>) - Method in interface jakarta.ws.rs.client.CompletionStageRxInvoker

get(GenericType<T>) - Method in interface jakarta.ws.rs.client.SyncInvoker

Invoke HTTP GET method for the current request synchronously.

get(Class<R>) - Method in interface jakarta.ws.rs.client.RxInvoker

Invoke HTTP GET method for the current request.

get(Class<T>) - Method in interface jakarta.ws.rs.client.AsyncInvoker

Invoke HTTP GET method for the current request asynchronously.

get(Class<T>) - Method in interface jakarta.ws.rs.client.CompletionStageRxInvoker

get(Class<T>) - Method in interface jakarta.ws.rs.client.SyncInvoker

Invoke HTTP GET method for the current request synchronously.

get(Object) - Method in class jakarta.ws.rs.core.AbstractMultivaluedMap

GET - Annotation Interface in jakarta.ws.rs

Indicates that the annotated method responds to HTTP GET requests.

GET - Static variable in annotation interface jakarta.ws.rs.HttpMethod

HTTP GET method.

getAbsolutePath() - Method in interface jakarta.ws.rs.core.UriInfo

Get the absolute path of the request.

getAbsolutePathBuilder() - Method in interface jakarta.ws.rs.core.UriInfo

Get the absolute path of the request in the form of a UriBuilder.

getAcceptableLanguages() - Method in interface jakarta.ws.rs.client.ClientRequestContext

Get a list of languages that are acceptable for the response.

getAcceptableLanguages() - Method in interface jakarta.ws.rs.container.ContainerRequestContext

Get a list of languages that are acceptable for the response.

getAcceptableLanguages() - Method in interface jakarta.ws.rs.core.HttpHeaders

Get a list of languages that are acceptable for the response.

getAcceptableMediaTypes() - Method in interface jakarta.ws.rs.client.ClientRequestContext

Get a list of media types that are acceptable for the response.

getAcceptableMediaTypes() - Method in interface jakarta.ws.rs.container.ContainerRequestContext

Get a list of media types that are acceptable for the response.

getAcceptableMediaTypes() - Method in interface jakarta.ws.rs.core.HttpHeaders

Get a list of media types that are acceptable for the response.

getAllowedMethods() - Method in interface jakarta.ws.rs.client.ClientResponseContext

Get the allowed HTTP methods from the Allow HTTP header.

getAllowedMethods() - Method in interface jakarta.ws.rs.container.ContainerResponseContext

Get the allowed HTTP methods from the Allow HTTP header.

getAllowedMethods() - Method in class jakarta.ws.rs.core.Response

Get the allowed HTTP methods from the Allow HTTP header.

getAnnotations() - Method in class jakarta.ws.rs.client.Entity

Get the entity annotations.

getAnnotations() - Method in interface jakarta.ws.rs.ext.InterceptorContext

Get an array of the annotations formally declared on the artifact that initiated the intercepted entity provider invocation.

getAuthenticationScheme() - Method in interface jakarta.ws.rs.core.SecurityContext

Returns the string value of the authentication scheme used to protect the resource.

getBaseUri() - Method in interface jakarta.ws.rs.core.UriInfo

Get the base URI of the application.

getBaseUriBuilder() - Method in interface jakarta.ws.rs.core.UriInfo

Get the base URI of the application in the form of a UriBuilder.

getCacheExtension() - Method in class jakarta.ws.rs.core.CacheControl

Corresponds to a set of extension cache control directives.

getChallenges() - Method in exception class jakarta.ws.rs.NotAuthorizedException

Get the list of authorization challenges associated with the exception and applicable to the resource requested by the client.

getClasses() - Method in class jakarta.ws.rs.core.Application

Get a set of root resource, provider and feature classes.

getClasses() - Method in interface jakarta.ws.rs.core.Configuration

Get the immutable set of registered JAX-RS component (such as provider, root resource or feature) classes to be instantiated, injected and utilized in the scope of the configurable instance.

getClient() - Method in interface jakarta.ws.rs.client.ClientRequestContext

Get the client instance associated with the request.

getComment() - Method in class jakarta.ws.rs.core.NewCookie

Get the comment associated with the cookie.

getComment() - Method in interface jakarta.ws.rs.sse.SseEvent

Get a comment string that accompanies the event.

getConfiguration() - Method in interface jakarta.ws.rs.client.ClientRequestContext

Get the immutable configuration of the request.

getConfiguration() - Method in interface jakarta.ws.rs.core.Configurable

Get a live view of an internal configuration state of this configurable instance.

getContent() - Method in interface jakarta.ws.rs.core.EntityPart

Returns the input stream for this part.

getContent(GenericType<T>) - Method in interface jakarta.ws.rs.core.EntityPart

Converts the content stream for this part to the specified type and returns it.

getContent(Class<T>) - Method in interface jakarta.ws.rs.core.EntityPart

Converts the content stream for this part to the specified class and returns it.

getContext(Class<?>) - Method in interface jakarta.ws.rs.ext.ContextResolver

Get a context of type T that is applicable to the supplied type.

getContextResolver(Class<T>, MediaType) - Method in interface jakarta.ws.rs.ext.Providers

Get a context resolver for a particular type of context and media type.

getContracts(Class<?>) - Method in interface jakarta.ws.rs.core.Configuration

Get the extension contract registration information for a component of a given class.

getConverter(Class<T>, Type, Annotation[]) - Method in interface jakarta.ws.rs.ext.ParamConverterProvider

Obtain a ParamConverter that can provide from/to string conversion for an instance of a particular Java type.

getCookies() - Method in interface jakarta.ws.rs.client.ClientRequestContext

Get any cookies that accompanied the request.

getCookies() - Method in interface jakarta.ws.rs.client.ClientResponseContext

Get any new cookies set on the response message.

getCookies() - Method in interface jakarta.ws.rs.container.ContainerRequestContext

Get any cookies that accompanied the request.

getCookies() - Method in interface jakarta.ws.rs.container.ContainerResponseContext

Get any new cookies set on the response message.

getCookies() - Method in interface jakarta.ws.rs.core.HttpHeaders

Get any cookies that accompanied the request.

getCookies() - Method in class jakarta.ws.rs.core.Response

Get any new cookies set on the response message.

getData() - Method in interface jakarta.ws.rs.sse.OutboundSseEvent

Get event data.

getDate() - Method in interface jakarta.ws.rs.client.ClientRequestContext

Get message date.

getDate() - Method in interface jakarta.ws.rs.client.ClientResponseContext

Get message date.

getDate() - Method in interface jakarta.ws.rs.container.ContainerRequestContext

Get message date.

getDate() - Method in interface jakarta.ws.rs.container.ContainerResponseContext

Get message date.

getDate() - Method in interface jakarta.ws.rs.core.HttpHeaders

Get message date.

getDate() - Method in class jakarta.ws.rs.core.Response

Get message date.

getDomain() - Method in class jakarta.ws.rs.core.Cookie

Get the domain of the cookie.

getEncoding() - Method in class jakarta.ws.rs.client.Entity

Get entity encoding.

getEncoding() - Method in class jakarta.ws.rs.core.Variant

Get the encoding of the variant.

getEntity() - Method in interface jakarta.ws.rs.client.ClientRequestContext

Get the message entity Java instance.

getEntity() - Method in class jakarta.ws.rs.client.Entity

Get entity data.

getEntity() - Method in interface jakarta.ws.rs.container.ContainerResponseContext

Get the message entity Java instance.

getEntity() - Method in class jakarta.ws.rs.core.GenericEntity

Get the enclosed entity.

getEntity() - Method in class jakarta.ws.rs.core.Response

Get the message entity Java instance.

getEntity() - Method in interface jakarta.ws.rs.ext.WriterInterceptorContext

Get object to be written as HTTP entity.

getEntityAnnotations() - Method in interface jakarta.ws.rs.client.ClientRequestContext

Get the annotations attached to the entity instance.

getEntityAnnotations() - Method in interface jakarta.ws.rs.container.ContainerResponseContext

Get the annotations attached to the entity instance.

getEntityClass() - Method in interface jakarta.ws.rs.client.ClientRequestContext

Get the raw entity type information.

getEntityClass() - Method in interface jakarta.ws.rs.container.ContainerResponseContext

Get the raw entity type information.

getEntityStream() - Method in interface jakarta.ws.rs.client.ClientRequestContext

Get the entity output stream.

getEntityStream() - Method in interface jakarta.ws.rs.client.ClientResponseContext

Get the entity input stream.

getEntityStream() - Method in interface jakarta.ws.rs.container.ContainerRequestContext

Get the entity input stream.

getEntityStream() - Method in interface jakarta.ws.rs.container.ContainerResponseContext

Get the entity output stream.

getEntityTag() - Method in interface jakarta.ws.rs.client.ClientResponseContext

Get the entity tag.

getEntityTag() - Method in interface jakarta.ws.rs.container.ContainerResponseContext

Get the entity tag.

getEntityTag() - Method in class jakarta.ws.rs.core.Response

Get the entity tag.

getEntityType() - Method in interface jakarta.ws.rs.client.ClientRequestContext

Get the generic entity type information.

getEntityType() - Method in interface jakarta.ws.rs.container.ContainerResponseContext

Get the generic entity type information.

getExceptionMapper(Class<T>) - Method in interface jakarta.ws.rs.ext.Providers

Get an exception mapping provider for a particular class of exception.

getExpiry() - Method in class jakarta.ws.rs.core.NewCookie

Get the cookie expiry date.

getFamily() - Method in enum class jakarta.ws.rs.core.Response.Status

Get the class of status code.

getFamily() - Method in interface jakarta.ws.rs.core.Response.StatusType

Get the class of status code.

getFileName() - Method in interface jakarta.ws.rs.core.EntityPart

Returns the filename of this part.

getFirst(K) - Method in class jakarta.ws.rs.core.AbstractMultivaluedMap

getFirst(K) - Method in interface jakarta.ws.rs.core.MultivaluedMap

A shortcut to get the first value of the supplied key.

getGenericType() - Method in interface jakarta.ws.rs.ext.InterceptorContext

Get the type of the object to be produced or written.

getGenericType() - Method in interface jakarta.ws.rs.sse.OutboundSseEvent

Get generic data type.

getHeaders() - Method in interface jakarta.ws.rs.client.ClientRequestContext

Get the mutable request headers multivalued map.

getHeaders() - Method in interface jakarta.ws.rs.client.ClientResponseContext

Get the mutable response headers multivalued map.

getHeaders() - Method in interface jakarta.ws.rs.container.ContainerRequestContext

Get the mutable request headers multivalued map.

getHeaders() - Method in interface jakarta.ws.rs.container.ContainerResponseContext

Get the mutable response headers multivalued map.

getHeaders() - Method in interface jakarta.ws.rs.core.EntityPart

Returns an immutable multivalued map of headers for this specific part.

getHeaders() - Method in class jakarta.ws.rs.core.Response

Get view of the response headers and their object values.

getHeaders() - Method in interface jakarta.ws.rs.ext.ReaderInterceptorContext

Get mutable map of HTTP headers.

getHeaders() - Method in interface jakarta.ws.rs.ext.WriterInterceptorContext

Get mutable map of HTTP headers.

getHeaderString(String) - Method in interface jakarta.ws.rs.client.ClientRequestContext

Get a message header as a single string value.

getHeaderString(String) - Method in interface jakarta.ws.rs.client.ClientResponseContext

Get a message header as a single string value.

getHeaderString(String) - Method in interface jakarta.ws.rs.container.ContainerRequestContext

Get a message header as a single string value.

getHeaderString(String) - Method in interface jakarta.ws.rs.container.ContainerResponseContext

Get a message header as a single string value.

getHeaderString(String) - Method in interface jakarta.ws.rs.core.HttpHeaders

Get a HTTP header as a single string value.

getHeaderString(String) - Method in class jakarta.ws.rs.core.Response

Get a message header as a single string value.

getHostnameVerifier() - Method in interface jakarta.ws.rs.client.Client

Get the hostname verifier configured in the client or null in case no hostname verifier has been configured.

getId() - Method in interface jakarta.ws.rs.sse.SseEvent

Get event identifier.

getInputStream() - Method in interface jakarta.ws.rs.ext.ReaderInterceptorContext

Get the input stream of the object to be read.

getInstance() - Static method in class jakarta.ws.rs.ext.RuntimeDelegate

Obtain a RuntimeDelegate instance.

getInstances() - Method in interface jakarta.ws.rs.core.Configuration

Get the immutable set of registered JAX-RS component (such as provider or feature) instances to be utilized by the configurable instance.

getLanguage() - Method in interface jakarta.ws.rs.client.ClientRequestContext

Get the language of the entity.

getLanguage() - Method in interface jakarta.ws.rs.client.ClientResponseContext

Get the language of the entity.

getLanguage() - Method in class jakarta.ws.rs.client.Entity

Get entity language.

getLanguage() - Method in interface jakarta.ws.rs.container.ContainerRequestContext

Get the language of the entity.

getLanguage() - Method in interface jakarta.ws.rs.container.ContainerResponseContext

Get the language of the entity.

getLanguage() - Method in interface jakarta.ws.rs.core.HttpHeaders

Get the language of the request entity.

getLanguage() - Method in class jakarta.ws.rs.core.Response

Get the language of the message entity.

getLanguage() - Method in class jakarta.ws.rs.core.Variant

Get the language of the variant.

getLanguageString() - Method in class jakarta.ws.rs.core.Variant

Get the string representation of the variant language, or null if no language has been set.

getLastModified() - Method in interface jakarta.ws.rs.client.ClientResponseContext

Get the last modified date.

getLastModified() - Method in interface jakarta.ws.rs.container.ContainerResponseContext

Get the last modified date.

getLastModified() - Method in class jakarta.ws.rs.core.Response

Get the last modified date.

getLength() - Method in interface jakarta.ws.rs.client.ClientResponseContext

Get Content-Length value.

getLength() - Method in interface jakarta.ws.rs.container.ContainerRequestContext

Get Content-Length value.

getLength() - Method in interface jakarta.ws.rs.container.ContainerResponseContext

Get Content-Length value.

getLength() - Method in interface jakarta.ws.rs.core.HttpHeaders

Get Content-Length value.

getLength() - Method in class jakarta.ws.rs.core.Response

Get Content-Length value.

getLink(String) - Method in interface jakarta.ws.rs.client.ClientResponseContext

Get the link for the relation.

getLink(String) - Method in interface jakarta.ws.rs.container.ContainerResponseContext

Get the link for the relation.

getLink(String) - Method in class jakarta.ws.rs.core.Response

Get the link for the relation.

getLinkBuilder(String) - Method in interface jakarta.ws.rs.client.ClientResponseContext

Convenience method that returns a Link.Builder for the relation.

getLinkBuilder(String) - Method in interface jakarta.ws.rs.container.ContainerResponseContext

Convenience method that returns a Link.Builder for the relation.

getLinkBuilder(String) - Method in class jakarta.ws.rs.core.Response

Convenience method that returns a Link.Builder for the relation.

getLinks() - Method in interface jakarta.ws.rs.client.ClientResponseContext

Get the links attached to the message as header.

getLinks() - Method in interface jakarta.ws.rs.container.ContainerResponseContext

Get the links attached to the message as header.

getLinks() - Method in class jakarta.ws.rs.core.Response

Get the links attached to the message as headers.

getLocation() - Method in interface jakarta.ws.rs.client.ClientResponseContext

Get the location.

getLocation() - Method in interface jakarta.ws.rs.container.ContainerResponseContext

Get the location.

getLocation() - Method in class jakarta.ws.rs.core.Response

Get the location.

getLocation() - Method in exception class jakarta.ws.rs.RedirectionException

Get the redirection response location.

getMatchedResources() - Method in interface jakarta.ws.rs.core.UriInfo

Get a read-only list of the currently matched resource class instances.

getMatchedResourceTemplate() - Method in interface jakarta.ws.rs.core.UriInfo

Get a URI template that includes all Paths (including ApplicationPath) matched by the current request's URI.

getMatchedURIs() - Method in interface jakarta.ws.rs.core.UriInfo

Get a read-only list of URIs for matched resources.

getMatchedURIs(boolean) - Method in interface jakarta.ws.rs.core.UriInfo

Get a read-only list of URIs for matched resources.

getMatrixParameters() - Method in interface jakarta.ws.rs.core.PathSegment

Get a map of the matrix parameters associated with the path segment.

getMaxAge() - Method in class jakarta.ws.rs.core.CacheControl

Corresponds to the max-age cache control directive.

getMaxAge() - Method in class jakarta.ws.rs.core.NewCookie

Get the maximum age of the the cookie in seconds.

getMediaType() - Method in interface jakarta.ws.rs.client.ClientRequestContext

Get the media type of the entity.

getMediaType() - Method in interface jakarta.ws.rs.client.ClientResponseContext

Get the media type of the entity.

getMediaType() - Method in class jakarta.ws.rs.client.Entity

Get entity media type.

getMediaType() - Method in interface jakarta.ws.rs.container.ContainerRequestContext

Get the media type of the entity.

getMediaType() - Method in interface jakarta.ws.rs.container.ContainerResponseContext

Get the media type of the entity.

getMediaType() - Method in interface jakarta.ws.rs.core.EntityPart

Returns the content type of this part, and equivalent to calling MediaType.valueOf(part.getHeaders().getFirst(HttpHeaders.CONTENT_TYPE)).

getMediaType() - Method in interface jakarta.ws.rs.core.HttpHeaders

Get the media type of the request entity.

getMediaType() - Method in class jakarta.ws.rs.core.Response

Get the media type of the message entity.

getMediaType() - Method in class jakarta.ws.rs.core.Variant

Get the media type of the variant.

getMediaType() - Method in interface jakarta.ws.rs.ext.InterceptorContext

Get media type of HTTP entity.

getMediaType() - Method in interface jakarta.ws.rs.sse.OutboundSseEvent

Get media type of the event data.

getMessageBodyReader(Class<T>, Type, Annotation[], MediaType) - Method in interface jakarta.ws.rs.ext.Providers

Get a message body reader that matches a set of criteria.

getMessageBodyWriter(Class<T>, Type, Annotation[], MediaType) - Method in interface jakarta.ws.rs.ext.Providers

Get a message body writer that matches a set of criteria.

getMetadata() - Method in class jakarta.ws.rs.core.Response

See Response.getHeaders().

getMethod() - Method in interface jakarta.ws.rs.client.ClientRequestContext

Get the request method.

getMethod() - Method in interface jakarta.ws.rs.container.ContainerRequestContext

Get the request method.

getMethod() - Method in interface jakarta.ws.rs.core.Request

Get the request method, e.g.

getName() - Method in class jakarta.ws.rs.core.Cookie

Get the name of the cookie.

getName() - Method in interface jakarta.ws.rs.core.EntityPart

Returns the name of this part within the multipart entity.

getName() - Method in interface jakarta.ws.rs.sse.SseEvent

Get event name.

getNoCacheFields() - Method in class jakarta.ws.rs.core.CacheControl

Corresponds to the value of the no-cache cache control directive.

getOutputStream() - Method in interface jakarta.ws.rs.ext.WriterInterceptorContext

Get the output stream for the object to be written.

getParameters() - Method in class jakarta.ws.rs.core.MediaType

Getter for a read-only parameter map.

getParams() - Method in class jakarta.ws.rs.core.Link

Returns an immutable map that includes all the link parameters defined on this link.

getPath() - Method in class jakarta.ws.rs.core.Cookie

Get the path of the cookie.

getPath() - Method in interface jakarta.ws.rs.core.PathSegment

Get the path segment.

getPath() - Method in interface jakarta.ws.rs.core.UriInfo

Get the path of the current request relative to the base URI as a string.

getPath(boolean) - Method in interface jakarta.ws.rs.core.UriInfo

Get the path of the current request relative to the base URI as a string.

getPathParameters() - Method in interface jakarta.ws.rs.core.UriInfo

Get the values of any embedded URI template parameters.

getPathParameters(boolean) - Method in interface jakarta.ws.rs.core.UriInfo

Get the values of any embedded URI template parameters.

getPathSegments() - Method in interface jakarta.ws.rs.core.UriInfo

Get the path of the current request relative to the base URI as a list of PathSegment.

getPathSegments(boolean) - Method in interface jakarta.ws.rs.core.UriInfo

Get the path of the current request relative to the base URI as a list of PathSegment.

getPrivateFields() - Method in class jakarta.ws.rs.core.CacheControl

Corresponds to the value of the private cache control directive.

getProperties() - Method in class jakarta.ws.rs.core.Application

Get a map of custom application-wide properties.

getProperties() - Method in interface jakarta.ws.rs.core.Configuration

Get the immutable bag of configuration properties.

getProperty(String) - Method in interface jakarta.ws.rs.client.ClientRequestContext

Returns the property with the given name registered in the current request/response exchange context, or null if there is no property by that name.

getProperty(String) - Method in interface jakarta.ws.rs.container.ContainerRequestContext

Returns the property with the given name registered in the current request/response exchange context, or null if there is no property by that name.

getProperty(String) - Method in interface jakarta.ws.rs.core.Configuration

Get the value for the property with a given name.

getProperty(String) - Method in interface jakarta.ws.rs.ext.InterceptorContext

Returns the property with the given name registered in the current request/response exchange context, or null if there is no property by that name.

getPropertyNames() - Method in interface jakarta.ws.rs.client.ClientRequestContext

Returns an immutable collection containing the property names available within the context of the current request/response exchange context.

getPropertyNames() - Method in interface jakarta.ws.rs.container.ContainerRequestContext

Returns an immutable collection containing the property names available within the context of the current request/response exchange context.

getPropertyNames() - Method in interface jakarta.ws.rs.core.Configuration

Returns an immutable collection containing the property names available within the context of the current configuration instance.

getPropertyNames() - Method in interface jakarta.ws.rs.ext.InterceptorContext

Returns an immutable collection containing the property names available within the context of the current request/response exchange context.

getQueryParameters() - Method in interface jakarta.ws.rs.core.UriInfo

Get the URI query parameters of the current request.

getQueryParameters(boolean) - Method in interface jakarta.ws.rs.core.UriInfo

Get the URI query parameters of the current request.

getRawType() - Method in class jakarta.ws.rs.core.GenericEntity

Gets the raw type of the enclosed entity.

getRawType() - Method in class jakarta.ws.rs.core.GenericType

Returns the object representing the class or interface that declared the type represented by this generic type instance.

getReasonPhrase() - Method in enum class jakarta.ws.rs.core.Response.Status

Get the reason phrase.

getReasonPhrase() - Method in interface jakarta.ws.rs.core.Response.StatusType

Get the reason phrase.

getReconnectDelay() - Method in interface jakarta.ws.rs.sse.SseEvent

Get new connection retry time in milliseconds the event receiver should wait before attempting to reconnect after a connection to the SSE event source is lost.

getRel() - Method in class jakarta.ws.rs.core.Link

Returns the value associated with the link rel param, or null if this param is not specified.

getRels() - Method in class jakarta.ws.rs.core.Link

Returns the value associated with the link rel param as a list of strings or the empty list if rel is not defined.

getRequest() - Method in interface jakarta.ws.rs.container.ContainerRequestContext

Get the injectable request information.

getRequestHeader(String) - Method in interface jakarta.ws.rs.core.HttpHeaders

Get the values of a HTTP request header if the header exists on the current request.

getRequestHeaders() - Method in interface jakarta.ws.rs.core.HttpHeaders

Get the values of HTTP request headers.

getRequestUri() - Method in interface jakarta.ws.rs.core.UriInfo

Get the absolute request URI including any query parameters.

getRequestUriBuilder() - Method in interface jakarta.ws.rs.core.UriInfo

Get the absolute request URI in the form of a UriBuilder.

getResource(Class<T>) - Method in interface jakarta.ws.rs.container.ResourceContext

Get a resolved instance of a resource or sub-resource class.

getResourceClass() - Method in interface jakarta.ws.rs.container.ResourceInfo

Get the resource class that is the target of a request, or null if this information is not available.

getResourceMethod() - Method in interface jakarta.ws.rs.container.ResourceInfo

Get the resource method that is the target of a request, or null if this information is not available.

getResponse() - Method in exception class jakarta.ws.rs.client.ResponseProcessingException

Get the HTTP response for which the processing has failed.

getResponse() - Method in exception class jakarta.ws.rs.WebApplicationException

Get the HTTP response.

getRetryTime(Date) - Method in exception class jakarta.ws.rs.ServiceUnavailableException

Get the retry time for the failed request.

getRuntimeType() - Method in interface jakarta.ws.rs.core.Configuration

Get the runtime type of this configuration context.

getRxInvoker(SyncInvoker, ExecutorService) - Method in interface jakarta.ws.rs.client.RxInvokerProvider

Get RxInvoker implementation instance.

getSameSite() - Method in class jakarta.ws.rs.core.NewCookie

Returns the value of the SameSite attribute for this cookie or null if the attribute is not set.

getSecurityContext() - Method in interface jakarta.ws.rs.container.ContainerRequestContext

Get the injectable security context information for the current request.

getSingletons() - Method in class jakarta.ws.rs.core.Application

Deprecated.

Automatic discovery of resources and providers or the getClasses method is preferred over getSingletons.

getSize(T, Class<?>, Type, Annotation[], MediaType) - Method in interface jakarta.ws.rs.ext.MessageBodyWriter

Originally, the method has been called before writeTo to ascertain the length in bytes of the serialized form of t.

getSMaxAge() - Method in class jakarta.ws.rs.core.CacheControl

Corresponds to the s-maxage cache control directive.

getSslContext() - Method in interface jakarta.ws.rs.client.Client

Get the SSL context configured to be used with the current client run-time.

getStatus() - Method in interface jakarta.ws.rs.client.ClientResponseContext

Get the status code associated with the response.

getStatus() - Method in interface jakarta.ws.rs.container.ContainerResponseContext

Get the status code associated with the response.

getStatus() - Method in class jakarta.ws.rs.core.Response

Get the status code associated with the response.

getStatusCode() - Method in enum class jakarta.ws.rs.core.Response.Status

Get the associated status code.

getStatusCode() - Method in interface jakarta.ws.rs.core.Response.StatusType

Get the associated status code.

getStatusInfo() - Method in interface jakarta.ws.rs.client.ClientResponseContext

Get the complete status information associated with the response.

getStatusInfo() - Method in interface jakarta.ws.rs.container.ContainerResponseContext

Get the complete status information associated with the response.

getStatusInfo() - Method in class jakarta.ws.rs.core.Response

Get the complete status information associated with the response.

getStringHeaders() - Method in interface jakarta.ws.rs.client.ClientRequestContext

Get a string view of header values associated with the message.

getStringHeaders() - Method in interface jakarta.ws.rs.container.ContainerResponseContext

Get a string view of header values associated with the message.

getStringHeaders() - Method in class jakarta.ws.rs.core.Response

Get view of the response headers and their string values.

getSubtype() - Method in class jakarta.ws.rs.core.MediaType

Getter for subtype.

getTitle() - Method in class jakarta.ws.rs.core.Link

Returns the value associated with the link title param, or null if this param is not specified.

getType() - Method in class jakarta.ws.rs.core.GenericEntity

Gets underlying Type instance.

getType() - Method in class jakarta.ws.rs.core.GenericType

Retrieve the type represented by the generic type instance.

getType() - Method in class jakarta.ws.rs.core.Link

Returns the value associated with the link type param, or null if this param is not specified.

getType() - Method in class jakarta.ws.rs.core.MediaType

Getter for primary type.

getType() - Method in interface jakarta.ws.rs.ext.InterceptorContext

Get Java type supported by corresponding message body provider.

getType() - Method in interface jakarta.ws.rs.sse.OutboundSseEvent

Get data type.

getUri() - Method in interface jakarta.ws.rs.client.ClientRequestContext

Get the request URI.

getUri() - Method in interface jakarta.ws.rs.client.WebTarget

Get the URI identifying the resource.

getUri() - Method in class jakarta.ws.rs.core.Link

Returns the underlying URI associated with this link.

getUriBuilder() - Method in interface jakarta.ws.rs.client.WebTarget

Get the URI builder initialized with the URI of the current resource target.

getUriBuilder() - Method in class jakarta.ws.rs.core.Link

Convenience method that returns a UriBuilder initialized with this link's underlying URI.

getUriInfo() - Method in interface jakarta.ws.rs.container.ContainerRequestContext

Get request URI information.

getUserPrincipal() - Method in interface jakarta.ws.rs.core.SecurityContext

Returns a java.security.Principal object containing the name of the current authenticated user.

getValue() - Method in class jakarta.ws.rs.core.Cookie

Get the value of the cookie.

getValue() - Method in class jakarta.ws.rs.core.EntityTag

Get the value of an EntityTag.

getValues(K) - Method in class jakarta.ws.rs.core.AbstractMultivaluedMap

Return a non-null list of values for a given key.

getVariant() - Method in class jakarta.ws.rs.client.Entity

Get entity variant information.

getVersion() - Method in class jakarta.ws.rs.core.Cookie

Get the version of the cookie.

GONE - Enum constant in enum class jakarta.ws.rs.core.Response.Status

410 Gone, see HTTP/1.1 documentation.

H

handleTimeout(AsyncResponse) - Method in interface jakarta.ws.rs.container.TimeoutHandler

Invoked when the suspended asynchronous response is about to time out.

hasEntity() - Method in interface jakarta.ws.rs.client.ClientRequestContext

Check if there is an entity available in the request.

hasEntity() - Method in interface jakarta.ws.rs.client.ClientResponseContext

Check if there is a non-empty entity input stream is available in the response message.

hasEntity() - Method in interface jakarta.ws.rs.container.ContainerRequestContext

Check if there is a non-empty entity input stream available in the request message.

hasEntity() - Method in interface jakarta.ws.rs.container.ContainerResponseContext

Check if there is an entity available in the response.

hasEntity() - Method in class jakarta.ws.rs.core.Response

Check if there is an entity available in the response.

hashCode() - Method in class jakarta.ws.rs.client.Entity

hashCode() - Method in class jakarta.ws.rs.core.AbstractMultivaluedMap

hashCode() - Method in class jakarta.ws.rs.core.CacheControl

Generate hash code from cache control properties.

hashCode() - Method in class jakarta.ws.rs.core.Cookie

Generate a hash code by hashing all of the cookies properties.

hashCode() - Method in class jakarta.ws.rs.core.EntityTag

Generate hashCode based on value and weakness.

hashCode() - Method in class jakarta.ws.rs.core.GenericEntity

hashCode() - Method in class jakarta.ws.rs.core.GenericType

hashCode() - Method in class jakarta.ws.rs.core.MediaType

Generate a hash code from the type, subtype and parameters.

hashCode() - Method in class jakarta.ws.rs.core.NewCookie

Generate a hash code by hashing all of the properties.

hashCode() - Method in class jakarta.ws.rs.core.Variant

Generate hash code from variant properties.

hasLink(String) - Method in interface jakarta.ws.rs.client.ClientResponseContext

Check if link for relation exists.

hasLink(String) - Method in interface jakarta.ws.rs.container.ContainerResponseContext

Check if link for relation exists.

hasLink(String) - Method in class jakarta.ws.rs.core.Response

Check if link for relation exists.

hasProperty(String) - Method in interface jakarta.ws.rs.client.ClientRequestContext

Returns true if the property with the given name is registered in the current request/response exchange context, or false if there is no property by that name.

hasProperty(String) - Method in interface jakarta.ws.rs.container.ContainerRequestContext

Returns true if the property with the given name is registered in the current request/response exchange context, or false if there is no property by that name.

hasProperty(String) - Method in interface jakarta.ws.rs.core.Configuration

Check whether the property with a given name is configured.

hasProperty(String) - Method in interface jakarta.ws.rs.ext.InterceptorContext

Returns true if the property with the given name is registered in the current request/response exchange context, or false if there is no property by that name.

hasProperty(String) - Method in interface jakarta.ws.rs.SeBootstrap.Configuration

Returns whether the property with the given name is configured, either explicitly or by default.

hasRetryAfter() - Method in exception class jakarta.ws.rs.ServiceUnavailableException

Check if the underlying response contains the information on when is it possible to HttpHeaders.RETRY_AFTER retry the request.

head() - Method in interface jakarta.ws.rs.client.AsyncInvoker

Invoke HTTP HEAD method for the current request asynchronously.

head() - Method in interface jakarta.ws.rs.client.CompletionStageRxInvoker

head() - Method in interface jakarta.ws.rs.client.RxInvoker

Invoke HTTP HEAD method for the current request.

head() - Method in interface jakarta.ws.rs.client.SyncInvoker

Invoke HTTP HEAD method for the current request synchronously.

head(InvocationCallback<Response>) - Method in interface jakarta.ws.rs.client.AsyncInvoker

Invoke HTTP HEAD method for the current request asynchronously.

HEAD - Annotation Interface in jakarta.ws.rs

Indicates that the annotated method responds to HTTP HEAD requests.

HEAD - Static variable in annotation interface jakarta.ws.rs.HttpMethod

HTTP HEAD method.

header(String, Object) - Method in interface jakarta.ws.rs.client.Invocation.Builder

Add an arbitrary header.

header(String, Object) - Method in class jakarta.ws.rs.core.Response.ResponseBuilder

Add an arbitrary header.

header(String, String...) - Method in interface jakarta.ws.rs.core.EntityPart.Builder

Adds a new header or replaces a previously added header and sets the header value(s).

HEADER_DECORATOR - Static variable in class jakarta.ws.rs.Priorities

Header decorator filter/interceptor priority.

HeaderParam - Annotation Interface in jakarta.ws.rs

Binds the value(s) of a HTTP header to a resource method parameter, resource class field, or resource class bean property.

headers(MultivaluedMap<String, Object>) - Method in interface jakarta.ws.rs.client.Invocation.Builder

Replaces all existing headers with the newly supplied headers.

headers(MultivaluedMap<String, String>) - Method in interface jakarta.ws.rs.core.EntityPart.Builder

Adds new headers or replaces previously added headers.

host() - Method in interface jakarta.ws.rs.SeBootstrap.Configuration

Convenience method to get the host to be used.

host(String) - Method in class jakarta.ws.rs.core.UriBuilder

Set the URI host.

host(String) - Method in interface jakarta.ws.rs.SeBootstrap.Configuration.Builder

Convenience method to set the host to be used.

HOST - Static variable in interface jakarta.ws.rs.core.HttpHeaders

See HTTP/1.1 documentation.

HOST - Static variable in interface jakarta.ws.rs.SeBootstrap.Configuration

Configuration key for the hostname or IP address an application is bound to.

hostnameVerifier(HostnameVerifier) - Method in class jakarta.ws.rs.client.ClientBuilder

Set the hostname verifier to be used by the client to verify the endpoint's hostname against it's identification information.

html(T) - Static method in class jakarta.ws.rs.client.Entity

Create a "text/html" entity.

HTTP_VERSION_NOT_SUPPORTED - Enum constant in enum class jakarta.ws.rs.core.Response.Status

505 HTTP Version Not Supported, see HTTP/1.1 documentation.

HttpHeaders - Interface in jakarta.ws.rs.core

An injectable interface that provides access to HTTP header information.

HttpMethod - Annotation Interface in jakarta.ws.rs

Associates the name of a HTTP method with an annotation.

httpOnly(boolean) - Method in class jakarta.ws.rs.core.NewCookie.AbstractNewCookieBuilder

Whether the cookie will only be visible as part of an HTTP request.

I

id(String) - Method in interface jakarta.ws.rs.sse.OutboundSseEvent.Builder

Set the event id.

IF_MATCH - Static variable in interface jakarta.ws.rs.core.HttpHeaders

See HTTP/1.1 documentation.

IF_MODIFIED_SINCE - Static variable in interface jakarta.ws.rs.core.HttpHeaders

See HTTP/1.1 documentation.

IF_NONE_MATCH - Static variable in interface jakarta.ws.rs.core.HttpHeaders

See HTTP/1.1 documentation.

IF_UNMODIFIED_SINCE - Static variable in interface jakarta.ws.rs.core.HttpHeaders

See HTTP/1.1 documentation.

InboundSseEvent - Interface in jakarta.ws.rs.sse

Inbound Server-sent event.

INFORMATIONAL - Enum constant in enum class jakarta.ws.rs.core.Response.Status.Family

1xx HTTP status codes.

initResource(T) - Method in interface jakarta.ws.rs.container.ResourceContext

Initialize the resource or sub-resource instance.

InterceptorContext - Interface in jakarta.ws.rs.ext

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).

INTERNAL_SERVER_ERROR - Enum constant in enum class jakarta.ws.rs.core.Response.Status

500 Internal Server Error, see HTTP/1.1 documentation.

InternalServerErrorException - Exception Class in jakarta.ws.rs

A runtime exception indicating an internal server error.

InternalServerErrorException() - Constructor for exception class jakarta.ws.rs.InternalServerErrorException

Construct a new internal server error exception.

InternalServerErrorException(Response) - Constructor for exception class jakarta.ws.rs.InternalServerErrorException

Construct a new internal server error exception.

InternalServerErrorException(Response, Throwable) - Constructor for exception class jakarta.ws.rs.InternalServerErrorException

Construct a new internal server error exception.

InternalServerErrorException(String) - Constructor for exception class jakarta.ws.rs.InternalServerErrorException

Construct a new internal server error exception.

InternalServerErrorException(String, Response) - Constructor for exception class jakarta.ws.rs.InternalServerErrorException

Construct a new internal server error exception.

InternalServerErrorException(String, Response, Throwable) - Constructor for exception class jakarta.ws.rs.InternalServerErrorException

Construct a new internal server error exception.

InternalServerErrorException(String, Throwable) - Constructor for exception class jakarta.ws.rs.InternalServerErrorException

Construct a new internal server error exception.

InternalServerErrorException(Throwable) - Constructor for exception class jakarta.ws.rs.InternalServerErrorException

Construct a new internal server error exception.

invocation(Link) - Method in interface jakarta.ws.rs.client.Client

Build an invocation builder from a link.

Invocation - Interface in jakarta.ws.rs.client

A client request invocation.

Invocation.Builder - Interface in jakarta.ws.rs.client

A client request invocation builder.

InvocationCallback<RESPONSE> - Interface in jakarta.ws.rs.client

Callback that can be implemented to receive the asynchronous processing events from the invocation processing.

invoke() - Method in interface jakarta.ws.rs.client.Invocation

Synchronously invoke the request and receive a response back.

invoke(GenericType<T>) - Method in interface jakarta.ws.rs.client.Invocation

Synchronously invoke the request and receive a response of the specified generic type back.

invoke(Class<T>) - Method in interface jakarta.ws.rs.client.Invocation

Synchronously invoke the request and receive a response of the specified type back.

isCancelled() - Method in interface jakarta.ws.rs.container.AsyncResponse

Check if the asynchronous response instance has been cancelled.

isClosed() - Method in class jakarta.ws.rs.core.Response

Check if the response is closed.

isClosed() - Method in interface jakarta.ws.rs.sse.SseEventSink

Check if the stream has been closed already.

isCompatible(MediaType) - Method in class jakarta.ws.rs.core.MediaType

Check if this media type is compatible with another media type.

isDone() - Method in interface jakarta.ws.rs.container.AsyncResponse

Check if the processing of a request this asynchronous response instance belongs to has finished.

isEmpty() - Method in class jakarta.ws.rs.core.AbstractMultivaluedMap

isEmpty() - Method in interface jakarta.ws.rs.sse.InboundSseEvent

Check if the event is empty (i.e.

isEnabled(Feature) - Method in interface jakarta.ws.rs.core.Configuration

Check if a particular feature instance has been previously enabled in the runtime configuration context.

isEnabled(Class<? extends Feature>) - Method in interface jakarta.ws.rs.core.Configuration

Check if a feature instance of featureClass class has been previously enabled in the runtime configuration context.

isHttpOnly() - Method in class jakarta.ws.rs.core.NewCookie

Returns true if this cookie contains the HttpOnly attribute.

isMustRevalidate() - Method in class jakarta.ws.rs.core.CacheControl

Corresponds to the must-revalidate cache control directive.

isNoCache() - Method in class jakarta.ws.rs.core.CacheControl

Corresponds to the no-cache cache control directive.

isNoStore() - Method in class jakarta.ws.rs.core.CacheControl

Corresponds to the no-store cache control directive.

isNoTransform() - Method in class jakarta.ws.rs.core.CacheControl

Corresponds to the no-transform cache control directive.

isOpen() - Method in interface jakarta.ws.rs.sse.SseEventSource

Check if this event source instance has already been opened.

isPrivate() - Method in class jakarta.ws.rs.core.CacheControl

Corresponds to the private cache control directive.

isProviderFor(Class<?>) - Method in interface jakarta.ws.rs.client.RxInvokerProvider

Determine if this is a provider for the given RxInvoker subclass.

isProxyRevalidate() - Method in class jakarta.ws.rs.core.CacheControl

Corresponds to the proxy-revalidate cache control directive.

isReadable(Class<?>, Type, Annotation[], MediaType) - Method in interface jakarta.ws.rs.ext.MessageBodyReader

Ascertain if the MessageBodyReader can produce an instance of a particular type.

isReconnectDelaySet() - Method in interface jakarta.ws.rs.sse.SseEvent

Check if the connection retry time has been set in the event.

isRegistered(Class<?>) - Method in interface jakarta.ws.rs.core.Configuration

Check if a JAX-RS component of the supplied componentClass class has been previously registered in the runtime configuration context.

isRegistered(Object) - Method in interface jakarta.ws.rs.core.Configuration

Check if a particular JAX-RS component instance (such as providers or features) has been previously registered in the runtime configuration context.

isSecure() - Method in class jakarta.ws.rs.core.NewCookie

Whether the cookie will only be sent over a secure connection.

isSecure() - Method in interface jakarta.ws.rs.core.SecurityContext

Returns a boolean indicating whether this request was made using a secure channel, such as HTTPS.

isSuspended() - Method in interface jakarta.ws.rs.container.AsyncResponse

Check if the asynchronous response instance is in a suspended state.

isUserInRole(String) - Method in interface jakarta.ws.rs.core.SecurityContext

Returns a boolean indicating whether the authenticated user is included in the specified logical "role".

isWeak() - Method in class jakarta.ws.rs.core.EntityTag

Check the strength of an EntityTag.

isWildcardSubtype() - Method in class jakarta.ws.rs.core.MediaType

Checks if the subtype is a wildcard.

isWildcardType() - Method in class jakarta.ws.rs.core.MediaType

Checks if the primary type is a wildcard.

isWriteable(Class<?>, Type, Annotation[], MediaType) - Method in interface jakarta.ws.rs.ext.MessageBodyWriter

Ascertain if the MessageBodyWriter supports a particular type.

J

jakarta.ws.rs - module jakarta.ws.rs

Defines the Jakarta RESTful Web Services API

jakarta.ws.rs - package jakarta.ws.rs

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

jakarta.ws.rs.client - package jakarta.ws.rs.client

The JAX-RS client API

jakarta.ws.rs.container - package jakarta.ws.rs.container

Container-specific JAX-RS API.

jakarta.ws.rs.core - package jakarta.ws.rs.core

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

jakarta.ws.rs.ext - package jakarta.ws.rs.ext

APIs that provide extensions to the types supported by the JAX-RS API.

jakarta.ws.rs.sse - package jakarta.ws.rs.sse

Server-Sent Events related API.

JAXRS_DEFAULT_CLIENT_BUILDER_PROPERTY - Static variable in class jakarta.ws.rs.client.ClientBuilder

Name of the property identifying the ClientBuilder implementation to be returned from ClientBuilder.newBuilder().

JAXRS_DEFAULT_SSE_BUILDER_PROPERTY - Static variable in class jakarta.ws.rs.sse.SseEventSource.Builder

Name of the property identifying the SseEventSource.Builder implementation to be returned from SseEventSource.Builder.newBuilder().

JAXRS_RUNTIME_DELEGATE_PROPERTY - Static variable in class jakarta.ws.rs.ext.RuntimeDelegate

Name of the property identifying the RuntimeDelegate implementation to be returned from RuntimeDelegate.getInstance().

json(T) - Static method in class jakarta.ws.rs.client.Entity

Create an "application/json" entity.

K

keySet() - Method in class jakarta.ws.rs.core.AbstractMultivaluedMap

keyStore(KeyStore, char[]) - Method in class jakarta.ws.rs.client.ClientBuilder

Set the client-side key store.

keyStore(KeyStore, String) - Method in class jakarta.ws.rs.client.ClientBuilder

Set the client-side key store.

L

language(String) - Method in class jakarta.ws.rs.core.Response.ResponseBuilder

Set the message entity language.

language(Locale) - Method in class jakarta.ws.rs.core.Response.ResponseBuilder

Set the message entity language.

languages(Locale...) - Static method in class jakarta.ws.rs.core.Variant

Create a Variant.VariantListBuilder initialized with a set of supported languages.

languages(Locale...) - Method in class jakarta.ws.rs.core.Variant.VariantListBuilder

Set the language(s) for this variant.

LAST_EVENT_ID_HEADER - Static variable in interface jakarta.ws.rs.core.HttpHeaders

"Last-Event-ID" HTTP request header name as defined by SSE specification.

LAST_MODIFIED - Static variable in interface jakarta.ws.rs.core.HttpHeaders

See HTTP/1.1 documentation.

lastModified(Date) - Method in class jakarta.ws.rs.core.Response.ResponseBuilder

Set the response entity last modification date.

LAX - Enum constant in enum class jakarta.ws.rs.core.NewCookie.SameSite

The Lax mode only allows to send cookies for cross-site top level navigation requests.

LENGTH_REQUIRED - Enum constant in enum class jakarta.ws.rs.core.Response.Status

411 Length Required, see HTTP/1.1 documentation.

link(Link) - Method in interface jakarta.ws.rs.core.Link.Builder

Initialize builder using another link.

link(String) - Method in interface jakarta.ws.rs.core.Link.Builder

Initialize builder using another link represented as a string.

link(String, String) - Method in class jakarta.ws.rs.core.Response.ResponseBuilder

Add a link header.

link(URI, String) - Method in class jakarta.ws.rs.core.Response.ResponseBuilder

Add a link header.

Link - Class in jakarta.ws.rs.core

Class representing hypermedia links.

Link() - Constructor for class jakarta.ws.rs.core.Link

LINK - Static variable in interface jakarta.ws.rs.core.HttpHeaders

See Web Linking (IETF RFC-5988) documentation.

Link.Builder - Interface in jakarta.ws.rs.core

Builder class for hypermedia links.

links(Link...) - Method in class jakarta.ws.rs.core.Response.ResponseBuilder

Add one or more link headers.

location(URI) - Method in class jakarta.ws.rs.core.Response.ResponseBuilder

Set the location.

LOCATION - Static variable in interface jakarta.ws.rs.core.HttpHeaders

See HTTP/1.1 documentation.

M

MANDATORY - Enum constant in enum class jakarta.ws.rs.SeBootstrap.Configuration.SSLClientAuthentication

Client authentication is performed, and invalid clients are rejected.

matrixParam(String, Object...) - Method in interface jakarta.ws.rs.client.WebTarget

Create a new WebTarget instance by appending a matrix parameter to the existing set of matrix parameters of the current final segment of the URI of the current target instance.

matrixParam(String, Object...) - Method in class jakarta.ws.rs.core.UriBuilder

Append a matrix parameter to the existing set of matrix parameters of the current final segment of the URI path.

MatrixParam - Annotation Interface in jakarta.ws.rs

Binds the value(s) of a URI matrix parameter to a resource method parameter, resource class field, or resource class bean property.

maxAge(int) - Method in class jakarta.ws.rs.core.NewCookie.AbstractNewCookieBuilder

Set the maximum age of the the cookie in seconds.

MEDIA_TYPE_WILDCARD - Static variable in class jakarta.ws.rs.core.MediaType

The value of a type or subtype wildcard "*".

mediaType(MediaType) - Method in interface jakarta.ws.rs.core.EntityPart.Builder

Sets the media type for the EntityPart.

mediaType(MediaType) - Method in interface jakarta.ws.rs.sse.OutboundSseEvent.Builder

Set the media type of the event data.

mediaType(String) - Method in interface jakarta.ws.rs.core.EntityPart.Builder

Convenience method for setting the media type for the EntityPart.

MediaType - Class in jakarta.ws.rs.core

An abstraction for a media type.

MediaType() - Constructor for class jakarta.ws.rs.core.MediaType

Creates a new instance of MediaType, both type and subtype are wildcards.

MediaType(String, String) - Constructor for class jakarta.ws.rs.core.MediaType

Creates a new instance of MediaType with the supplied type and subtype.

MediaType(String, String, String) - Constructor for class jakarta.ws.rs.core.MediaType

Creates a new instance of MediaType with the supplied type, subtype and "charset" parameter.

MediaType(String, String, Map<String, String>) - Constructor for class jakarta.ws.rs.core.MediaType

Creates a new instance of MediaType with the supplied type, subtype and parameters.

mediaTypes(MediaType...) - Static method in class jakarta.ws.rs.core.Variant

Create a Variant.VariantListBuilder initialized with a set of supported media types.

mediaTypes(MediaType...) - Method in class jakarta.ws.rs.core.Variant.VariantListBuilder

Set the media type(s) for this variant.

MessageBodyReader<T> - Interface in jakarta.ws.rs.ext

Contract for a provider that supports the conversion of a stream to a Java type.

MessageBodyWriter<T> - Interface in jakarta.ws.rs.ext

Contract for a provider that supports the conversion of a Java type to a stream.

method(String) - Method in interface jakarta.ws.rs.client.AsyncInvoker

Invoke an arbitrary method for the current request asynchronously.

method(String) - Method in interface jakarta.ws.rs.client.CompletionStageRxInvoker

method(String) - Method in interface jakarta.ws.rs.client.RxInvoker

Invoke an arbitrary method for the current request.

method(String) - Method in interface jakarta.ws.rs.client.SyncInvoker

Invoke an arbitrary method for the current request synchronously.

method(String, Entity<?>) - Method in interface jakarta.ws.rs.client.AsyncInvoker

Invoke an arbitrary method for the current request asynchronously.

method(String, Entity<?>) - Method in interface jakarta.ws.rs.client.CompletionStageRxInvoker

method(String, Entity<?>) - Method in interface jakarta.ws.rs.client.RxInvoker

Invoke an arbitrary method for the current request.

method(String, Entity<?>) - Method in interface jakarta.ws.rs.client.SyncInvoker

Invoke an arbitrary method for the current request synchronously.

method(String, Entity<?>, InvocationCallback<T>) - Method in interface jakarta.ws.rs.client.AsyncInvoker

Invoke an arbitrary method for the current request asynchronously.

method(String, Entity<?>, GenericType<R>) - Method in interface jakarta.ws.rs.client.RxInvoker

Invoke an arbitrary method for the current request.

method(String, Entity<?>, GenericType<T>) - Method in interface jakarta.ws.rs.client.AsyncInvoker

Invoke an arbitrary method for the current request asynchronously.

method(String, Entity<?>, GenericType<T>) - Method in interface jakarta.ws.rs.client.CompletionStageRxInvoker

method(String, Entity<?>, GenericType<T>) - Method in interface jakarta.ws.rs.client.SyncInvoker

Invoke an arbitrary method for the current request synchronously.

method(String, Entity<?>, Class<R>) - Method in interface jakarta.ws.rs.client.RxInvoker

Invoke an arbitrary method for the current request.

method(String, Entity<?>, Class<T>) - Method in interface jakarta.ws.rs.client.AsyncInvoker

Invoke an arbitrary method for the current request asynchronously.

method(String, Entity<?>, Class<T>) - Method in interface jakarta.ws.rs.client.CompletionStageRxInvoker

method(String, Entity<?>, Class<T>) - Method in interface jakarta.ws.rs.client.SyncInvoker

Invoke an arbitrary method for the current request synchronously.

method(String, InvocationCallback<T>) - Method in interface jakarta.ws.rs.client.AsyncInvoker

Invoke an arbitrary method for the current request asynchronously.

method(String, GenericType<R>) - Method in interface jakarta.ws.rs.client.RxInvoker

Invoke an arbitrary method for the current request.

method(String, GenericType<T>) - Method in interface jakarta.ws.rs.client.AsyncInvoker

Invoke an arbitrary method for the current request asynchronously.

method(String, GenericType<T>) - Method in interface jakarta.ws.rs.client.CompletionStageRxInvoker

method(String, GenericType<T>) - Method in interface jakarta.ws.rs.client.SyncInvoker

Invoke an arbitrary method for the current request synchronously.

method(String, Class<R>) - Method in interface jakarta.ws.rs.client.RxInvoker

Invoke an arbitrary method for the current request.

method(String, Class<T>) - Method in interface jakarta.ws.rs.client.AsyncInvoker

Invoke an arbitrary method for the current request asynchronously.

method(String, Class<T>) - Method in interface jakarta.ws.rs.client.CompletionStageRxInvoker

method(String, Class<T>) - Method in interface jakarta.ws.rs.client.SyncInvoker

Invoke an arbitrary method for the current request synchronously.

METHOD_NOT_ALLOWED - Enum constant in enum class jakarta.ws.rs.core.Response.Status

405 Method Not Allowed, see HTTP/1.1 documentation.

MOVED_PERMANENTLY - Enum constant in enum class jakarta.ws.rs.core.Response.Status

301 Moved Permanently, see HTTP/1.1 documentation.

MULTIPART_FORM_DATA - Static variable in class jakarta.ws.rs.core.MediaType

A String constant representing "multipart/form-data" media type.

MULTIPART_FORM_DATA_TYPE - Static variable in class jakarta.ws.rs.core.MediaType

A MediaType constant representing "multipart/form-data" media type.

MULTIPLE_CHOICES - Enum constant in enum class jakarta.ws.rs.core.Response.Status

300 Multiple Choices, see HTTP/1.1: Semantics and Content.

MultivaluedHashMap<K,V> - Class in jakarta.ws.rs.core

A hash table based implementation of MultivaluedMap interface.

MultivaluedHashMap() - Constructor for class jakarta.ws.rs.core.MultivaluedHashMap

Constructs an empty multivalued hash map with the default initial capacity (16) and the default load factor (0.75).

MultivaluedHashMap(int) - Constructor for class jakarta.ws.rs.core.MultivaluedHashMap

Constructs an empty multivalued hash map with the specified initial capacity and the default load factor (0.75).

MultivaluedHashMap(int, float) - Constructor for class jakarta.ws.rs.core.MultivaluedHashMap

Constructs an empty multivalued hash map with the specified initial capacity and load factor.

MultivaluedHashMap(MultivaluedMap<? extends K, ? extends V>) - Constructor for class jakarta.ws.rs.core.MultivaluedHashMap

Constructs a new multivalued hash map with the same mappings as the specified MultivaluedMap.

MultivaluedHashMap(Map<? extends K, ? extends V>) - Constructor for class jakarta.ws.rs.core.MultivaluedHashMap

Constructs a new multivalued hash map with the same mappings as the specified single-valued Map.

MultivaluedMap<K,V> - Interface in jakarta.ws.rs.core

A map of key-values pairs.

N

name(String) - Method in interface jakarta.ws.rs.sse.OutboundSseEvent.Builder

Set event name.

NameBinding - Annotation Interface in jakarta.ws.rs

Meta-annotation used to create name binding annotations for filters and interceptors.

NETWORK_AUTHENTICATION_REQUIRED - Enum constant in enum class jakarta.ws.rs.core.Response.Status

511 Network Authentication Required, see RFC 6585: Additional HTTP Status Codes.

newBroadcaster() - Method in interface jakarta.ws.rs.sse.Sse

Get a new Server-sent event broadcaster.

newBuilder() - Static method in class jakarta.ws.rs.client.ClientBuilder

Create a new ClientBuilder instance using the default client builder implementation class provided by the JAX-RS implementation provider.

newClient() - Static method in class jakarta.ws.rs.client.ClientBuilder

Create a new Client instance using the default client builder implementation class provided by the JAX-RS implementation provider.

newClient(Configuration) - Static method in class jakarta.ws.rs.client.ClientBuilder

Create a new custom-configured Client instance using the default client builder implementation class provided by the JAX-RS implementation provider.

NewCookie - Class in jakarta.ws.rs.core

Used to create a new HTTP cookie, transferred in a response.

NewCookie(Cookie) - Constructor for class jakarta.ws.rs.core.NewCookie

Deprecated.

This constructor will be removed in a future version. Please use NewCookie.Builder instead.

NewCookie(Cookie, String, int, boolean) - Constructor for class jakarta.ws.rs.core.NewCookie

Deprecated.

This constructor will be removed in a future version. Please use NewCookie.Builder instead.

NewCookie(Cookie, String, int, Date, boolean, boolean) - Constructor for class jakarta.ws.rs.core.NewCookie

Deprecated.

This constructor will be removed in a future version. Please use NewCookie.Builder instead.

NewCookie(Cookie, String, int, Date, boolean, boolean, NewCookie.SameSite) - Constructor for class jakarta.ws.rs.core.NewCookie

Deprecated.

This constructor will be removed in a future version. Please use NewCookie.Builder instead.

NewCookie(NewCookie.AbstractNewCookieBuilder<?>) - Constructor for class jakarta.ws.rs.core.NewCookie

Create a new instance from the supplied NewCookie.AbstractNewCookieBuilder instance.

NewCookie(String, String) - Constructor for class jakarta.ws.rs.core.NewCookie

Deprecated.

This constructor will be removed in a future version. Please use NewCookie.Builder instead.

NewCookie(String, String, String, String, int, String, int, boolean) - Constructor for class jakarta.ws.rs.core.NewCookie

Deprecated.

This constructor will be removed in a future version. Please use NewCookie.Builder instead.

NewCookie(String, String, String, String, int, String, int, Date, boolean, boolean) - Constructor for class jakarta.ws.rs.core.NewCookie

Deprecated.

This constructor will be removed in a future version. Please use NewCookie.Builder instead.

NewCookie(String, String, String, String, int, String, int, Date, boolean, boolean, NewCookie.SameSite) - Constructor for class jakarta.ws.rs.core.NewCookie

Deprecated.

This constructor will be removed in a future version. Please use NewCookie.Builder instead.

NewCookie(String, String, String, String, String, int, boolean) - Constructor for class jakarta.ws.rs.core.NewCookie

Deprecated.

This constructor will be removed in a future version. Please use NewCookie.Builder instead.

NewCookie(String, String, String, String, String, int, boolean, boolean) - Constructor for class jakarta.ws.rs.core.NewCookie

Deprecated.

This constructor will be removed in a future version. Please use NewCookie.Builder instead.

NewCookie.AbstractNewCookieBuilder<T> - Class in jakarta.ws.rs.core

JAX-RS abstract NewCookie builder class.

NewCookie.Builder - Class in jakarta.ws.rs.core

JAX-RS NewCookie builder class.

NewCookie.SameSite - Enum Class in jakarta.ws.rs.core

The available values for the SameSite cookie attribute.

newEvent(String) - Method in interface jakarta.ws.rs.sse.Sse

Create new OutboundSseEvent from provided data.

newEvent(String, String) - Method in interface jakarta.ws.rs.sse.Sse

Create new OutboundSseEvent from provided data and name.

newEventBuilder() - Method in interface jakarta.ws.rs.sse.Sse

Get a new outbound event builder.

newInstance() - Static method in class jakarta.ws.rs.core.Response.ResponseBuilder

Create a new builder instance.

newInstance() - Static method in class jakarta.ws.rs.core.UriBuilder

Creates a new instance of UriBuilder.

newInstance() - Static method in class jakarta.ws.rs.core.Variant.VariantListBuilder

Create a new builder instance.

NO_CONTENT - Enum constant in enum class jakarta.ws.rs.core.Response.Status

204 No Content, see HTTP/1.1 documentation.

NO_TIMEOUT - Static variable in interface jakarta.ws.rs.container.AsyncResponse

Constant specifying no suspend timeout value.

noContent() - Static method in class jakarta.ws.rs.core.Response

Create a new ResponseBuilder for an empty response.

NoContentException - Exception Class in jakarta.ws.rs.core

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.

NoContentException(String) - Constructor for exception class jakarta.ws.rs.core.NoContentException

Construct a new NoContentException instance.

NoContentException(String, Throwable) - Constructor for exception class jakarta.ws.rs.core.NoContentException

Construct a new NoContentException instance.

NoContentException(Throwable) - Constructor for exception class jakarta.ws.rs.core.NoContentException

Construct a new NoContentException instance.

NONE - Enum constant in enum class jakarta.ws.rs.core.NewCookie.SameSite

The None mode disables protection provided by the SameSite cookie attribute.

NONE - Enum constant in enum class jakarta.ws.rs.SeBootstrap.Configuration.SSLClientAuthentication

Server will not request client authentication.

NOT_ACCEPTABLE - Enum constant in enum class jakarta.ws.rs.core.Response.Status

406 Not Acceptable, see HTTP/1.1 documentation.

NOT_FOUND - Enum constant in enum class jakarta.ws.rs.core.Response.Status

404 Not Found, see HTTP/1.1 documentation.

NOT_IMPLEMENTED - Enum constant in enum class jakarta.ws.rs.core.Response.Status

501 Not Implemented, see HTTP/1.1 documentation.

NOT_MODIFIED - Enum constant in enum class jakarta.ws.rs.core.Response.Status

304 Not Modified, see HTTP/1.1 documentation.

notAcceptable(List<Variant>) - Static method in class jakarta.ws.rs.core.Response

Create a new ResponseBuilder for a not acceptable response.

NotAcceptableException - Exception Class in jakarta.ws.rs

A runtime exception indicating that a client request is not acceptable by the server.

NotAcceptableException() - Constructor for exception class jakarta.ws.rs.NotAcceptableException

Construct a new "request not acceptable" exception.

NotAcceptableException(Response) - Constructor for exception class jakarta.ws.rs.NotAcceptableException

Construct a new "request not acceptable" exception.

NotAcceptableException(Response, Throwable) - Constructor for exception class jakarta.ws.rs.NotAcceptableException

Construct a new "request not acceptable" exception.

NotAcceptableException(String) - Constructor for exception class jakarta.ws.rs.NotAcceptableException

Construct a new "request not acceptable" exception.

NotAcceptableException(String, Response) - Constructor for exception class jakarta.ws.rs.NotAcceptableException

Construct a new "request not acceptable" exception.

NotAcceptableException(String, Response, Throwable) - Constructor for exception class jakarta.ws.rs.NotAcceptableException

Construct a new "request not acceptable" exception.

NotAcceptableException(String, Throwable) - Constructor for exception class jakarta.ws.rs.NotAcceptableException

Construct a new "request not acceptable" exception.

NotAcceptableException(Throwable) - Constructor for exception class jakarta.ws.rs.NotAcceptableException

Construct a new "request not acceptable" exception.

NotAllowedException - Exception Class in jakarta.ws.rs

A runtime exception indicating a client requesting a resource method that is not allowed.

NotAllowedException(Response) - Constructor for exception class jakarta.ws.rs.NotAllowedException

Construct a new method not allowed exception.

NotAllowedException(Response, Throwable) - Constructor for exception class jakarta.ws.rs.NotAllowedException

Construct a new method not allowed exception.

NotAllowedException(String, Response) - Constructor for exception class jakarta.ws.rs.NotAllowedException

Construct a new method not allowed exception.

NotAllowedException(String, Response, Throwable) - Constructor for exception class jakarta.ws.rs.NotAllowedException

Construct a new method not allowed exception.

NotAllowedException(String, String...) - Constructor for exception class jakarta.ws.rs.NotAllowedException

Construct a new method not allowed exception.

NotAllowedException(String, String, String...) - Constructor for exception class jakarta.ws.rs.NotAllowedException

Construct a new method not allowed exception.

NotAllowedException(String, Throwable, String...) - Constructor for exception class jakarta.ws.rs.NotAllowedException

Construct a new method not allowed exception.

NotAllowedException(Throwable, String...) - Constructor for exception class jakarta.ws.rs.NotAllowedException

Construct a new method not allowed exception.

NotAuthorizedException - Exception Class in jakarta.ws.rs

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.

NotAuthorizedException(Response) - Constructor for exception class jakarta.ws.rs.NotAuthorizedException

Construct a new "not authorized" exception.

NotAuthorizedException(Response, Throwable) - Constructor for exception class jakarta.ws.rs.NotAuthorizedException

Construct a new "not authorized" exception.

NotAuthorizedException(Object, Object...) - Constructor for exception class jakarta.ws.rs.NotAuthorizedException

Construct a new "not authorized" exception.

NotAuthorizedException(String, Response) - Constructor for exception class jakarta.ws.rs.NotAuthorizedException

Construct a new "not authorized" exception.

NotAuthorizedException(String, Response, Throwable) - Constructor for exception class jakarta.ws.rs.NotAuthorizedException

Construct a new "not authorized" exception.

NotAuthorizedException(String, Object, Object...) - Constructor for exception class jakarta.ws.rs.NotAuthorizedException

Construct a new "not authorized" exception.

NotAuthorizedException(String, Throwable, Object, Object...) - Constructor for exception class jakarta.ws.rs.NotAuthorizedException

Construct a new "not authorized" exception.

NotAuthorizedException(Throwable, Object, Object...) - Constructor for exception class jakarta.ws.rs.NotAuthorizedException

Construct a new "not authorized" exception.

NotFoundException - Exception Class in jakarta.ws.rs

A runtime exception indicating a resource requested by a client was not found on the server.

NotFoundException() - Constructor for exception class jakarta.ws.rs.NotFoundException

Construct a new "not found" exception.

NotFoundException(Response) - Constructor for exception class jakarta.ws.rs.NotFoundException

Construct a new "not found" exception.

NotFoundException(Response, Throwable) - Constructor for exception class jakarta.ws.rs.NotFoundException

Construct a new "not found" exception.

NotFoundException(String) - Constructor for exception class jakarta.ws.rs.NotFoundException

Construct a new "not found" exception.

NotFoundException(String, Response) - Constructor for exception class jakarta.ws.rs.NotFoundException

Construct a new "not found" exception.

NotFoundException(String, Response, Throwable) - Constructor for exception class jakarta.ws.rs.NotFoundException

Construct a new "not found" exception.

NotFoundException(String, Throwable) - Constructor for exception class jakarta.ws.rs.NotFoundException

Construct a new "not found" exception.

NotFoundException(Throwable) - Constructor for exception class jakarta.ws.rs.NotFoundException

Construct a new "not found" exception.

notModified() - Static method in class jakarta.ws.rs.core.Response

Create a new ResponseBuilder with a not-modified status.

notModified(EntityTag) - Static method in class jakarta.ws.rs.core.Response

Create a new ResponseBuilder with a not-modified status.

notModified(String) - Static method in class jakarta.ws.rs.core.Response

Create a new ResponseBuilder with a not-modified status and a strong entity tag.

NotSupportedException - Exception Class in jakarta.ws.rs

A runtime exception indicating that the client request entity media type is not supported.

NotSupportedException() - Constructor for exception class jakarta.ws.rs.NotSupportedException

Construct a new unsupported media type exception.

NotSupportedException(Response) - Constructor for exception class jakarta.ws.rs.NotSupportedException

Construct a new unsupported media type exception.

NotSupportedException(Response, Throwable) - Constructor for exception class jakarta.ws.rs.NotSupportedException

Construct a new unsupported media type exception.

NotSupportedException(String) - Constructor for exception class jakarta.ws.rs.NotSupportedException

Construct a new unsupported media type exception.

NotSupportedException(String, Response) - Constructor for exception class jakarta.ws.rs.NotSupportedException

Construct a new unsupported media type exception.

NotSupportedException(String, Response, Throwable) - Constructor for exception class jakarta.ws.rs.NotSupportedException

Construct a new unsupported media type exception.

NotSupportedException(String, Throwable) - Constructor for exception class jakarta.ws.rs.NotSupportedException

Construct a new unsupported media type exception.

NotSupportedException(Throwable) - Constructor for exception class jakarta.ws.rs.NotSupportedException

Construct a new unsupported media type exception.

O

ok() - Static method in class jakarta.ws.rs.core.Response

Create a new ResponseBuilder with an OK status.

ok(Object) - Static method in class jakarta.ws.rs.core.Response

Create a new ResponseBuilder that contains a representation.

ok(Object, MediaType) - Static method in class jakarta.ws.rs.core.Response

Create a new ResponseBuilder that contains a representation.

ok(Object, Variant) - Static method in class jakarta.ws.rs.core.Response

Create a new ResponseBuilder that contains a representation.

ok(Object, String) - Static method in class jakarta.ws.rs.core.Response

Create a new ResponseBuilder that contains a representation.

OK - Enum constant in enum class jakarta.ws.rs.core.Response.Status

200 OK, see HTTP/1.1 documentation.

onClose(Consumer<SseEventSink>) - Method in interface jakarta.ws.rs.sse.SseBroadcaster

Register a listener, which will be called when this SseBroadcaster closes a given event SseEventSink or tries to write to a given SseEventSink that is already closed (either by client closing the connection or by calling SseEventSink.close() on the server side.

onComplete(Throwable) - Method in interface jakarta.ws.rs.container.CompletionCallback

An unmapped throwable is propagated to the default exception mapper in case no exception mapper has been found for a request processing failure.

onDisconnect(AsyncResponse) - Method in interface jakarta.ws.rs.container.ConnectionCallback

This callback notification method is invoked in case the container detects that the remote client connection associated with the asynchronous response has been disconnected.

onError(BiConsumer<SseEventSink, Throwable>) - Method in interface jakarta.ws.rs.sse.SseBroadcaster

Register a listener, which will be called when an exception is thrown by a given SseEventSink when this SseBroadcaster tries to write to it or close it.

open() - Method in interface jakarta.ws.rs.sse.SseEventSource

Open the connection to the supplied SSE underlying web target and start processing incoming events.

OPTIONAL - Enum constant in enum class jakarta.ws.rs.SeBootstrap.Configuration.SSLClientAuthentication

Client authentication is performed, but invalid clients are accepted.

options() - Method in interface jakarta.ws.rs.client.AsyncInvoker

Invoke HTTP OPTIONS method for the current request asynchronously.

options() - Method in interface jakarta.ws.rs.client.CompletionStageRxInvoker

options() - Method in interface jakarta.ws.rs.client.RxInvoker

Invoke HTTP OPTIONS method for the current request.

options() - Method in interface jakarta.ws.rs.client.SyncInvoker

Invoke HTTP OPTIONS method for the current request synchronously.

options(InvocationCallback<T>) - Method in interface jakarta.ws.rs.client.AsyncInvoker

Invoke HTTP OPTIONS method for the current request asynchronously.

options(GenericType<R>) - Method in interface jakarta.ws.rs.client.RxInvoker

Invoke HTTP OPTIONS method for the current request.

options(GenericType<T>) - Method in interface jakarta.ws.rs.client.AsyncInvoker

Invoke HTTP OPTIONS method for the current request asynchronously.

options(GenericType<T>) - Method in interface jakarta.ws.rs.client.CompletionStageRxInvoker

options(GenericType<T>) - Method in interface jakarta.ws.rs.client.SyncInvoker

Invoke HTTP OPTIONS method for the current request synchronously.

options(Class<R>) - Method in interface jakarta.ws.rs.client.RxInvoker

Invoke HTTP OPTIONS method for the current request.

options(Class<T>) - Method in interface jakarta.ws.rs.client.AsyncInvoker

Invoke HTTP OPTIONS method for the current request asynchronously.

options(Class<T>) - Method in interface jakarta.ws.rs.client.CompletionStageRxInvoker

options(Class<T>) - Method in interface jakarta.ws.rs.client.SyncInvoker

Invoke HTTP OPTIONS method for the current request synchronously.

OPTIONS - Annotation Interface in jakarta.ws.rs

Indicates that the annotated method responds to HTTP OPTIONS requests.

OPTIONS - Static variable in annotation interface jakarta.ws.rs.HttpMethod

HTTP OPTIONS method.

OTHER - Enum constant in enum class jakarta.ws.rs.core.Response.Status.Family

Other, unrecognized HTTP status codes.

OutboundSseEvent - Interface in jakarta.ws.rs.sse

Representation of a single outbound Server-sent event.

OutboundSseEvent.Builder - Interface in jakarta.ws.rs.sse

A builder class used for creating OutboundSseEvent instances.

P

param(String, String) - Method in class jakarta.ws.rs.core.Form

Adds a new value to the specified form parameter.

param(String, String) - Method in interface jakarta.ws.rs.core.Link.Builder

Set an arbitrary parameter on this link.

ParamConverter<T> - Interface in jakarta.ws.rs.ext

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 - Annotation Interface in jakarta.ws.rs.ext

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 - Interface in jakarta.ws.rs.ext

Contract for a provider of ParamConverter instances.

PARTIAL_CONTENT - Enum constant in enum class jakarta.ws.rs.core.Response.Status

206 Reset Content, see HTTP/1.1 documentation.

PATCH - Annotation Interface in jakarta.ws.rs

Indicates that the annotated method responds to HTTP PATCH requests.

PATCH - Static variable in annotation interface jakarta.ws.rs.HttpMethod

HTTP PATCH method.

path(Class) - Method in class jakarta.ws.rs.core.UriBuilder

Append the path from a Path-annotated class to the existing path.

path(Class, String) - Method in class jakarta.ws.rs.core.UriBuilder

Append the path from a Path-annotated method to the existing path.

path(Method) - Method in class jakarta.ws.rs.core.UriBuilder

Append the path from a Path-annotated method to the existing path.

path(String) - Method in interface jakarta.ws.rs.client.WebTarget

Create a new WebTarget instance by appending path to the URI of the current target instance.

path(String) - Method in class jakarta.ws.rs.core.Cookie.AbstractCookieBuilder

Set the path of the cookie.

path(String) - Method in class jakarta.ws.rs.core.UriBuilder

Append path to the existing path.

Path - Annotation Interface in jakarta.ws.rs

Identifies the URI path that a resource class or class method will serve requests for.

PathParam - Annotation Interface in jakarta.ws.rs

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 - Interface in jakarta.ws.rs.core

Represents a URI path segment and any associated matrix parameters.

PAYMENT_REQUIRED - Enum constant in enum class jakarta.ws.rs.core.Response.Status

402 Payment Required, see HTTP/1.1 documentation.

PERMANENT_REDIRECT - Enum constant in enum class jakarta.ws.rs.core.Response.Status

308 Permanent Redirect, see RFC 7538: The Hypertext Transfer Protocol Status Code 308 (Permanent Redirect).

port() - Method in interface jakarta.ws.rs.SeBootstrap.Configuration

Convenience method to get the actually used port.

port(int) - Method in class jakarta.ws.rs.core.UriBuilder

Set the URI port.

port(Integer) - Method in interface jakarta.ws.rs.SeBootstrap.Configuration.Builder

Convenience method to set the port to be used.

PORT - Static variable in interface jakarta.ws.rs.SeBootstrap.Configuration

Configuration key for the TCP port an application is bound to.

post(Entity<?>) - Method in interface jakarta.ws.rs.client.AsyncInvoker

Invoke HTTP POST method for the current request asynchronously.

post(Entity<?>) - Method in interface jakarta.ws.rs.client.CompletionStageRxInvoker

post(Entity<?>) - Method in interface jakarta.ws.rs.client.RxInvoker

Invoke HTTP POST method for the current request.

post(Entity<?>) - Method in interface jakarta.ws.rs.client.SyncInvoker

Invoke HTTP POST method for the current request synchronously.

post(Entity<?>, InvocationCallback<T>) - Method in interface jakarta.ws.rs.client.AsyncInvoker

Invoke HTTP POST method for the current request asynchronously.

post(Entity<?>, GenericType<R>) - Method in interface jakarta.ws.rs.client.RxInvoker

Invoke HTTP POST method for the current request.

post(Entity<?>, GenericType<T>) - Method in interface jakarta.ws.rs.client.AsyncInvoker

Invoke HTTP POST method for the current request asynchronously.

post(Entity<?>, GenericType<T>) - Method in interface jakarta.ws.rs.client.CompletionStageRxInvoker

post(Entity<?>, GenericType<T>) - Method in interface jakarta.ws.rs.client.SyncInvoker

Invoke HTTP POST method for the current request synchronously.

post(Entity<?>, Class<R>) - Method in interface jakarta.ws.rs.client.RxInvoker

Invoke HTTP POST method for the current request.

post(Entity<?>, Class<T>) - Method in interface jakarta.ws.rs.client.AsyncInvoker

Invoke HTTP POST method for the current request asynchronously.

post(Entity<?>, Class<T>) - Method in interface jakarta.ws.rs.client.CompletionStageRxInvoker

post(Entity<?>, Class<T>) - Method in interface jakarta.ws.rs.client.SyncInvoker

Invoke HTTP POST method for the current request synchronously.

POST - Annotation Interface in jakarta.ws.rs

Indicates that the annotated method responds to HTTP POST requests.

POST - Static variable in annotation interface jakarta.ws.rs.HttpMethod

HTTP POST method.

PRECONDITION_FAILED - Enum constant in enum class jakarta.ws.rs.core.Response.Status

412 Precondition Failed, see HTTP/1.1 documentation.

PRECONDITION_REQUIRED - Enum constant in enum class jakarta.ws.rs.core.Response.Status

428 Precondition required, see RFC 6585: Additional HTTP Status Codes.

PreMatching - Annotation Interface in jakarta.ws.rs.container

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 - Class in jakarta.ws.rs

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.

proceed() - Method in interface jakarta.ws.rs.ext.ReaderInterceptorContext

Proceed to the next interceptor in the chain.

proceed() - Method in interface jakarta.ws.rs.ext.WriterInterceptorContext

Proceed to the next interceptor in the chain.

ProcessingException - Exception Class in jakarta.ws.rs

A base JAX-RS runtime processing exception.

ProcessingException(String) - Constructor for exception class jakarta.ws.rs.ProcessingException

Constructs a new JAX-RS runtime processing exception with the specified detail message.

ProcessingException(String, Throwable) - Constructor for exception class jakarta.ws.rs.ProcessingException

Constructs a new JAX-RS runtime processing exception with the specified detail message and cause.

ProcessingException(Throwable) - Constructor for exception class jakarta.ws.rs.ProcessingException

Constructs a new JAX-RS runtime processing exception with the specified cause and a detail message of (cause==null ? null : cause.toString()) (which typically contains the class and detail message of cause).

Produces - Annotation Interface in jakarta.ws.rs

Defines the media type(s) that the methods of a resource class or MessageBodyWriter can produce.

property(String) - Method in interface jakarta.ws.rs.SeBootstrap.Configuration

Returns the value of the property with the given name, or null if there is no property of that name.

property(String, Object) - Method in interface jakarta.ws.rs.client.Invocation.Builder

Set a new property in the context of a request represented by this invocation builder.

property(String, Object) - Method in interface jakarta.ws.rs.client.Invocation

Set a new property in the context of a request represented by this invocation.

property(String, Object) - Method in interface jakarta.ws.rs.core.Configurable

Set the new configuration property, if already set, the existing value of the property will be updated.

property(String, Object) - Method in interface jakarta.ws.rs.SeBootstrap.Configuration.Builder

Sets the property name to the provided value.

protocol() - Method in interface jakarta.ws.rs.SeBootstrap.Configuration

Convenience method to get the protocol to be used.

protocol(String) - Method in interface jakarta.ws.rs.SeBootstrap.Configuration.Builder

Convenience method to set the protocol to be used.

PROTOCOL - Static variable in interface jakarta.ws.rs.SeBootstrap.Configuration

Configuration key for the protocol an application is bound to.

Provider - Annotation Interface in jakarta.ws.rs.ext

Marks an implementation of an extension interface that should be discoverable by JAX-RS runtime during a provider scanning phase.

Provider extensions - Search tag in Overview

Section

Providers - Interface in jakarta.ws.rs.ext

An injectable interface providing runtime lookup of provider instances.

PROXY_AUTHENTICATION_REQUIRED - Enum constant in enum class jakarta.ws.rs.core.Response.Status

407 Proxy Authentication Required, see HTTP/1.1 documentation.

put(Entity<?>) - Method in interface jakarta.ws.rs.client.AsyncInvoker

Invoke HTTP PUT method for the current request asynchronously.

put(Entity<?>) - Method in interface jakarta.ws.rs.client.CompletionStageRxInvoker

put(Entity<?>) - Method in interface jakarta.ws.rs.client.RxInvoker

Invoke HTTP PUT method for the current request.

put(Entity<?>) - Method in interface jakarta.ws.rs.client.SyncInvoker

Invoke HTTP PUT method for the current request synchronously.

put(Entity<?>, InvocationCallback<T>) - Method in interface jakarta.ws.rs.client.AsyncInvoker

Invoke HTTP PUT method for the current request asynchronously.

put(Entity<?>, GenericType<R>) - Method in interface jakarta.ws.rs.client.RxInvoker

Invoke HTTP PUT method for the current request.

put(Entity<?>, GenericType<T>) - Method in interface jakarta.ws.rs.client.AsyncInvoker

Invoke HTTP PUT method for the current request asynchronously.

put(Entity<?>, GenericType<T>) - Method in interface jakarta.ws.rs.client.CompletionStageRxInvoker

put(Entity<?>, GenericType<T>) - Method in interface jakarta.ws.rs.client.SyncInvoker

Invoke HTTP PUT method for the current request synchronously.

put(Entity<?>, Class<R>) - Method in interface jakarta.ws.rs.client.RxInvoker

Invoke HTTP PUT method for the current request.

put(Entity<?>, Class<T>) - Method in interface jakarta.ws.rs.client.AsyncInvoker

Invoke HTTP PUT method for the current request asynchronously.

put(Entity<?>, Class<T>) - Method in interface jakarta.ws.rs.client.CompletionStageRxInvoker

put(Entity<?>, Class<T>) - Method in interface jakarta.ws.rs.client.SyncInvoker

Invoke HTTP PUT method for the current request synchronously.

put(K, List<V>) - Method in class jakarta.ws.rs.core.AbstractMultivaluedMap

PUT - Annotation Interface in jakarta.ws.rs

Indicates that the annotated method responds to HTTP PUT requests.

PUT - Static variable in annotation interface jakarta.ws.rs.HttpMethod

HTTP PUT method.

putAll(Map<? extends K, ? extends List<V>>) - Method in class jakarta.ws.rs.core.AbstractMultivaluedMap

putSingle(K, V) - Method in class jakarta.ws.rs.core.AbstractMultivaluedMap

Set the value for the key to be a one item list consisting of the supplied value.

putSingle(K, V) - Method in interface jakarta.ws.rs.core.MultivaluedMap

Set the key's value to be a one item list consisting of the supplied value.

Q

queryParam(String, Object...) - Method in interface jakarta.ws.rs.client.WebTarget

Create a new WebTarget instance by configuring a query parameter on the URI of the current target instance.

queryParam(String, Object...) - Method in class jakarta.ws.rs.core.UriBuilder

Append a query parameter to the existing set of query parameters.

QueryParam - Annotation Interface in jakarta.ws.rs

Binds the value(s) of a HTTP query parameter to a resource method parameter, resource class field, or resource class bean property.

R

readData() - Method in interface jakarta.ws.rs.sse.InboundSseEvent

Get the original event data as String.

readData(GenericType<T>) - Method in interface jakarta.ws.rs.sse.InboundSseEvent

Read event data as a given generic type.

readData(GenericType<T>, MediaType) - Method in interface jakarta.ws.rs.sse.InboundSseEvent

Read event data as a given generic type.

readData(Class<T>) - Method in interface jakarta.ws.rs.sse.InboundSseEvent

Read event data as a given Java type.

readData(Class<T>, MediaType) - Method in interface jakarta.ws.rs.sse.InboundSseEvent

Read event data as a given Java type.

readEntity(GenericType<T>) - Method in class jakarta.ws.rs.core.Response

Read the message entity input stream as an instance of specified Java type using a MessageBodyReader that supports mapping the message entity stream onto the requested type.

readEntity(GenericType<T>, Annotation[]) - Method in class jakarta.ws.rs.core.Response

Read the message entity input stream as an instance of specified Java type using a MessageBodyReader that supports mapping the message entity stream onto the requested type.

readEntity(Class<T>) - Method in class jakarta.ws.rs.core.Response

Read the message entity input stream as an instance of specified Java type using a MessageBodyReader that supports mapping the message entity stream onto the requested type.

readEntity(Class<T>, Annotation[]) - Method in class jakarta.ws.rs.core.Response

Read the message entity input stream as an instance of specified Java type using a MessageBodyReader that supports mapping the message entity stream onto the requested type.

ReaderInterceptor - Interface in jakarta.ws.rs.ext

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 - Interface in jakarta.ws.rs.ext

Context class used by ReaderInterceptor to intercept calls to (@link jakarta.ws.rs.ext.MessageBodyReader#readFrom}.

readFrom(Class<T>, Type, Annotation[], MediaType, MultivaluedMap<String, String>, InputStream) - Method in interface jakarta.ws.rs.ext.MessageBodyReader

Read a type from the InputStream.

readTimeout(long, TimeUnit) - Method in class jakarta.ws.rs.client.ClientBuilder

Set the read timeout.

RECONNECT_NOT_SET - Static variable in interface jakarta.ws.rs.sse.SseEvent

A "reconnection not set" value for the SSE reconnect delay set via SSE event retry field.

reconnectDelay(long) - Method in interface jakarta.ws.rs.sse.OutboundSseEvent.Builder

Set reconnection delay (in milliseconds) that indicates how long the event receiver should wait before attempting to reconnect in case a connection to SSE event source is lost.

reconnectingEvery(long, TimeUnit) - Method in class jakarta.ws.rs.sse.SseEventSource.Builder

Set the initial reconnect delay to be used by the event source.

Reconnect support - Search tag in interface jakarta.ws.rs.sse.SseEventSource

Section

REDIRECTION - Enum constant in enum class jakarta.ws.rs.core.Response.Status.Family

3xx HTTP status codes.

RedirectionException - Exception Class in jakarta.ws.rs

A runtime application exception indicating a request redirection (HTTP 3xx status codes).

RedirectionException(int, URI) - Constructor for exception class jakarta.ws.rs.RedirectionException

Construct a new redirection exception.

RedirectionException(Response) - Constructor for exception class jakarta.ws.rs.RedirectionException

Construct a new redirection exception.

RedirectionException(Response.Status, URI) - Constructor for exception class jakarta.ws.rs.RedirectionException

Construct a new redirection exception.

RedirectionException(String, int, URI) - Constructor for exception class jakarta.ws.rs.RedirectionException

Construct a new redirection exception.

RedirectionException(String, Response) - Constructor for exception class jakarta.ws.rs.RedirectionException

Construct a new redirection exception.

RedirectionException(String, Response.Status, URI) - Constructor for exception class jakarta.ws.rs.RedirectionException

Construct a new redirection exception.

register(SseEventSink) - Method in interface jakarta.ws.rs.sse.SseBroadcaster

Register provided SseEventSink instance to this SseBroadcaster.

register(Class<?>) - Method in interface jakarta.ws.rs.container.AsyncResponse

Register an asynchronous processing lifecycle callback class to receive lifecycle events for the asynchronous response based on the implemented callback interfaces.

register(Class<?>) - Method in interface jakarta.ws.rs.core.Configurable

Register a class of a custom JAX-RS component (such as an extension provider or a feature meta-provider) to be instantiated and used in the scope of this configurable context.

register(Class<?>, int) - Method in interface jakarta.ws.rs.core.Configurable

Register a class of a custom JAX-RS component (such as an extension provider or a feature meta-provider) to be instantiated and used in the scope of this configurable context.

register(Class<?>, Class<?>...) - Method in interface jakarta.ws.rs.container.AsyncResponse

Register asynchronous processing lifecycle callback classes to receive lifecycle events for the asynchronous response based on the implemented callback interfaces.

register(Class<?>, Class<?>...) - Method in interface jakarta.ws.rs.core.Configurable

Register a class of a custom JAX-RS component (such as an extension provider or a feature meta-provider) to be instantiated and used in the scope of this configurable context.

register(Class<?>, Map<Class<?>, Integer>) - Method in interface jakarta.ws.rs.core.Configurable

Register a class of a custom JAX-RS component (such as an extension provider or a feature meta-provider) to be instantiated and used in the scope of this configurable context.

register(Object) - Method in interface jakarta.ws.rs.container.AsyncResponse

Register an asynchronous processing lifecycle callback instance to receive lifecycle events for the asynchronous response based on the implemented callback interfaces.

register(Object) - Method in interface jakarta.ws.rs.core.Configurable

Register an instance of a custom JAX-RS component (such as an extension provider or a feature meta-provider) to be instantiated and used in the scope of this configurable context.

register(Object, int) - Method in interface jakarta.ws.rs.core.Configurable

Register an instance of a custom JAX-RS component (such as an extension provider or a feature meta-provider) to be instantiated and used in the scope of this configurable context.

register(Object, Class<?>...) - Method in interface jakarta.ws.rs.core.Configurable

Register an instance of a custom JAX-RS component (such as an extension provider or a feature meta-provider) to be instantiated and used in the scope of this configurable context.

register(Object, Object...) - Method in interface jakarta.ws.rs.container.AsyncResponse

Register an asynchronous processing lifecycle callback instances to receive lifecycle events for the asynchronous response based on the implemented callback interfaces.

register(Object, Map<Class<?>, Integer>) - Method in interface jakarta.ws.rs.core.Configurable

Register an instance of a custom JAX-RS component (such as an extension provider or a feature meta-provider) to be instantiated and used in the scope of this configurable context.

register(Consumer<InboundSseEvent>) - Method in interface jakarta.ws.rs.sse.SseEventSource

Register a InboundSseEvent consumer.

register(Consumer<InboundSseEvent>, Consumer<Throwable>) - Method in interface jakarta.ws.rs.sse.SseEventSource

Register InboundSseEvent and Throwable consumers.

register(Consumer<InboundSseEvent>, Consumer<Throwable>, Runnable) - Method in interface jakarta.ws.rs.sse.SseEventSource

Register InboundSseEvent and Throwable consumers and onComplete callback.

Registering JAX-RS components. - Search tag in interface jakarta.ws.rs.core.Configurable

Section

rel(String) - Method in interface jakarta.ws.rs.core.Link.Builder

Convenience method to set a link relation.

REL - Static variable in class jakarta.ws.rs.core.Link

Rel link param from RFC 5988.

relativize(URI) - Method in interface jakarta.ws.rs.core.UriInfo

Relativize a URI with respect to the current request URI.

remove(Object) - Method in class jakarta.ws.rs.core.AbstractMultivaluedMap

removeProperty(String) - Method in interface jakarta.ws.rs.client.ClientRequestContext

Removes a property with the given name from the current request/response exchange context.

removeProperty(String) - Method in interface jakarta.ws.rs.container.ContainerRequestContext

Removes a property with the given name from the current request/response exchange context.

removeProperty(String) - Method in interface jakarta.ws.rs.ext.InterceptorContext

Removes a property with the given name from the current request/response exchange context.

replaceAll(MultivaluedMap<String, Object>) - Method in class jakarta.ws.rs.core.Response.ResponseBuilder

Replaces all existing headers with the newly supplied headers.

replaceMatrix(String) - Method in class jakarta.ws.rs.core.UriBuilder

Set the matrix parameters of the current final segment of the current URI path.

replaceMatrixParam(String, Object...) - Method in class jakarta.ws.rs.core.UriBuilder

Replace the existing value(s) of a matrix parameter on the current final segment of the URI path.

replacePath(String) - Method in class jakarta.ws.rs.core.UriBuilder

Set the URI path.

replaceQuery(String) - Method in class jakarta.ws.rs.core.UriBuilder

Set the URI query string.

replaceQueryParam(String, Object...) - Method in class jakarta.ws.rs.core.UriBuilder

Replace the existing value(s) of a query parameter.

request() - Method in interface jakarta.ws.rs.client.WebTarget

Start building a request to the targeted web resource.

request(MediaType...) - Method in interface jakarta.ws.rs.client.WebTarget

Start building a request to the targeted web resource and define the accepted response media types.

request(String...) - Method in interface jakarta.ws.rs.client.WebTarget

Start building a request to the targeted web resource and define the accepted response media types.

Request - Interface in jakarta.ws.rs.core

An injectable helper for request processing, all methods throw an IllegalStateException if called outside the scope of a request (e.g.

REQUEST_ENTITY_TOO_LARGE - Enum constant in enum class jakarta.ws.rs.core.Response.Status

413 Request Entity Too Large, see HTTP/1.1 documentation.

REQUEST_HEADER_FIELDS_TOO_LARGE - Enum constant in enum class jakarta.ws.rs.core.Response.Status

431 Request Header Fields Too Large, see RFC 6585: Additional HTTP Status Codes.

REQUEST_TIMEOUT - Enum constant in enum class jakarta.ws.rs.core.Response.Status

408 Request Timeout, see HTTP/1.1 documentation.

REQUEST_URI_TOO_LONG - Enum constant in enum class jakarta.ws.rs.core.Response.Status

414 Request-URI Too Long, see HTTP/1.1 documentation.

REQUESTED_RANGE_NOT_SATISFIABLE - Enum constant in enum class jakarta.ws.rs.core.Response.Status

416 Requested Range Not Satisfiable, see HTTP/1.1 documentation.

RESET_CONTENT - Enum constant in enum class jakarta.ws.rs.core.Response.Status

205 Reset Content, see HTTP/1.1 documentation.

resolve(URI) - Method in interface jakarta.ws.rs.core.UriInfo

Resolve a relative URI with respect to the base URI of the application.

resolveTemplate(String, Object) - Method in interface jakarta.ws.rs.client.WebTarget

Create a new WebTarget instance by resolving a URI template with a given name in the URI of the current target instance using a supplied value.

resolveTemplate(String, Object) - Method in class jakarta.ws.rs.core.UriBuilder

Resolve a URI template with a given name in this UriBuilder instance using a supplied value.

resolveTemplate(String, Object, boolean) - Method in interface jakarta.ws.rs.client.WebTarget

Create a new WebTarget instance by resolving a URI template with a given name in the URI of the current target instance using a supplied value.

resolveTemplate(String, Object, boolean) - Method in class jakarta.ws.rs.core.UriBuilder

Resolve a URI template with a given name in this UriBuilder instance using a supplied value.

resolveTemplateFromEncoded(String, Object) - Method in interface jakarta.ws.rs.client.WebTarget

Create a new WebTarget instance by resolving a URI template with a given name in the URI of the current target instance using a supplied encoded value.

resolveTemplateFromEncoded(String, Object) - Method in class jakarta.ws.rs.core.UriBuilder

Resolve a URI template with a given name in this UriBuilder instance using a supplied encoded value.

resolveTemplates(Map<String, Object>) - Method in interface jakarta.ws.rs.client.WebTarget

Create a new WebTarget instance by resolving one or more URI templates in the URI of the current target instance using supplied name-value pairs.

resolveTemplates(Map<String, Object>) - Method in class jakarta.ws.rs.core.UriBuilder

Resolve one or more URI templates in this UriBuilder instance using supplied name-value pairs.

resolveTemplates(Map<String, Object>, boolean) - Method in interface jakarta.ws.rs.client.WebTarget

Create a new WebTarget instance by resolving one or more URI templates in the URI of the current target instance using supplied name-value pairs.

resolveTemplates(Map<String, Object>, boolean) - Method in class jakarta.ws.rs.core.UriBuilder

Resolve one or more URI templates in this UriBuilder instance using supplied name-value pairs.

resolveTemplatesFromEncoded(Map<String, Object>) - Method in interface jakarta.ws.rs.client.WebTarget

Create a new WebTarget instance by resolving one or more URI templates in the URI of the current target instance using supplied name-encoded value pairs.

resolveTemplatesFromEncoded(Map<String, Object>) - Method in class jakarta.ws.rs.core.UriBuilder

Resolve one or more URI templates in this UriBuilder instance using supplied name-value pairs.

ResourceContext - Interface in jakarta.ws.rs.container

The resource context provides access to instances of resource classes.

ResourceInfo - Interface in jakarta.ws.rs.container

An injectable class to access the resource class and resource method matched by the current request.

Response - Class in jakarta.ws.rs.core

Defines the contract between a returned instance and the runtime when an application needs to provide meta-data to the runtime.

Response() - Constructor for class jakarta.ws.rs.core.Response

Protected constructor, use one of the static methods to obtain a Response.ResponseBuilder instance and obtain a Response from that.

Response.ResponseBuilder - Class in jakarta.ws.rs.core

A class used to build Response instances that contain metadata instead of or in addition to an entity.

Response.Status - Enum Class in jakarta.ws.rs.core

Commonly used status codes defined by HTTP, see HTTP/1.1 documentation for the complete list.

Response.Status.Family - Enum Class in jakarta.ws.rs.core

An enumeration representing the class of status code.

Response.StatusType - Interface in jakarta.ws.rs.core

Base interface for statuses used in responses.

ResponseBuilder() - Constructor for class jakarta.ws.rs.core.Response.ResponseBuilder

Protected constructor, use one of the static methods of Response to obtain an instance.

ResponseProcessingException - Exception Class in jakarta.ws.rs.client

JAX-RS client-side runtime processing exception thrown to indicate that response processing has failed (e.g.

ResponseProcessingException(Response, String) - Constructor for exception class jakarta.ws.rs.client.ResponseProcessingException

Constructs a new JAX-RS runtime processing exception with the specified detail message.

ResponseProcessingException(Response, String, Throwable) - Constructor for exception class jakarta.ws.rs.client.ResponseProcessingException

Constructs a new JAX-RS runtime response processing exception with the specified detail message and cause.

ResponseProcessingException(Response, Throwable) - Constructor for exception class jakarta.ws.rs.client.ResponseProcessingException

Constructs a new JAX-RS runtime response processing exception for a specific response with the specified cause and a detail message of (cause==null ? null : cause.toString()) (which typically contains the class and detail message of cause).

resume(Object) - Method in interface jakarta.ws.rs.container.AsyncResponse

Resume the suspended request processing using the provided response data.

resume(Throwable) - Method in interface jakarta.ws.rs.container.AsyncResponse

Resume the suspended request processing using the provided throwable.

RETRY_AFTER - Static variable in interface jakarta.ws.rs.core.HttpHeaders

See HTTP/1.1 documentation.

ROOT_PATH - Static variable in interface jakarta.ws.rs.SeBootstrap.Configuration

Configuration key for the root path an application is bound to.

rootPath() - Method in interface jakarta.ws.rs.SeBootstrap.Configuration

Convenience method to get the rootPath to be used.

rootPath(String) - Method in interface jakarta.ws.rs.SeBootstrap.Configuration.Builder

Convenience method to set the rootPath to be used.

RuntimeDelegate - Class in jakarta.ws.rs.ext

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() - Constructor for class jakarta.ws.rs.ext.RuntimeDelegate

Allows custom implementations to extend the RuntimeDelegate class.

RuntimeDelegate.HeaderDelegate<T> - Interface in jakarta.ws.rs.ext

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 - Enum Class in jakarta.ws.rs

Enumeration of JAX-RS runtime types.

rx() - Method in interface jakarta.ws.rs.client.Invocation.Builder

Access the default reactive invoker based on CompletionStage.

rx(Class<T>) - Method in interface jakarta.ws.rs.client.Invocation.Builder

Access a reactive invoker based on a RxInvoker subclass provider.

RxInvoker<T> - Interface in jakarta.ws.rs.client

Uniform interface for reactive invocation of HTTP methods.

RxInvokerProvider<T> - Interface in jakarta.ws.rs.client

RxInvoker provider.

S

sameSite(NewCookie.SameSite) - Method in class jakarta.ws.rs.core.NewCookie.AbstractNewCookieBuilder

Set the attribute that controls whether the cookie is sent with cross-origin requests, providing protection against cross-site request forgery.

scheduledExecutorService(ScheduledExecutorService) - Method in class jakarta.ws.rs.client.ClientBuilder

Set the client-side ScheduledExecutorService.

scheme(String) - Method in class jakarta.ws.rs.core.UriBuilder

Set the URI scheme.

schemeSpecificPart(String) - Method in class jakarta.ws.rs.core.UriBuilder

Set the URI scheme-specific-part (see URI).

SeBootstrap - Interface in jakarta.ws.rs

Bootstrap class used to startup a JAX-RS application in Java SE environments.

SeBootstrap.Configuration - Interface in jakarta.ws.rs

Provides information needed by the JAX-RS implementation for bootstrapping an application.

SeBootstrap.Configuration.Builder - Interface in jakarta.ws.rs

Builder for bootstrap SeBootstrap.Configuration.

SeBootstrap.Configuration.SSLClientAuthentication - Enum Class in jakarta.ws.rs

Secure socket client authentication policy

SeBootstrap.Instance - Interface in jakarta.ws.rs

Handle of the running application instance.

SeBootstrap.Instance.StopResult - Interface in jakarta.ws.rs

Result of stopping the application instance.

secure(boolean) - Method in class jakarta.ws.rs.core.NewCookie.AbstractNewCookieBuilder

Whether the cookie will only be sent over a secure connection.

SecurityContext - Interface in jakarta.ws.rs.core

An injectable interface that provides access to security related information.

SEE_OTHER - Enum constant in enum class jakarta.ws.rs.core.Response.Status

303 See Other, see HTTP/1.1 documentation.

seeOther(URI) - Static method in class jakarta.ws.rs.core.Response

Create a new ResponseBuilder for a redirection.

segment(String...) - Method in class jakarta.ws.rs.core.UriBuilder

Append path segments to the existing path.

selectVariant(List<Variant>) - Method in interface jakarta.ws.rs.core.Request

Select the representation variant that best matches the request.

send(OutboundSseEvent) - Method in interface jakarta.ws.rs.sse.SseEventSink

Send an outbound Server-sent event to this sink.

SERVER - Enum constant in enum class jakarta.ws.rs.RuntimeType

JAX-RS server run-time.

SERVER_ERROR - Enum constant in enum class jakarta.ws.rs.core.Response.Status.Family

5xx HTTP status codes.

SERVER_SENT_EVENTS - Static variable in class jakarta.ws.rs.core.MediaType

String representation of Server sent events media type.

SERVER_SENT_EVENTS_TYPE - Static variable in class jakarta.ws.rs.core.MediaType

Server sent events media type.

serverError() - Static method in class jakarta.ws.rs.core.Response

Create a new ResponseBuilder with an server error status.

ServerErrorException - Exception Class in jakarta.ws.rs

A base runtime application exception indicating a server error (HTTP 5xx status codes).

ServerErrorException(int) - Constructor for exception class jakarta.ws.rs.ServerErrorException

Construct a new server error exception.

ServerErrorException(int, Throwable) - Constructor for exception class jakarta.ws.rs.ServerErrorException

Construct a new server error exception.

ServerErrorException(Response) - Constructor for exception class jakarta.ws.rs.ServerErrorException

Construct a new server error exception.

ServerErrorException(Response.Status) - Constructor for exception class jakarta.ws.rs.ServerErrorException

Construct a new server error exception.

ServerErrorException(Response.Status, Throwable) - Constructor for exception class jakarta.ws.rs.ServerErrorException

Construct a new server error exception.

ServerErrorException(Response, Throwable) - Constructor for exception class jakarta.ws.rs.ServerErrorException

Construct a new server error exception.

ServerErrorException(String, int) - Constructor for exception class jakarta.ws.rs.ServerErrorException

Construct a new server error exception.

ServerErrorException(String, int, Throwable) - Constructor for exception class jakarta.ws.rs.ServerErrorException

Construct a new server error exception.

ServerErrorException(String, Response) - Constructor for exception class jakarta.ws.rs.ServerErrorException

Construct a new server error exception.

ServerErrorException(String, Response.Status) - Constructor for exception class jakarta.ws.rs.ServerErrorException

Construct a new server error exception.

ServerErrorException(String, Response.Status, Throwable) - Constructor for exception class jakarta.ws.rs.ServerErrorException

Construct a new server error exception.

ServerErrorException(String, Response, Throwable) - Constructor for exception class jakarta.ws.rs.ServerErrorException

Construct a new server error exception.

SERVICE_UNAVAILABLE - Enum constant in enum class jakarta.ws.rs.core.Response.Status

503 Service Unavailable, see HTTP/1.1 documentation.

ServiceUnavailableException - Exception Class in jakarta.ws.rs

A runtime exception indicating that the requested resource cannot be served.

ServiceUnavailableException() - Constructor for exception class jakarta.ws.rs.ServiceUnavailableException

Construct a new "service unavailable" exception without any "Retry-After" information specified for the failed request.

ServiceUnavailableException(Response) - Constructor for exception class jakarta.ws.rs.ServiceUnavailableException

Construct a new "service unavailable" exception.

ServiceUnavailableException(Response, Throwable) - Constructor for exception class jakarta.ws.rs.ServiceUnavailableException

Construct a new "service unavailable" exception.

ServiceUnavailableException(Long) - Constructor for exception class jakarta.ws.rs.ServiceUnavailableException

Construct a new "service unavailable" exception with an interval specifying the "Retry-After" information for the failed request.

ServiceUnavailableException(Long, Throwable) - Constructor for exception class jakarta.ws.rs.ServiceUnavailableException

Construct a new "service unavailable" exception with an interval specifying the "Retry-After" information for the failed request and an underlying request failure cause.

ServiceUnavailableException(String) - Constructor for exception class jakarta.ws.rs.ServiceUnavailableException

Construct a new "service unavailable" exception without any "Retry-After" information specified for the failed request.

ServiceUnavailableException(String, Response) - Constructor for exception class jakarta.ws.rs.ServiceUnavailableException

Construct a new "service unavailable" exception.

ServiceUnavailableException(String, Response, Throwable) - Constructor for exception class jakarta.ws.rs.ServiceUnavailableException

Construct a new "service unavailable" exception.

ServiceUnavailableException(String, Long) - Constructor for exception class jakarta.ws.rs.ServiceUnavailableException

Construct a new "service unavailable" exception with an interval specifying the "Retry-After" information for the failed request.

ServiceUnavailableException(String, Long, Throwable) - Constructor for exception class jakarta.ws.rs.ServiceUnavailableException

Construct a new "service unavailable" exception with an interval specifying the "Retry-After" information for the failed request and an underlying request failure cause.

ServiceUnavailableException(String, Date) - Constructor for exception class jakarta.ws.rs.ServiceUnavailableException

Construct a new "service unavailable" exception with an interval specifying the "Retry-After" information for the failed request.

ServiceUnavailableException(String, Date, Throwable) - Constructor for exception class jakarta.ws.rs.ServiceUnavailableException

Construct a new "service unavailable" exception with a date specifying the "Retry-After" information for the failed request and an underlying request failure cause.

ServiceUnavailableException(Date) - Constructor for exception class jakarta.ws.rs.ServiceUnavailableException

Construct a new "service unavailable" exception with an interval specifying the "Retry-After" information for the failed request.

ServiceUnavailableException(Date, Throwable) - Constructor for exception class jakarta.ws.rs.ServiceUnavailableException

Construct a new "service unavailable" exception with a date specifying the "Retry-After" information for the failed request and an underlying request failure cause.

SET_COOKIE - Static variable in interface jakarta.ws.rs.core.HttpHeaders

See IETF RFC 2109.

setAnnotations(Annotation[]) - Method in interface jakarta.ws.rs.ext.InterceptorContext

Update annotations on the formal declaration of the artifact that initiated the intercepted entity provider invocation.

setEntity(Object) - Method in interface jakarta.ws.rs.client.ClientRequestContext

Set a new message entity.

setEntity(Object) - Method in interface jakarta.ws.rs.container.ContainerResponseContext

Set a new message entity.

setEntity(Object) - Method in interface jakarta.ws.rs.ext.WriterInterceptorContext

Update object to be written as HTTP entity.

setEntity(Object, Annotation[], MediaType) - Method in interface jakarta.ws.rs.client.ClientRequestContext

Set a new message entity, including the attached annotations and the media type.

setEntity(Object, Annotation[], MediaType) - Method in interface jakarta.ws.rs.container.ContainerResponseContext

Set a new message entity, including the attached annotations and the media type.

setEntityStream(InputStream) - Method in interface jakarta.ws.rs.client.ClientResponseContext

Set a new entity input stream.

setEntityStream(InputStream) - Method in interface jakarta.ws.rs.container.ContainerRequestContext

Set a new entity input stream.

setEntityStream(OutputStream) - Method in interface jakarta.ws.rs.client.ClientRequestContext

Set a new entity output stream.

setEntityStream(OutputStream) - Method in interface jakarta.ws.rs.container.ContainerResponseContext

Set a new entity output stream.

setGenericType(Type) - Method in interface jakarta.ws.rs.ext.InterceptorContext

Update type of the object to be produced or written.

setInputStream(InputStream) - Method in interface jakarta.ws.rs.ext.ReaderInterceptorContext

Set the input stream of the object to be read.

setInstance(RuntimeDelegate) - Static method in class jakarta.ws.rs.ext.RuntimeDelegate

Set the runtime delegate that will be used by JAX-RS classes.

setMaxAge(int) - Method in class jakarta.ws.rs.core.CacheControl

Corresponds to the max-age cache control directive.

setMediaType(MediaType) - Method in interface jakarta.ws.rs.ext.InterceptorContext

Update media type of HTTP entity.

setMethod(String) - Method in interface jakarta.ws.rs.client.ClientRequestContext

Set the request method.

setMethod(String) - Method in interface jakarta.ws.rs.container.ContainerRequestContext

Set the request method.

setMustRevalidate(boolean) - Method in class jakarta.ws.rs.core.CacheControl

Corresponds to the must-revalidate cache control directive.

setNoCache(boolean) - Method in class jakarta.ws.rs.core.CacheControl

Corresponds to the no-cache cache control directive.

setNoStore(boolean) - Method in class jakarta.ws.rs.core.CacheControl

Corresponds to the no-store cache control directive.

setNoTransform(boolean) - Method in class jakarta.ws.rs.core.CacheControl

Corresponds to the no-transform cache control directive.

setOutputStream(OutputStream) - Method in interface jakarta.ws.rs.ext.WriterInterceptorContext

Set a new output stream for the object to be written.

setPrivate(boolean) - Method in class jakarta.ws.rs.core.CacheControl

Corresponds to the private cache control directive.

setProperty(String, Object) - Method in interface jakarta.ws.rs.client.ClientRequestContext

Binds an object to a given property name in the current request/response exchange context.

setProperty(String, Object) - Method in interface jakarta.ws.rs.container.ContainerRequestContext

Binds an object to a given property name in the current request/response exchange context.

setProperty(String, Object) - Method in interface jakarta.ws.rs.ext.InterceptorContext

Binds an object to a given property name in the current request/response exchange context.

setProxyRevalidate(boolean) - Method in class jakarta.ws.rs.core.CacheControl

Corresponds to the must-revalidate cache control directive.

setRequestUri(URI) - Method in interface jakarta.ws.rs.container.ContainerRequestContext

Set a new request URI using the current base URI of the application to resolve the application-specific request URI part.

setRequestUri(URI, URI) - Method in interface jakarta.ws.rs.container.ContainerRequestContext

Set a new request URI using a new base URI to resolve the application-specific request URI part.

setSecurityContext(SecurityContext) - Method in interface jakarta.ws.rs.container.ContainerRequestContext

Set a new injectable security context information for the current request.

setSMaxAge(int) - Method in class jakarta.ws.rs.core.CacheControl

Corresponds to the s-maxage cache control directive.

setStatus(int) - Method in interface jakarta.ws.rs.client.ClientResponseContext

Set a new response status code.

setStatus(int) - Method in interface jakarta.ws.rs.container.ContainerResponseContext

Set a new response status code.

setStatusInfo(Response.StatusType) - Method in interface jakarta.ws.rs.client.ClientResponseContext

Set the complete status information (status code and reason phrase) associated with the response.

setStatusInfo(Response.StatusType) - Method in interface jakarta.ws.rs.container.ContainerResponseContext

Set the complete status information (status code and reason phrase) associated with the response.

setTimeout(long, TimeUnit) - Method in interface jakarta.ws.rs.container.AsyncResponse

Set/update the suspend timeout.

setTimeoutHandler(TimeoutHandler) - Method in interface jakarta.ws.rs.container.AsyncResponse

Set/replace a time-out handler for the suspended asynchronous response.

Setting properties. - Search tag in interface jakarta.ws.rs.core.Configurable

Section

setType(Class<?>) - Method in interface jakarta.ws.rs.ext.InterceptorContext

Update Java type before calling message body provider.

setUri(URI) - Method in interface jakarta.ws.rs.client.ClientRequestContext

Set a new request URI.

size() - Method in class jakarta.ws.rs.core.AbstractMultivaluedMap

Sse - Interface in jakarta.ws.rs.sse

Server-side entry point for creating OutboundSseEvent and SseBroadcaster.

SseBroadcaster - Interface in jakarta.ws.rs.sse

Server-Sent events broadcasting facility.

SseEvent - Interface in jakarta.ws.rs.sse

Base Server Sent Event definition.

SseEventSink - Interface in jakarta.ws.rs.sse

Outbound Server-Sent Events stream.

SseEventSource - Interface in jakarta.ws.rs.sse

Client for reading and processing incoming Server-Sent Events.

SseEventSource.Builder - Class in jakarta.ws.rs.sse

JAX-RS SseEventSource builder class.

SSL_CLIENT_AUTHENTICATION - Static variable in interface jakarta.ws.rs.SeBootstrap.Configuration

Configuration key for the secure socket client authentication policy.

SSL_CONTEXT - Static variable in interface jakarta.ws.rs.SeBootstrap.Configuration

Configuration key for the secure socket configuration to be used.

sslClientAuthentication() - Method in interface jakarta.ws.rs.SeBootstrap.Configuration

Convenience method to get the secure socket client authentication policy.

sslClientAuthentication(SeBootstrap.Configuration.SSLClientAuthentication) - Method in interface jakarta.ws.rs.SeBootstrap.Configuration.Builder

Convenience method to set SSL client authentication policy.

sslContext() - Method in interface jakarta.ws.rs.SeBootstrap.Configuration

Convenience method to get the sslContext to be used.

sslContext(SSLContext) - Method in class jakarta.ws.rs.client.ClientBuilder

Set the SSL context that will be used when creating secured transport connections to server endpoints from web targets created by the client instance that is using this SSL context.

sslContext(SSLContext) - Method in interface jakarta.ws.rs.SeBootstrap.Configuration.Builder

Convenience method to set the sslContext to be used.

start(Application) - Static method in interface jakarta.ws.rs.SeBootstrap

Starts the provided application using a default configuration.

start(Application, SeBootstrap.Configuration) - Static method in interface jakarta.ws.rs.SeBootstrap

Starts the provided application using the specified configuration.

start(Class<? extends Application>) - Static method in interface jakarta.ws.rs.SeBootstrap

Starts the provided application using a default configuration.

start(Class<? extends Application>, SeBootstrap.Configuration) - Static method in interface jakarta.ws.rs.SeBootstrap

Starts the provided application using the specified configuration.

status(int) - Method in class jakarta.ws.rs.core.Response.ResponseBuilder

Set the status on the ResponseBuilder.

status(int) - Static method in class jakarta.ws.rs.core.Response

Create a new ResponseBuilder with the supplied status.

status(int, String) - Method in class jakarta.ws.rs.core.Response.ResponseBuilder

Set the status on the ResponseBuilder.

status(int, String) - Static method in class jakarta.ws.rs.core.Response

Create a new ResponseBuilder with the supplied status and reason phrase.

status(Response.Status) - Method in class jakarta.ws.rs.core.Response.ResponseBuilder

Set the status on the ResponseBuilder.

status(Response.Status) - Static method in class jakarta.ws.rs.core.Response

Create a new ResponseBuilder with the supplied status.

status(Response.StatusType) - Method in class jakarta.ws.rs.core.Response.ResponseBuilder

Set the status on the ResponseBuilder.

status(Response.StatusType) - Static method in class jakarta.ws.rs.core.Response

Create a new ResponseBuilder with the supplied status.

stop() - Method in interface jakarta.ws.rs.SeBootstrap.Instance

Initiate immediate shutdown of running application instance.

stopOnShutdown(Consumer<SeBootstrap.Instance.StopResult>) - Method in interface jakarta.ws.rs.SeBootstrap.Instance

Registers a consumer for a SeBootstrap.Instance.StopResult which will be executed in a new thread during the JVM shutdown phase.

store - Variable in class jakarta.ws.rs.core.AbstractMultivaluedMap

Backing store for the [key, multi-value] pairs.

StreamingOutput - Interface in jakarta.ws.rs.core

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.

STRICT - Enum constant in enum class jakarta.ws.rs.core.NewCookie.SameSite

The Strict mode prevents clients from sending cookies with any cross-site request.

submit() - Method in interface jakarta.ws.rs.client.Invocation

Submit the request for an asynchronous invocation and receive a future response back.

submit(InvocationCallback<T>) - Method in interface jakarta.ws.rs.client.Invocation

Submit the request for an asynchronous invocation and register an InvocationCallback to process the future result of the invocation.

submit(GenericType<T>) - Method in interface jakarta.ws.rs.client.Invocation

Submit the request for an asynchronous invocation and receive a future response of the specified generic type back.

submit(Class<T>) - Method in interface jakarta.ws.rs.client.Invocation

Submit the request for an asynchronous invocation and receive a future response of the specified type back.

SUCCESSFUL - Enum constant in enum class jakarta.ws.rs.core.Response.Status.Family

2xx HTTP status codes.

Suspended - Annotation Interface in jakarta.ws.rs.container

Inject a suspended AsyncResponse into a parameter of an invoked JAX-RS resource or sub-resource method.

SyncInvoker - Interface in jakarta.ws.rs.client

Uniform interface for synchronous invocation of HTTP methods.

T

tag(EntityTag) - Method in class jakarta.ws.rs.core.Response.ResponseBuilder

Set a response entity tag.

tag(String) - Method in class jakarta.ws.rs.core.Response.ResponseBuilder

Set a strong response entity tag.

target(WebTarget) - Method in class jakarta.ws.rs.sse.SseEventSource.Builder

Set the SSE streaming endpoint.

target(WebTarget) - Static method in interface jakarta.ws.rs.sse.SseEventSource

Create a new event source builder that provides convenient way how to configure and fine-tune various aspects of a newly prepared event source instance.

target(Link) - Method in interface jakarta.ws.rs.client.Client

Build a new web resource target.

target(UriBuilder) - Method in interface jakarta.ws.rs.client.Client

Build a new web resource target.

target(String) - Method in interface jakarta.ws.rs.client.Client

Build a new web resource target.

target(URI) - Method in interface jakarta.ws.rs.client.Client

Build a new web resource target.

TEMPORARY_REDIRECT - Enum constant in enum class jakarta.ws.rs.core.Response.Status

307 Temporary Redirect, see HTTP/1.1 documentation.

temporaryRedirect(URI) - Static method in class jakarta.ws.rs.core.Response

Create a new ResponseBuilder for a temporary redirection.

text(T) - Static method in class jakarta.ws.rs.client.Entity

Create a "text/plain" entity.

TEXT_HTML - Static variable in class jakarta.ws.rs.core.MediaType

A String constant representing "text/html" media type.

TEXT_HTML_TYPE - Static variable in class jakarta.ws.rs.core.MediaType

A MediaType constant representing "text/html" media type.

TEXT_PLAIN - Static variable in class jakarta.ws.rs.core.MediaType

A String constant representing "text/plain" media type.

TEXT_PLAIN_TYPE - Static variable in class jakarta.ws.rs.core.MediaType

A MediaType constant representing "text/plain" media type.

TEXT_XML - Static variable in class jakarta.ws.rs.core.MediaType

A String constant representing "text/xml" media type.

TEXT_XML_TYPE - Static variable in class jakarta.ws.rs.core.MediaType

A MediaType constant representing "text/xml" media type.

The JAX-RS client API - Search tag in package jakarta.ws.rs.client

Section

TimeoutHandler - Interface in jakarta.ws.rs.container

Asynchronous response suspend time-out handler.

title(String) - Method in interface jakarta.ws.rs.core.Link.Builder

Convenience method to set a title on this link.

TITLE - Static variable in class jakarta.ws.rs.core.Link

Title link param from RFC 5988.

toCookie() - Method in class jakarta.ws.rs.core.NewCookie

Obtain a new instance of a Cookie with the same name, value, path, domain and version as this NewCookie.

toEnum() - Method in interface jakarta.ws.rs.core.Response.StatusType

Get the this Status Type as a Response.Status.

TOO_MANY_REQUESTS - Enum constant in enum class jakarta.ws.rs.core.Response.Status

429 Too Many Requests, see RFC 6585: Additional HTTP Status Codes.

toResponse(E) - Method in interface jakarta.ws.rs.ext.ExceptionMapper

Map an exception to a Response.

toString() - Method in class jakarta.ws.rs.client.Entity

toString() - Method in class jakarta.ws.rs.core.AbstractMultivaluedMap

toString() - Method in class jakarta.ws.rs.core.CacheControl

Deprecated.

The format of the toString() method is subject to change in a future version. Please use RuntimeDelegate.getInstance().createHeaderDelegate(CacheControl.class).toString(value) instead if you rely on the format of this method.

toString() - Method in class jakarta.ws.rs.core.Cookie

Deprecated.

The format of the toString() method is subject to change in a future version. Please use RuntimeDelegate.getInstance().createHeaderDelegate(Cookie.class).toString(value) instead if you rely on the format of this method.

toString() - Method in class jakarta.ws.rs.core.EntityTag

Deprecated.

The format of the toString() method is subject to change in a future version. Please use RuntimeDelegate.getInstance().createHeaderDelegate(EntityTag.class).toString(value) instead if you rely on the format of this method.

toString() - Method in class jakarta.ws.rs.core.GenericEntity

toString() - Method in class jakarta.ws.rs.core.GenericType

toString() - Method in class jakarta.ws.rs.core.Link

Returns a string representation as a link header (RFC 5988).

toString() - Method in class jakarta.ws.rs.core.MediaType

Convert the media type to a string suitable for use as the value of a corresponding HTTP header.

toString() - Method in class jakarta.ws.rs.core.NewCookie

Deprecated.

The format of the toString() method is subject to change in a future version. Please use RuntimeDelegate.getInstance().createHeaderDelegate(NewCookie.class).toString(value) instead if you rely on the format of this method.

toString() - Method in enum class jakarta.ws.rs.core.Response.Status

Get the reason phrase.

toString() - Method in class jakarta.ws.rs.core.Variant

toString(T) - Method in interface jakarta.ws.rs.ext.ParamConverter

Convert the supplied value to a String.

toString(T) - Method in interface jakarta.ws.rs.ext.RuntimeDelegate.HeaderDelegate

Convert the supplied value to a String.

toTemplate() - Method in class jakarta.ws.rs.core.UriBuilder

Get the URI template string represented by this URI builder.

trace() - Method in interface jakarta.ws.rs.client.AsyncInvoker

Invoke HTTP TRACE method for the current request asynchronously.

trace() - Method in interface jakarta.ws.rs.client.CompletionStageRxInvoker

trace() - Method in interface jakarta.ws.rs.client.RxInvoker

Invoke HTTP TRACE method for the current request.

trace() - Method in interface jakarta.ws.rs.client.SyncInvoker

Invoke HTTP TRACE method for the current request synchronously.

trace(InvocationCallback<T>) - Method in interface jakarta.ws.rs.client.AsyncInvoker

Invoke HTTP TRACE method for the current request asynchronously.

trace(GenericType<R>) - Method in interface jakarta.ws.rs.client.RxInvoker

Invoke HTTP TRACE method for the current request.

trace(GenericType<T>) - Method in interface jakarta.ws.rs.client.AsyncInvoker

Invoke HTTP TRACE method for the current request asynchronously.

trace(GenericType<T>) - Method in interface jakarta.ws.rs.client.CompletionStageRxInvoker

trace(GenericType<T>) - Method in interface jakarta.ws.rs.client.SyncInvoker

Invoke HTTP TRACE method for the current request synchronously.

trace(Class<R>) - Method in interface jakarta.ws.rs.client.RxInvoker

Invoke HTTP TRACE method for the current request.

trace(Class<T>) - Method in interface jakarta.ws.rs.client.AsyncInvoker

Invoke HTTP TRACE method for the current request asynchronously.

trace(Class<T>) - Method in interface jakarta.ws.rs.client.CompletionStageRxInvoker

trace(Class<T>) - Method in interface jakarta.ws.rs.client.SyncInvoker

Invoke HTTP TRACE method for the current request synchronously.

trustStore(KeyStore) - Method in class jakarta.ws.rs.client.ClientBuilder

Set the client-side trust store.

type(MediaType) - Method in class jakarta.ws.rs.core.Response.ResponseBuilder

Set the message entity media type.

type(String) - Method in interface jakarta.ws.rs.core.Link.Builder

Convenience method to set a type on this link.

type(String) - Method in class jakarta.ws.rs.core.Response.ResponseBuilder

Set the message entity media type.

TYPE - Static variable in class jakarta.ws.rs.core.Link

Type link param from RFC 5988.

U

UNAUTHORIZED - Enum constant in enum class jakarta.ws.rs.core.Response.Status

401 Unauthorized, see HTTP/1.1 documentation.

UNAVAILABLE_FOR_LEGAL_REASONS - Enum constant in enum class jakarta.ws.rs.core.Response.Status

451 Unavailable For Legal Reasons, see RFC 7725: An HTTP Status Code to Report Legal Obstacles.

UNSUPPORTED_MEDIA_TYPE - Enum constant in enum class jakarta.ws.rs.core.Response.Status

415 Unsupported Media Type, see HTTP/1.1 documentation.

unwrap(Class<T>) - Method in interface jakarta.ws.rs.SeBootstrap.Instance.StopResult

Provides access to the wrapped native shutdown result.

unwrap(Class<T>) - Method in interface jakarta.ws.rs.SeBootstrap.Instance

Provides access to the wrapped native handle of the application instance.

uri(String) - Method in interface jakarta.ws.rs.core.Link.Builder

Set underlying string representing URI template for the link being constructed.

uri(String) - Method in class jakarta.ws.rs.core.UriBuilder

Parses the uriTemplate string and copies the parsed components of the supplied URI to the UriBuilder replacing any existing values for those components.

uri(URI) - Method in interface jakarta.ws.rs.core.Link.Builder

Set underlying URI template for the link being constructed.

uri(URI) - Method in class jakarta.ws.rs.core.UriBuilder

Copies the non-null components of the supplied URI to the UriBuilder replacing any existing values for those components.

uriBuilder(UriBuilder) - Method in interface jakarta.ws.rs.core.Link.Builder

Set underlying URI builder representing the URI template for the link being constructed.

UriBuilder - Class in jakarta.ws.rs.core

URI template-aware utility class for building URIs from their components.

UriBuilder() - Constructor for class jakarta.ws.rs.core.UriBuilder

Protected constructor, use one of the static fromXxx(...) methods to obtain an instance.

UriBuilderException - Exception Class in jakarta.ws.rs.core

A runtime exception thrown by UriBuilder.build(Object...) methods when a URI cannot be constructed based on the current state of the builder.

UriBuilderException() - Constructor for exception class jakarta.ws.rs.core.UriBuilderException

Creates a new instance of UriBuilderException without detail message.

UriBuilderException(String) - Constructor for exception class jakarta.ws.rs.core.UriBuilderException

Constructs an instance of UriBuilderException with the specified detail message.

UriBuilderException(String, Throwable) - Constructor for exception class jakarta.ws.rs.core.UriBuilderException

Constructs an instance of UriBuilderException with the specified detail message and cause.

UriBuilderException(Throwable) - Constructor for exception class jakarta.ws.rs.core.UriBuilderException

Constructs a new exception with the specified cause and a detail message of (cause==null ? null : cause.toString()) (which typically contains the class and detail message of cause).

UriInfo - Interface in jakarta.ws.rs.core

An injectable interface that provides access to application and request URI information.

USE_PROXY - Enum constant in enum class jakarta.ws.rs.core.Response.Status

305 Use Proxy, see HTTP/1.1 documentation.

USER - Static variable in class jakarta.ws.rs.Priorities

User-level filter/interceptor priority.

USER_AGENT - Static variable in interface jakarta.ws.rs.core.HttpHeaders

See HTTP/1.1 documentation.

userInfo(String) - Method in class jakarta.ws.rs.core.UriBuilder

Set the URI user-info.

V

value() - Element in annotation interface jakarta.ws.rs.ApplicationPath

Defines the base URI for all resource URIs.

value() - Element in annotation interface jakarta.ws.rs.ConstrainedTo

Define the constraint type to be placed on a JAX-RS provider.

value() - Element in annotation interface jakarta.ws.rs.Consumes

A list of media types.

value() - Element in annotation interface jakarta.ws.rs.CookieParam

Defines the name of the HTTP cookie whose value will be used to initialize the value of the annotated method argument, class field or bean property.

value() - Element in annotation interface jakarta.ws.rs.DefaultValue

The specified default value.

value() - Element in annotation interface jakarta.ws.rs.FormParam

Defines the name of the form parameter whose value will be used to initialize the value of the annotated method argument.

value() - Element in annotation interface jakarta.ws.rs.HeaderParam

Defines the name of the HTTP header whose value will be used to initialize the value of the annotated method argument, class field or bean property.

value() - Element in annotation interface jakarta.ws.rs.HttpMethod

Specifies the name of a HTTP method.

value() - Element in annotation interface jakarta.ws.rs.MatrixParam

Defines the name of the URI matrix parameter whose value will be used to initialize the value of the annotated method argument, class field or bean property.

value() - Element in annotation interface jakarta.ws.rs.Path

Defines a URI template for the resource class or method, must not include matrix parameters.

value() - Element in annotation interface jakarta.ws.rs.PathParam

Defines the name of the URI template parameter whose value will be used to initialize the value of the annotated method parameter, class field or property.

value() - Element in annotation interface jakarta.ws.rs.Produces

A list of media types.

value() - Element in annotation interface jakarta.ws.rs.QueryParam

Defines the name of the HTTP query parameter whose value will be used to initialize the value of the annotated method argument, class field or bean property.

value(String) - Method in class jakarta.ws.rs.core.Cookie.AbstractCookieBuilder

Set the value of the cookie.

valueOf(String) - Static method in class jakarta.ws.rs.core.CacheControl

Deprecated.

This method will be removed in a future version. Please use RuntimeDelegate.getInstance().createHeaderDelegate(CacheControl.class).fromString(value) instead.

valueOf(String) - Static method in class jakarta.ws.rs.core.Cookie

Deprecated.

This method will be removed in a future version. Please use RuntimeDelegate.getInstance().createHeaderDelegate(Cookie.class).fromString(value) instead.

valueOf(String) - Static method in class jakarta.ws.rs.core.EntityTag

Deprecated.

This method will be removed in a future version. Please use RuntimeDelegate.getInstance().createHeaderDelegate(EntityTag.class).fromString(value) instead.

valueOf(String) - Static method in class jakarta.ws.rs.core.Link

Simple parser to convert link header string representations into a link.

valueOf(String) - Static method in class jakarta.ws.rs.core.MediaType

Creates a new instance of MediaType by parsing the supplied string.

valueOf(String) - Static method in enum class jakarta.ws.rs.core.NewCookie.SameSite

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in class jakarta.ws.rs.core.NewCookie

Deprecated.

This method will be removed in a future version. Please use RuntimeDelegate.getInstance().createHeaderDelegate(NewCookie.class).fromString(value) instead.

valueOf(String) - Static method in enum class jakarta.ws.rs.core.Response.Status.Family

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class jakarta.ws.rs.core.Response.Status

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class jakarta.ws.rs.RuntimeType

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class jakarta.ws.rs.SeBootstrap.Configuration.SSLClientAuthentication

Returns the enum constant of this class with the specified name.

values() - Method in class jakarta.ws.rs.core.AbstractMultivaluedMap

values() - Static method in enum class jakarta.ws.rs.core.NewCookie.SameSite

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class jakarta.ws.rs.core.Response.Status.Family

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class jakarta.ws.rs.core.Response.Status

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class jakarta.ws.rs.RuntimeType

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class jakarta.ws.rs.SeBootstrap.Configuration.SSLClientAuthentication

Returns an array containing the constants of this enum class, in the order they are declared.

variant(Variant) - Method in class jakarta.ws.rs.core.Response.ResponseBuilder

Set message entity representation metadata.

Variant - Class in jakarta.ws.rs.core

Abstraction for a resource representation variant.

Variant(MediaType, String, String) - Constructor for class jakarta.ws.rs.core.Variant

Create a new instance of Variant.

Variant(MediaType, String, String, String) - Constructor for class jakarta.ws.rs.core.Variant

Create a new instance of Variant.

Variant(MediaType, String, String, String, String) - Constructor for class jakarta.ws.rs.core.Variant

Create a new instance of Variant.

Variant(MediaType, Locale, String) - Constructor for class jakarta.ws.rs.core.Variant

Create a new instance of Variant.

Variant.VariantListBuilder - Class in jakarta.ws.rs.core

A builder for a list of representation variants.

VariantListBuilder() - Constructor for class jakarta.ws.rs.core.Variant.VariantListBuilder

Protected constructor, use the static newInstance method to obtain an instance.

variants(Variant...) - Method in class jakarta.ws.rs.core.Response.ResponseBuilder

Add a Vary header that lists the available variants.

variants(List<Variant>) - Method in class jakarta.ws.rs.core.Response.ResponseBuilder

Add a Vary header that lists the available variants.

VARY - Static variable in interface jakarta.ws.rs.core.HttpHeaders

See HTTP/1.1 documentation.

version(int) - Method in class jakarta.ws.rs.core.Cookie.AbstractCookieBuilder

Set the version of the cookie.

W

WebApplicationException - Exception Class in jakarta.ws.rs

Runtime exception for applications.

WebApplicationException() - Constructor for exception class jakarta.ws.rs.WebApplicationException

Construct a new instance with a default HTTP status code of 500 and a default message generated from the HTTP status code and the associated HTTP status reason phrase.

WebApplicationException(int) - Constructor for exception class jakarta.ws.rs.WebApplicationException

Construct a new instance with the supplied HTTP status code and a default message generated from the HTTP status code and the associated HTTP status reason phrase.

WebApplicationException(Response) - Constructor for exception class jakarta.ws.rs.WebApplicationException

Construct a new instance using the supplied response and a default message generated from the response's HTTP status code and the associated HTTP status reason phrase.

WebApplicationException(Response.Status) - Constructor for exception class jakarta.ws.rs.WebApplicationException

Construct a new instance with the supplied HTTP status and a default message generated from the HTTP status code and the associated HTTP status reason phrase.

WebApplicationException(String) - Constructor for exception class jakarta.ws.rs.WebApplicationException

Construct a new instance with the supplied message and a default HTTP status code of 500.

WebApplicationException(String, int) - Constructor for exception class jakarta.ws.rs.WebApplicationException

Construct a new instance with a supplied message and HTTP status code.

WebApplicationException(String, Response) - Constructor for exception class jakarta.ws.rs.WebApplicationException

Construct a new instance using the supplied message and response.

WebApplicationException(String, Response.Status) - Constructor for exception class jakarta.ws.rs.WebApplicationException

Construct a new instance with the supplied message and HTTP status.

WebApplicationException(String, Throwable) - Constructor for exception class jakarta.ws.rs.WebApplicationException

Construct a new instance with the supplied message, root cause and default HTTP status code of 500.

WebApplicationException(String, Throwable, int) - Constructor for exception class jakarta.ws.rs.WebApplicationException

Construct a new instance with the supplied message, root cause and HTTP status code.

WebApplicationException(String, Throwable, Response) - Constructor for exception class jakarta.ws.rs.WebApplicationException

Construct a new instance with the supplied message, root cause and response.

WebApplicationException(String, Throwable, Response.Status) - Constructor for exception class jakarta.ws.rs.WebApplicationException

Construct a new instance with a the supplied message, root cause and HTTP status code.

WebApplicationException(Throwable) - Constructor for exception class jakarta.ws.rs.WebApplicationException

Construct a new instance with the supplied root cause, default HTTP status code of 500 and a default message generated from the HTTP status code and the associated HTTP status reason phrase.

WebApplicationException(Throwable, int) - Constructor for exception class jakarta.ws.rs.WebApplicationException

Construct a new instance with the supplied root cause, HTTP status code and a default message generated from the HTTP status code and the associated HTTP status reason phrase.

WebApplicationException(Throwable, Response) - Constructor for exception class jakarta.ws.rs.WebApplicationException

Construct a new instance with the supplied root cause, response and a default message generated from the response's HTTP status code and the associated HTTP status reason phrase.

WebApplicationException(Throwable, Response.Status) - Constructor for exception class jakarta.ws.rs.WebApplicationException

Construct a new instance with the supplied root cause, HTTP status code and a default message generated from the HTTP status code and the associated HTTP status reason phrase.

Web resource clients - Search tag in Overview

Section

Web resources - Search tag in Overview

Section

WebTarget - Interface in jakarta.ws.rs.client

A resource target identified by the resource URI.

WILDCARD - Static variable in class jakarta.ws.rs.core.MediaType

A String constant representing wildcard "*/*" media type .

WILDCARD_TYPE - Static variable in class jakarta.ws.rs.core.MediaType

A MediaType constant representing wildcard "*/*" media type.

withCharset(String) - Method in class jakarta.ws.rs.core.MediaType

Create a new MediaType instance with the same type, subtype and parameters copied from the original instance and the supplied "charset" parameter.

withConfig(Configuration) - Method in class jakarta.ws.rs.client.ClientBuilder

Set the internal configuration state to an externally provided configuration state.

withFileName(String) - Static method in interface jakarta.ws.rs.core.EntityPart

Creates a new EntityPart.Builder instance that sets the part name and fileName to the passed in partAndFileName value.

withName(String) - Static method in interface jakarta.ws.rs.core.EntityPart

Creates a new EntityPart.Builder instance.

write(OutputStream) - Method in interface jakarta.ws.rs.core.StreamingOutput

Called to write the message body.

WriterInterceptor - Interface in jakarta.ws.rs.ext

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 - Interface in jakarta.ws.rs.ext

Context class used by WriterInterceptor to intercept 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).

writeTo(T, Class<?>, Type, Annotation[], MediaType, MultivaluedMap<String, Object>, OutputStream) - Method in interface jakarta.ws.rs.ext.MessageBodyWriter

Write a type to an HTTP message.

WWW_AUTHENTICATE - Static variable in interface jakarta.ws.rs.core.HttpHeaders

See HTTP/1.1 documentation.

X

xhtml(T) - Static method in class jakarta.ws.rs.client.Entity

Create an "application/xhtml+xml" entity.

xml(T) - Static method in class jakarta.ws.rs.client.Entity

Create an "application/xml" entity.

A B C D E F G H I J K L M N O P Q R S T U V W X
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form