From dea0910e432c84ede32e539c3f999ac4136652e5 Mon Sep 17 00:00:00 2001 From: jim-krueger Date: Wed, 3 Apr 2024 14:40:24 -0500 Subject: [PATCH] Update content and links --- restful-ws/4.0/_index.md | 17 +- restful-ws/4.0/apidocs/allclasses-index.html | 689 ++ restful-ws/4.0/apidocs/allpackages-index.html | 92 + restful-ws/4.0/apidocs/constant-values.html | 448 ++ restful-ws/4.0/apidocs/copy.svg | 33 + restful-ws/4.0/apidocs/deprecated-list.html | 245 + restful-ws/4.0/apidocs/element-list | 7 + restful-ws/4.0/apidocs/help-doc.html | 219 + restful-ws/4.0/apidocs/index-all.html | 5865 +++++++++++++++++ restful-ws/4.0/apidocs/index.html | 149 + .../jakarta/ws/rs/ApplicationPath.html | 174 + .../jakarta/ws/rs/BadRequestException.html | 316 + .../jakarta/ws/rs/BeanParam.html | 148 + .../jakarta/ws/rs/ClientErrorException.html | 431 ++ .../jakarta/ws/rs/ConstrainedTo.html | 195 + .../jakarta.ws.rs/jakarta/ws/rs/Consumes.html | 176 + .../jakarta/ws/rs/CookieParam.html | 184 + .../jakarta.ws.rs/jakarta/ws/rs/DELETE.html | 118 + .../jakarta/ws/rs/DefaultValue.html | 178 + .../jakarta.ws.rs/jakarta/ws/rs/Encoded.html | 122 + .../jakarta/ws/rs/ForbiddenException.html | 317 + .../jakarta/ws/rs/FormParam.html | 197 + .../jakarta.ws.rs/jakarta/ws/rs/GET.html | 118 + .../jakarta.ws.rs/jakarta/ws/rs/HEAD.html | 118 + .../jakarta/ws/rs/HeaderParam.html | 187 + .../jakarta/ws/rs/HttpMethod.html | 330 + .../ws/rs/InternalServerErrorException.html | 317 + .../jakarta/ws/rs/MatrixParam.html | 197 + .../jakarta/ws/rs/NameBinding.html | 160 + .../jakarta/ws/rs/NotAcceptableException.html | 317 + .../jakarta/ws/rs/NotAllowedException.html | 356 + .../jakarta/ws/rs/NotAuthorizedException.html | 387 ++ .../jakarta/ws/rs/NotFoundException.html | 316 + .../jakarta/ws/rs/NotSupportedException.html | 317 + .../jakarta.ws.rs/jakarta/ws/rs/OPTIONS.html | 118 + .../jakarta.ws.rs/jakarta/ws/rs/PATCH.html | 118 + .../jakarta.ws.rs/jakarta/ws/rs/POST.html | 118 + .../jakarta.ws.rs/jakarta/ws/rs/PUT.html | 118 + .../jakarta.ws.rs/jakarta/ws/rs/Path.html | 224 + .../jakarta/ws/rs/PathParam.html | 200 + .../jakarta/ws/rs/Priorities.html | 267 + .../jakarta/ws/rs/ProcessingException.html | 251 + .../jakarta.ws.rs/jakarta/ws/rs/Produces.html | 181 + .../jakarta/ws/rs/QueryParam.html | 191 + .../jakarta/ws/rs/RedirectionException.html | 338 + .../jakarta/ws/rs/RuntimeType.html | 251 + .../rs/SeBootstrap.Configuration.Builder.html | 424 ++ ...Configuration.SSLClientAuthentication.html | 284 + .../ws/rs/SeBootstrap.Configuration.html | 689 ++ .../rs/SeBootstrap.Instance.StopResult.html | 176 + .../jakarta/ws/rs/SeBootstrap.Instance.html | 254 + .../jakarta/ws/rs/SeBootstrap.html | 387 ++ .../jakarta/ws/rs/ServerErrorException.html | 431 ++ .../ws/rs/ServiceUnavailableException.html | 505 ++ .../ws/rs/WebApplicationException.html | 533 ++ .../ws/rs/class-use/ApplicationPath.html | 63 + .../ws/rs/class-use/BadRequestException.html | 63 + .../jakarta/ws/rs/class-use/BeanParam.html | 63 + .../ws/rs/class-use/ClientErrorException.html | 128 + .../ws/rs/class-use/ConstrainedTo.html | 63 + .../jakarta/ws/rs/class-use/Consumes.html | 63 + .../jakarta/ws/rs/class-use/CookieParam.html | 63 + .../jakarta/ws/rs/class-use/DELETE.html | 63 + .../jakarta/ws/rs/class-use/DefaultValue.html | 63 + .../jakarta/ws/rs/class-use/Encoded.html | 63 + .../ws/rs/class-use/ForbiddenException.html | 63 + .../jakarta/ws/rs/class-use/FormParam.html | 63 + .../jakarta/ws/rs/class-use/GET.html | 63 + .../jakarta/ws/rs/class-use/HEAD.html | 63 + .../jakarta/ws/rs/class-use/HeaderParam.html | 63 + .../jakarta/ws/rs/class-use/HttpMethod.html | 122 + .../InternalServerErrorException.html | 63 + .../jakarta/ws/rs/class-use/MatrixParam.html | 63 + .../jakarta/ws/rs/class-use/NameBinding.html | 63 + .../rs/class-use/NotAcceptableException.html | 63 + .../ws/rs/class-use/NotAllowedException.html | 63 + .../rs/class-use/NotAuthorizedException.html | 63 + .../ws/rs/class-use/NotFoundException.html | 63 + .../rs/class-use/NotSupportedException.html | 63 + .../jakarta/ws/rs/class-use/OPTIONS.html | 63 + .../jakarta/ws/rs/class-use/PATCH.html | 63 + .../jakarta/ws/rs/class-use/POST.html | 63 + .../jakarta/ws/rs/class-use/PUT.html | 63 + .../jakarta/ws/rs/class-use/Path.html | 63 + .../jakarta/ws/rs/class-use/PathParam.html | 63 + .../jakarta/ws/rs/class-use/Priorities.html | 63 + .../ws/rs/class-use/ProcessingException.html | 92 + .../jakarta/ws/rs/class-use/Produces.html | 63 + .../jakarta/ws/rs/class-use/QueryParam.html | 63 + .../ws/rs/class-use/RedirectionException.html | 63 + .../jakarta/ws/rs/class-use/RuntimeType.html | 118 + .../SeBootstrap.Configuration.Builder.html | 158 + ...Configuration.SSLClientAuthentication.html | 114 + .../class-use/SeBootstrap.Configuration.html | 142 + .../SeBootstrap.Instance.StopResult.html | 104 + .../ws/rs/class-use/SeBootstrap.Instance.html | 136 + .../jakarta/ws/rs/class-use/SeBootstrap.html | 63 + .../ws/rs/class-use/ServerErrorException.html | 99 + .../ServiceUnavailableException.html | 63 + .../rs/class-use/WebApplicationException.html | 248 + .../jakarta/ws/rs/client/AsyncInvoker.html | 1095 +++ .../jakarta/ws/rs/client/Client.html | 325 + .../jakarta/ws/rs/client/ClientBuilder.html | 620 ++ .../ws/rs/client/ClientRequestContext.html | 864 +++ .../ws/rs/client/ClientRequestFilter.html | 174 + .../ws/rs/client/ClientResponseContext.html | 600 ++ .../ws/rs/client/ClientResponseFilter.html | 179 + .../rs/client/CompletionStageRxInvoker.html | 746 +++ .../jakarta/ws/rs/client/Entity.html | 546 ++ .../ws/rs/client/Invocation.Builder.html | 601 ++ .../jakarta/ws/rs/client/Invocation.html | 387 ++ .../ws/rs/client/InvocationCallback.html | 200 + .../client/ResponseProcessingException.html | 278 + .../jakarta/ws/rs/client/RxInvoker.html | 830 +++ .../ws/rs/client/RxInvokerProvider.html | 199 + .../jakarta/ws/rs/client/SyncInvoker.html | 816 +++ .../jakarta/ws/rs/client/WebTarget.html | 553 ++ .../ws/rs/client/class-use/AsyncInvoker.html | 92 + .../ws/rs/client/class-use/Client.html | 109 + .../ws/rs/client/class-use/ClientBuilder.html | 149 + .../class-use/ClientRequestContext.html | 99 + .../client/class-use/ClientRequestFilter.html | 63 + .../class-use/ClientResponseContext.html | 94 + .../class-use/ClientResponseFilter.html | 63 + .../class-use/CompletionStageRxInvoker.html | 92 + .../ws/rs/client/class-use/Entity.html | 393 ++ .../client/class-use/Invocation.Builder.html | 166 + .../ws/rs/client/class-use/Invocation.html | 124 + .../client/class-use/InvocationCallback.html | 143 + .../ResponseProcessingException.html | 63 + .../ws/rs/client/class-use/RxInvoker.html | 114 + .../client/class-use/RxInvokerProvider.html | 63 + .../ws/rs/client/class-use/SyncInvoker.html | 104 + .../ws/rs/client/class-use/WebTarget.html | 192 + .../jakarta/ws/rs/client/package-summary.html | 279 + .../jakarta/ws/rs/client/package-tree.html | 129 + .../jakarta/ws/rs/client/package-use.html | 156 + .../ws/rs/container/AsyncResponse.html | 653 ++ .../ws/rs/container/CompletionCallback.html | 169 + .../ws/rs/container/ConnectionCallback.html | 165 + .../rs/container/ContainerRequestContext.html | 808 +++ .../rs/container/ContainerRequestFilter.html | 207 + .../container/ContainerResponseContext.html | 830 +++ .../rs/container/ContainerResponseFilter.html | 192 + .../ws/rs/container/DynamicFeature.html | 205 + .../jakarta/ws/rs/container/PreMatching.html | 115 + .../ws/rs/container/ResourceContext.html | 197 + .../jakarta/ws/rs/container/ResourceInfo.html | 189 + .../jakarta/ws/rs/container/Suspended.html | 159 + .../ws/rs/container/TimeoutHandler.html | 226 + .../rs/container/class-use/AsyncResponse.html | 98 + .../class-use/CompletionCallback.html | 63 + .../class-use/ConnectionCallback.html | 63 + .../class-use/ContainerRequestContext.html | 98 + .../class-use/ContainerRequestFilter.html | 63 + .../class-use/ContainerResponseContext.html | 93 + .../class-use/ContainerResponseFilter.html | 63 + .../container/class-use/DynamicFeature.html | 63 + .../rs/container/class-use/PreMatching.html | 63 + .../container/class-use/ResourceContext.html | 63 + .../rs/container/class-use/ResourceInfo.html | 95 + .../ws/rs/container/class-use/Suspended.html | 63 + .../container/class-use/TimeoutHandler.html | 92 + .../ws/rs/container/package-summary.html | 187 + .../jakarta/ws/rs/container/package-tree.html | 90 + .../jakarta/ws/rs/container/package-use.html | 105 + .../ws/rs/core/AbstractMultivaluedMap.html | 715 ++ .../jakarta/ws/rs/core/Application.html | 280 + .../jakarta/ws/rs/core/CacheControl.html | 723 ++ .../jakarta/ws/rs/core/Configurable.html | 563 ++ .../jakarta/ws/rs/core/Configuration.html | 444 ++ .../jakarta/ws/rs/core/Context.html | 126 + .../rs/core/Cookie.AbstractCookieBuilder.html | 284 + .../jakarta/ws/rs/core/Cookie.Builder.html | 222 + .../jakarta/ws/rs/core/Cookie.html | 535 ++ .../ws/rs/core/EntityPart.Builder.html | 461 ++ .../jakarta/ws/rs/core/EntityPart.html | 438 ++ .../jakarta/ws/rs/core/EntityTag.html | 335 + .../jakarta/ws/rs/core/Feature.html | 187 + .../jakarta/ws/rs/core/FeatureContext.html | 128 + .../jakarta/ws/rs/core/Form.html | 269 + .../jakarta/ws/rs/core/GenericEntity.html | 354 + .../jakarta/ws/rs/core/GenericType.html | 346 + .../jakarta/ws/rs/core/HttpHeaders.html | 1132 ++++ .../jakarta/ws/rs/core/Link.Builder.html | 457 ++ .../jakarta/ws/rs/core/Link.html | 624 ++ .../jakarta/ws/rs/core/MediaType.html | 1021 +++ .../ws/rs/core/MultivaluedHashMap.html | 335 + .../jakarta/ws/rs/core/MultivaluedMap.html | 317 + .../NewCookie.AbstractNewCookieBuilder.html | 364 + .../jakarta/ws/rs/core/NewCookie.Builder.html | 243 + .../ws/rs/core/NewCookie.SameSite.html | 264 + .../jakarta/ws/rs/core/NewCookie.html | 926 +++ .../ws/rs/core/NoContentException.html | 225 + .../jakarta/ws/rs/core/PathSegment.html | 192 + .../jakarta/ws/rs/core/Request.html | 311 + .../ws/rs/core/Response.ResponseBuilder.html | 890 +++ .../ws/rs/core/Response.Status.Family.html | 311 + .../jakarta/ws/rs/core/Response.Status.html | 983 +++ .../ws/rs/core/Response.StatusType.html | 218 + .../jakarta/ws/rs/core/Response.html | 1410 ++++ .../jakarta/ws/rs/core/SecurityContext.html | 331 + .../jakarta/ws/rs/core/StreamingOutput.html | 173 + .../jakarta/ws/rs/core/UriBuilder.html | 1302 ++++ .../ws/rs/core/UriBuilderException.html | 238 + .../jakarta/ws/rs/core/UriInfo.html | 755 +++ .../rs/core/Variant.VariantListBuilder.html | 313 + .../jakarta/ws/rs/core/Variant.html | 476 ++ .../class-use/AbstractMultivaluedMap.html | 92 + .../ws/rs/core/class-use/Application.html | 154 + .../ws/rs/core/class-use/CacheControl.html | 125 + .../ws/rs/core/class-use/Configurable.html | 142 + .../ws/rs/core/class-use/Configuration.html | 129 + .../jakarta/ws/rs/core/class-use/Context.html | 63 + .../Cookie.AbstractCookieBuilder.html | 124 + .../ws/rs/core/class-use/Cookie.Builder.html | 63 + .../jakarta/ws/rs/core/class-use/Cookie.html | 239 + .../rs/core/class-use/EntityPart.Builder.html | 175 + .../ws/rs/core/class-use/EntityPart.html | 92 + .../ws/rs/core/class-use/EntityTag.html | 166 + .../jakarta/ws/rs/core/class-use/Feature.html | 105 + .../ws/rs/core/class-use/FeatureContext.html | 115 + .../jakarta/ws/rs/core/class-use/Form.html | 129 + .../ws/rs/core/class-use/GenericEntity.html | 63 + .../ws/rs/core/class-use/GenericType.html | 344 + .../ws/rs/core/class-use/HttpHeaders.html | 63 + .../ws/rs/core/class-use/Link.Builder.html | 244 + .../jakarta/ws/rs/core/class-use/Link.html | 225 + .../ws/rs/core/class-use/MediaType.html | 557 ++ .../rs/core/class-use/MultivaluedHashMap.html | 63 + .../ws/rs/core/class-use/MultivaluedMap.html | 327 + .../NewCookie.AbstractNewCookieBuilder.html | 114 + .../rs/core/class-use/NewCookie.Builder.html | 63 + .../rs/core/class-use/NewCookie.SameSite.html | 151 + .../ws/rs/core/class-use/NewCookie.html | 164 + .../rs/core/class-use/NoContentException.html | 63 + .../ws/rs/core/class-use/PathSegment.html | 97 + .../jakarta/ws/rs/core/class-use/Request.html | 92 + .../class-use/Response.ResponseBuilder.html | 399 ++ .../class-use/Response.Status.Family.html | 113 + .../ws/rs/core/class-use/Response.Status.html | 226 + .../core/class-use/Response.StatusType.html | 183 + .../ws/rs/core/class-use/Response.html | 681 ++ .../ws/rs/core/class-use/SecurityContext.html | 103 + .../ws/rs/core/class-use/StreamingOutput.html | 63 + .../ws/rs/core/class-use/UriBuilder.html | 377 ++ .../core/class-use/UriBuilderException.html | 114 + .../jakarta/ws/rs/core/class-use/UriInfo.html | 92 + .../class-use/Variant.VariantListBuilder.html | 148 + .../jakarta/ws/rs/core/class-use/Variant.html | 187 + .../jakarta/ws/rs/core/package-summary.html | 310 + .../jakarta/ws/rs/core/package-tree.html | 176 + .../jakarta/ws/rs/core/package-use.html | 465 ++ .../jakarta/ws/rs/ext/ContextResolver.html | 183 + .../jakarta/ws/rs/ext/ExceptionMapper.html | 178 + .../jakarta/ws/rs/ext/InterceptorContext.html | 460 ++ .../jakarta/ws/rs/ext/MessageBodyReader.html | 254 + .../jakarta/ws/rs/ext/MessageBodyWriter.html | 273 + .../ws/rs/ext/ParamConverter.Lazy.html | 115 + .../jakarta/ws/rs/ext/ParamConverter.html | 232 + .../ws/rs/ext/ParamConverterProvider.html | 178 + .../jakarta/ws/rs/ext/Provider.html | 112 + .../jakarta/ws/rs/ext/Providers.html | 281 + .../jakarta/ws/rs/ext/ReaderInterceptor.html | 184 + .../ws/rs/ext/ReaderInterceptorContext.html | 237 + .../ext/RuntimeDelegate.HeaderDelegate.html | 186 + .../jakarta/ws/rs/ext/RuntimeDelegate.html | 547 ++ .../jakarta/ws/rs/ext/WriterInterceptor.html | 182 + .../ws/rs/ext/WriterInterceptorContext.html | 264 + .../ws/rs/ext/class-use/ContextResolver.html | 93 + .../ws/rs/ext/class-use/ExceptionMapper.html | 92 + .../rs/ext/class-use/InterceptorContext.html | 99 + .../rs/ext/class-use/MessageBodyReader.html | 95 + .../rs/ext/class-use/MessageBodyWriter.html | 95 + .../rs/ext/class-use/ParamConverter.Lazy.html | 63 + .../ws/rs/ext/class-use/ParamConverter.html | 94 + .../ext/class-use/ParamConverterProvider.html | 63 + .../jakarta/ws/rs/ext/class-use/Provider.html | 63 + .../ws/rs/ext/class-use/Providers.html | 63 + .../rs/ext/class-use/ReaderInterceptor.html | 63 + .../class-use/ReaderInterceptorContext.html | 92 + .../RuntimeDelegate.HeaderDelegate.html | 92 + .../ws/rs/ext/class-use/RuntimeDelegate.html | 103 + .../rs/ext/class-use/WriterInterceptor.html | 63 + .../class-use/WriterInterceptorContext.html | 92 + .../jakarta/ws/rs/ext/package-summary.html | 204 + .../jakarta/ws/rs/ext/package-tree.html | 105 + .../jakarta/ws/rs/ext/package-use.html | 131 + .../jakarta/ws/rs/package-summary.html | 351 + .../jakarta/ws/rs/package-tree.html | 165 + .../jakarta/ws/rs/package-use.html | 192 + .../jakarta/ws/rs/sse/InboundSseEvent.html | 295 + .../ws/rs/sse/OutboundSseEvent.Builder.html | 358 + .../jakarta/ws/rs/sse/OutboundSseEvent.html | 257 + .../jakarta.ws.rs/jakarta/ws/rs/sse/Sse.html | 224 + .../jakarta/ws/rs/sse/SseBroadcaster.html | 276 + .../jakarta/ws/rs/sse/SseEvent.html | 287 + .../jakarta/ws/rs/sse/SseEventSink.html | 229 + .../ws/rs/sse/SseEventSource.Builder.html | 311 + .../jakarta/ws/rs/sse/SseEventSource.html | 392 ++ .../ws/rs/sse/class-use/InboundSseEvent.html | 105 + .../class-use/OutboundSseEvent.Builder.html | 135 + .../ws/rs/sse/class-use/OutboundSseEvent.html | 119 + .../jakarta/ws/rs/sse/class-use/Sse.html | 63 + .../ws/rs/sse/class-use/SseBroadcaster.html | 92 + .../jakarta/ws/rs/sse/class-use/SseEvent.html | 97 + .../ws/rs/sse/class-use/SseEventSink.html | 111 + .../sse/class-use/SseEventSource.Builder.html | 104 + .../ws/rs/sse/class-use/SseEventSource.html | 92 + .../jakarta/ws/rs/sse/package-summary.html | 169 + .../jakarta/ws/rs/sse/package-tree.html | 97 + .../jakarta/ws/rs/sse/package-use.html | 117 + .../apidocs/jakarta.ws.rs/module-summary.html | 129 + .../4.0/apidocs/legal/ADDITIONAL_LICENSE_INFO | 37 + .../4.0/apidocs/legal/ASSEMBLY_EXCEPTION | 27 + restful-ws/4.0/apidocs/legal/LICENSE | 347 + restful-ws/4.0/apidocs/legal/jquery.md | 72 + restful-ws/4.0/apidocs/legal/jqueryUI.md | 49 + restful-ws/4.0/apidocs/link.svg | 31 + restful-ws/4.0/apidocs/member-search-index.js | 1 + restful-ws/4.0/apidocs/module-search-index.js | 1 + restful-ws/4.0/apidocs/overview-summary.html | 25 + restful-ws/4.0/apidocs/overview-tree.html | 310 + .../4.0/apidocs/package-search-index.js | 1 + restful-ws/4.0/apidocs/resources/EFSL.html | 72 + restful-ws/4.0/apidocs/resources/glass.png | Bin 0 -> 499 bytes restful-ws/4.0/apidocs/resources/x.png | Bin 0 -> 394 bytes .../apidocs/script-dir/jquery-3.6.1.min.js | 2 + .../4.0/apidocs/script-dir/jquery-ui.min.css | 6 + .../4.0/apidocs/script-dir/jquery-ui.min.js | 6 + restful-ws/4.0/apidocs/script.js | 253 + restful-ws/4.0/apidocs/search-page.js | 284 + restful-ws/4.0/apidocs/search.html | 78 + restful-ws/4.0/apidocs/search.js | 458 ++ restful-ws/4.0/apidocs/serialized-form.html | 300 + restful-ws/4.0/apidocs/stylesheet.css | 1272 ++++ restful-ws/4.0/apidocs/tag-search-index.js | 1 + restful-ws/4.0/apidocs/type-search-index.js | 1 + 338 files changed, 82706 insertions(+), 5 deletions(-) create mode 100644 restful-ws/4.0/apidocs/allclasses-index.html create mode 100644 restful-ws/4.0/apidocs/allpackages-index.html create mode 100644 restful-ws/4.0/apidocs/constant-values.html create mode 100644 restful-ws/4.0/apidocs/copy.svg create mode 100644 restful-ws/4.0/apidocs/deprecated-list.html create mode 100644 restful-ws/4.0/apidocs/element-list create mode 100644 restful-ws/4.0/apidocs/help-doc.html create mode 100644 restful-ws/4.0/apidocs/index-all.html create mode 100644 restful-ws/4.0/apidocs/index.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/ApplicationPath.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/BadRequestException.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/BeanParam.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/ClientErrorException.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/ConstrainedTo.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/Consumes.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/CookieParam.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/DELETE.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/DefaultValue.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/Encoded.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/ForbiddenException.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/FormParam.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/GET.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/HEAD.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/HeaderParam.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/HttpMethod.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/InternalServerErrorException.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/MatrixParam.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/NameBinding.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/NotAcceptableException.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/NotAllowedException.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/NotAuthorizedException.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/NotFoundException.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/NotSupportedException.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/OPTIONS.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/PATCH.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/POST.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/PUT.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/Path.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/PathParam.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/Priorities.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/ProcessingException.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/Produces.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/QueryParam.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/RedirectionException.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/RuntimeType.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/SeBootstrap.Configuration.Builder.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/SeBootstrap.Configuration.SSLClientAuthentication.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/SeBootstrap.Configuration.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/SeBootstrap.Instance.StopResult.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/SeBootstrap.Instance.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/SeBootstrap.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/ServerErrorException.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/ServiceUnavailableException.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/WebApplicationException.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/class-use/ApplicationPath.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/class-use/BadRequestException.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/class-use/BeanParam.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/class-use/ClientErrorException.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/class-use/ConstrainedTo.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/class-use/Consumes.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/class-use/CookieParam.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/class-use/DELETE.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/class-use/DefaultValue.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/class-use/Encoded.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/class-use/ForbiddenException.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/class-use/FormParam.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/class-use/GET.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/class-use/HEAD.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/class-use/HeaderParam.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/class-use/HttpMethod.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/class-use/InternalServerErrorException.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/class-use/MatrixParam.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/class-use/NameBinding.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/class-use/NotAcceptableException.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/class-use/NotAllowedException.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/class-use/NotAuthorizedException.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/class-use/NotFoundException.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/class-use/NotSupportedException.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/class-use/OPTIONS.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/class-use/PATCH.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/class-use/POST.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/class-use/PUT.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/class-use/Path.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/class-use/PathParam.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/class-use/Priorities.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/class-use/ProcessingException.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/class-use/Produces.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/class-use/QueryParam.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/class-use/RedirectionException.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/class-use/RuntimeType.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/class-use/SeBootstrap.Configuration.Builder.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/class-use/SeBootstrap.Configuration.SSLClientAuthentication.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/class-use/SeBootstrap.Configuration.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/class-use/SeBootstrap.Instance.StopResult.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/class-use/SeBootstrap.Instance.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/class-use/SeBootstrap.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/class-use/ServerErrorException.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/class-use/ServiceUnavailableException.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/class-use/WebApplicationException.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/client/AsyncInvoker.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/client/Client.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/client/ClientBuilder.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/client/ClientRequestContext.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/client/ClientRequestFilter.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/client/ClientResponseContext.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/client/ClientResponseFilter.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/client/CompletionStageRxInvoker.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/client/Entity.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/client/Invocation.Builder.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/client/Invocation.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/client/InvocationCallback.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/client/ResponseProcessingException.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/client/RxInvoker.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/client/RxInvokerProvider.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/client/SyncInvoker.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/client/WebTarget.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/client/class-use/AsyncInvoker.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/client/class-use/Client.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/client/class-use/ClientBuilder.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/client/class-use/ClientRequestContext.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/client/class-use/ClientRequestFilter.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/client/class-use/ClientResponseContext.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/client/class-use/ClientResponseFilter.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/client/class-use/CompletionStageRxInvoker.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/client/class-use/Entity.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/client/class-use/Invocation.Builder.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/client/class-use/Invocation.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/client/class-use/InvocationCallback.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/client/class-use/ResponseProcessingException.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/client/class-use/RxInvoker.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/client/class-use/RxInvokerProvider.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/client/class-use/SyncInvoker.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/client/class-use/WebTarget.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/client/package-summary.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/client/package-tree.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/client/package-use.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/container/AsyncResponse.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/container/CompletionCallback.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/container/ConnectionCallback.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/container/ContainerRequestContext.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/container/ContainerRequestFilter.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/container/ContainerResponseContext.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/container/ContainerResponseFilter.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/container/DynamicFeature.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/container/PreMatching.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/container/ResourceContext.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/container/ResourceInfo.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/container/Suspended.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/container/TimeoutHandler.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/container/class-use/AsyncResponse.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/container/class-use/CompletionCallback.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/container/class-use/ConnectionCallback.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/container/class-use/ContainerRequestContext.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/container/class-use/ContainerRequestFilter.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/container/class-use/ContainerResponseContext.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/container/class-use/ContainerResponseFilter.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/container/class-use/DynamicFeature.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/container/class-use/PreMatching.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/container/class-use/ResourceContext.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/container/class-use/ResourceInfo.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/container/class-use/Suspended.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/container/class-use/TimeoutHandler.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/container/package-summary.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/container/package-tree.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/container/package-use.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/AbstractMultivaluedMap.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/Application.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/CacheControl.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/Configurable.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/Configuration.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/Context.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/Cookie.AbstractCookieBuilder.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/Cookie.Builder.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/Cookie.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/EntityPart.Builder.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/EntityPart.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/EntityTag.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/Feature.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/FeatureContext.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/Form.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/GenericEntity.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/GenericType.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/HttpHeaders.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/Link.Builder.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/Link.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/MediaType.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/MultivaluedHashMap.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/MultivaluedMap.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/NewCookie.AbstractNewCookieBuilder.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/NewCookie.Builder.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/NewCookie.SameSite.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/NewCookie.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/NoContentException.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/PathSegment.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/Request.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/Response.ResponseBuilder.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/Response.Status.Family.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/Response.Status.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/Response.StatusType.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/Response.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/SecurityContext.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/StreamingOutput.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/UriBuilder.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/UriBuilderException.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/UriInfo.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/Variant.VariantListBuilder.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/Variant.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/class-use/AbstractMultivaluedMap.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/class-use/Application.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/class-use/CacheControl.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/class-use/Configurable.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/class-use/Configuration.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/class-use/Context.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/class-use/Cookie.AbstractCookieBuilder.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/class-use/Cookie.Builder.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/class-use/Cookie.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/class-use/EntityPart.Builder.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/class-use/EntityPart.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/class-use/EntityTag.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/class-use/Feature.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/class-use/FeatureContext.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/class-use/Form.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/class-use/GenericEntity.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/class-use/GenericType.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/class-use/HttpHeaders.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/class-use/Link.Builder.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/class-use/Link.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/class-use/MediaType.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/class-use/MultivaluedHashMap.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/class-use/MultivaluedMap.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/class-use/NewCookie.AbstractNewCookieBuilder.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/class-use/NewCookie.Builder.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/class-use/NewCookie.SameSite.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/class-use/NewCookie.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/class-use/NoContentException.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/class-use/PathSegment.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/class-use/Request.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/class-use/Response.ResponseBuilder.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/class-use/Response.Status.Family.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/class-use/Response.Status.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/class-use/Response.StatusType.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/class-use/Response.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/class-use/SecurityContext.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/class-use/StreamingOutput.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/class-use/UriBuilder.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/class-use/UriBuilderException.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/class-use/UriInfo.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/class-use/Variant.VariantListBuilder.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/class-use/Variant.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/package-summary.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/package-tree.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/package-use.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/ext/ContextResolver.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/ext/ExceptionMapper.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/ext/InterceptorContext.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/ext/MessageBodyReader.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/ext/MessageBodyWriter.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/ext/ParamConverter.Lazy.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/ext/ParamConverter.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/ext/ParamConverterProvider.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/ext/Provider.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/ext/Providers.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/ext/ReaderInterceptor.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/ext/ReaderInterceptorContext.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/ext/RuntimeDelegate.HeaderDelegate.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/ext/RuntimeDelegate.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/ext/WriterInterceptor.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/ext/WriterInterceptorContext.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/ext/class-use/ContextResolver.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/ext/class-use/ExceptionMapper.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/ext/class-use/InterceptorContext.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/ext/class-use/MessageBodyReader.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/ext/class-use/MessageBodyWriter.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/ext/class-use/ParamConverter.Lazy.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/ext/class-use/ParamConverter.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/ext/class-use/ParamConverterProvider.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/ext/class-use/Provider.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/ext/class-use/Providers.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/ext/class-use/ReaderInterceptor.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/ext/class-use/ReaderInterceptorContext.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/ext/class-use/RuntimeDelegate.HeaderDelegate.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/ext/class-use/RuntimeDelegate.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/ext/class-use/WriterInterceptor.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/ext/class-use/WriterInterceptorContext.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/ext/package-summary.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/ext/package-tree.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/ext/package-use.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/package-summary.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/package-tree.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/package-use.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/sse/InboundSseEvent.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/sse/OutboundSseEvent.Builder.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/sse/OutboundSseEvent.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/sse/Sse.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/sse/SseBroadcaster.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/sse/SseEvent.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/sse/SseEventSink.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/sse/SseEventSource.Builder.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/sse/SseEventSource.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/sse/class-use/InboundSseEvent.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/sse/class-use/OutboundSseEvent.Builder.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/sse/class-use/OutboundSseEvent.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/sse/class-use/Sse.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/sse/class-use/SseBroadcaster.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/sse/class-use/SseEvent.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/sse/class-use/SseEventSink.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/sse/class-use/SseEventSource.Builder.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/sse/class-use/SseEventSource.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/sse/package-summary.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/sse/package-tree.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/sse/package-use.html create mode 100644 restful-ws/4.0/apidocs/jakarta.ws.rs/module-summary.html create mode 100644 restful-ws/4.0/apidocs/legal/ADDITIONAL_LICENSE_INFO create mode 100644 restful-ws/4.0/apidocs/legal/ASSEMBLY_EXCEPTION create mode 100644 restful-ws/4.0/apidocs/legal/LICENSE create mode 100644 restful-ws/4.0/apidocs/legal/jquery.md create mode 100644 restful-ws/4.0/apidocs/legal/jqueryUI.md create mode 100644 restful-ws/4.0/apidocs/link.svg create mode 100644 restful-ws/4.0/apidocs/member-search-index.js create mode 100644 restful-ws/4.0/apidocs/module-search-index.js create mode 100644 restful-ws/4.0/apidocs/overview-summary.html create mode 100644 restful-ws/4.0/apidocs/overview-tree.html create mode 100644 restful-ws/4.0/apidocs/package-search-index.js create mode 100644 restful-ws/4.0/apidocs/resources/EFSL.html create mode 100644 restful-ws/4.0/apidocs/resources/glass.png create mode 100644 restful-ws/4.0/apidocs/resources/x.png create mode 100644 restful-ws/4.0/apidocs/script-dir/jquery-3.6.1.min.js create mode 100644 restful-ws/4.0/apidocs/script-dir/jquery-ui.min.css create mode 100644 restful-ws/4.0/apidocs/script-dir/jquery-ui.min.js create mode 100644 restful-ws/4.0/apidocs/script.js create mode 100644 restful-ws/4.0/apidocs/search-page.js create mode 100644 restful-ws/4.0/apidocs/search.html create mode 100644 restful-ws/4.0/apidocs/search.js create mode 100644 restful-ws/4.0/apidocs/serialized-form.html create mode 100644 restful-ws/4.0/apidocs/stylesheet.css create mode 100644 restful-ws/4.0/apidocs/tag-search-index.js create mode 100644 restful-ws/4.0/apidocs/type-search-index.js diff --git a/restful-ws/4.0/_index.md b/restful-ws/4.0/_index.md index ebf71abfdb..7d8745d7de 100644 --- a/restful-ws/4.0/_index.md +++ b/restful-ws/4.0/_index.md @@ -29,13 +29,20 @@ earlier releases. * **Java SE 17 or higher** # Details -The latest details and progress for this work -may be found on the [Project Site](https://projects.eclipse.org/projects/ee4j.rest) as well as the -[Github Wiki](https://github.com/jakartaee/rest/wiki). Also see -[Jakarta RESTful Web Services 4.0 Release Record](https://projects.eclipse.org/projects/ee4j.rest/releases/4.0.0). + +* [Jakarta RESTful Web Services 4.0 Release Record](https://projects.eclipse.org/projects/ee4j.jaxrs/releases/4.0.0) + * [Jakarta EE Platform 10 Release Plan](https://jakartaee.github.io/platform/jakartaee11/#jakarta-ee-11-release-plan) +* [Jakarta RESTful Web Services 4.0 Specification Document](./jakarta-restful-ws-spec-4.0.pdf) (PDF) +* [Jakarta RESTful Web Services 4.0 Specification Document](./jakarta-restful-ws-spec-4.0.html) (HTML) +* [Jakarta RESTful Web Services 4.0 Javadoc](./apidocs) +* [Jakarta RESTful Web Services 4.0.0 TCK](https://download.eclipse.org/jakartaee/restful-ws/4.0/jakarta-restful-ws-tck-4.0.0.zip) ([sig](https://download.eclipse.org/jakartaee/restful-ws/4.0/jakarta-restful-ws-tck-4.0.0.zip.sig), [sha](https://download.eclipse.org/jakartaee/restful-ws/4.0/jakarta-restful-ws-tck-4.0.0.zip.sha256), [pub](https://jakarta.ee/specifications/jakartaee-spec-committee.pub)) +* Maven coordinates + * [jakarta.jaxrs:jakarta.jaxrs-api:jar:4.0.0](https://search.maven.org/artifact/jakarta.ws.rs/jakarta.ws.rs-api/4.0.0/jar) # Compatible Implementations -* [Eclipse Jersey 4.0](https://projects.eclipse.org/projects/ee4j.jersey) +* [RESTEasy 7.0.0.Alpha1](https://repository.jboss.org/nexus/content/groups/root_repository/org/jboss/resteasy/resteasy-cdi/7.0.0.Alpha1/) +* [Eclipse Jersey 4.0.0-M1 for jdk17](https://eclipse-ee4j.github.io/jersey/tck/eclipse-jersey-4.0.0-M1-jdk17) +* [Eclipse Jersey 4.0.0-M1 for jdk21](https://eclipse-ee4j.github.io/jersey/tck/eclipse-jersey-4.0.0-M1-jdk21) # Ballots diff --git a/restful-ws/4.0/apidocs/allclasses-index.html b/restful-ws/4.0/apidocs/allclasses-index.html new file mode 100644 index 0000000000..59e01a9c99 --- /dev/null +++ b/restful-ws/4.0/apidocs/allclasses-index.html @@ -0,0 +1,689 @@ + + + + +All Classes and Interfaces (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

All Classes and Interfaces

+
+
+
+
+
+
Class
+
Description
+
AbstractMultivaluedMap<K,V>
+
+
Abstract skeleton implementation of a MultivaluedMap that is backed by a [key, multi-value] store represented + as a Map<K, List<V>>.
+
+
Application
+
+
Defines the components of a JAX-RS application and supplies additional meta-data.
+
+
ApplicationPath
+
+
Identifies the application path that serves as the base URI for all resource URIs provided by + Path.
+
+
AsyncInvoker
+
+
Uniform interface for asynchronous invocation of HTTP methods.
+
+
AsyncResponse
+
+
An injectable JAX-RS asynchronous response that provides means for asynchronous server side response processing.
+
+
BadRequestException
+
+
A runtime exception indicating a bad client request.
+
+
BeanParam
+
+
The annotation that may be used to inject custom JAX-RS "parameter aggregator" value object into a resource class + field, property or resource method parameter.
+
+
CacheControl
+
+
An abstraction for the value of a HTTP Cache-Control response header.
+
+
Client
+
+
+ Client is the main entry point to the fluent API used to build and execute client requests in order to consume + responses returned.
+
+
ClientBuilder
+
+
Main entry point to the client API used to bootstrap Client instances.
+
+
ClientErrorException
+
+
A base runtime application exception indicating a client request error (HTTP 4xx status codes).
+
+
ClientRequestContext
+
+
Client request filter context.
+
+
ClientRequestFilter
+
+
An extension interface implemented by client request filters.
+
+
ClientResponseContext
+
+
Client response filter context.
+
+
ClientResponseFilter
+
+
An extension interface implemented by client response filters.
+
+
CompletionCallback
+
+
A request processing callback that receives request processing completion events.
+
+
CompletionStageRxInvoker
+
+
Reactive invoker based CompletionStage.
+
+
Configurable<C>
+
+
Represents a client or server-side configurable context in JAX-RS.
+
+
Configuration
+
+
A configuration state associated with a configurable JAX-RS context.
+
+
ConnectionCallback
+
+
Asynchronous request processing lifecycle callback that receives connection related asynchronous + response lifecycle events.
+
+
ConstrainedTo
+
+
Indicates the run-time context in which an annotated JAX-RS provider is applicable.
+
+
Consumes
+
+
Defines the media types that the methods of a resource class or MessageBodyReader can accept.
+
+
ContainerRequestContext
+
+
Container request filter context.
+
+
ContainerRequestFilter
+
+
An extension interface implemented by container request filters.
+
+
ContainerResponseContext
+
+
Container response filter context.
+
+
ContainerResponseFilter
+
+
An extension interface implemented by container response filters.
+
+
Context
+
+
This annotation is used to inject information into a class field, bean property or method parameter.
+
+
ContextResolver<T>
+
+
Contract for a provider that supplies context information to resource classes and other providers.
+
+
Cookie
+
+
Represents the value of a HTTP cookie, transferred in a request.
+
+
Cookie.AbstractCookieBuilder<T>
+
+
JAX-RS abstract Cookie builder class.
+
+
Cookie.Builder
+
+
JAX-RS Cookie builder class.
+
+
CookieParam
+
+
Binds the value of a HTTP cookie to a resource method parameter, resource class field, or resource class bean + property.
+
+
DefaultValue
+
+
Defines the default value of request meta-data that is bound using one of the following annotations: + PathParam, QueryParam, MatrixParam, + CookieParam, FormParam, or HeaderParam.
+
+
DELETE
+
+
Indicates that the annotated method responds to HTTP DELETE requests.
+
+
DynamicFeature
+
+
A JAX-RS meta-provider for dynamic registration of post-matching providers during a JAX-RS application setup + at deployment time.
+
+
Encoded
+
+
Disables automatic decoding of parameter values bound using QueryParam, PathParam, FormParam + or MatrixParam.
+
+
Entity<T>
+
+
Encapsulates message entity including the associated variant information.
+
+
EntityPart
+
+
A EntityPart is one part of a multipart entity.
+
+
EntityPart.Builder
+
+
Builder for EntityPart instances.
+
+
EntityTag
+
+
An abstraction for the value of a HTTP Entity Tag, used as the value of an ETag response header.
+
+
ExceptionMapper<E>
+
+
Contract for a provider that maps Java exceptions to Response.
+
+
Feature
+
+
A feature extension contract.
+
+
FeatureContext
+
+
A configurable context passed to Feature and DynamicFeature instances by JAX-RS + runtime during the phase of their configuration.
+
+
ForbiddenException
+
+
A runtime exception indicating that an access to a resource requested by a client has been + forbidden by the server.
+
+
Form
+
+
Represents the the HTML form data request entity encoded using the "application/x-www-form-urlencoded" + content type.
+
+
FormParam
+
+
Binds the value(s) of a form parameter contained within a request entity body to a resource method parameter.
+
+
GenericEntity<T>
+
+
Represents a message entity of a generic type T.
+
+
GenericType<T>
+
+
Represents a generic message entity type T.
+
+
GET
+
+
Indicates that the annotated method responds to HTTP GET requests.
+
+
HEAD
+
+
Indicates that the annotated method responds to HTTP HEAD requests.
+
+
HeaderParam
+
+
Binds the value(s) of a HTTP header to a resource method parameter, resource class field, or resource class bean + property.
+
+
HttpHeaders
+
+
An injectable interface that provides access to HTTP header information.
+
+
HttpMethod
+
+
Associates the name of a HTTP method with an annotation.
+
+
InboundSseEvent
+
+
Inbound Server-sent event.
+
+
InterceptorContext
+
+
Context shared by message body interceptors that can be used to wrap calls to + MessageBodyReader.readFrom(java.lang.Class<T>, java.lang.reflect.Type, java.lang.annotation.Annotation[], jakarta.ws.rs.core.MediaType, jakarta.ws.rs.core.MultivaluedMap<java.lang.String, java.lang.String>, java.io.InputStream) and MessageBodyWriter.writeTo(T, java.lang.Class<?>, java.lang.reflect.Type, java.lang.annotation.Annotation[], jakarta.ws.rs.core.MediaType, jakarta.ws.rs.core.MultivaluedMap<java.lang.String, java.lang.Object>, java.io.OutputStream).
+
+
InternalServerErrorException
+
+
A runtime exception indicating an internal server + error.
+
+
Invocation
+
+
A client request invocation.
+
+
Invocation.Builder
+
+
A client request invocation builder.
+
+
InvocationCallback<RESPONSE>
+
+
Callback that can be implemented to receive the asynchronous processing events from the invocation processing.
+
+
Link
+
+
+ Class representing hypermedia links.
+
+
Link.Builder
+
+
Builder class for hypermedia links.
+
+
MatrixParam
+
+
Binds the value(s) of a URI matrix parameter to a resource method parameter, resource class field, or resource class + bean property.
+
+
MediaType
+
+
An abstraction for a media type.
+
+
MessageBodyReader<T>
+
+
Contract for a provider that supports the conversion of a stream to a Java type.
+
+
MessageBodyWriter<T>
+
+
Contract for a provider that supports the conversion of a Java type to a stream.
+
+
MultivaluedHashMap<K,V>
+
+
A hash table based implementation of MultivaluedMap interface.
+
+
MultivaluedMap<K,V>
+
+
A map of key-values pairs.
+
+
NameBinding
+
+
Meta-annotation used to create name binding annotations for filters and interceptors.
+
+
NewCookie
+
+
Used to create a new HTTP cookie, transferred in a response.
+
+
NewCookie.AbstractNewCookieBuilder<T>
+
+
JAX-RS abstract NewCookie builder class.
+
+
NewCookie.Builder
+
+
JAX-RS NewCookie builder class.
+
+
NewCookie.SameSite
+
+
The available values for the SameSite cookie attribute.
+
+
NoContentException
+
+
An I/O exception thrown by MessageBodyReader implementations when reading a zero-length + message content to indicate that the message body reader is not able to produce an instance representing an + zero-length message content.
+
+
NotAcceptableException
+
+
A runtime exception indicating that a client request is not + acceptable by the server.
+
+
NotAllowedException
+
+
A runtime exception indicating a client requesting a resource method that is + not allowed.
+
+
NotAuthorizedException
+
+
A runtime exception indicating request authorization failure caused by one of the following scenarios: + + a client did not send the required authorization credentials to access the requested resource, i.e.
+
+
NotFoundException
+
+
A runtime exception indicating a resource requested by a client was not found on the server.
+
+
NotSupportedException
+
+
A runtime exception indicating that the client request entity media type is + not supported.
+
+
OPTIONS
+
+
Indicates that the annotated method responds to HTTP OPTIONS requests.
+
+
OutboundSseEvent
+
+
Representation of a single outbound Server-sent event.
+
+
OutboundSseEvent.Builder
+
+
A builder class used for creating OutboundSseEvent instances.
+
+
ParamConverter<T>
+
+
Defines a contract for a delegate responsible for converting between a String form of a message parameter + value and the corresponding custom Java type T.
+
+
ParamConverter.Lazy
+
+
Mandates that a conversion of any default value delegated to a parameter + converter annotated with @Lazy annotation SHOULD occur only once the value is actually required (e.g.
+
+
ParamConverterProvider
+
+
Contract for a provider of ParamConverter instances.
+
+
PATCH
+
+
Indicates that the annotated method responds to HTTP PATCH requests.
+
+
Path
+
+
Identifies the URI path that a resource class or class method will serve requests for.
+
+
PathParam
+
+
Binds the value of a URI template parameter or a path segment containing the template parameter to a resource method + parameter, resource class field, or resource class bean property.
+
+
PathSegment
+
+
Represents a URI path segment and any associated matrix parameters.
+
+
POST
+
+
Indicates that the annotated method responds to HTTP POST requests.
+
+
PreMatching
+
+
Global binding annotation that can be applied to a container request filter to + indicate that such filter should be applied globally on all resources in the application before the actual resource + matching occurs.
+
+
Priorities
+
+
A collection of built-in priority constants for the JAX-RS components that are supposed to be ordered based on their + jakarta.annotation.Priority class-level annotation value when used or applied by JAX-RS runtime.
+
+
ProcessingException
+
+
A base JAX-RS runtime processing exception.
+
+
Produces
+
+
Defines the media type(s) that the methods of a resource class or MessageBodyWriter can + produce.
+
+
Provider
+
+
Marks an implementation of an extension interface that should be discoverable by JAX-RS runtime during a provider + scanning phase.
+
+
Providers
+
+
An injectable interface providing runtime lookup of provider instances.
+
+
PUT
+
+
Indicates that the annotated method responds to HTTP PUT requests.
+
+
QueryParam
+
+
Binds the value(s) of a HTTP query parameter to a resource method parameter, resource class field, or resource class + bean property.
+
+
ReaderInterceptor
+
+
Interface for message body reader interceptors that wrap around calls to + MessageBodyReader.readFrom(java.lang.Class<T>, java.lang.reflect.Type, java.lang.annotation.Annotation[], jakarta.ws.rs.core.MediaType, jakarta.ws.rs.core.MultivaluedMap<java.lang.String, java.lang.String>, java.io.InputStream).
+
+
ReaderInterceptorContext
+
+
Context class used by ReaderInterceptor to intercept calls to (@link + jakarta.ws.rs.ext.MessageBodyReader#readFrom}.
+
+
RedirectionException
+
+
A runtime application exception indicating a request redirection (HTTP 3xx status codes).
+
+
Request
+
+
An injectable helper for request processing, all methods throw an IllegalStateException if called outside the + scope of a request (e.g.
+
+
ResourceContext
+
+
The resource context provides access to instances of resource classes.
+
+
ResourceInfo
+
+
An injectable class to access the resource class and resource method matched by the current request.
+
+
Response
+
+
Defines the contract between a returned instance and the runtime when an application needs to provide meta-data to + the runtime.
+
+
Response.ResponseBuilder
+
+
A class used to build Response instances that contain metadata instead of or in addition to an entity.
+
+
Response.Status
+
+
Commonly used status codes defined by HTTP, see + HTTP/1.1 documentation for the complete + list.
+
+
Response.Status.Family
+
+
An enumeration representing the class of status code.
+
+
Response.StatusType
+
+
Base interface for statuses used in responses.
+
+
ResponseProcessingException
+
+
JAX-RS client-side runtime processing exception thrown to indicate that response processing has failed (e.g.
+
+
RuntimeDelegate
+
+
Implementations of JAX-RS provide a concrete subclass of RuntimeDelegate and various JAX-RS API methods defer to + methods of RuntimeDelegate for their functionality.
+
+
RuntimeDelegate.HeaderDelegate<T>
+
+
Defines the contract for a delegate that is responsible for converting between the String form of a HTTP header and + the corresponding JAX-RS type T.
+
+
RuntimeType
+
+
Enumeration of JAX-RS runtime types.
+
+
RxInvoker<T>
+
+
Uniform interface for reactive invocation of HTTP methods.
+
+
RxInvokerProvider<T>
+
+
RxInvoker provider.
+
+
SeBootstrap
+
+
Bootstrap class used to startup a JAX-RS application in Java SE environments.
+
+
SeBootstrap.Configuration
+
+
Provides information needed by the JAX-RS implementation for bootstrapping an application.
+
+
SeBootstrap.Configuration.Builder
+
+
Builder for bootstrap SeBootstrap.Configuration.
+
+
SeBootstrap.Configuration.SSLClientAuthentication
+
+
Secure socket client authentication policy
+
+
SeBootstrap.Instance
+
+
Handle of the running application instance.
+
+
SeBootstrap.Instance.StopResult
+
+
Result of stopping the application instance.
+
+
SecurityContext
+
+
An injectable interface that provides access to security related information.
+
+
ServerErrorException
+
+
A base runtime application exception indicating a server error (HTTP 5xx status codes).
+
+
ServiceUnavailableException
+
+
A runtime exception indicating that the requested resource + cannot be served.
+
+
Sse
+
+
Server-side entry point for creating OutboundSseEvent and SseBroadcaster.
+
+
SseBroadcaster
+
+
Server-Sent events broadcasting facility.
+
+
SseEvent
+
+
Base Server Sent Event definition.
+
+
SseEventSink
+
+
Outbound Server-Sent Events stream.
+
+
SseEventSource
+
+
Client for reading and processing incoming Server-Sent Events.
+
+
SseEventSource.Builder
+
+
JAX-RS SseEventSource builder class.
+
+
StreamingOutput
+
+
A type that may be used as a resource method return value or as the entity in a Response when the application + wishes to stream the output.
+
+
Suspended
+
+
Inject a suspended AsyncResponse into a parameter of an invoked JAX-RS resource + or sub-resource method.
+
+
SyncInvoker
+
+
Uniform interface for synchronous invocation of HTTP methods.
+
+
TimeoutHandler
+
+
Asynchronous response suspend time-out handler.
+
+
UriBuilder
+
+
URI template-aware utility class for building URIs from their components.
+
+
UriBuilderException
+
+
A runtime exception thrown by UriBuilder.build(Object...) methods when a URI cannot be + constructed based on the current state of the builder.
+
+
UriInfo
+
+
An injectable interface that provides access to application and request URI information.
+
+
Variant
+
+
Abstraction for a resource representation variant.
+
+
Variant.VariantListBuilder
+
+
A builder for a list of representation variants.
+
+
WebApplicationException
+
+
Runtime exception for applications.
+
+
WebTarget
+
+
A resource target identified by the resource URI.
+
+
WriterInterceptor
+
+
Interface for message body writer interceptors that wrap around calls to + MessageBodyWriter.writeTo(T, java.lang.Class<?>, java.lang.reflect.Type, java.lang.annotation.Annotation[], jakarta.ws.rs.core.MediaType, jakarta.ws.rs.core.MultivaluedMap<java.lang.String, java.lang.Object>, java.io.OutputStream).
+
+
WriterInterceptorContext
+
+
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).
+
+
+
+
+
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/allpackages-index.html b/restful-ws/4.0/apidocs/allpackages-index.html new file mode 100644 index 0000000000..5ba4d60cbb --- /dev/null +++ b/restful-ws/4.0/apidocs/allpackages-index.html @@ -0,0 +1,92 @@ + + + + +All Packages (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

All Packages

+
+
Package Summary
+
+
Package
+
Description
+
jakarta.ws.rs
+
+
High-level interfaces and annotations used to create RESTful service resources.
+
+
jakarta.ws.rs.client
+
+
The JAX-RS client API
+
+
jakarta.ws.rs.container
+
+
Container-specific JAX-RS API.
+
+
jakarta.ws.rs.core
+
+
Low-level interfaces and annotations used to create RESTful service resources.
+
+
jakarta.ws.rs.ext
+
+
APIs that provide extensions to the types supported by the JAX-RS API.
+
+
jakarta.ws.rs.sse
+
+
Server-Sent Events related API.
+
+
+
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/constant-values.html b/restful-ws/4.0/apidocs/constant-values.html new file mode 100644 index 0000000000..d2662cfd47 --- /dev/null +++ b/restful-ws/4.0/apidocs/constant-values.html @@ -0,0 +1,448 @@ + + + + +Constant Field Values (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Constant Field Values

+
+
+

Contents

+ +
+
+

jakarta.ws.*

+ + +
    +
  • +
    jakarta.ws.rs.container.AsyncResponse
    +
    +
    Modifier and Type
    +
    Constant Field
    +
    Value
    +
    public static final long
    +
    NO_TIMEOUT
    +
    0L
    +
    +
    • +
+ + + +
+
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/copy.svg b/restful-ws/4.0/apidocs/copy.svg new file mode 100644 index 0000000000..7c46ab15fe --- /dev/null +++ b/restful-ws/4.0/apidocs/copy.svg @@ -0,0 +1,33 @@ + + + + + + + + diff --git a/restful-ws/4.0/apidocs/deprecated-list.html b/restful-ws/4.0/apidocs/deprecated-list.html new file mode 100644 index 0000000000..36cb79bfb2 --- /dev/null +++ b/restful-ws/4.0/apidocs/deprecated-list.html @@ -0,0 +1,245 @@ + + + + +Deprecated List (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Deprecated API

+
+

Contents

+ + + +
    +
  • +
    +
    Deprecated Methods
    +
    +
    Method
    +
    Description
    +
    jakarta.ws.rs.core.Application.getSingletons()
    +
    +
    Automatic discovery of resources and providers or the getClasses method is preferred over + getSingletons.
    +
    +
    jakarta.ws.rs.core.CacheControl.toString()
    +
    +
    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.
    +
    +
    jakarta.ws.rs.core.CacheControl.valueOf(String)
    +
    +
    This method will be removed in a future version. Please use + RuntimeDelegate.getInstance().createHeaderDelegate(CacheControl.class).fromString(value) instead.
    +
    +
    jakarta.ws.rs.core.Cookie.toString()
    +
    +
    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.
    +
    +
    jakarta.ws.rs.core.Cookie.valueOf(String)
    +
    +
    This method will be removed in a future version. Please use + RuntimeDelegate.getInstance().createHeaderDelegate(Cookie.class).fromString(value) instead.
    +
    +
    jakarta.ws.rs.core.EntityTag.toString()
    +
    +
    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.
    +
    +
    jakarta.ws.rs.core.EntityTag.valueOf(String)
    +
    +
    This method will be removed in a future version. Please use + RuntimeDelegate.getInstance().createHeaderDelegate(EntityTag.class).fromString(value) instead.
    +
    +
    jakarta.ws.rs.core.NewCookie.toString()
    +
    +
    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.
    +
    +
    jakarta.ws.rs.core.NewCookie.valueOf(String)
    +
    +
    This method will be removed in a future version. Please use + RuntimeDelegate.getInstance().createHeaderDelegate(NewCookie.class).fromString(value) instead.
    +
    +
    +
    +
    • +
+ + +
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/element-list b/restful-ws/4.0/apidocs/element-list new file mode 100644 index 0000000000..7c2e835936 --- /dev/null +++ b/restful-ws/4.0/apidocs/element-list @@ -0,0 +1,7 @@ +module:jakarta.ws.rs +jakarta.ws.rs +jakarta.ws.rs.client +jakarta.ws.rs.container +jakarta.ws.rs.core +jakarta.ws.rs.ext +jakarta.ws.rs.sse diff --git a/restful-ws/4.0/apidocs/help-doc.html b/restful-ws/4.0/apidocs/help-doc.html new file mode 100644 index 0000000000..838851b3b3 --- /dev/null +++ b/restful-ws/4.0/apidocs/help-doc.html @@ -0,0 +1,219 @@ + + + + +API Help (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+

JavaDoc Help

+ +
+
+

Navigation

+Starting from the Overview page, you can browse the documentation using the links in each page, and in the navigation bar at the top of each page. The Index and Search box allow you to navigate to specific declarations and summary pages, including: All Packages, All Classes and Interfaces + +
+
+
+

Kinds of Pages

+The following sections describe the different kinds of pages in this collection. +
+

Overview

+

The Overview page is the front page of this API document and provides a list of all modules with a summary for each. This page can also contain an overall description of the set of modules.

+
+
+

Module

+

Each module has a page that contains a list of its packages, dependencies on other modules, and services, with a summary for each. These pages may contain the following categories:

+
    +
  • Packages
    • +
  • Modules
    • +
  • Services
    • +
+
+
+

Package

+

Each package has a page that contains a list of its classes and interfaces, with a summary for each. These pages may contain the following categories:

+
    +
  • Interfaces
    • +
  • Classes
    • +
  • Enum Classes
    • +
  • Exception Classes
    • +
  • Annotation Interfaces
    • +
+
+
+

Class or Interface

+

Each class, interface, nested class and nested interface has its own separate page. Each of these pages has three sections consisting of a declaration and description, member summary tables, and detailed member descriptions. Entries in each of these sections are omitted if they are empty or not applicable.

+
    +
  • Class Inheritance Diagram
    • +
  • Direct Subclasses
    • +
  • All Known Subinterfaces
    • +
  • All Known Implementing Classes
    • +
  • Class or Interface Declaration
    • +
  • Class or Interface Description
    • +
+
+
    +
  • Nested Class Summary
    • +
  • Enum Constant Summary
    • +
  • Field Summary
    • +
  • Property Summary
    • +
  • Constructor Summary
    • +
  • Method Summary
    • +
  • Required Element Summary
    • +
  • Optional Element Summary
    • +
+
+
    +
  • Enum Constant Details
    • +
  • Field Details
    • +
  • Property Details
    • +
  • Constructor Details
    • +
  • Method Details
    • +
  • Element Details
    • +
+

Note: Annotation interfaces have required and optional elements, but not methods. Only enum classes have enum constants. The components of a record class are displayed as part of the declaration of the record class. Properties are a feature of JavaFX.

+

The summary entries are alphabetical, while the detailed descriptions are in the order they appear in the source code. This preserves the logical groupings established by the programmer.

+
+
+

Other Files

+

Packages and modules may contain pages with additional information related to the declarations nearby.

+
+
+

Use

+

Each documented package, class and interface has its own Use page. This page describes what packages, classes, methods, constructors and fields use any part of the given class or package. Given a class or interface A, its Use page includes subclasses of A, fields declared as A, methods that return A, and methods and constructors with parameters of type A. You can access this page by first going to the package, class or interface, then clicking on the USE link in the navigation bar.

+
+
+

Tree (Class Hierarchy)

+

There is a Class Hierarchy page for all packages, plus a hierarchy for each package. Each hierarchy page contains a list of classes and a list of interfaces. Classes are organized by inheritance structure starting with java.lang.Object. Interfaces do not inherit from java.lang.Object.

+
    +
  • When viewing the Overview page, clicking on TREE displays the hierarchy for all packages.
    • +
  • When viewing a particular package, class or interface page, clicking on TREE displays the hierarchy for only that package.
    • +
+
+
+

Deprecated API

+

The Deprecated API page lists all of the API that have been deprecated. A deprecated API is not recommended for use, generally due to shortcomings, and a replacement API is usually given. Deprecated APIs may be removed in future implementations.

+
+
+

Constant Field Values

+

The Constant Field Values page lists the static final fields and their values.

+
+
+

Serialized Form

+

Each serializable or externalizable class has a description of its serialization fields and methods. This information is of interest to those who implement rather than use the API. While there is no link in the navigation bar, you can get to this information by going to any serialized class and clicking "Serialized Form" in the "See Also" section of the class description.

+
+
+

All Packages

+

The All Packages page contains an alphabetic index of all packages contained in the documentation.

+
+
+

All Classes and Interfaces

+

The All Classes and Interfaces page contains an alphabetic index of all classes and interfaces contained in the documentation, including annotation interfaces, enum classes, and record classes.

+
+
+

Index

+

The Index contains an alphabetic index of all classes, interfaces, constructors, methods, and fields in the documentation, as well as summary pages such as All Packages, All Classes and Interfaces.

+
+
+
+This help file applies to API documentation generated by the standard doclet.
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/index-all.html b/restful-ws/4.0/apidocs/index-all.html new file mode 100644 index 0000000000..9845406bc3 --- /dev/null +++ b/restful-ws/4.0/apidocs/index-all.html @@ -0,0 +1,5865 @@ + + + + +Index (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

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
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/index.html b/restful-ws/4.0/apidocs/index.html new file mode 100644 index 0000000000..8875bd767e --- /dev/null +++ b/restful-ws/4.0/apidocs/index.html @@ -0,0 +1,149 @@ + + + + +Overview (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Jakarta RESTful Web Services 4.0 API Specification

+
+

Jakarta RESTful Web Services provides a foundational API to develop web services + following the Representational State Transfer (REST) architectural pattern. + This API is distributed under the Eclipse Foundation Specification License.

+ +

Web resources

+ +

JAX-RS core APIs enable developers to rapidly build Web applications in Java that are characteristic + of the best designed parts of the Web. The API brings in support for designing and implementing + Web resources and application that follow principles of + REST (Representational + State Transfer) architectural style to the Java Platform.

+ +

In JAX-RS, Java POJOs can be exposed as RESTful Web resources independent of the underlying technology + using a high level easy-to-use declarative annotation-based API. E.g.:

+ +
+@Path("widgets/{widgetid}")
+@Consumes("application/widgets+xml")
+@Produces("application/widgets+xml")
+public class WidgetResource {
+
+    @GET
+    public String getWidget(@PathParam("widgetid") String id) {
+        return getWidgetAsXml(id);
+    }
+
+    @PUT
+    public void updateWidget(@PathParam("widgetid") String id,
+                             Source update) {
+       updateWidgetFromXml(id, update);
+    }
+
+    ...
+}
+
+ +

Web resource clients

+ +

JAX-RS client API is a Java based API used to access resources on the Web. It is not restricted + to resources implemented using JAX-RS. It provides a higher-level abstraction compared to a + plain HTTP communication API as well as integration with the + JAX-RS extension providers, in order to enable concise and efficient implementation of + reusable client-side solutions that leverage existing and well + established client-side implementations of HTTP-based communication.

+ +

The JAX-RS Client API also encapsulates the Uniform Interface Constraint – + a key constraint of the REST architectural style – and associated data + elements as client-side Java artifacts and supports a pluggable architecture + by defining multiple extension points.

+ +

Following example demonstrates a simple JAX-RS client API usage scenario:

+ +
+    Client client = ClientBuilder.newClient();
+
+    client.property("MyProperty", "MyValue")
+          .register(MyProvider.class)
+          .enable(MyFeature.class);
+
+    Response res = client.target("http://example.org/hello").request("text/plain").get();
+    String message = res.readEntity(String.class);
+
+ +

Provider extensions

+ +

JAX-RS applications may provide custom extensions to the client and server runtime using the + common extension APIs defined in jakarta.ws.rs.ext + package, namely entity providers and entity provider interceptors. Additionally, request and + response processing chains on client as well as server side can be further customized by + implemening custom request and response filters - see the + ClientRequestFilter, + ClientResponseFilter, + ContainerRequestFilter, + ContainerResponseFilter + APIs.

+
+
Modules
+
+
Module
+
Description
+
jakarta.ws.rs
+
+
Defines the Jakarta RESTful Web Services API
+
+
+
+
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/ApplicationPath.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/ApplicationPath.html new file mode 100644 index 0000000000..02a5e63c6f --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/ApplicationPath.html @@ -0,0 +1,174 @@ + + + + +ApplicationPath (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Module jakarta.ws.rs
+
Package jakarta.ws.rs
+

Annotation Interface ApplicationPath

+
+
+
+
@Documented +@Target(TYPE) +@Retention(RUNTIME) +public @interface ApplicationPath
+
Identifies the application path that serves as the base URI for all resource URIs provided by + Path. May only be applied to a subclass of Application. + +

+ When published in a Servlet container, the value of the application path may be overridden using a servlet-mapping + element in the web.xml. +

+
+
Since:
+
1.1
+
Author:
+
Paul Sandoz, Marc Hadley
+
See Also:
+
+ +
+
+
+
+
    + +
  • +
    +

    Required Element Summary

    +
    Required Elements
    +
    +
    Modifier and Type
    +
    Required Element
    +
    Description
    +
    String
    +
    value
    +
    +
    Defines the base URI for all resource URIs.
    +
    +
    +
    +
    • +
+
+
+
    + +
  • +
    +

    Element Details

    +
      +
    • +
      +

      value

      +
      String value
      +
      Defines the base URI for all resource URIs. A trailing '/' character will be automatically appended if one is not + present. + +

      + The supplied value is automatically percent encoded to conform to the path production of + RFC 3986 section 3.3. Note that percent encoded values + are allowed in the value, an implementation will recognize such values and will not double encode the '%' character. +

      +
      +
      Returns:
      +
      base URI.
      +
      +
      +
      • +
    +
    +
    • +
+
+ +
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/BadRequestException.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/BadRequestException.html new file mode 100644 index 0000000000..5fc890473b --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/BadRequestException.html @@ -0,0 +1,316 @@ + + + + +BadRequestException (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Module jakarta.ws.rs
+
Package jakarta.ws.rs
+

Class BadRequestException

+
+
java.lang.Object +
java.lang.Throwable +
java.lang.Exception +
java.lang.RuntimeException +
jakarta.ws.rs.WebApplicationException +
jakarta.ws.rs.ClientErrorException +
jakarta.ws.rs.BadRequestException
+
+
+
+
+
+
+
+
+
All Implemented Interfaces:
+
Serializable
+
+
+
public class BadRequestException +extends ClientErrorException
+
A runtime exception indicating a bad client request.
+
+
Since:
+
2.0
+
Author:
+
Sergey Beryozkin, Marek Potociar
+
See Also:
+
+ +
+
+
+
+ +
+
+
    + +
  • +
    +

    Constructor Details

    +
      +
    • +
      +

      BadRequestException

      +
      public BadRequestException()
      +
      Construct a new bad client request exception.
      +
      +
      • +
    • +
      +

      BadRequestException

      +
      public BadRequestException(String message)
      +
      Construct a new bad client request exception.
      +
      +
      Parameters:
      +
      message - the detail message (which is saved for later retrieval by the Throwable.getMessage() method).
      +
      +
      +
      • +
    • +
      +

      BadRequestException

      +
      public BadRequestException(Response response)
      +
      Construct a new bad client request exception.
      +
      +
      Parameters:
      +
      response - error response.
      +
      Throws:
      +
      IllegalArgumentException - in case the status code set in the response is not HTTP 400.
      +
      +
      +
      • +
    • +
      +

      BadRequestException

      +
      public BadRequestException(String message, + Response response)
      +
      Construct a new bad client request exception.
      +
      +
      Parameters:
      +
      message - the detail message (which is saved for later retrieval by the Throwable.getMessage() method).
      +
      response - error response.
      +
      Throws:
      +
      IllegalArgumentException - in case the status code set in the response is not HTTP 400.
      +
      +
      +
      • +
    • +
      +

      BadRequestException

      +
      public BadRequestException(Throwable cause)
      +
      Construct a new bad client request exception.
      +
      +
      Parameters:
      +
      cause - the underlying cause of the exception.
      +
      +
      +
      • +
    • +
      +

      BadRequestException

      +
      public BadRequestException(String message, + Throwable cause)
      +
      Construct a new bad client request exception.
      +
      +
      Parameters:
      +
      message - the detail message (which is saved for later retrieval by the Throwable.getMessage() method).
      +
      cause - the underlying cause of the exception.
      +
      +
      +
      • +
    • +
      +

      BadRequestException

      +
      public BadRequestException(Response response, + Throwable cause)
      +
      Construct a new bad client request exception.
      +
      +
      Parameters:
      +
      response - error response.
      +
      cause - the underlying cause of the exception.
      +
      Throws:
      +
      IllegalArgumentException - in case the status code set in the response is not HTTP 400.
      +
      +
      +
      • +
    • +
      +

      BadRequestException

      +
      public BadRequestException(String message, + Response response, + Throwable cause)
      +
      Construct a new bad client request exception.
      +
      +
      Parameters:
      +
      message - the detail message (which is saved for later retrieval by the Throwable.getMessage() method).
      +
      response - error response.
      +
      cause - the underlying cause of the exception.
      +
      Throws:
      +
      IllegalArgumentException - in case the status code set in the response is not HTTP 400.
      +
      +
      +
      • +
    +
    +
    • +
+
+ +
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/BeanParam.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/BeanParam.html new file mode 100644 index 0000000000..dd61ceb4ef --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/BeanParam.html @@ -0,0 +1,148 @@ + + + + +BeanParam (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Module jakarta.ws.rs
+
Package jakarta.ws.rs
+

Annotation Interface BeanParam

+
+
+
+
@Target({PARAMETER,METHOD,FIELD}) +@Retention(RUNTIME) +@Documented +public @interface BeanParam
+
The annotation that may be used to inject custom JAX-RS "parameter aggregator" value object into a resource class + field, property or resource method parameter. +

+ The JAX-RS runtime will instantiate the object and inject all it's fields and properties annotated with either one of + the @XxxParam annotation (@PathParam, @FormParam ...) or the + @Context annotation. For the POJO classes same instantiation and injection rules + apply as in case of instantiation and injection of request-scoped root resource classes. +

+ For example: + + 
+ public class MyBean {
+   @FormParam("myData")
+   private String data;
+
+   @HeaderParam("myHeader")
+   private String header;
+
+   @PathParam("id")
+   public void setResourceId(String id) {...}
+
+   ...
+ }
+
+ @Path("myresources")
+ public class MyResources {
+   @POST
+   @Path("{id}")
+   public void post(@BeanParam MyBean myBean) {...}
+
+   ...
+ }
+
+

+ Because injection occurs at object creation time, use of this annotation on resource class fields and bean properties + is only supported for the default per-request resource class lifecycle. Resource classes using other lifecycles + should only use this annotation on resource method parameters. +

+
+
Since:
+
2.0
+
Author:
+
Marek Potociar
+
+
+
+ +
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/ClientErrorException.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/ClientErrorException.html new file mode 100644 index 0000000000..c12fe69ef4 --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/ClientErrorException.html @@ -0,0 +1,431 @@ + + + + +ClientErrorException (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Module jakarta.ws.rs
+
Package jakarta.ws.rs
+

Class ClientErrorException

+
+
java.lang.Object +
java.lang.Throwable +
java.lang.Exception +
java.lang.RuntimeException +
jakarta.ws.rs.WebApplicationException +
jakarta.ws.rs.ClientErrorException
+
+
+
+
+
+
+
+
All Implemented Interfaces:
+
Serializable
+
+
+
Direct Known Subclasses:
+
BadRequestException, ForbiddenException, NotAcceptableException, NotAllowedException, NotAuthorizedException, NotFoundException, NotSupportedException
+
+
+
public class ClientErrorException +extends WebApplicationException
+
A base runtime application exception indicating a client request error (HTTP 4xx status codes).
+
+
Since:
+
2.0
+
Author:
+
Marek Potociar
+
See Also:
+
+ +
+
+
+
+ +
+
+
    + +
  • +
    +

    Constructor Details

    +
      +
    • +
      +

      ClientErrorException

      +
      public ClientErrorException(Response.Status status)
      +
      Construct a new client error exception.
      +
      +
      Parameters:
      +
      status - client error status. Must be a 4xx status code.
      +
      Throws:
      +
      IllegalArgumentException - in case the status code is null or is not from + Response.Status.Family.CLIENT_ERROR status code family.
      +
      +
      +
      • +
    • +
      +

      ClientErrorException

      +
      public ClientErrorException(String message, + Response.Status status)
      +
      Construct a new client error exception.
      +
      +
      Parameters:
      +
      message - the detail message (which is saved for later retrieval by the Throwable.getMessage() method).
      +
      status - client error status. Must be a 4xx status code.
      +
      Throws:
      +
      IllegalArgumentException - in case the status code is null or is not from + Response.Status.Family.CLIENT_ERROR status code family.
      +
      +
      +
      • +
    • +
      +

      ClientErrorException

      +
      public ClientErrorException(int status)
      +
      Construct a new client error exception.
      +
      +
      Parameters:
      +
      status - client error status. Must be a 4xx status code.
      +
      Throws:
      +
      IllegalArgumentException - in case the status code is not a valid HTTP status code or if it is not from the + Response.Status.Family.CLIENT_ERROR status code family.
      +
      +
      +
      • +
    • +
      +

      ClientErrorException

      +
      public ClientErrorException(String message, + int status)
      +
      Construct a new client error exception.
      +
      +
      Parameters:
      +
      message - the detail message (which is saved for later retrieval by the Throwable.getMessage() method).
      +
      status - client error status. Must be a 4xx status code.
      +
      Throws:
      +
      IllegalArgumentException - in case the status code is not a valid HTTP status code or if it is not from the + Response.Status.Family.CLIENT_ERROR status code family.
      +
      +
      +
      • +
    • +
      +

      ClientErrorException

      +
      public ClientErrorException(Response response)
      +
      Construct a new client error exception.
      +
      +
      Parameters:
      +
      response - client error response. Must have a status code set to a 4xx status code.
      +
      Throws:
      +
      IllegalArgumentException - in case the response status code is not from the + Response.Status.Family.CLIENT_ERROR status code family.
      +
      +
      +
      • +
    • +
      +

      ClientErrorException

      +
      public ClientErrorException(String message, + Response response)
      +
      Construct a new client error exception.
      +
      +
      Parameters:
      +
      message - the detail message (which is saved for later retrieval by the Throwable.getMessage() method).
      +
      response - client error response. Must have a status code set to a 4xx status code.
      +
      Throws:
      +
      IllegalArgumentException - in case the response status code is not from the + Response.Status.Family.CLIENT_ERROR status code family.
      +
      +
      +
      • +
    • +
      +

      ClientErrorException

      +
      public ClientErrorException(Response.Status status, + Throwable cause)
      +
      Construct a new client error exception.
      +
      +
      Parameters:
      +
      status - client error status. Must be a 4xx status code.
      +
      cause - the underlying cause of the exception.
      +
      Throws:
      +
      IllegalArgumentException - in case the status code is null or is not from + Response.Status.Family.CLIENT_ERROR status code family.
      +
      +
      +
      • +
    • +
      +

      ClientErrorException

      +
      public ClientErrorException(String message, + Response.Status status, + Throwable cause)
      +
      Construct a new client error exception.
      +
      +
      Parameters:
      +
      message - the detail message (which is saved for later retrieval by the Throwable.getMessage() method).
      +
      status - client error status. Must be a 4xx status code.
      +
      cause - the underlying cause of the exception.
      +
      Throws:
      +
      IllegalArgumentException - in case the status code is null or is not from + Response.Status.Family.CLIENT_ERROR status code family.
      +
      +
      +
      • +
    • +
      +

      ClientErrorException

      +
      public ClientErrorException(int status, + Throwable cause)
      +
      Construct a new client error exception.
      +
      +
      Parameters:
      +
      status - client error status. Must be a 4xx status code.
      +
      cause - the underlying cause of the exception.
      +
      Throws:
      +
      IllegalArgumentException - in case the status code is not a valid HTTP status code or if it is not from the + Response.Status.Family.CLIENT_ERROR status code family.
      +
      +
      +
      • +
    • +
      +

      ClientErrorException

      +
      public ClientErrorException(String message, + int status, + Throwable cause)
      +
      Construct a new client error exception.
      +
      +
      Parameters:
      +
      message - the detail message (which is saved for later retrieval by the Throwable.getMessage() method).
      +
      status - client error status. Must be a 4xx status code.
      +
      cause - the underlying cause of the exception.
      +
      Throws:
      +
      IllegalArgumentException - in case the status code is not a valid HTTP status code or if it is not from the + Response.Status.Family.CLIENT_ERROR status code family.
      +
      +
      +
      • +
    • +
      +

      ClientErrorException

      +
      public ClientErrorException(Response response, + Throwable cause)
      +
      Construct a new client error exception.
      +
      +
      Parameters:
      +
      response - client error response. Must have a status code set to a 4xx status code.
      +
      cause - the underlying cause of the exception.
      +
      Throws:
      +
      IllegalArgumentException - in case the response status code is not from the + Response.Status.Family.CLIENT_ERROR status code family.
      +
      +
      +
      • +
    • +
      +

      ClientErrorException

      +
      public ClientErrorException(String message, + Response response, + Throwable cause)
      +
      Construct a new client error exception.
      +
      +
      Parameters:
      +
      message - the detail message (which is saved for later retrieval by the Throwable.getMessage() method).
      +
      response - client error response. Must have a status code set to a 4xx status code.
      +
      cause - the underlying cause of the exception.
      +
      Throws:
      +
      IllegalArgumentException - in case the response status code is not from the + Response.Status.Family.CLIENT_ERROR status code family.
      +
      +
      +
      • +
    +
    +
    • +
+
+ +
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/ConstrainedTo.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/ConstrainedTo.html new file mode 100644 index 0000000000..27e96d7ee6 --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/ConstrainedTo.html @@ -0,0 +1,195 @@ + + + + +ConstrainedTo (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Module jakarta.ws.rs
+
Package jakarta.ws.rs
+

Annotation Interface ConstrainedTo

+
+
+
+
@Target(TYPE) +@Retention(RUNTIME) +@Documented +public @interface ConstrainedTo
+
Indicates the run-time context in which an annotated JAX-RS provider is applicable. If a @ConstrainedTo + annotation is not present on a JAX-RS provider type declaration, the declared provider may be used in any run-time + context. If such a annotation is present, the JAX-RS runtime will enforce the specified usage restriction. +

+ The following example illustrates restricting a MessageBodyReader provider implementation to + run only as part of a JAX-RS client run-time: +

+ + 
+  @ConstrainedTo(RuntimeType.CLIENT)
+  public class MyReader implements MessageBodyReader {
+      ...
+  }
+
+

+ The following example illustrates restricting a WriterInterceptor provider implementation to + run only as part of a JAX-RS server run-time: +

+ + 
+  @ConstrainedTo(RuntimeType.SERVER)
+  public class MyWriterInterceptor implements WriterInterceptor {
+      ...
+  }
+
+

+ It is a configuration error to constraint a JAX-RS provider implementation to a run-time context in which the + provider cannot be applied. In such case a JAX-RS runtime SHOULD inform a user about the issue and ignore the + provider implementation in further processing. +

+

+ For example, the following restriction of a ClientRequestFilter to run only as part of a + JAX-RS server run-time would be considered invalid: +

+ + 
+  // reported as invalid and ignored by JAX-RS runtime
+  @ConstrainedTo(RuntimeType.SERVER)
+  public class MyFilter implements ClientRequestFilter {
+      ...
+  }
+
+
+
Since:
+
2.0
+
Author:
+
Marek Potociar
+
+
+
+
    + +
  • +
    +

    Required Element Summary

    +
    Required Elements
    +
    +
    Modifier and Type
    +
    Required Element
    +
    Description
    +
    RuntimeType
    +
    value
    +
    +
    Define the constraint type to be placed on a JAX-RS provider.
    +
    +
    +
    +
    • +
+
+
+
    + +
  • +
    +

    Element Details

    +
      +
    • +
      +

      value

      +
      RuntimeType value
      +
      Define the constraint type to be placed on a JAX-RS provider.
      +
      +
      Returns:
      +
      applicable run-time context.
      +
      +
      +
      • +
    +
    +
    • +
+
+ +
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/Consumes.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/Consumes.html new file mode 100644 index 0000000000..33ad49ea87 --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/Consumes.html @@ -0,0 +1,176 @@ + + + + +Consumes (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Module jakarta.ws.rs
+
Package jakarta.ws.rs
+

Annotation Interface Consumes

+
+
+
+
@Inherited +@Target({TYPE,METHOD}) +@Retention(RUNTIME) +@Documented +public @interface Consumes
+
Defines the media types that the methods of a resource class or MessageBodyReader can accept. + If not specified, a container will assume that any media type is acceptable. Method level annotations override a + class level annotation. A container is responsible for ensuring that the method invoked is capable of consuming the + media type of the HTTP request entity body. If no such method is available the container must respond with a HTTP + "415 Unsupported Media Type" as specified by RFC 2616.
+
+
Since:
+
1.0
+
Author:
+
Paul Sandoz, Marc Hadley
+
See Also:
+
+ +
+
+
+
+
    + +
  • +
    +

    Optional Element Summary

    +
    Optional Elements
    +
    +
    Modifier and Type
    +
    Optional Element
    +
    Description
    +
    String[]
    +
    value
    +
    +
    A list of media types.
    +
    +
    +
    +
    • +
+
+
+
    + +
  • +
    +

    Element Details

    +
      +
    • +
      +

      value

      +
      String[] value
      +
      A list of media types. Each entry may specify a single type or consist of a comma separated list of types, with any + leading or trailing white-spaces in a single type entry being ignored. For example: + + 
      + { "image/jpeg, image/gif ", " image/png" }
+
      + + Use of the comma-separated form allows definition of a common string constant for use on multiple targets.
      +
      +
      Returns:
      +
      media types to accept.
      +
      +
      +
      Default:
      +
      {"*/*"}
      +
      +
      +
      • +
    +
    +
    • +
+
+ +
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/CookieParam.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/CookieParam.html new file mode 100644 index 0000000000..2531a60165 --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/CookieParam.html @@ -0,0 +1,184 @@ + + + + +CookieParam (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Module jakarta.ws.rs
+
Package jakarta.ws.rs
+

Annotation Interface CookieParam

+
+
+
+
@Target({PARAMETER,METHOD,FIELD}) +@Retention(RUNTIME) +@Documented +public @interface CookieParam
+
Binds the value of a HTTP cookie to a resource method parameter, resource class field, or resource class bean + property. A default value can be specified using the DefaultValue annotation. + + The type T of the annotated parameter, field or property must either: +
    +
  1. Be a primitive type
    2. +
  2. Be Cookie
    3. +
  3. Have a constructor that accepts a single String argument
    4. +
  4. Have a static method named valueOf or fromString that accepts a single String argument (see, for + example, Integer.valueOf(String))
    5. +
  5. Have a registered implementation of ParamConverterProvider JAX-RS extension SPI that + returns a ParamConverter instance capable of a "from string" conversion for the type.
    6. +
  6. Be List<T>, Set<T>, SortedSet<T> or T[] array, where T satisfies 2, 3, 4 + or 5 above. The resulting collection is read-only.
    7. +
+ +

+ Because injection occurs at object creation time, use of this annotation on resource class fields and bean properties + is only supported for the default per-request resource class lifecycle. Resource classes using other lifecycles + should only use this annotation on resource method parameters. +

+
+
Since:
+
1.0
+
Author:
+
Paul Sandoz, Marc Hadley
+
See Also:
+
+ +
+
+
+
+
    + +
  • +
    +

    Required Element Summary

    +
    Required Elements
    +
    +
    Modifier and Type
    +
    Required Element
    +
    Description
    +
    String
    +
    value
    +
    +
    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.
    +
    +
    +
    +
    • +
+
+
+
    + +
  • +
    +

    Element Details

    +
      +
    • +
      +

      value

      +
      String value
      +
      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.
      +
      +
      Returns:
      +
      HTTP cookie name.
      +
      +
      +
      • +
    +
    +
    • +
+
+ +
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/DELETE.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/DELETE.html new file mode 100644 index 0000000000..952e57fb3f --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/DELETE.html @@ -0,0 +1,118 @@ + + + + +DELETE (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Module jakarta.ws.rs
+
Package jakarta.ws.rs
+

Annotation Interface DELETE

+
+
+
+
@Target(METHOD) +@Retention(RUNTIME) +@HttpMethod("DELETE") +@Documented +public @interface DELETE
+
Indicates that the annotated method responds to HTTP DELETE requests.
+
+
Since:
+
1.0
+
Author:
+
Paul Sandoz, Marc Hadley
+
See Also:
+
+ +
+
+
+
+ +
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/DefaultValue.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/DefaultValue.html new file mode 100644 index 0000000000..00e92c2cce --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/DefaultValue.html @@ -0,0 +1,178 @@ + + + + +DefaultValue (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Module jakarta.ws.rs
+
Package jakarta.ws.rs
+

Annotation Interface DefaultValue

+
+
+
+
@Target({PARAMETER,METHOD,FIELD}) +@Retention(RUNTIME) +@Documented +public @interface DefaultValue
+
Defines the default value of request meta-data that is bound using one of the following annotations: + PathParam, QueryParam, MatrixParam, + CookieParam, FormParam, or HeaderParam. The default value + is used if the corresponding meta-data is not present in the request. +

+ If the type of the annotated parameter is List, Set or + SortedSet then the resulting collection will have a single entry mapped from the supplied default + value. +

+

+ If this annotation is not used and the corresponding meta-data is not present in the request, the value will be an + empty collection for List, Set or SortedSet, null for other object types, and the + Java-defined default for primitive types. +

+
+
Since:
+
1.0
+
Author:
+
Paul Sandoz, Marc Hadley
+
See Also:
+
+ +
+
+
+
+
    + +
  • +
    +

    Required Element Summary

    +
    Required Elements
    +
    +
    Modifier and Type
    +
    Required Element
    +
    Description
    +
    String
    +
    value
    +
    +
    The specified default value.
    +
    +
    +
    +
    • +
+
+
+
    + +
  • +
    +

    Element Details

    +
      +
    • +
      +

      value

      +
      String value
      +
      The specified default value.
      +
      +
      Returns:
      +
      default value.
      +
      +
      +
      • +
    +
    +
    • +
+
+ +
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/Encoded.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/Encoded.html new file mode 100644 index 0000000000..47a10a8085 --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/Encoded.html @@ -0,0 +1,122 @@ + + + + +Encoded (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Module jakarta.ws.rs
+
Package jakarta.ws.rs
+

Annotation Interface Encoded

+
+
+
+
@Target({PARAMETER,METHOD,FIELD,CONSTRUCTOR,TYPE}) +@Retention(RUNTIME) +@Documented +public @interface Encoded
+
Disables automatic decoding of parameter values bound using QueryParam, PathParam, FormParam + or MatrixParam. Using this annotation on a method will disable decoding for all parameters. Using this + annotation on a class will disable decoding for all parameters of all methods.
+
+
Since:
+
1.0
+
Author:
+
Paul Sandoz, Marc Hadley
+
See Also:
+
+ +
+
+
+
+ +
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/ForbiddenException.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/ForbiddenException.html new file mode 100644 index 0000000000..a04d9a3bb4 --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/ForbiddenException.html @@ -0,0 +1,317 @@ + + + + +ForbiddenException (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Module jakarta.ws.rs
+
Package jakarta.ws.rs
+

Class ForbiddenException

+
+
java.lang.Object +
java.lang.Throwable +
java.lang.Exception +
java.lang.RuntimeException +
jakarta.ws.rs.WebApplicationException +
jakarta.ws.rs.ClientErrorException +
jakarta.ws.rs.ForbiddenException
+
+
+
+
+
+
+
+
+
All Implemented Interfaces:
+
Serializable
+
+
+
public class ForbiddenException +extends ClientErrorException
+
A runtime exception indicating that an access to a resource requested by a client has been + forbidden by the server.
+
+
Since:
+
2.0
+
Author:
+
Marek Potociar
+
See Also:
+
+ +
+
+
+
+ +
+
+
    + +
  • +
    +

    Constructor Details

    +
      +
    • +
      +

      ForbiddenException

      +
      public ForbiddenException()
      +
      Construct a new "forbidden" exception.
      +
      +
      • +
    • +
      +

      ForbiddenException

      +
      public ForbiddenException(String message)
      +
      Construct a new "forbidden" exception.
      +
      +
      Parameters:
      +
      message - the detail message (which is saved for later retrieval by the Throwable.getMessage() method).
      +
      +
      +
      • +
    • +
      +

      ForbiddenException

      +
      public ForbiddenException(Response response)
      +
      Construct a new "forbidden" exception.
      +
      +
      Parameters:
      +
      response - error response.
      +
      Throws:
      +
      IllegalArgumentException - in case the status code set in the response is not HTTP 403.
      +
      +
      +
      • +
    • +
      +

      ForbiddenException

      +
      public ForbiddenException(String message, + Response response)
      +
      Construct a new "forbidden" exception.
      +
      +
      Parameters:
      +
      message - the detail message (which is saved for later retrieval by the Throwable.getMessage() method).
      +
      response - error response.
      +
      Throws:
      +
      IllegalArgumentException - in case the status code set in the response is not HTTP 403.
      +
      +
      +
      • +
    • +
      +

      ForbiddenException

      +
      public ForbiddenException(Throwable cause)
      +
      Construct a new "forbidden" exception.
      +
      +
      Parameters:
      +
      cause - the underlying cause of the exception.
      +
      +
      +
      • +
    • +
      +

      ForbiddenException

      +
      public ForbiddenException(String message, + Throwable cause)
      +
      Construct a new "forbidden" exception.
      +
      +
      Parameters:
      +
      message - the detail message (which is saved for later retrieval by the Throwable.getMessage() method).
      +
      cause - the underlying cause of the exception.
      +
      +
      +
      • +
    • +
      +

      ForbiddenException

      +
      public ForbiddenException(Response response, + Throwable cause)
      +
      Construct a new "forbidden" exception.
      +
      +
      Parameters:
      +
      response - error response.
      +
      cause - the underlying cause of the exception.
      +
      Throws:
      +
      IllegalArgumentException - in case the status code set in the response is not HTTP 403.
      +
      +
      +
      • +
    • +
      +

      ForbiddenException

      +
      public ForbiddenException(String message, + Response response, + Throwable cause)
      +
      Construct a new "forbidden" exception.
      +
      +
      Parameters:
      +
      message - the detail message (which is saved for later retrieval by the Throwable.getMessage() method).
      +
      response - error response.
      +
      cause - the underlying cause of the exception.
      +
      Throws:
      +
      IllegalArgumentException - in case the status code set in the response is not HTTP 403.
      +
      +
      +
      • +
    +
    +
    • +
+
+ +
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/FormParam.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/FormParam.html new file mode 100644 index 0000000000..ec4627b052 --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/FormParam.html @@ -0,0 +1,197 @@ + + + + +FormParam (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Module jakarta.ws.rs
+
Package jakarta.ws.rs
+

Annotation Interface FormParam

+
+
+
+
@Target({PARAMETER,METHOD,FIELD}) +@Retention(RUNTIME) +@Documented +public @interface FormParam
+
Binds the value(s) of a form parameter contained within a request entity body to a resource method parameter. Values + are URL decoded unless this is disabled using the Encoded annotation. A default value can be specified using + the DefaultValue annotation. If the request entity body is absent or is an unsupported media type, the + default value is used. + + The type T of the annotated parameter must either: +
    +
  1. Be a primitive type
    2. +
  2. Have a constructor that accepts a single String argument
    3. +
  3. Have a static method named valueOf or fromString that accepts a single String argument + (see, for example, Integer.valueOf(String))
    4. +
  4. Have a registered implementation of ParamConverterProvider JAX-RS extension SPI that + returns a ParamConverter instance capable of a "from string" conversion for the type.
    5. +
  5. Be List<T>, Set<T>, SortedSet<T> or T[] array, where T satisfies 2, 3 or + 4 above. The resulting collection is read-only.
    6. +
+ +

+ If the type is not one of the collection types listed in 5 above and the form parameter is represented by multiple + values then the first value (lexically) of the parameter is used. +

+ +

+ If this annotation is used to bind form parameters, a JAX-RS implementation MUST use the entity provider API + to create a Form and derive the values from this instance. If there is at least one + FormParam for a resource method, JAX-RS implementations MUST support a Form + entity parameter for the same method. Support for other entity parameter types is OPTIONAL. +

+ +

+ Note that, whilst the annotation target permits use on fields and methods, this annotation is only required to be + supported on resource method parameters. +

+
+
Since:
+
1.0
+
Author:
+
Paul Sandoz, Marc Hadley
+
See Also:
+
+ +
+
+
+
+
    + +
  • +
    +

    Required Element Summary

    +
    Required Elements
    +
    +
    Modifier and Type
    +
    Required Element
    +
    Description
    +
    String
    +
    value
    +
    +
    Defines the name of the form parameter whose value will be used to initialize the value of the annotated method + argument.
    +
    +
    +
    +
    • +
+
+
+
    + +
  • +
    +

    Element Details

    +
      +
    • +
      +

      value

      +
      String value
      +
      Defines the name of the form parameter whose value will be used to initialize the value of the annotated method + argument. The name is specified in decoded form, any percent encoded literals within the value will not be decoded + and will instead be treated as literal text. E.g. if the parameter name is "a b" then the value of the annotation is + "a b", not "a+b" or "a%20b".
      +
      +
      Returns:
      +
      form parameter name.
      +
      +
      +
      • +
    +
    +
    • +
+
+ +
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/GET.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/GET.html new file mode 100644 index 0000000000..6a73f096b2 --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/GET.html @@ -0,0 +1,118 @@ + + + + +GET (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Module jakarta.ws.rs
+
Package jakarta.ws.rs
+

Annotation Interface GET

+
+
+
+
@Target(METHOD) +@Retention(RUNTIME) +@HttpMethod("GET") +@Documented +public @interface GET
+
Indicates that the annotated method responds to HTTP GET requests.
+
+
Since:
+
1.0
+
Author:
+
Paul Sandoz, Marc Hadley
+
See Also:
+
+ +
+
+
+
+ +
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/HEAD.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/HEAD.html new file mode 100644 index 0000000000..fcda3f6ebb --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/HEAD.html @@ -0,0 +1,118 @@ + + + + +HEAD (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Module jakarta.ws.rs
+
Package jakarta.ws.rs
+

Annotation Interface HEAD

+
+
+
+
@Target(METHOD) +@Retention(RUNTIME) +@HttpMethod("HEAD") +@Documented +public @interface HEAD
+
Indicates that the annotated method responds to HTTP HEAD requests.
+
+
Since:
+
1.0
+
Author:
+
Paul Sandoz, Marc Hadley
+
See Also:
+
+ +
+
+
+
+ +
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/HeaderParam.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/HeaderParam.html new file mode 100644 index 0000000000..8ceafce9b0 --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/HeaderParam.html @@ -0,0 +1,187 @@ + + + + +HeaderParam (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Module jakarta.ws.rs
+
Package jakarta.ws.rs
+

Annotation Interface HeaderParam

+
+
+
+
@Target({PARAMETER,METHOD,FIELD}) +@Retention(RUNTIME) +@Documented +public @interface HeaderParam
+
Binds the value(s) of a HTTP header to a resource method parameter, resource class field, or resource class bean + property. A default value can be specified using the DefaultValue annotation. + + The type T of the annotated parameter, field or property must either: +
    +
  1. Be a primitive type
    2. +
  2. Have a constructor that accepts a single String argument
    3. +
  3. Have a static method named valueOf or fromString that accepts a single String argument + (see, for example, Integer.valueOf(String))
    4. +
  4. Have a registered implementation of ParamConverterProvider JAX-RS extension SPI that + returns a ParamConverter instance capable of a "from string" conversion for the type.
    5. +
  5. Be List<T>, Set<T>, SortedSet<T> or T[] array, where T satisfies 2, 3 or + 4 above. The resulting collection is read-only.
    6. +
+ +

+ If the type is not one of the collection types listed in 5 above and the header parameter is represented by multiple + values then the first value (lexically) of the parameter is used. +

+ +

+ Because injection occurs at object creation time, use of this annotation on resource class fields and bean properties + is only supported for the default per-request resource class lifecycle. Resource classes using other lifecycles + should only use this annotation on resource method parameters. +

+
+
Since:
+
1.0
+
Author:
+
Paul Sandoz, Marc Hadley
+
See Also:
+
+ +
+
+
+
+
    + +
  • +
    +

    Required Element Summary

    +
    Required Elements
    +
    +
    Modifier and Type
    +
    Required Element
    +
    Description
    +
    String
    +
    value
    +
    +
    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.
    +
    +
    +
    +
    • +
+
+
+
    + +
  • +
    +

    Element Details

    +
      +
    • +
      +

      value

      +
      String value
      +
      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. Case insensitive.
      +
      +
      Returns:
      +
      HTTP header name.
      +
      +
      +
      • +
    +
    +
    • +
+
+ +
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/HttpMethod.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/HttpMethod.html new file mode 100644 index 0000000000..cfa8796281 --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/HttpMethod.html @@ -0,0 +1,330 @@ + + + + +HttpMethod (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Module jakarta.ws.rs
+
Package jakarta.ws.rs
+

Annotation Interface HttpMethod

+
+
+
+
@Target(ANNOTATION_TYPE) +@Retention(RUNTIME) +@Documented +public @interface HttpMethod
+
Associates the name of a HTTP method with an annotation. A Java method annotated with a runtime annotation that is + itself annotated with this annotation will be used to handle HTTP requests of the indicated HTTP method. It is an + error for a method to be annotated with more than one annotation that is annotated with HttpMethod.
+
+
Since:
+
1.0
+
Author:
+
Paul Sandoz, Marc Hadley
+
See Also:
+
+ +
+
+
+
+
    + +
  • +
    +

    Required Element Summary

    +
    Required Elements
    +
    +
    Modifier and Type
    +
    Required Element
    +
    Description
    +
    String
    +
    value
    +
    +
    Specifies the name of a HTTP method.
    +
    +
    +
    +
    • + +
  • +
    +

    Field Summary

    +
    Fields
    +
    +
    Modifier and Type
    +
    Field
    +
    Description
    +
    static final String
    +
    DELETE
    +
    +
    HTTP DELETE method.
    +
    +
    static final String
    +
    GET
    +
    +
    HTTP GET method.
    +
    +
    static final String
    +
    HEAD
    +
    +
    HTTP HEAD method.
    +
    +
    static final String
    +
    OPTIONS
    +
    +
    HTTP OPTIONS method.
    +
    +
    static final String
    +
    PATCH
    +
    +
    HTTP PATCH method.
    +
    +
    static final String
    +
    POST
    +
    +
    HTTP POST method.
    +
    +
    static final String
    +
    PUT
    +
    +
    HTTP PUT method.
    +
    +
    +
    +
    • +
+
+
+ +
+ +
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/InternalServerErrorException.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/InternalServerErrorException.html new file mode 100644 index 0000000000..9e839090e9 --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/InternalServerErrorException.html @@ -0,0 +1,317 @@ + + + + +InternalServerErrorException (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Module jakarta.ws.rs
+
Package jakarta.ws.rs
+

Class InternalServerErrorException

+
+
java.lang.Object +
java.lang.Throwable +
java.lang.Exception +
java.lang.RuntimeException +
jakarta.ws.rs.WebApplicationException +
jakarta.ws.rs.ServerErrorException +
jakarta.ws.rs.InternalServerErrorException
+
+
+
+
+
+
+
+
+
All Implemented Interfaces:
+
Serializable
+
+
+
public class InternalServerErrorException +extends ServerErrorException
+
A runtime exception indicating an internal server + error.
+
+
Since:
+
2.0
+
Author:
+
Sergey Beryozkin, Marek Potociar
+
See Also:
+
+ +
+
+
+
+ +
+
+
    + +
  • +
    +

    Constructor Details

    +
      +
    • +
      +

      InternalServerErrorException

      +
      public InternalServerErrorException()
      +
      Construct a new internal server error exception.
      +
      +
      • +
    • +
      +

      InternalServerErrorException

      +
      public InternalServerErrorException(String message)
      +
      Construct a new internal server error exception.
      +
      +
      Parameters:
      +
      message - the detail message (which is saved for later retrieval by the Throwable.getMessage() method).
      +
      +
      +
      • +
    • +
      +

      InternalServerErrorException

      +
      public InternalServerErrorException(Response response)
      +
      Construct a new internal server error exception.
      +
      +
      Parameters:
      +
      response - internal server error response.
      +
      Throws:
      +
      IllegalArgumentException - in case the status code set in the response is not HTTP 500.
      +
      +
      +
      • +
    • +
      +

      InternalServerErrorException

      +
      public InternalServerErrorException(String message, + Response response)
      +
      Construct a new internal server error exception.
      +
      +
      Parameters:
      +
      message - the detail message (which is saved for later retrieval by the Throwable.getMessage() method).
      +
      response - internal server error response.
      +
      Throws:
      +
      IllegalArgumentException - in case the status code set in the response is not HTTP 500.
      +
      +
      +
      • +
    • +
      +

      InternalServerErrorException

      +
      public InternalServerErrorException(Throwable cause)
      +
      Construct a new internal server error exception.
      +
      +
      Parameters:
      +
      cause - the underlying cause of the exception.
      +
      +
      +
      • +
    • +
      +

      InternalServerErrorException

      +
      public InternalServerErrorException(String message, + Throwable cause)
      +
      Construct a new internal server error exception.
      +
      +
      Parameters:
      +
      message - the detail message (which is saved for later retrieval by the Throwable.getMessage() method).
      +
      cause - the underlying cause of the exception.
      +
      +
      +
      • +
    • +
      +

      InternalServerErrorException

      +
      public InternalServerErrorException(Response response, + Throwable cause)
      +
      Construct a new internal server error exception.
      +
      +
      Parameters:
      +
      response - internal server error response.
      +
      cause - the underlying cause of the exception.
      +
      Throws:
      +
      IllegalArgumentException - in case the status code set in the response is not HTTP 500.
      +
      +
      +
      • +
    • +
      +

      InternalServerErrorException

      +
      public InternalServerErrorException(String message, + Response response, + Throwable cause)
      +
      Construct a new internal server error exception.
      +
      +
      Parameters:
      +
      message - the detail message (which is saved for later retrieval by the Throwable.getMessage() method).
      +
      response - internal server error response.
      +
      cause - the underlying cause of the exception.
      +
      Throws:
      +
      IllegalArgumentException - in case the status code set in the response is not HTTP 500.
      +
      +
      +
      • +
    +
    +
    • +
+
+ +
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/MatrixParam.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/MatrixParam.html new file mode 100644 index 0000000000..8e61d22ca2 --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/MatrixParam.html @@ -0,0 +1,197 @@ + + + + +MatrixParam (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Module jakarta.ws.rs
+
Package jakarta.ws.rs
+

Annotation Interface MatrixParam

+
+
+
+
@Target({PARAMETER,METHOD,FIELD}) +@Retention(RUNTIME) +@Documented +public @interface MatrixParam
+
Binds the value(s) of a URI matrix parameter to a resource method parameter, resource class field, or resource class + bean property. Values are URL decoded unless this is disabled using the Encoded annotation. A default value + can be specified using the DefaultValue annotation. +

+ Note that the @MatrixParam annotation value refers to a name of a matrix parameter that + resides in the last matched path segment of the Path-annotated Java structure that injects the value of the + matrix parameter. +

+

+ The type T of the annotated parameter, field or property must either: +

+
    +
  1. Be a primitive type
    2. +
  2. Have a constructor that accepts a single String argument
    3. +
  3. Have a static method named valueOf or fromString that accepts a single String argument + (see, for example, Integer.valueOf(String))
    4. +
  4. Have a registered implementation of ParamConverterProvider JAX-RS extension SPI that + returns a ParamConverter instance capable of a "from string" conversion for the type.
    5. +
  5. Be List<T>, Set<T>, SortedSet<T> or T[] array, where T satisfies 2, 3 or + 4 above. The resulting collection is read-only.
    6. +
+ +

+ If the type is not one of the collection types listed in 5 above and the matrix parameter is represented by multiple + values then the first value (lexically) of the parameter is used. +

+ +

+ Because injection occurs at object creation time, use of this annotation on resource class fields and bean properties + is only supported for the default per-request resource class lifecycle. Resource classes using other lifecycles + should only use this annotation on resource method parameters. +

+
+
Since:
+
1.0
+
Author:
+
Paul Sandoz, Marc Hadley
+
See Also:
+
+ +
+
+
+
+
    + +
  • +
    +

    Required Element Summary

    +
    Required Elements
    +
    +
    Modifier and Type
    +
    Required Element
    +
    Description
    +
    String
    +
    value
    +
    +
    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.
    +
    +
    +
    +
    • +
+
+
+
    + +
  • +
    +

    Element Details

    +
      +
    • +
      +

      value

      +
      String value
      +
      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. The name is specified in decoded form, any percent encoded literals within + the value will not be decoded and will instead be treated as literal text. E.g. if the parameter name is "a b" then + the value of the annotation is "a b", not "a+b" or "a%20b".
      +
      +
      Returns:
      +
      URI matrix parameter name.
      +
      +
      +
      • +
    +
    +
    • +
+
+ +
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/NameBinding.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/NameBinding.html new file mode 100644 index 0000000000..6c1b1e5561 --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/NameBinding.html @@ -0,0 +1,160 @@ + + + + +NameBinding (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Module jakarta.ws.rs
+
Package jakarta.ws.rs
+

Annotation Interface NameBinding

+
+
+
+
@Target(ANNOTATION_TYPE) +@Retention(RUNTIME) +@Documented +public @interface NameBinding
+
Meta-annotation used to create name binding annotations for filters and interceptors. + + Name binding via annotations is only supported as part of the Server API. In name binding, a name-binding + annotation is first defined using the @NameBinding meta-annotation: + + 
+  @Target({ ElementType.TYPE, ElementType.METHOD })
+  @Retention(value = RetentionPolicy.RUNTIME)
+  @NameBinding
+  public @interface Logged { }
+
+ + The defined name-binding annotation is then used to decorate a filter or interceptor class (more than one filter or + interceptor may be decorated with the same name-binding annotation): + + 
+  @Logged
+  public class LoggingFilter
+          implements ContainerRequestFilter, ContainerResponseFilter {
+      ...
+  }
+
+ + At last, the name-binding annotation is applied to the resource method(s) to which the name-bound JAX-RS provider(s) + should be bound to: + + 
+  @Path("/")
+  public class MyResourceClass {
+      @GET
+      @Produces("text/plain")
+      @Path("{name}")
+      @Logged
+      public String hello(@PathParam("name") String name) {
+          return "Hello " + name;
+      }
+  }
+
+ + A name-binding annotation may also be attached to a custom JAX-RS Application subclass. In + such case a name-bound JAX-RS provider bound by the annotation will be applied to all resource and + sub-resource methods in the JAX-RS application: + + 
+  @Logged
+  @ApplicationPath("myApp")
+  public class MyApplication extends jakarta.ws.rs.core.Application {
+      ...
+  }
+
+
+
Since:
+
2.0
+
Author:
+
Santiago Pericas-Geertsen, Marek Potociar
+
+
+
+ +
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/NotAcceptableException.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/NotAcceptableException.html new file mode 100644 index 0000000000..d71d6bfc0f --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/NotAcceptableException.html @@ -0,0 +1,317 @@ + + + + +NotAcceptableException (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Module jakarta.ws.rs
+
Package jakarta.ws.rs
+

Class NotAcceptableException

+
+
java.lang.Object +
java.lang.Throwable +
java.lang.Exception +
java.lang.RuntimeException +
jakarta.ws.rs.WebApplicationException +
jakarta.ws.rs.ClientErrorException +
jakarta.ws.rs.NotAcceptableException
+
+
+
+
+
+
+
+
+
All Implemented Interfaces:
+
Serializable
+
+
+
public class NotAcceptableException +extends ClientErrorException
+
A runtime exception indicating that a client request is not + acceptable by the server.
+
+
Since:
+
2.0
+
Author:
+
Sergey Beryozkin, Marek Potociar
+
See Also:
+
+ +
+
+
+
+ +
+
+
    + +
  • +
    +

    Constructor Details

    +
      +
    • +
      +

      NotAcceptableException

      +
      public NotAcceptableException()
      +
      Construct a new "request not acceptable" exception.
      +
      +
      • +
    • +
      +

      NotAcceptableException

      +
      public NotAcceptableException(String message)
      +
      Construct a new "request not acceptable" exception.
      +
      +
      Parameters:
      +
      message - the detail message (which is saved for later retrieval by the Throwable.getMessage() method).
      +
      +
      +
      • +
    • +
      +

      NotAcceptableException

      +
      public NotAcceptableException(Response response)
      +
      Construct a new "request not acceptable" exception.
      +
      +
      Parameters:
      +
      response - error response.
      +
      Throws:
      +
      IllegalArgumentException - in case the status code set in the response is not HTTP 406.
      +
      +
      +
      • +
    • +
      +

      NotAcceptableException

      +
      public NotAcceptableException(String message, + Response response)
      +
      Construct a new "request not acceptable" exception.
      +
      +
      Parameters:
      +
      message - the detail message (which is saved for later retrieval by the Throwable.getMessage() method).
      +
      response - error response.
      +
      Throws:
      +
      IllegalArgumentException - in case the status code set in the response is not HTTP 406.
      +
      +
      +
      • +
    • +
      +

      NotAcceptableException

      +
      public NotAcceptableException(Throwable cause)
      +
      Construct a new "request not acceptable" exception.
      +
      +
      Parameters:
      +
      cause - the underlying cause of the exception.
      +
      +
      +
      • +
    • +
      +

      NotAcceptableException

      +
      public NotAcceptableException(String message, + Throwable cause)
      +
      Construct a new "request not acceptable" exception.
      +
      +
      Parameters:
      +
      message - the detail message (which is saved for later retrieval by the Throwable.getMessage() method).
      +
      cause - the underlying cause of the exception.
      +
      +
      +
      • +
    • +
      +

      NotAcceptableException

      +
      public NotAcceptableException(Response response, + Throwable cause)
      +
      Construct a new "request not acceptable" exception.
      +
      +
      Parameters:
      +
      response - error response.
      +
      cause - the underlying cause of the exception.
      +
      Throws:
      +
      IllegalArgumentException - in case the status code set in the response is not HTTP 406.
      +
      +
      +
      • +
    • +
      +

      NotAcceptableException

      +
      public NotAcceptableException(String message, + Response response, + Throwable cause)
      +
      Construct a new "request not acceptable" exception.
      +
      +
      Parameters:
      +
      message - the detail message (which is saved for later retrieval by the Throwable.getMessage() method).
      +
      response - error response.
      +
      cause - the underlying cause of the exception.
      +
      Throws:
      +
      IllegalArgumentException - in case the status code set in the response is not HTTP 406.
      +
      +
      +
      • +
    +
    +
    • +
+
+ +
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/NotAllowedException.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/NotAllowedException.html new file mode 100644 index 0000000000..658689f4c7 --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/NotAllowedException.html @@ -0,0 +1,356 @@ + + + + +NotAllowedException (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Module jakarta.ws.rs
+
Package jakarta.ws.rs
+

Class NotAllowedException

+
+
java.lang.Object +
java.lang.Throwable +
java.lang.Exception +
java.lang.RuntimeException +
jakarta.ws.rs.WebApplicationException +
jakarta.ws.rs.ClientErrorException +
jakarta.ws.rs.NotAllowedException
+
+
+
+
+
+
+
+
+
All Implemented Interfaces:
+
Serializable
+
+
+
public class NotAllowedException +extends ClientErrorException
+
A runtime exception indicating a client requesting a resource method that is + not allowed.
+
+
Since:
+
2.0
+
Author:
+
Marek Potociar
+
See Also:
+
+ +
+
+
+
+ +
+
+
    + +
  • +
    +

    Constructor Details

    +
      +
    • +
      +

      NotAllowedException

      +
      public NotAllowedException(String allowed, + String... moreAllowed)
      +
      Construct a new method not allowed exception.
      +
      +
      Parameters:
      +
      allowed - allowed request method.
      +
      moreAllowed - more allowed request methods.
      +
      Throws:
      +
      NullPointerException - in case the allowed method is null.
      +
      +
      +
      • +
    • +
      +

      NotAllowedException

      +
      public NotAllowedException(String message, + String allowed, + String... moreAllowed)
      +
      Construct a new method not allowed exception.
      +
      +
      Parameters:
      +
      message - the detail message (which is saved for later retrieval by the Throwable.getMessage() method).
      +
      allowed - allowed request method.
      +
      moreAllowed - more allowed request methods.
      +
      Throws:
      +
      NullPointerException - in case the allowed method is null.
      +
      +
      +
      • +
    • +
      +

      NotAllowedException

      +
      public NotAllowedException(Response response)
      +
      Construct a new method not allowed exception. +

      + Note that this constructor does not validate the presence of HTTP Allow header. I.e. it is possible to use + the constructor to create a client-side exception instance even for an invalid HTTP 405 response content + returned from a server. +

      +
      +
      Parameters:
      +
      response - error response.
      +
      Throws:
      +
      IllegalArgumentException - in case the status code set in the response is not HTTP 405.
      +
      +
      +
      • +
    • +
      +

      NotAllowedException

      +
      public NotAllowedException(String message, + Response response)
      +
      Construct a new method not allowed exception. +

      + Note that this constructor does not validate the presence of HTTP Allow header. I.e. it is possible to use + the constructor to create a client-side exception instance even for an invalid HTTP 405 response content + returned from a server. +

      +
      +
      Parameters:
      +
      message - the detail message (which is saved for later retrieval by the Throwable.getMessage() method).
      +
      response - error response.
      +
      Throws:
      +
      IllegalArgumentException - in case the status code set in the response is not HTTP 405.
      +
      +
      +
      • +
    • +
      +

      NotAllowedException

      +
      public NotAllowedException(Throwable cause, + String... allowedMethods)
      +
      Construct a new method not allowed exception.
      +
      +
      Parameters:
      +
      cause - the underlying cause of the exception.
      +
      allowedMethods - allowed request methods.
      +
      Throws:
      +
      IllegalArgumentException - in case the allowed methods varargs are null.
      +
      +
      +
      • +
    • +
      +

      NotAllowedException

      +
      public NotAllowedException(String message, + Throwable cause, + String... allowedMethods)
      +
      Construct a new method not allowed exception.
      +
      +
      Parameters:
      +
      message - the detail message (which is saved for later retrieval by the Throwable.getMessage() method).
      +
      cause - the underlying cause of the exception.
      +
      allowedMethods - allowed request methods.
      +
      Throws:
      +
      IllegalArgumentException - in case the allowed methods varargs are null.
      +
      +
      +
      • +
    • +
      +

      NotAllowedException

      +
      public NotAllowedException(Response response, + Throwable cause)
      +
      Construct a new method not allowed exception.
      +
      +
      Parameters:
      +
      response - error response.
      +
      cause - the underlying cause of the exception.
      +
      Throws:
      +
      IllegalArgumentException - in case the status code set in the response is not HTTP 405 or does not + contain an HTTP Allow header.
      +
      +
      +
      • +
    • +
      +

      NotAllowedException

      +
      public NotAllowedException(String message, + Response response, + Throwable cause)
      +
      Construct a new method not allowed exception.
      +
      +
      Parameters:
      +
      message - the detail message (which is saved for later retrieval by the Throwable.getMessage() method).
      +
      response - error response.
      +
      cause - the underlying cause of the exception.
      +
      Throws:
      +
      IllegalArgumentException - in case the status code set in the response is not HTTP 405 or does not + contain an HTTP Allow header.
      +
      +
      +
      • +
    +
    +
    • +
+
+ +
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/NotAuthorizedException.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/NotAuthorizedException.html new file mode 100644 index 0000000000..7cc0f21abd --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/NotAuthorizedException.html @@ -0,0 +1,387 @@ + + + + +NotAuthorizedException (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Module jakarta.ws.rs
+
Package jakarta.ws.rs
+

Class NotAuthorizedException

+
+
java.lang.Object +
java.lang.Throwable +
java.lang.Exception +
java.lang.RuntimeException +
jakarta.ws.rs.WebApplicationException +
jakarta.ws.rs.ClientErrorException +
jakarta.ws.rs.NotAuthorizedException
+
+
+
+
+
+
+
+
+
All Implemented Interfaces:
+
Serializable
+
+
+
public class NotAuthorizedException +extends ClientErrorException
+
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. + Authorization HTTP header is missing in the request,
    • +
  • or - in case the request already contains the HTTP Authorization header - then the exception indicates + that authorization has been refused for the credentials contained in the request header.
    • +
+
+
Since:
+
2.0
+
Author:
+
Marek Potociar
+
See Also:
+
+ +
+
+
+
+ +
+
+
    + +
  • +
    +

    Constructor Details

    +
      +
    • +
      +

      NotAuthorizedException

      +
      public NotAuthorizedException(Object challenge, + Object... moreChallenges)
      +
      Construct a new "not authorized" exception.
      +
      +
      Parameters:
      +
      challenge - authorization challenge applicable to the resource requested by the client.
      +
      moreChallenges - additional authorization challenge applicable to the requested resource.
      +
      Throws:
      +
      NullPointerException - in case the challenge parameter is null.
      +
      +
      +
      • +
    • +
      +

      NotAuthorizedException

      +
      public NotAuthorizedException(String message, + Object challenge, + Object... moreChallenges)
      +
      Construct a new "not authorized" exception.
      +
      +
      Parameters:
      +
      message - the detail message (which is saved for later retrieval by the Throwable.getMessage() method).
      +
      challenge - authorization challenge applicable to the resource requested by the client.
      +
      moreChallenges - additional authorization challenge applicable to the requested resource.
      +
      Throws:
      +
      NullPointerException - in case the challenge parameter is null.
      +
      +
      +
      • +
    • +
      +

      NotAuthorizedException

      +
      public NotAuthorizedException(Response response)
      +
      Construct a new "not authorized" exception.
      +
      +
      Parameters:
      +
      response - error response.
      +
      Throws:
      +
      IllegalArgumentException - in case the status code set in the response is not HTTP 401.
      +
      +
      +
      • +
    • +
      +

      NotAuthorizedException

      +
      public NotAuthorizedException(String message, + Response response)
      +
      Construct a new "not authorized" exception.
      +
      +
      Parameters:
      +
      message - the detail message (which is saved for later retrieval by the Throwable.getMessage() method).
      +
      response - error response.
      +
      Throws:
      +
      IllegalArgumentException - in case the status code set in the response is not HTTP 401.
      +
      +
      +
      • +
    • +
      +

      NotAuthorizedException

      +
      public NotAuthorizedException(Throwable cause, + Object challenge, + Object... moreChallenges)
      +
      Construct a new "not authorized" exception.
      +
      +
      Parameters:
      +
      cause - the underlying cause of the exception.
      +
      challenge - authorization challenge applicable to the requested resource.
      +
      moreChallenges - additional authorization challenge applicable to the requested resource.
      +
      +
      +
      • +
    • +
      +

      NotAuthorizedException

      +
      public NotAuthorizedException(String message, + Throwable cause, + Object challenge, + Object... moreChallenges)
      +
      Construct a new "not authorized" exception.
      +
      +
      Parameters:
      +
      message - the detail message (which is saved for later retrieval by the Throwable.getMessage() method).
      +
      cause - the underlying cause of the exception.
      +
      challenge - authorization challenge applicable to the requested resource.
      +
      moreChallenges - additional authorization challenge applicable to the requested resource.
      +
      +
      +
      • +
    • +
      +

      NotAuthorizedException

      +
      public NotAuthorizedException(Response response, + Throwable cause)
      +
      Construct a new "not authorized" exception.
      +
      +
      Parameters:
      +
      response - error response.
      +
      cause - the underlying cause of the exception.
      +
      Throws:
      +
      IllegalArgumentException - in case the status code set in the response is not HTTP 401.
      +
      +
      +
      • +
    • +
      +

      NotAuthorizedException

      +
      public NotAuthorizedException(String message, + Response response, + Throwable cause)
      +
      Construct a new "not authorized" exception.
      +
      +
      Parameters:
      +
      message - the detail message (which is saved for later retrieval by the Throwable.getMessage() method).
      +
      response - error response.
      +
      cause - the underlying cause of the exception.
      +
      Throws:
      +
      IllegalArgumentException - in case the status code set in the response is not HTTP 401.
      +
      +
      +
      • +
    +
    +
    • + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      getChallenges

      +
      public List<Object> getChallenges()
      +
      Get the list of authorization challenges associated with the exception and applicable to the resource requested by + the client.
      +
      +
      Returns:
      +
      list of authorization challenges applicable to the resource requested by the client.
      +
      +
      +
      • +
    +
    +
    • +
+
+ +
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/NotFoundException.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/NotFoundException.html new file mode 100644 index 0000000000..574c4d3320 --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/NotFoundException.html @@ -0,0 +1,316 @@ + + + + +NotFoundException (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Module jakarta.ws.rs
+
Package jakarta.ws.rs
+

Class NotFoundException

+
+
java.lang.Object +
java.lang.Throwable +
java.lang.Exception +
java.lang.RuntimeException +
jakarta.ws.rs.WebApplicationException +
jakarta.ws.rs.ClientErrorException +
jakarta.ws.rs.NotFoundException
+
+
+
+
+
+
+
+
+
All Implemented Interfaces:
+
Serializable
+
+
+
public class NotFoundException +extends ClientErrorException
+
A runtime exception indicating a resource requested by a client was not found on the server.
+
+
Since:
+
2.0
+
Author:
+
Sergey Beryozkin, Marek Potociar
+
See Also:
+
+ +
+
+
+
+ +
+
+
    + +
  • +
    +

    Constructor Details

    +
      +
    • +
      +

      NotFoundException

      +
      public NotFoundException()
      +
      Construct a new "not found" exception.
      +
      +
      • +
    • +
      +

      NotFoundException

      +
      public NotFoundException(String message)
      +
      Construct a new "not found" exception.
      +
      +
      Parameters:
      +
      message - the detail message (which is saved for later retrieval by the Throwable.getMessage() method).
      +
      +
      +
      • +
    • +
      +

      NotFoundException

      +
      public NotFoundException(Response response)
      +
      Construct a new "not found" exception.
      +
      +
      Parameters:
      +
      response - error response.
      +
      Throws:
      +
      IllegalArgumentException - in case the status code set in the response is not HTTP 404.
      +
      +
      +
      • +
    • +
      +

      NotFoundException

      +
      public NotFoundException(String message, + Response response)
      +
      Construct a new "not found" exception.
      +
      +
      Parameters:
      +
      message - the detail message (which is saved for later retrieval by the Throwable.getMessage() method).
      +
      response - error response.
      +
      Throws:
      +
      IllegalArgumentException - in case the status code set in the response is not HTTP 404.
      +
      +
      +
      • +
    • +
      +

      NotFoundException

      +
      public NotFoundException(Throwable cause)
      +
      Construct a new "not found" exception.
      +
      +
      Parameters:
      +
      cause - the underlying cause of the exception.
      +
      +
      +
      • +
    • +
      +

      NotFoundException

      +
      public NotFoundException(String message, + Throwable cause)
      +
      Construct a new "not found" exception.
      +
      +
      Parameters:
      +
      message - the detail message (which is saved for later retrieval by the Throwable.getMessage() method).
      +
      cause - the underlying cause of the exception.
      +
      +
      +
      • +
    • +
      +

      NotFoundException

      +
      public NotFoundException(Response response, + Throwable cause)
      +
      Construct a new "not found" exception.
      +
      +
      Parameters:
      +
      response - error response.
      +
      cause - the underlying cause of the exception.
      +
      Throws:
      +
      IllegalArgumentException - in case the status code set in the response is not HTTP 404.
      +
      +
      +
      • +
    • +
      +

      NotFoundException

      +
      public NotFoundException(String message, + Response response, + Throwable cause)
      +
      Construct a new "not found" exception.
      +
      +
      Parameters:
      +
      message - the detail message (which is saved for later retrieval by the Throwable.getMessage() method).
      +
      response - error response.
      +
      cause - the underlying cause of the exception.
      +
      Throws:
      +
      IllegalArgumentException - in case the status code set in the response is not HTTP 404.
      +
      +
      +
      • +
    +
    +
    • +
+
+ +
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/NotSupportedException.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/NotSupportedException.html new file mode 100644 index 0000000000..07ea4da965 --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/NotSupportedException.html @@ -0,0 +1,317 @@ + + + + +NotSupportedException (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Module jakarta.ws.rs
+
Package jakarta.ws.rs
+

Class NotSupportedException

+
+
java.lang.Object +
java.lang.Throwable +
java.lang.Exception +
java.lang.RuntimeException +
jakarta.ws.rs.WebApplicationException +
jakarta.ws.rs.ClientErrorException +
jakarta.ws.rs.NotSupportedException
+
+
+
+
+
+
+
+
+
All Implemented Interfaces:
+
Serializable
+
+
+
public class NotSupportedException +extends ClientErrorException
+
A runtime exception indicating that the client request entity media type is + not supported.
+
+
Since:
+
2.0
+
Author:
+
Sergey Beryozkin, Marek Potociar
+
See Also:
+
+ +
+
+
+
+ +
+
+
    + +
  • +
    +

    Constructor Details

    +
      +
    • +
      +

      NotSupportedException

      +
      public NotSupportedException()
      +
      Construct a new unsupported media type exception.
      +
      +
      • +
    • +
      +

      NotSupportedException

      +
      public NotSupportedException(String message)
      +
      Construct a new unsupported media type exception.
      +
      +
      Parameters:
      +
      message - the detail message (which is saved for later retrieval by the Throwable.getMessage() method).
      +
      +
      +
      • +
    • +
      +

      NotSupportedException

      +
      public NotSupportedException(Response response)
      +
      Construct a new unsupported media type exception.
      +
      +
      Parameters:
      +
      response - error response.
      +
      Throws:
      +
      IllegalArgumentException - in case the status code set in the response is not HTTP 415.
      +
      +
      +
      • +
    • +
      +

      NotSupportedException

      +
      public NotSupportedException(String message, + Response response)
      +
      Construct a new unsupported media type exception.
      +
      +
      Parameters:
      +
      message - the detail message (which is saved for later retrieval by the Throwable.getMessage() method).
      +
      response - error response.
      +
      Throws:
      +
      IllegalArgumentException - in case the status code set in the response is not HTTP 415.
      +
      +
      +
      • +
    • +
      +

      NotSupportedException

      +
      public NotSupportedException(Throwable cause)
      +
      Construct a new unsupported media type exception.
      +
      +
      Parameters:
      +
      cause - the underlying cause of the exception.
      +
      +
      +
      • +
    • +
      +

      NotSupportedException

      +
      public NotSupportedException(String message, + Throwable cause)
      +
      Construct a new unsupported media type exception.
      +
      +
      Parameters:
      +
      message - the detail message (which is saved for later retrieval by the Throwable.getMessage() method).
      +
      cause - the underlying cause of the exception.
      +
      +
      +
      • +
    • +
      +

      NotSupportedException

      +
      public NotSupportedException(Response response, + Throwable cause)
      +
      Construct a new unsupported media type exception.
      +
      +
      Parameters:
      +
      response - error response.
      +
      cause - the underlying cause of the exception.
      +
      Throws:
      +
      IllegalArgumentException - in case the status code set in the response is not HTTP 415.
      +
      +
      +
      • +
    • +
      +

      NotSupportedException

      +
      public NotSupportedException(String message, + Response response, + Throwable cause)
      +
      Construct a new unsupported media type exception.
      +
      +
      Parameters:
      +
      message - the detail message (which is saved for later retrieval by the Throwable.getMessage() method).
      +
      response - error response.
      +
      cause - the underlying cause of the exception.
      +
      Throws:
      +
      IllegalArgumentException - in case the status code set in the response is not HTTP 415.
      +
      +
      +
      • +
    +
    +
    • +
+
+ +
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/OPTIONS.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/OPTIONS.html new file mode 100644 index 0000000000..604f1223b8 --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/OPTIONS.html @@ -0,0 +1,118 @@ + + + + +OPTIONS (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Module jakarta.ws.rs
+
Package jakarta.ws.rs
+

Annotation Interface OPTIONS

+
+
+
+
@Target(METHOD) +@Retention(RUNTIME) +@HttpMethod("OPTIONS") +@Documented +public @interface OPTIONS
+
Indicates that the annotated method responds to HTTP OPTIONS requests.
+
+
Since:
+
1.1
+
Author:
+
Paul Sandoz, Marc Hadley
+
See Also:
+
+ +
+
+
+
+ +
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/PATCH.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/PATCH.html new file mode 100644 index 0000000000..439920393f --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/PATCH.html @@ -0,0 +1,118 @@ + + + + +PATCH (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Module jakarta.ws.rs
+
Package jakarta.ws.rs
+

Annotation Interface PATCH

+
+
+
+
@Target(METHOD) +@Retention(RUNTIME) +@HttpMethod("PATCH") +@Documented +public @interface PATCH
+
Indicates that the annotated method responds to HTTP PATCH requests.
+
+
Since:
+
2.1
+
Author:
+
Pavel Bucek (pavel.bucek at oracle.com)
+
See Also:
+
+ +
+
+
+
+ +
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/POST.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/POST.html new file mode 100644 index 0000000000..bf4bb50939 --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/POST.html @@ -0,0 +1,118 @@ + + + + +POST (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Module jakarta.ws.rs
+
Package jakarta.ws.rs
+

Annotation Interface POST

+
+
+
+
@Target(METHOD) +@Retention(RUNTIME) +@HttpMethod("POST") +@Documented +public @interface POST
+
Indicates that the annotated method responds to HTTP POST requests.
+
+
Since:
+
1.0
+
Author:
+
Paul Sandoz, Marc Hadley
+
See Also:
+
+ +
+
+
+
+ +
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/PUT.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/PUT.html new file mode 100644 index 0000000000..87dc21a00f --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/PUT.html @@ -0,0 +1,118 @@ + + + + +PUT (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Module jakarta.ws.rs
+
Package jakarta.ws.rs
+

Annotation Interface PUT

+
+
+
+
@Target(METHOD) +@Retention(RUNTIME) +@HttpMethod("PUT") +@Documented +public @interface PUT
+
Indicates that the annotated method responds to HTTP PUT requests.
+
+
Since:
+
1.0
+
Author:
+
Paul Sandoz, Marc Hadley
+
See Also:
+
+ +
+
+
+
+ +
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/Path.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/Path.html new file mode 100644 index 0000000000..7803878999 --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/Path.html @@ -0,0 +1,224 @@ + + + + +Path (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Module jakarta.ws.rs
+
Package jakarta.ws.rs
+

Annotation Interface Path

+
+
+
+
@Target({TYPE,METHOD}) +@Retention(RUNTIME) +@Documented +public @interface Path
+
Identifies the URI path that a resource class or class method will serve requests for. + +

+ Paths are relative. For an annotated class the base URI is the application path, see ApplicationPath. For an + annotated method the base URI is the effective URI of the containing class. For the purposes of absolutizing a path + against the base URI , a leading '/' in a path is ignored and base URIs are treated as if they ended in '/'. E.g.: +

+ + 
+ @Path("widgets")
+ public class WidgetsResource {
+  @GET
+  String getList() {...}
+
+  @GET @Path("{id}")
+  String getWidget(@PathParam("id") String id) {...}
+ }
+
+ +

+ In the above, if the application path is catalogue and the application is deployed at + http://example.com/, then GET requests for http://example.com/catalogue/widgets will be + handled by the getList method while requests for http://example.com/catalogue/widgets/nnn + (where nnn is some value) will be handled by the getWidget method. The same would apply + if the value of either @Path annotation started with '/'. +

+ +

+ Classes and methods may also be annotated with Consumes and Produces to filter the requests they will + receive. +

+
+
Since:
+
1.0
+
Author:
+
Paul Sandoz, Marc Hadley
+
See Also:
+
+ +
+
+
+
+
    + +
  • +
    +

    Required Element Summary

    +
    Required Elements
    +
    +
    Modifier and Type
    +
    Required Element
    +
    Description
    +
    String
    +
    value
    +
    +
    Defines a URI template for the resource class or method, must not include matrix parameters.
    +
    +
    +
    +
    • +
+
+
+
    + +
  • +
    +

    Element Details

    +
      +
    • +
      +

      value

      +
      String value
      +
      Defines a URI template for the resource class or method, must not include matrix parameters. + +

      + Embedded template parameters are allowed and are of the form: +

      + + 
      +  param = "{" *WSP name *WSP [ ":" *WSP regex *WSP ] "}"
+ name = (ALPHA / DIGIT / "_")*(ALPHA / DIGIT / "." / "_" / "-" ) ; \w[\w\.-]*
+ regex = *( nonbrace / "{" *nonbrace "}" ) ; where nonbrace is any char other than "{" and "}"
+
      + +

      + See RFC 5234 for a description of the syntax used above and the + expansions of WSP, ALPHA and DIGIT. In the above name is the template parameter name + and the optional regex specifies the contents of the capturing group for the parameter. If regex is + not supplied then a default value of [^/]+ which terminates at a path segment boundary, is used. Matching of + request URIs to URI templates is performed against encoded path values and implementations will not escape literal + characters in regex automatically, therefore any literals in regex should be escaped by the author according + to the rules of RFC 3986 section 3.3. Caution is + recommended in the use of regex, incorrect use can lead to a template parameter matching unexpected URI + paths. See Pattern for + further information on the syntax of regular expressions. Values of template parameters may be extracted using + PathParam. +

      + +

      + The literal part of the supplied value (those characters that are not part of a template parameter) is automatically + percent encoded to conform to the path production of + RFC 3986 section 3.3. Note that percent encoded values + are allowed in the literal part of the value, an implementation will recognize such values and will not double encode + the '%' character. +

      +
      +
      Returns:
      +
      URI template.
      +
      +
      +
      • +
    +
    +
    • +
+
+ +
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/PathParam.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/PathParam.html new file mode 100644 index 0000000000..a47686d0f4 --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/PathParam.html @@ -0,0 +1,200 @@ + + + + +PathParam (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Module jakarta.ws.rs
+
Package jakarta.ws.rs
+

Annotation Interface PathParam

+
+
+
+
@Target({PARAMETER,METHOD,FIELD}) +@Retention(RUNTIME) +@Documented +public @interface PathParam
+
Binds the value of a URI template parameter or a path segment containing the template parameter to a resource method + parameter, resource class field, or resource class bean property. The value is URL decoded unless this is disabled + using the @Encoded annotation. A default value can be specified using the @DefaultValue annotation. + + The type of the annotated parameter, field or property must either: +
    +
  • Be PathSegment, the value will be the final segment of the matching part of the path. + See UriInfo for a means of retrieving all request path segments.
    • +
  • Be List<jakarta.ws.rs.core.PathSegment>, the value will be a list of PathSegment corresponding to + the path segment(s) that matched the named template parameter. See UriInfo for a means of + retrieving all request path segments.
    • +
  • Be a primitive type.
    • +
  • Have a constructor that accepts a single String argument.
    • +
  • Have a static method named valueOf or fromString that accepts a single String argument (see, for + example, Integer.valueOf(String)).
    • +
  • Have a registered implementation of ParamConverterProvider JAX-RS extension SPI that + returns a ParamConverter instance capable of a "from string" conversion for the type.
    • +
+ +

+ The injected value corresponds to the latest use (in terms of scope) of the path parameter. E.g. if a class and a + sub-resource method are both annotated with a @Path containing the same URI template parameter, use + of @PathParam on a sub-resource method parameter will bind the value matching URI template parameter in the + method's @Path annotation. +

+ +

+ Because injection occurs at object creation time, use of this annotation on resource class fields and bean properties + is only supported for the default per-request resource class lifecycle. Resource classes using other lifecycles + should only use this annotation on resource method parameters. +

+
+
Since:
+
1.0
+
Author:
+
Paul Sandoz, Marc Hadley
+
See Also:
+
+ +
+
+
+
+
    + +
  • +
    +

    Required Element Summary

    +
    Required Elements
    +
    +
    Modifier and Type
    +
    Required Element
    +
    Description
    +
    String
    +
    value
    +
    +
    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.
    +
    +
    +
    +
    • +
+
+
+
    + +
  • +
    +

    Element Details

    +
      +
    • +
      +

      value

      +
      String value
      +
      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. See Path.value() for a description of the syntax of template + parameters. + +

      + E.g. a class annotated with: @Path("widgets/{id}") can have methods annotated whose arguments are annotated + with @PathParam("id").

      +
      +
      Returns:
      +
      resource URI template parameter name.
      +
      +
      +
      • +
    +
    +
    • +
+
+ +
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/Priorities.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/Priorities.html new file mode 100644 index 0000000000..662c84ac9e --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/Priorities.html @@ -0,0 +1,267 @@ + + + + +Priorities (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Module jakarta.ws.rs
+
Package jakarta.ws.rs
+

Class Priorities

+
+
java.lang.Object +
jakarta.ws.rs.Priorities
+
+
+
+
public final class Priorities +extends Object
+
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. +

+ For example, JAX-RS filters and interceptors are grouped in chains for each of the message processing extension + points: Pre, PreMatch, Post as well as ReadFrom and WriteTo. Each of these chains is sorted based on priorities which + are represented as integer numbers. All chains, except Post, are sorted in ascending order; the lower the number the + higher the priority. The Post filter chain is sorted in descending order to ensure that response filters are executed + in reverse order. +

+

+ JAX-RS components that belong to the same priority class (same integer value) are executed in an + implementation-defined manner. By default, when the @Priority annotation is absent on a component, for which + a priority should be applied, the USER priority value is used. +

+
+
Since:
+
2.0
+
Author:
+
Marek Potociar (marek.potociar at oracle.com)
+
+
+
+
    + +
  • +
    +

    Field Summary

    +
    Fields
    +
    +
    Modifier and Type
    +
    Field
    +
    Description
    +
    static final int
    +
    AUTHENTICATION
    +
    +
    Security authentication filter/interceptor priority.
    +
    +
    static final int
    +
    AUTHORIZATION
    +
    +
    Security authorization filter/interceptor priority.
    +
    +
    static final int
    +
    ENTITY_CODER
    +
    +
    Message encoder or decoder filter/interceptor priority.
    +
    +
    static final int
    +
    HEADER_DECORATOR
    +
    +
    Header decorator filter/interceptor priority.
    +
    +
    static final int
    +
    USER
    +
    +
    User-level filter/interceptor priority.
    +
    +
    +
    +
    • + +
  • +
    +

    Method Summary

    +
    +

    Methods inherited from class java.lang.Object

    +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +
    +
    • +
+
+
+
    + +
  • +
    +

    Field Details

    +
      +
    • +
      +

      AUTHENTICATION

      +
      public static final int AUTHENTICATION
      +
      Security authentication filter/interceptor priority.
      +
      +
      See Also:
      +
      + +
      +
      +
      +
      • +
    • +
      +

      AUTHORIZATION

      +
      public static final int AUTHORIZATION
      +
      Security authorization filter/interceptor priority.
      +
      +
      See Also:
      +
      + +
      +
      +
      +
      • +
    • +
      +

      HEADER_DECORATOR

      +
      public static final int HEADER_DECORATOR
      +
      Header decorator filter/interceptor priority.
      +
      +
      See Also:
      +
      + +
      +
      +
      +
      • +
    • +
      +

      ENTITY_CODER

      +
      public static final int ENTITY_CODER
      +
      Message encoder or decoder filter/interceptor priority.
      +
      +
      See Also:
      +
      + +
      +
      +
      +
      • +
    • +
      +

      USER

      +
      public static final int USER
      +
      User-level filter/interceptor priority. + + This value is also used as a default priority for application-supplied providers.
      +
      +
      See Also:
      +
      + +
      +
      +
      +
      • +
    +
    +
    • +
+
+ +
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/ProcessingException.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/ProcessingException.html new file mode 100644 index 0000000000..418eb95b22 --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/ProcessingException.html @@ -0,0 +1,251 @@ + + + + +ProcessingException (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Module jakarta.ws.rs
+
Package jakarta.ws.rs
+

Class ProcessingException

+
+
java.lang.Object +
java.lang.Throwable +
java.lang.Exception +
java.lang.RuntimeException +
jakarta.ws.rs.ProcessingException
+
+
+
+
+
+
+
All Implemented Interfaces:
+
Serializable
+
+
+
Direct Known Subclasses:
+
ResponseProcessingException
+
+
+
public class ProcessingException +extends RuntimeException
+
A base JAX-RS runtime processing exception. + + The exception of this type is thrown during HTTP request or response processing, to signal a runtime processing + failure. Typical classes of failures covered by ProcessingException include +
    +
  • failures in filter or interceptor chain execution,
    • +
  • errors caused by missing message body readers or writers for the particular Java type and media type + combinations,
    • +
  • propagated IO exceptions thrown by entity readers and writers during entity serialization and de-serialization.
    • +
+ as well as any other JAX-RS runtime processing errors. The exception message or nested Throwable cause SHOULD + contain additional information about the reason of the processing failure. +

+ Note that the exception is used to indicate (internal) JAX-RS processing errors. It is not used to indicate HTTP + error response states. A HTTP error response is represented by a WebApplicationException class or + one of it's sub-classes. +

+
+
Since:
+
2.0
+
Author:
+
Marek Potociar
+
See Also:
+
+ +
+
+
+
+ +
+
+
    + +
  • +
    +

    Constructor Details

    +
      +
    • +
      +

      ProcessingException

      +
      public ProcessingException(Throwable cause)
      +
      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). This constructor is useful for runtime exceptions that are little more than wrappers for other + throwables.
      +
      +
      Parameters:
      +
      cause - the cause (which is saved for later retrieval by the Throwable.getCause() method). (A null value + is permitted, and indicates that the cause is nonexistent or unknown.)
      +
      +
      +
      • +
    • +
      +

      ProcessingException

      +
      public ProcessingException(String message, + Throwable cause)
      +

      + Constructs a new JAX-RS runtime processing exception with the specified detail message and cause. +

      + Note that the detail message associated with cause is not automatically incorporated in this runtime + exception's detail message.
      +
      +
      Parameters:
      +
      message - the detail message (which is saved for later retrieval by the Throwable.getMessage() method).
      +
      cause - the cause (which is saved for later retrieval by the Throwable.getCause() method). (A null value + is permitted, and indicates that the cause is nonexistent or unknown.)
      +
      +
      +
      • +
    • +
      +

      ProcessingException

      +
      public ProcessingException(String message)
      +
      Constructs a new JAX-RS runtime processing exception with the specified detail message. The cause is not initialized, + and may subsequently be initialized by a call to Throwable.initCause(java.lang.Throwable).
      +
      +
      Parameters:
      +
      message - the detail message (which is saved for later retrieval by the Throwable.getMessage() method).
      +
      +
      +
      • +
    +
    +
    • +
+
+ +
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/Produces.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/Produces.html new file mode 100644 index 0000000000..d971843479 --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/Produces.html @@ -0,0 +1,181 @@ + + + + +Produces (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Module jakarta.ws.rs
+
Package jakarta.ws.rs
+

Annotation Interface Produces

+
+
+
+
@Inherited +@Target({TYPE,METHOD}) +@Retention(RUNTIME) +@Documented +public @interface Produces
+
Defines the media type(s) that the methods of a resource class or MessageBodyWriter can + produce. If not specified then a container will assume that any type can be produced. Method level annotations + override a class level annotation. A container is responsible for ensuring that the method invoked is capable of + producing one of the media types requested in the HTTP request. If no such method is available the container must + respond with a HTTP "406 Not Acceptable" as specified by RFC 2616. + +

+ A method for which there is a single-valued @Produces is not required to set the media type of + representations that it produces: the container will use the value of the @Produces when sending a response. +

+
+
Since:
+
1.0
+
Author:
+
Paul Sandoz, Marc Hadley
+
See Also:
+
+ +
+
+
+
+
    + +
  • +
    +

    Optional Element Summary

    +
    Optional Elements
    +
    +
    Modifier and Type
    +
    Optional Element
    +
    Description
    +
    String[]
    +
    value
    +
    +
    A list of media types.
    +
    +
    +
    +
    • +
+
+
+
    + +
  • +
    +

    Element Details

    +
      +
    • +
      +

      value

      +
      String[] value
      +
      A list of media types. Each entry may specify a single type or consist of a comma separated list of types, with any + leading or trailing white-spaces in a single type entry being ignored. For example: + + 
      + { "image/jpeg, image/gif ", " image/png" }
+
      + + Use of the comma-separated form allows definition of a common string constant for use on multiple targets.
      +
      +
      Returns:
      +
      media types to accept.
      +
      +
      +
      Default:
      +
      {"*/*"}
      +
      +
      +
      • +
    +
    +
    • +
+
+ +
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/QueryParam.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/QueryParam.html new file mode 100644 index 0000000000..94491a0b80 --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/QueryParam.html @@ -0,0 +1,191 @@ + + + + +QueryParam (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Module jakarta.ws.rs
+
Package jakarta.ws.rs
+

Annotation Interface QueryParam

+
+
+
+
@Target({PARAMETER,METHOD,FIELD}) +@Retention(RUNTIME) +@Documented +public @interface QueryParam
+
Binds the value(s) of a HTTP query parameter to a resource method parameter, resource class field, or resource class + bean property. Values are URL decoded unless this is disabled using the Encoded annotation. A default value + can be specified using the DefaultValue annotation. + + The type T of the annotated parameter, field or property must either: +
    +
  1. Be a primitive type
    2. +
  2. Have a constructor that accepts a single String argument
    3. +
  3. Have a static method named valueOf or fromString that accepts a single String argument + (see, for example, Integer.valueOf(String))
    4. +
  4. Have a registered implementation of ParamConverterProvider JAX-RS extension SPI that + returns a ParamConverter instance capable of a "from string" conversion for the type.
    5. +
  5. Be List<T>, Set<T>, SortedSet<T> or T[] array, where T satisfies 2, 3 or + 4 above. The resulting collection is read-only.
    6. +
+ +

+ If the type is not one of the collection types listed in 5 above and the query parameter is represented by multiple + values then the first value (lexically) of the parameter is used. +

+ +

+ Because injection occurs at object creation time, use of this annotation on resource class fields and bean properties + is only supported for the default per-request resource class lifecycle. Resource classes using other lifecycles + should only use this annotation on resource method parameters. +

+
+
Since:
+
1.0
+
Author:
+
Paul Sandoz, Marc Hadley
+
See Also:
+
+ +
+
+
+
+
    + +
  • +
    +

    Required Element Summary

    +
    Required Elements
    +
    +
    Modifier and Type
    +
    Required Element
    +
    Description
    +
    String
    +
    value
    +
    +
    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.
    +
    +
    +
    +
    • +
+
+
+
    + +
  • +
    +

    Element Details

    +
      +
    • +
      +

      value

      +
      String value
      +
      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. The name is specified in decoded form, any percent encoded literals within + the value will not be decoded and will instead be treated as literal text. E.g. if the parameter name is "a b" then + the value of the annotation is "a b", not "a+b" or "a%20b".
      +
      +
      Returns:
      +
      HTTP query parameter name.
      +
      +
      +
      • +
    +
    +
    • +
+
+ +
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/RedirectionException.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/RedirectionException.html new file mode 100644 index 0000000000..4cbb565bad --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/RedirectionException.html @@ -0,0 +1,338 @@ + + + + +RedirectionException (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Module jakarta.ws.rs
+
Package jakarta.ws.rs
+

Class RedirectionException

+
+
java.lang.Object +
java.lang.Throwable +
java.lang.Exception +
java.lang.RuntimeException +
jakarta.ws.rs.WebApplicationException +
jakarta.ws.rs.RedirectionException
+
+
+
+
+
+
+
+
All Implemented Interfaces:
+
Serializable
+
+
+
public class RedirectionException +extends WebApplicationException
+
A runtime application exception indicating a request redirection (HTTP 3xx status codes).
+
+
Since:
+
2.0
+
Author:
+
Marek Potociar
+
See Also:
+
+ +
+
+
+
+ +
+
+
    + +
  • +
    +

    Constructor Details

    +
      +
    • +
      +

      RedirectionException

      +
      public RedirectionException(Response.Status status, + URI location)
      +
      Construct a new redirection exception.
      +
      +
      Parameters:
      +
      status - redirection status. Must be a 3xx redirection code.
      +
      location - redirection URI placed into the response Location header.
      +
      Throws:
      +
      IllegalArgumentException - in case the status code is null or is not from + Response.Status.Family.REDIRECTION status code family.
      +
      +
      +
      • +
    • +
      +

      RedirectionException

      +
      public RedirectionException(String message, + Response.Status status, + URI location)
      +
      Construct a new redirection exception.
      +
      +
      Parameters:
      +
      message - the detail message (which is saved for later retrieval by the Throwable.getMessage() method).
      +
      status - redirection status. Must be a 3xx redirection code.
      +
      location - redirection URI placed into the response Location header.
      +
      Throws:
      +
      IllegalArgumentException - in case the status code is null or is not from + Response.Status.Family.REDIRECTION status code family.
      +
      +
      +
      • +
    • +
      +

      RedirectionException

      +
      public RedirectionException(int status, + URI location)
      +
      Construct a new redirection exception.
      +
      +
      Parameters:
      +
      status - redirection status. Must be a 3xx redirection code.
      +
      location - redirection URI placed into the response Location header.
      +
      Throws:
      +
      IllegalArgumentException - in case the status code is not a valid HTTP status code or if it is not from the + Response.Status.Family.REDIRECTION status code family.
      +
      +
      +
      • +
    • +
      +

      RedirectionException

      +
      public RedirectionException(String message, + int status, + URI location)
      +
      Construct a new redirection exception.
      +
      +
      Parameters:
      +
      message - the detail message (which is saved for later retrieval by the Throwable.getMessage() method).
      +
      status - redirection status. Must be a 3xx redirection code.
      +
      location - redirection URI placed into the response Location header.
      +
      Throws:
      +
      IllegalArgumentException - in case the status code is not a valid HTTP status code or if it is not from the + Response.Status.Family.REDIRECTION status code family.
      +
      +
      +
      • +
    • +
      +

      RedirectionException

      +
      public RedirectionException(Response response)
      +
      Construct a new redirection exception.
      +
      +
      Parameters:
      +
      response - redirection response. Must have a status code set to a 3xx redirection code.
      +
      Throws:
      +
      IllegalArgumentException - in case the response status code is not from the + Response.Status.Family.REDIRECTION status code family.
      +
      +
      +
      • +
    • +
      +

      RedirectionException

      +
      public RedirectionException(String message, + Response response)
      +
      Construct a new redirection exception.
      +
      +
      Parameters:
      +
      message - the detail message (which is saved for later retrieval by the Throwable.getMessage() method).
      +
      response - redirection response. Must have a status code set to a 3xx redirection code.
      +
      Throws:
      +
      IllegalArgumentException - in case the response status code is not from the + Response.Status.Family.REDIRECTION status code family.
      +
      +
      +
      • +
    +
    +
    • + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      getLocation

      +
      public URI getLocation()
      +
      Get the redirection response location.
      +
      +
      Returns:
      +
      redirection response location.
      +
      +
      +
      • +
    +
    +
    • +
+
+ +
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/RuntimeType.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/RuntimeType.html new file mode 100644 index 0000000000..b18222abfd --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/RuntimeType.html @@ -0,0 +1,251 @@ + + + + +RuntimeType (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Module jakarta.ws.rs
+
Package jakarta.ws.rs
+

Enum Class RuntimeType

+
+
java.lang.Object +
java.lang.Enum<RuntimeType> +
jakarta.ws.rs.RuntimeType
+
+
+
+
+
All Implemented Interfaces:
+
Serializable, Comparable<RuntimeType>, Constable
+
+
+
public enum RuntimeType +extends Enum<RuntimeType>
+
Enumeration of JAX-RS runtime types.
+
+
Since:
+
2.0
+
Author:
+
Marek Potociar
+
+
+
+ +
+
+
    + +
  • +
    +

    Enum Constant Details

    +
      +
    • +
      +

      CLIENT

      +
      public static final RuntimeType CLIENT
      +
      JAX-RS client run-time.
      +
      +
      • +
    • +
      +

      SERVER

      +
      public static final RuntimeType SERVER
      +
      JAX-RS server run-time.
      +
      +
      • +
    +
    +
    • + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      values

      +
      public static RuntimeType[] values()
      +
      Returns an array containing the constants of this enum class, in +the order they are declared.
      +
      +
      Returns:
      +
      an array containing the constants of this enum class, in the order they are declared
      +
      +
      +
      • +
    • +
      +

      valueOf

      +
      public static RuntimeType valueOf(String name)
      +
      Returns the enum constant of this class with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this class. (Extraneous whitespace characters are +not permitted.)
      +
      +
      Parameters:
      +
      name - the name of the enum constant to be returned.
      +
      Returns:
      +
      the enum constant with the specified name
      +
      Throws:
      +
      IllegalArgumentException - if this enum class has no constant with the specified name
      +
      NullPointerException - if the argument is null
      +
      +
      +
      • +
    +
    +
    • +
+
+ +
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/SeBootstrap.Configuration.Builder.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/SeBootstrap.Configuration.Builder.html new file mode 100644 index 0000000000..b1560cdc3a --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/SeBootstrap.Configuration.Builder.html @@ -0,0 +1,424 @@ + + + + +SeBootstrap.Configuration.Builder (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Module jakarta.ws.rs
+
Package jakarta.ws.rs
+

Interface SeBootstrap.Configuration.Builder

+
+
+
+
Enclosing interface:
+
SeBootstrap.Configuration
+
+
+
public static interface SeBootstrap.Configuration.Builder
+
Builder for bootstrap SeBootstrap.Configuration.
+
+
Since:
+
3.1
+
Author:
+
Markus KARG (markus@headcrashing.eu)
+
+
+
+ +
+
+
    + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      build

      +
      SeBootstrap.Configuration build()
      +
      Builds a bootstrap configuration instance from the provided property values.
      +
      +
      Returns:
      +
      SeBootstrap.Configuration built from provided property values.
      +
      Since:
      +
      3.1
      +
      +
      +
      • +
    • +
      +

      property

      +
      SeBootstrap.Configuration.Builder property(String name, + Object value)
      +
      Sets the property name to the provided value. +

      + This method does not check the validity, type or syntax of the provided value. +

      +
      +
      Parameters:
      +
      name - name of the parameter to set.
      +
      value - value to set, or null to use the default value.
      +
      Returns:
      +
      the updated builder.
      +
      Since:
      +
      3.1
      +
      +
      +
      • +
    • +
      +

      protocol

      +
      default SeBootstrap.Configuration.Builder protocol(String protocol)
      +
      Convenience method to set the protocol to be used. +

      + Same as if calling property(PROTOCOL, value). +

      +
      +
      Parameters:
      +
      protocol - protocol parameter of this configuration, or null to use the default value.
      +
      Returns:
      +
      the updated builder.
      +
      Since:
      +
      3.1
      +
      See Also:
      +
      + +
      +
      +
      +
      • +
    • +
      +

      host

      +
      default SeBootstrap.Configuration.Builder host(String host)
      +
      Convenience method to set the host to be used. +

      + Same as if calling property(HOST, value). +

      +
      +
      Parameters:
      +
      host - host parameter (IP address or hostname) of this configuration, or null to use the default value.
      +
      Returns:
      +
      the updated builder.
      +
      Since:
      +
      3.1
      +
      See Also:
      +
      + +
      +
      +
      +
      • +
    • +
      +

      port

      +
      default SeBootstrap.Configuration.Builder port(Integer port)
      +
      Convenience method to set the port to be used. +

      + Same as if calling property(PORT, value). +

      +
      +
      Parameters:
      +
      port - port parameter of this configuration, or null to use the default value.
      +
      Returns:
      +
      the updated builder.
      +
      Since:
      +
      3.1
      +
      See Also:
      +
      + +
      +
      +
      +
      • +
    • +
      +

      rootPath

      +
      default SeBootstrap.Configuration.Builder rootPath(String rootPath)
      +
      Convenience method to set the rootPath to be used. +

      + Same as if calling property(ROOT_PATH, value). +

      +
      +
      Parameters:
      +
      rootPath - rootPath parameter of this configuration, or null to use the default value.
      +
      Returns:
      +
      the updated builder.
      +
      Since:
      +
      3.1
      +
      See Also:
      +
      + +
      +
      +
      +
      • +
    • +
      +

      sslContext

      +
      default SeBootstrap.Configuration.Builder sslContext(SSLContext sslContext)
      +
      Convenience method to set the sslContext to be used. +

      + Same as if calling property(SSL_CONTEXT, value). +

      +
      +
      Parameters:
      +
      sslContext - sslContext parameter of this configuration, or null to use the default value.
      +
      Returns:
      +
      the updated builder.
      +
      Since:
      +
      3.1
      +
      See Also:
      +
      + +
      +
      +
      +
      • +
    • +
      +

      sslClientAuthentication

      +
      default SeBootstrap.Configuration.Builder sslClientAuthentication(SeBootstrap.Configuration.SSLClientAuthentication sslClientAuthentication)
      +
      Convenience method to set SSL client authentication policy. +

      + Same as if calling property(SSL_CLIENT_AUTHENTICATION, value). +

      +
      +
      Parameters:
      +
      sslClientAuthentication - SSL client authentication mode of this configuration
      +
      Returns:
      +
      the updated builder.
      +
      Since:
      +
      3.1
      +
      See Also:
      +
      + +
      +
      +
      +
      • +
    • +
      +

      from

      +
      <T> SeBootstrap.Configuration.Builder from(BiFunction<String,Class<T>,Optional<T>> propertiesProvider)
      +
      Convenience method for bulk-loading configuration from a property supplier. +

      + Implementations ask the passed provider function for the actual values of all their supported properties, before + returning from this configuration method. For each single request the implementation provides the name of the + property and the expected data type of the value. If no such property exists (i. e. either the name is unknown or + misspelled, or the type does not exactly match), the Optional is empty. +

      +
      +
      Type Parameters:
      +
      T - Type of the requested property value.
      +
      Parameters:
      +
      propertiesProvider - Retrieval function of externally managed properties. MUST NOT return null.
      +
      Returns:
      +
      the updated builder.
      +
      Since:
      +
      3.1
      +
      +
      +
      • +
    • +
      +

      from

      +
      default SeBootstrap.Configuration.Builder from(Object externalConfig)
      +
      Optional convenience method to bulk-load external configuration. +

      + Implementations are free to support any external configuration mechanics, or none at all. It is completely up to the + implementation what set of properties is effectively loaded from the provided external configuration, possibly none + at all. +

      +

      + If the passed external configuration mechanics is unsupported, this method MUST simply do nothing. +

      +

      + Portable applications should not call this method, as the outcome is completely implementation-specific. +

      +
      +
      Parameters:
      +
      externalConfig - source of externally managed properties
      +
      Returns:
      +
      the updated builder.
      +
      Since:
      +
      3.1
      +
      +
      +
      • +
    +
    +
    • +
+
+ +
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/SeBootstrap.Configuration.SSLClientAuthentication.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/SeBootstrap.Configuration.SSLClientAuthentication.html new file mode 100644 index 0000000000..70b5b955af --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/SeBootstrap.Configuration.SSLClientAuthentication.html @@ -0,0 +1,284 @@ + + + + +SeBootstrap.Configuration.SSLClientAuthentication (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Module jakarta.ws.rs
+
Package jakarta.ws.rs
+

Enum Class SeBootstrap.Configuration.SSLClientAuthentication

+
+
java.lang.Object +
java.lang.Enum<SeBootstrap.Configuration.SSLClientAuthentication> +
jakarta.ws.rs.SeBootstrap.Configuration.SSLClientAuthentication
+
+
+
+
+
All Implemented Interfaces:
+
Serializable, Comparable<SeBootstrap.Configuration.SSLClientAuthentication>, Constable
+
+
+
Enclosing interface:
+
SeBootstrap.Configuration
+
+
+
public static enum SeBootstrap.Configuration.SSLClientAuthentication +extends Enum<SeBootstrap.Configuration.SSLClientAuthentication>
+
Secure socket client authentication policy + +

+ This policy is used in secure socket handshake to control whether the server requests client authentication, + and whether successful client authentication is mandatory (i. e. connection attempt will fail for + invalid clients). +

+
+
Since:
+
3.1
+
Author:
+
Markus KARG (markus@headcrashing.eu)
+
+
+
+ +
+
+
    + +
  • +
    +

    Enum Constant Details

    + +
    +
    • + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      values

      +
      public static SeBootstrap.Configuration.SSLClientAuthentication[] values()
      +
      Returns an array containing the constants of this enum class, in +the order they are declared.
      +
      +
      Returns:
      +
      an array containing the constants of this enum class, in the order they are declared
      +
      +
      +
      • +
    • +
      +

      valueOf

      +
      public static SeBootstrap.Configuration.SSLClientAuthentication valueOf(String name)
      +
      Returns the enum constant of this class with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this class. (Extraneous whitespace characters are +not permitted.)
      +
      +
      Parameters:
      +
      name - the name of the enum constant to be returned.
      +
      Returns:
      +
      the enum constant with the specified name
      +
      Throws:
      +
      IllegalArgumentException - if this enum class has no constant with the specified name
      +
      NullPointerException - if the argument is null
      +
      +
      +
      • +
    +
    +
    • +
+
+ +
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/SeBootstrap.Configuration.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/SeBootstrap.Configuration.html new file mode 100644 index 0000000000..c351d9ecaf --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/SeBootstrap.Configuration.html @@ -0,0 +1,689 @@ + + + + +SeBootstrap.Configuration (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Module jakarta.ws.rs
+
Package jakarta.ws.rs
+

Interface SeBootstrap.Configuration

+
+
+
+
Enclosing interface:
+
SeBootstrap
+
+
+
public static interface SeBootstrap.Configuration
+
Provides information needed by the JAX-RS implementation for bootstrapping an application. +

+ The configuration essentially consists of a set of parameters. While the set of actually effective keys is product + specific, the key constants defined by the SeBootstrap.Configuration interface MUST be effective on all compliant + products. Any unknown key MUST be silently ignored. +

+
+
Since:
+
3.1
+
Author:
+
Markus KARG (markus@headcrashing.eu)
+
+
+
+
    + +
  • +
    +

    Nested Class Summary

    +
    Nested Classes
    +
    +
    Modifier and Type
    +
    Interface
    +
    Description
    +
    static interface 
    +
    SeBootstrap.Configuration.Builder
    +
    +
    Builder for bootstrap SeBootstrap.Configuration.
    +
    +
    static enum 
    +
    SeBootstrap.Configuration.SSLClientAuthentication
    +
    +
    Secure socket client authentication policy
    +
    +
    +
    +
    • + +
  • +
    +

    Field Summary

    +
    Fields
    +
    +
    Modifier and Type
    +
    Field
    +
    Description
    +
    static final int
    +
    DEFAULT_PORT
    +
    +
    Special value for PORT property indicating that the implementation MUST use its default port.
    +
    +
    static final int
    +
    FREE_PORT
    +
    +
    Special value for PORT property indicating that the implementation MUST scan for a free port.
    +
    +
    static final String
    +
    HOST
    +
    +
    Configuration key for the hostname or IP address an application is bound to.
    +
    +
    static final String
    +
    PORT
    +
    +
    Configuration key for the TCP port an application is bound to.
    +
    +
    static final String
    +
    PROTOCOL
    +
    +
    Configuration key for the protocol an application is bound to.
    +
    +
    static final String
    +
    ROOT_PATH
    +
    +
    Configuration key for the root path an application is bound to.
    +
    +
    static final String
    +
    SSL_CLIENT_AUTHENTICATION
    +
    +
    Configuration key for the secure socket client authentication policy.
    +
    +
    static final String
    +
    SSL_CONTEXT
    +
    +
    Configuration key for the secure socket configuration to be used.
    +
    +
    +
    +
    • + +
  • +
    +

    Method Summary

    +
    +
    +
    +
    +
    Modifier and Type
    +
    Method
    +
    Description
    +
    default URI
    +
    baseUri()
    +
    +
    Convenience method that returns a built the URI for the application.
    +
    +
    default UriBuilder
    +
    baseUriBuilder()
    +
    +
    Returns a UriBuilder that includes the application root path.
    +
    +
    static SeBootstrap.Configuration.Builder
    +
    builder()
    +
    +
    Creates a new bootstrap configuration builder instance.
    +
    +
    default boolean
    +
    hasProperty(String name)
    +
    +
    Returns whether the property with the given name is configured, either explicitly or by default.
    +
    +
    default String
    +
    host()
    +
    +
    Convenience method to get the host to be used.
    +
    +
    default int
    +
    port()
    +
    +
    Convenience method to get the actually used port.
    +
    +
    Object
    +
    property(String name)
    +
    +
    Returns the value of the property with the given name, or null if there is no property of that name.
    +
    +
    default String
    +
    protocol()
    +
    +
    Convenience method to get the protocol to be used.
    +
    +
    default String
    +
    rootPath()
    +
    +
    Convenience method to get the rootPath to be used.
    +
    +
    default SeBootstrap.Configuration.SSLClientAuthentication
    +
    sslClientAuthentication()
    +
    +
    Convenience method to get the secure socket client authentication policy.
    +
    +
    default SSLContext
    +
    sslContext()
    +
    +
    Convenience method to get the sslContext to be used.
    +
    +
    +
    +
    +
    +
    • +
+
+
+
    + +
  • +
    +

    Field Details

    +
      +
    • +
      +

      PROTOCOL

      +
      static final String PROTOCOL
      +
      Configuration key for the protocol an application is bound to. +

      + A compliant implementation at least MUST accept the strings "HTTP" and "HTTPS" if these protocols are + supported. +

      +

      + The default value is "HTTP". +

      +
      +
      Since:
      +
      3.1
      +
      See Also:
      +
      + +
      +
      +
      +
      • +
    • +
      +

      HOST

      +
      static final String HOST
      +
      Configuration key for the hostname or IP address an application is bound to. +

      + A compliant implementation at least MUST accept string values bearing hostnames, IP4 address text representations, + and IP6 address text representations. If a hostname string, the special IP4 address string "0.0.0.0" or + "::" for IP6 is provided, the application MUST be bound to all IP addresses assigned to that + hostname. If the hostname string is "localhost" the application MUST be bound to the local host's loopback + adapter only. +

      +

      + The default value is "localhost". +

      +
      +
      Since:
      +
      3.1
      +
      See Also:
      +
      + +
      +
      +
      +
      • +
    • +
      +

      PORT

      +
      static final String PORT
      +
      Configuration key for the TCP port an application is bound to. + +

      + A compliant implementation MUST accept java.lang.Integer values. +

      +

      + There is no default port mandated by this specification, but the default value of this property is + DEFAULT_PORT (i. e. -1). A compliant implementation MUST use its own default port when + the value -1 is provided, and MAY apply (but is not obligated to) auto-selection and + range-scanning algorithms. +

      +
      +
      Since:
      +
      3.1
      +
      See Also:
      +
      + +
      +
      +
      +
      • +
    • +
      +

      ROOT_PATH

      +
      static final String ROOT_PATH
      +
      Configuration key for the root path an application is bound to. +

      + The default value is "/". +

      +
      +
      Since:
      +
      3.1
      +
      See Also:
      +
      + +
      +
      +
      +
      • +
    • +
      +

      SSL_CONTEXT

      +
      static final String SSL_CONTEXT
      +
      Configuration key for the secure socket configuration to be used. +

      + The default value is SSLContext.getDefault(). +

      +
      +
      Since:
      +
      3.1
      +
      See Also:
      +
      + +
      +
      +
      +
      • +
    • +
      +

      SSL_CLIENT_AUTHENTICATION

      +
      static final String SSL_CLIENT_AUTHENTICATION
      +
      Configuration key for the secure socket client authentication policy. + +

      + A compliant implementation MUST accept SeBootstrap.Configuration.SSLClientAuthentication enums. +

      +

      + The default value is SSLClientAuthentication#NONE. +

      +
      +
      Since:
      +
      3.1
      +
      See Also:
      +
      + +
      +
      +
      +
      • +
    • +
      +

      FREE_PORT

      +
      static final int FREE_PORT
      +
      Special value for PORT property indicating that the implementation MUST scan for a free port.
      +
      +
      Since:
      +
      3.1
      +
      See Also:
      +
      + +
      +
      +
      +
      • +
    • +
      +

      DEFAULT_PORT

      +
      static final int DEFAULT_PORT
      +
      Special value for PORT property indicating that the implementation MUST use its default port.
      +
      +
      Since:
      +
      3.1
      +
      See Also:
      +
      + +
      +
      +
      +
      • +
    +
    +
    • + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      property

      +
      Object property(String name)
      +
      Returns the value of the property with the given name, or null if there is no property of that name.
      +
      +
      Parameters:
      +
      name - a String specifying the name of the property.
      +
      Returns:
      +
      an Object containing the value of the property, or null if no property exists matching the + given name.
      +
      Since:
      +
      3.1
      +
      +
      +
      • +
    • +
      +

      hasProperty

      +
      default boolean hasProperty(String name)
      +
      Returns whether the property with the given name is configured, either explicitly or by default.
      +
      +
      Parameters:
      +
      name - a String specifying the name of the property.
      +
      Returns:
      +
      false if no property exists matching the given name, true otherwise.
      +
      Since:
      +
      3.1
      +
      +
      +
      • +
    • +
      +

      protocol

      +
      default String protocol()
      +
      Convenience method to get the protocol to be used. +

      + Same as if calling (String) property(PROTOCOL). +

      +
      +
      Returns:
      +
      protocol to be used (e. g. "HTTP").
      +
      Throws:
      +
      ClassCastException - if protocol is not a String.
      +
      Since:
      +
      3.1
      +
      See Also:
      +
      + +
      +
      +
      +
      • +
    • +
      +

      host

      +
      default String host()
      +
      Convenience method to get the host to be used. +

      + Same as if calling (String) property(HOST). +

      +
      +
      Returns:
      +
      host name or IP address to be used (e. g. "localhost" or "0.0.0.0").
      +
      Throws:
      +
      ClassCastException - if host is not a String.
      +
      Since:
      +
      3.1
      +
      See Also:
      +
      + +
      +
      +
      +
      • +
    • +
      +

      port

      +
      default int port()
      +
      Convenience method to get the actually used port. +

      + Same as if calling (int) property(PORT). +

      +

      + If the port was not explicitly given, this will return the port chosen implicitly by the JAX-RS + implementation. +

      +
      +
      Returns:
      +
      port number actually used (e. g. 8080).
      +
      Throws:
      +
      ClassCastException - if port is not an Integer.
      +
      Since:
      +
      3.1
      +
      See Also:
      +
      + +
      +
      +
      +
      • +
    • +
      +

      rootPath

      +
      default String rootPath()
      +
      Convenience method to get the rootPath to be used. +

      + Same as if calling (String) property(ROOT_PATH). +

      +
      +
      Returns:
      +
      root path to be used, e.g. "/".
      +
      Throws:
      +
      ClassCastException - if root path is not a String.
      +
      Since:
      +
      3.1
      +
      See Also:
      +
      + +
      +
      +
      +
      • +
    • +
      +

      sslContext

      +
      default SSLContext sslContext()
      +
      Convenience method to get the sslContext to be used. +

      + Same as if calling (SSLContext) property(SSL_CONTEXT). +

      +
      +
      Returns:
      +
      root path to be used, e. g. "/".
      +
      Throws:
      +
      ClassCastException - if sslContext is not a SSLContext.
      +
      Since:
      +
      3.1
      +
      See Also:
      +
      + +
      +
      +
      +
      • +
    • +
      +

      sslClientAuthentication

      +
      default SeBootstrap.Configuration.SSLClientAuthentication sslClientAuthentication()
      +
      Convenience method to get the secure socket client authentication policy. +

      + Same as if calling (SSLClientAuthentication) property(SSL_CLIENT_AUTHENTICATION). +

      +
      +
      Returns:
      +
      client authentication mode, e. g. NONE.
      +
      Throws:
      +
      ClassCastException - if sslClientAuthentication is not a SeBootstrap.Configuration.SSLClientAuthentication.
      +
      Since:
      +
      3.1
      +
      See Also:
      +
      + +
      +
      +
      +
      • +
    • +
      +

      baseUriBuilder

      +
      default UriBuilder baseUriBuilder()
      +
      Returns a UriBuilder that includes the application root path.
      +
      +
      Returns:
      +
      a UriBuilder for the application.
      +
      Since:
      +
      3.1
      +
      +
      +
      • +
    • +
      +

      baseUri

      +
      default URI baseUri()
      +
      Convenience method that returns a built the URI for the application.
      +
      +
      Returns:
      +
      a built URI for the application.
      +
      Since:
      +
      3.1
      +
      See Also:
      +
      + +
      +
      +
      +
      • +
    • +
      +

      builder

      +
      static SeBootstrap.Configuration.Builder builder()
      +
      Creates a new bootstrap configuration builder instance.
      +
      +
      Returns:
      +
      SeBootstrap.Configuration.Builder for bootstrap configuration.
      +
      Since:
      +
      3.1
      +
      +
      +
      • +
    +
    +
    • +
+
+ +
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/SeBootstrap.Instance.StopResult.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/SeBootstrap.Instance.StopResult.html new file mode 100644 index 0000000000..9803008696 --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/SeBootstrap.Instance.StopResult.html @@ -0,0 +1,176 @@ + + + + +SeBootstrap.Instance.StopResult (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Module jakarta.ws.rs
+
Package jakarta.ws.rs
+

Interface SeBootstrap.Instance.StopResult

+
+
+
+
Enclosing interface:
+
SeBootstrap.Instance
+
+
+
public static interface SeBootstrap.Instance.StopResult
+
Result of stopping the application instance.
+
+
Since:
+
3.1
+
Author:
+
Markus KARG (markus@headcrashing.eu)
+
+
+
+
    + +
  • +
    +

    Method Summary

    +
    +
    +
    +
    +
    Modifier and Type
    +
    Method
    +
    Description
    +
    <T> T
    +
    unwrap(Class<T> nativeClass)
    +
    +
    Provides access to the wrapped native shutdown result.
    +
    +
    +
    +
    +
    +
    • +
+
+
+
    + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      unwrap

      +
      <T> T unwrap(Class<T> nativeClass)
      +
      Provides access to the wrapped native shutdown result. +

      + Implementations may, or may not, have native shutdown results. Portable applications should not invoke this method, + as the outcome is undefined. +

      +
      +
      Type Parameters:
      +
      T - Requested type of the native result to return.
      +
      Parameters:
      +
      nativeClass - Requested type of the native result to return.
      +
      Returns:
      +
      Native result of shutting down the running application instance or null if the implementation has no + native result.
      +
      Throws:
      +
      ClassCastException - if the result is not null or is not assignable to the type T.
      +
      Since:
      +
      3.1
      +
      +
      +
      • +
    +
    +
    • +
+
+ +
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/SeBootstrap.Instance.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/SeBootstrap.Instance.html new file mode 100644 index 0000000000..9fd7f3888b --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/SeBootstrap.Instance.html @@ -0,0 +1,254 @@ + + + + +SeBootstrap.Instance (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Module jakarta.ws.rs
+
Package jakarta.ws.rs
+

Interface SeBootstrap.Instance

+
+
+
+
Enclosing interface:
+
SeBootstrap
+
+
+
public static interface SeBootstrap.Instance
+
Handle of the running application instance.
+
+
Since:
+
3.1
+
Author:
+
Markus KARG (markus@headcrashing.eu)
+
+
+
+ +
+
+
    + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      configuration

      +
      SeBootstrap.Configuration configuration()
      +
      Provides access to the configuration actually used by the implementation used to create this instance. +

      + This may, or may not, be the same instance passed to SeBootstrap.start(Application, Configuration), not even an + equal instance, as implementations MAY create a new intance and MUST update at least the PORT property with + the actually used value. Portable applications should not make any assumptions but always explicitly read the actual + values from the configuration returned from this method. +

      +
      +
      Returns:
      +
      The configuration actually used to create this instance.
      +
      Since:
      +
      3.1
      +
      +
      +
      • +
    • +
      +

      stop

      +
      CompletionStage<SeBootstrap.Instance.StopResult> stop()
      +
      Initiate immediate shutdown of running application instance.
      +
      +
      Returns:
      +
      CompletionStage asynchronously shutting down this application instance.
      +
      Since:
      +
      3.1
      +
      +
      +
      • +
    • +
      +

      unwrap

      +
      <T> T unwrap(Class<T> nativeClass)
      +
      Provides access to the wrapped native handle of the application instance. +

      + Implementations may, or may not, have native handles. Portable applications should not invoke this method, as the + outcome is undefined. +

      +
      +
      Type Parameters:
      +
      T - Requested type of the native handle to return.
      +
      Parameters:
      +
      nativeClass - Requested type of the native handle to return.
      +
      Returns:
      +
      Native handle of the running application instance or null if the implementation has no native handle.
      +
      Throws:
      +
      ClassCastException - if the handle is not null and is not assignable to the type T.
      +
      Since:
      +
      3.1
      +
      +
      +
      • +
    • +
      +

      stopOnShutdown

      +
      default void stopOnShutdown(Consumer<SeBootstrap.Instance.StopResult> consumer)
      +
      Registers a consumer for a SeBootstrap.Instance.StopResult which will be executed in a new thread + during the JVM shutdown phase.
      +
      +
      Parameters:
      +
      consumer - The consumer.
      +
      Since:
      +
      3.1
      +
      +
      +
      • +
    +
    +
    • +
+
+ +
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/SeBootstrap.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/SeBootstrap.html new file mode 100644 index 0000000000..94d6b19139 --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/SeBootstrap.html @@ -0,0 +1,387 @@ + + + + +SeBootstrap (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Module jakarta.ws.rs
+
Package jakarta.ws.rs
+

Interface SeBootstrap

+
+
+
+
public interface SeBootstrap
+
Bootstrap class used to startup a JAX-RS application in Java SE environments. +

+ The SeBootstrap class is available in a Jakarta EE container environment as well; however, support for the Java SE + bootstrapping APIs is not required in container environments. +

+

+ In a Java SE environment an application is getting started by the following command using default configuration + values (i. e. mounting application at http://localhost:80/ or a different port (there is no + particular default port mandated by this specification). As the JAX-RS implementation is free to choose any port + by default, the caller will not know the actual port unless explicitly checking the actual configuration of the + instance started: +

+ + 
+ Application app = new MyApplication();
+ SeBootstrap.Configuration config = SeBootstrap.Configuration.builder().build();
+ SeBootstrap.start(app, config).thenAccept(instance -> instance.configuration().port());
+
+ +

+ Running instances can be instructed to stop serving the application: +

+ + 
+ SeBootstrap.start(app, config).thenAccept(instance -> { ... instance.stop(); } );
+
+ +

+ A shutdown callback can be registered which will get invoked once the implementation stops serving the application: +

+ + 
+ instance.stop().thenAccept(stopResult -> ...));
+
+ + stopResult is not further defined but solely acts as a wrapper around a native result provided by the + particular JAX-RS implementation. Portable applications should not assume any particular data type or value. + +

+ Protocol, host address, port and root path can be overridden explicitly. As the JAX-RS implementation is bound to + that values, no querying of the actual configuration is needed in that case: +

+ + 
+ SeBootstrap.Configuration.builder().protocol("HTTPS").host("0.0.0.0").port(8443).rootPath("api").build();
+
+ +

+ TLS can be configured by explicitly passing a customized SSLContext: +

+ + 
+ SSLContext tls = SSLContext.getInstance("TLSv1.2");
+ // ...further initialize context here (see JSSE API)...
+ SeBootstrap.Configuration.builder().protocol("HTTPS").sslContext(tls).build();
+
+ +

+ In case of HTTPS, client authentication can be enforced to ensure that only trustworthy clients can connect: +

+ + 
+ SeBootstrap.Configuration.builder().protocol("HTTPS").sslClientAuthentication(SSLClientAuthentication.MANDATORY).build();
+
+ +

+ Implementations are free to support more use cases by native properties, which effectively render the application + non-portable: +

+ + 
+ SeBootstrap.Configuration.builder().property("productname.foo", "bar").build()
+
+ +

+ Bulk-loading allows to attach configuration storages easily without the need to write down all properties to be + transferred. Hence, even properties unknown to the application author will get channeled into the implementation. + This can be done both, explicitly (hence portable) and implicitly (hence not necessarily portable as no + particular configuration mechanics are required to be supported by compliant implementations): +

+ + 
+ // Explicit use of particular configuration mechanics is portable
+ SeBootstrap.Configuration.builder().from((name, type) -> externalConfigurationSystem.getValue(name, type)).build();
+
+ // Implicitly relying on the support of particular configuration mechanics by
+ // the actual JAX-RS implementation is not necessarily portable
+ SeBootstrap.Configuration.builder().from(externalConfigurationSystem).build();
+
+
+
Since:
+
3.1
+
Author:
+
Markus KARG (markus@headcrashing.eu)
+
+
+
+ +
+
+
    + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      start

      +
      static CompletionStage<SeBootstrap.Instance> start(Application application, + SeBootstrap.Configuration configuration)
      +
      Starts the provided application using the specified configuration. + +

      + This method is intended to be used in Java SE environments only. The outcome of invocations in Jakarta EE container + environments is undefined. +

      +
      +
      Parameters:
      +
      application - The application to start up.
      +
      configuration - Provides information needed for bootstrapping the application.
      +
      Returns:
      +
      CompletionStage (possibly asynchronously) producing handle of the running application + instance.
      +
      Since:
      +
      3.1
      +
      See Also:
      +
      + +
      +
      +
      +
      • +
    • +
      +

      start

      +
      static CompletionStage<SeBootstrap.Instance> start(Application application)
      +
      Starts the provided application using a default configuration. + +

      + This method is intended to be used in Java SE environments only. The outcome of invocations in Jakarta EE container + environments is undefined. +

      +
      +
      Parameters:
      +
      application - The application to start up.
      +
      Returns:
      +
      CompletionStage (possibly asynchronously) producing handle of the running application + instance.
      +
      Since:
      +
      3.1
      +
      See Also:
      +
      + +
      +
      +
      +
      • +
    • +
      +

      start

      +
      static CompletionStage<SeBootstrap.Instance> start(Class<? extends Application> clazz, + SeBootstrap.Configuration configuration)
      +
      Starts the provided application using the specified configuration. Creates application instance + from class using default constructor. Injection is not supported. + +

      + This method is intended to be used in Java SE environments only. The outcome of invocations in Jakarta EE container + environments is undefined. +

      +
      +
      Parameters:
      +
      clazz - The application class.
      +
      configuration - Provides information needed for bootstrapping the application.
      +
      Returns:
      +
      CompletionStage (possibly asynchronously) producing handle of the running application + instance.
      +
      Since:
      +
      3.1
      +
      See Also:
      +
      + +
      +
      +
      +
      • +
    • +
      +

      start

      +
      static CompletionStage<SeBootstrap.Instance> start(Class<? extends Application> clazz)
      +
      Starts the provided application using a default configuration. Creates application instance + from class using default constructor. Injection is not supported. + +

      + This method is intended to be used in Java SE environments only. The outcome of invocations in Jakarta EE container + environments is undefined. +

      +
      +
      Parameters:
      +
      clazz - The application class.
      +
      Returns:
      +
      CompletionStage (possibly asynchronously) producing handle of the running application + instance.
      +
      Since:
      +
      3.1
      +
      See Also:
      +
      + +
      +
      +
      +
      • +
    +
    +
    • +
+
+ +
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/ServerErrorException.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/ServerErrorException.html new file mode 100644 index 0000000000..d4e73df91f --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/ServerErrorException.html @@ -0,0 +1,431 @@ + + + + +ServerErrorException (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Module jakarta.ws.rs
+
Package jakarta.ws.rs
+

Class ServerErrorException

+
+
java.lang.Object +
java.lang.Throwable +
java.lang.Exception +
java.lang.RuntimeException +
jakarta.ws.rs.WebApplicationException +
jakarta.ws.rs.ServerErrorException
+
+
+
+
+
+
+
+
All Implemented Interfaces:
+
Serializable
+
+
+
Direct Known Subclasses:
+
InternalServerErrorException, ServiceUnavailableException
+
+
+
public class ServerErrorException +extends WebApplicationException
+
A base runtime application exception indicating a server error (HTTP 5xx status codes).
+
+
Since:
+
2.0
+
Author:
+
Marek Potociar
+
See Also:
+
+ +
+
+
+
+ +
+
+
    + +
  • +
    +

    Constructor Details

    +
      +
    • +
      +

      ServerErrorException

      +
      public ServerErrorException(Response.Status status)
      +
      Construct a new server error exception.
      +
      +
      Parameters:
      +
      status - server error status. Must be a 5xx status code.
      +
      Throws:
      +
      IllegalArgumentException - in case the status code is null or is not from + Response.Status.Family.SERVER_ERROR status code family.
      +
      +
      +
      • +
    • +
      +

      ServerErrorException

      +
      public ServerErrorException(String message, + Response.Status status)
      +
      Construct a new server error exception.
      +
      +
      Parameters:
      +
      message - the detail message (which is saved for later retrieval by the Throwable.getMessage() method).
      +
      status - server error status. Must be a 5xx status code.
      +
      Throws:
      +
      IllegalArgumentException - in case the status code is null or is not from + Response.Status.Family.SERVER_ERROR status code family.
      +
      +
      +
      • +
    • +
      +

      ServerErrorException

      +
      public ServerErrorException(int status)
      +
      Construct a new server error exception.
      +
      +
      Parameters:
      +
      status - server error status. Must be a 5xx status code.
      +
      Throws:
      +
      IllegalArgumentException - in case the status code is not a valid HTTP status code or if it is not from the + Response.Status.Family.SERVER_ERROR status code family.
      +
      +
      +
      • +
    • +
      +

      ServerErrorException

      +
      public ServerErrorException(String message, + int status)
      +
      Construct a new server error exception.
      +
      +
      Parameters:
      +
      message - the detail message (which is saved for later retrieval by the Throwable.getMessage() method).
      +
      status - server error status. Must be a 5xx status code.
      +
      Throws:
      +
      IllegalArgumentException - in case the status code is not a valid HTTP status code or if it is not from the + Response.Status.Family.SERVER_ERROR status code family.
      +
      +
      +
      • +
    • +
      +

      ServerErrorException

      +
      public ServerErrorException(Response response)
      +
      Construct a new server error exception.
      +
      +
      Parameters:
      +
      response - server error response. Must have a status code set to a 5xx status code.
      +
      Throws:
      +
      IllegalArgumentException - in case the response status code is not from the + Response.Status.Family.SERVER_ERROR status code family.
      +
      +
      +
      • +
    • +
      +

      ServerErrorException

      +
      public ServerErrorException(String message, + Response response)
      +
      Construct a new server error exception.
      +
      +
      Parameters:
      +
      message - the detail message (which is saved for later retrieval by the Throwable.getMessage() method).
      +
      response - server error response. Must have a status code set to a 5xx status code.
      +
      Throws:
      +
      IllegalArgumentException - in case the response status code is not from the + Response.Status.Family.SERVER_ERROR status code family.
      +
      +
      +
      • +
    • +
      +

      ServerErrorException

      +
      public ServerErrorException(Response.Status status, + Throwable cause)
      +
      Construct a new server error exception.
      +
      +
      Parameters:
      +
      status - server error status. Must be a 5xx status code.
      +
      cause - the underlying cause of the exception.
      +
      Throws:
      +
      IllegalArgumentException - in case the status code is null or is not from + Response.Status.Family.SERVER_ERROR status code family.
      +
      +
      +
      • +
    • +
      +

      ServerErrorException

      +
      public ServerErrorException(String message, + Response.Status status, + Throwable cause)
      +
      Construct a new server error exception.
      +
      +
      Parameters:
      +
      message - the detail message (which is saved for later retrieval by the Throwable.getMessage() method).
      +
      status - server error status. Must be a 5xx status code.
      +
      cause - the underlying cause of the exception.
      +
      Throws:
      +
      IllegalArgumentException - in case the status code is null or is not from + Response.Status.Family.SERVER_ERROR status code family.
      +
      +
      +
      • +
    • +
      +

      ServerErrorException

      +
      public ServerErrorException(int status, + Throwable cause)
      +
      Construct a new server error exception.
      +
      +
      Parameters:
      +
      status - server error status. Must be a 5xx status code.
      +
      cause - the underlying cause of the exception.
      +
      Throws:
      +
      IllegalArgumentException - in case the status code is not a valid HTTP status code or if it is not from the + Response.Status.Family.SERVER_ERROR status code family.
      +
      +
      +
      • +
    • +
      +

      ServerErrorException

      +
      public ServerErrorException(String message, + int status, + Throwable cause)
      +
      Construct a new server error exception.
      +
      +
      Parameters:
      +
      message - the detail message (which is saved for later retrieval by the Throwable.getMessage() method).
      +
      status - server error status. Must be a 5xx status code.
      +
      cause - the underlying cause of the exception.
      +
      Throws:
      +
      IllegalArgumentException - in case the status code is not a valid HTTP status code or if it is not from the + Response.Status.Family.SERVER_ERROR status code family.
      +
      +
      +
      • +
    • +
      +

      ServerErrorException

      +
      public ServerErrorException(Response response, + Throwable cause)
      +
      Construct a new server error exception.
      +
      +
      Parameters:
      +
      response - server error response. Must have a status code set to a 5xx status code.
      +
      cause - the underlying cause of the exception.
      +
      Throws:
      +
      IllegalArgumentException - in case the response status code is not from the + Response.Status.Family.SERVER_ERROR status code family.
      +
      +
      +
      • +
    • +
      +

      ServerErrorException

      +
      public ServerErrorException(String message, + Response response, + Throwable cause)
      +
      Construct a new server error exception.
      +
      +
      Parameters:
      +
      message - the detail message (which is saved for later retrieval by the Throwable.getMessage() method).
      +
      response - server error response. Must have a status code set to a 5xx status code.
      +
      cause - the underlying cause of the exception.
      +
      Throws:
      +
      IllegalArgumentException - in case the response status code is not from the + Response.Status.Family.SERVER_ERROR status code family.
      +
      +
      +
      • +
    +
    +
    • +
+
+ +
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/ServiceUnavailableException.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/ServiceUnavailableException.html new file mode 100644 index 0000000000..aebad99d2e --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/ServiceUnavailableException.html @@ -0,0 +1,505 @@ + + + + +ServiceUnavailableException (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Module jakarta.ws.rs
+
Package jakarta.ws.rs
+

Class ServiceUnavailableException

+
+
java.lang.Object +
java.lang.Throwable +
java.lang.Exception +
java.lang.RuntimeException +
jakarta.ws.rs.WebApplicationException +
jakarta.ws.rs.ServerErrorException +
jakarta.ws.rs.ServiceUnavailableException
+
+
+
+
+
+
+
+
+
All Implemented Interfaces:
+
Serializable
+
+
+
public class ServiceUnavailableException +extends ServerErrorException
+
A runtime exception indicating that the requested resource + cannot be served.
+
+
Since:
+
2.0
+
Author:
+
Marek Potociar
+
See Also:
+
+ +
+
+
+
+ +
+
+
    + +
  • +
    +

    Constructor Details

    +
      +
    • +
      +

      ServiceUnavailableException

      +
      public ServiceUnavailableException()
      +
      Construct a new "service unavailable" exception without any "Retry-After" information specified for the failed + request.
      +
      +
      • +
    • +
      +

      ServiceUnavailableException

      +
      public ServiceUnavailableException(String message)
      +
      Construct a new "service unavailable" exception without any "Retry-After" information specified for the failed + request.
      +
      +
      Parameters:
      +
      message - the detail message (which is saved for later retrieval by the Throwable.getMessage() method).
      +
      +
      +
      • +
    • +
      +

      ServiceUnavailableException

      +
      public ServiceUnavailableException(Long retryAfter)
      +
      Construct a new "service unavailable" exception with an interval specifying the "Retry-After" information for the + failed request.
      +
      +
      Parameters:
      +
      retryAfter - decimal interval in seconds after which the failed request may be retried.
      +
      +
      +
      • +
    • +
      +

      ServiceUnavailableException

      +
      public ServiceUnavailableException(String message, + Long retryAfter)
      +
      Construct a new "service unavailable" exception with an interval specifying the "Retry-After" information for the + failed request.
      +
      +
      Parameters:
      +
      message - the detail message (which is saved for later retrieval by the Throwable.getMessage() method).
      +
      retryAfter - decimal interval in seconds after which the failed request may be retried.
      +
      +
      +
      • +
    • +
      +

      ServiceUnavailableException

      +
      public ServiceUnavailableException(Date retryAfter)
      +
      Construct a new "service unavailable" exception with an interval specifying the "Retry-After" information for the + failed request.
      +
      +
      Parameters:
      +
      retryAfter - a date/time after which the failed request may be retried.
      +
      +
      +
      • +
    • +
      +

      ServiceUnavailableException

      +
      public ServiceUnavailableException(String message, + Date retryAfter)
      +
      Construct a new "service unavailable" exception with an interval specifying the "Retry-After" information for the + failed request.
      +
      +
      Parameters:
      +
      message - the detail message (which is saved for later retrieval by the Throwable.getMessage() method).
      +
      retryAfter - a date/time after which the failed request may be retried.
      +
      +
      +
      • +
    • +
      +

      ServiceUnavailableException

      +
      public ServiceUnavailableException(Response response)
      +
      Construct a new "service unavailable" exception.
      +
      +
      Parameters:
      +
      response - error response.
      +
      Throws:
      +
      IllegalArgumentException - in case the status code set in the response is not HTTP 503.
      +
      +
      +
      • +
    • +
      +

      ServiceUnavailableException

      +
      public ServiceUnavailableException(String message, + Response response)
      +
      Construct a new "service unavailable" exception.
      +
      +
      Parameters:
      +
      message - the detail message (which is saved for later retrieval by the Throwable.getMessage() method).
      +
      response - error response.
      +
      Throws:
      +
      IllegalArgumentException - in case the status code set in the response is not HTTP 503.
      +
      +
      +
      • +
    • +
      +

      ServiceUnavailableException

      +
      public ServiceUnavailableException(Date retryAfter, + Throwable cause)
      +
      Construct a new "service unavailable" exception with a date specifying the "Retry-After" information for the failed + request and an underlying request failure cause.
      +
      +
      Parameters:
      +
      retryAfter - a date/time after which the failed request may be retried.
      +
      cause - the underlying cause of the exception.
      +
      +
      +
      • +
    • +
      +

      ServiceUnavailableException

      +
      public ServiceUnavailableException(String message, + Date retryAfter, + Throwable cause)
      +
      Construct a new "service unavailable" exception with a date specifying the "Retry-After" information for the failed + request and an underlying request failure cause.
      +
      +
      Parameters:
      +
      message - the detail message (which is saved for later retrieval by the Throwable.getMessage() method).
      +
      retryAfter - a date/time after which the failed request may be retried.
      +
      cause - the underlying cause of the exception.
      +
      +
      +
      • +
    • +
      +

      ServiceUnavailableException

      +
      public ServiceUnavailableException(Long retryAfter, + Throwable cause)
      +
      Construct a new "service unavailable" exception with an interval specifying the "Retry-After" information for the + failed request and an underlying request failure cause.
      +
      +
      Parameters:
      +
      retryAfter - decimal interval in seconds after which the failed request may be retried.
      +
      cause - the underlying cause of the exception.
      +
      +
      +
      • +
    • +
      +

      ServiceUnavailableException

      +
      public ServiceUnavailableException(String message, + Long retryAfter, + Throwable cause)
      +
      Construct a new "service unavailable" exception with an interval specifying the "Retry-After" information for the + failed request and an underlying request failure cause.
      +
      +
      Parameters:
      +
      message - the detail message (which is saved for later retrieval by the Throwable.getMessage() method).
      +
      retryAfter - decimal interval in seconds after which the failed request may be retried.
      +
      cause - the underlying cause of the exception.
      +
      +
      +
      • +
    • +
      +

      ServiceUnavailableException

      +
      public ServiceUnavailableException(Response response, + Throwable cause)
      +
      Construct a new "service unavailable" exception.
      +
      +
      Parameters:
      +
      response - error response.
      +
      cause - the underlying cause of the exception.
      +
      Throws:
      +
      IllegalArgumentException - in case the status code set in the response is not HTTP 503.
      +
      +
      +
      • +
    • +
      +

      ServiceUnavailableException

      +
      public ServiceUnavailableException(String message, + Response response, + Throwable cause)
      +
      Construct a new "service unavailable" exception.
      +
      +
      Parameters:
      +
      message - the detail message (which is saved for later retrieval by the Throwable.getMessage() method).
      +
      response - error response.
      +
      cause - the underlying cause of the exception.
      +
      Throws:
      +
      IllegalArgumentException - in case the status code set in the response is not HTTP 503.
      +
      +
      +
      • +
    +
    +
    • + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      hasRetryAfter

      +
      public boolean hasRetryAfter()
      +
      Check if the underlying response contains the information on when is it possible to + HttpHeaders.RETRY_AFTER retry the request.
      +
      +
      Returns:
      +
      true in case the retry time is specified in the underlying response, false otherwise.
      +
      +
      +
      • +
    • +
      +

      getRetryTime

      +
      public Date getRetryTime(Date requestTime)
      +
      Get the retry time for the failed request.
      +
      +
      Parameters:
      +
      requestTime - time of sending the original request that may be used to compute the retry time (in case the retry + time information specified as a decimal interval in seconds).
      +
      Returns:
      +
      time when the request may be retried or null if there is no retry information available.
      +
      Throws:
      +
      NullPointerException - in case the requestTime parameter is null.
      +
      +
      +
      • +
    +
    +
    • +
+
+ +
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/WebApplicationException.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/WebApplicationException.html new file mode 100644 index 0000000000..f60a5ee18a --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/WebApplicationException.html @@ -0,0 +1,533 @@ + + + + +WebApplicationException (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Module jakarta.ws.rs
+
Package jakarta.ws.rs
+

Class WebApplicationException

+
+
java.lang.Object +
java.lang.Throwable +
java.lang.Exception +
java.lang.RuntimeException +
jakarta.ws.rs.WebApplicationException
+
+
+
+
+
+
+
All Implemented Interfaces:
+
Serializable
+
+
+
Direct Known Subclasses:
+
ClientErrorException, RedirectionException, ServerErrorException
+
+
+
public class WebApplicationException +extends RuntimeException
+
Runtime exception for applications. +

+ This exception may be thrown by a resource method, provider or StreamingOutput + implementation if a specific HTTP error response needs to be produced. Only effective if thrown prior to the response + being committed.

+
+
Since:
+
1.0
+
Author:
+
Paul Sandoz, Marek Potociar
+
See Also:
+
+ +
+
+
+
+ +
+
+
    + +
  • +
    +

    Constructor Details

    +
      +
    • +
      +

      WebApplicationException

      +
      public 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

      +
      public WebApplicationException(String message)
      +
      Construct a new instance with the supplied message and a default HTTP status code of 500.
      +
      +
      Parameters:
      +
      message - the detail message (which is saved for later retrieval by the Throwable.getMessage() method).
      +
      Since:
      +
      2.0
      +
      +
      +
      • +
    • +
      +

      WebApplicationException

      +
      public WebApplicationException(Response response)
      +
      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.
      +
      +
      Parameters:
      +
      response - the response that will be returned to the client, a value of null will be replaced with an internal + server error response (status code 500).
      +
      +
      +
      • +
    • +
      +

      WebApplicationException

      +
      public WebApplicationException(String message, + Response response)
      +
      Construct a new instance using the supplied message and response.
      +
      +
      Parameters:
      +
      message - the detail message (which is saved for later retrieval by the Throwable.getMessage() method).
      +
      response - the response that will be returned to the client, a value of null will be replaced with an internal + server error response (status code 500).
      +
      Since:
      +
      2.0
      +
      +
      +
      • +
    • +
      +

      WebApplicationException

      +
      public WebApplicationException(int status)
      +
      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.
      +
      +
      Parameters:
      +
      status - the HTTP status code that will be returned to the client.
      +
      +
      +
      • +
    • +
      +

      WebApplicationException

      +
      public WebApplicationException(String message, + int status)
      +
      Construct a new instance with a supplied message and HTTP status code.
      +
      +
      Parameters:
      +
      message - the detail message (which is saved for later retrieval by the Throwable.getMessage() method).
      +
      status - the HTTP status code that will be returned to the client.
      +
      Since:
      +
      2.0
      +
      +
      +
      • +
    • +
      +

      WebApplicationException

      +
      public WebApplicationException(Response.Status status)
      +
      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.
      +
      +
      Parameters:
      +
      status - the HTTP status code that will be returned to the client.
      +
      Throws:
      +
      IllegalArgumentException - if status is null.
      +
      +
      +
      • +
    • +
      +

      WebApplicationException

      +
      public WebApplicationException(String message, + Response.Status status)
      +
      Construct a new instance with the supplied message and HTTP status.
      +
      +
      Parameters:
      +
      message - the detail message (which is saved for later retrieval by the Throwable.getMessage() method).
      +
      status - the HTTP status code that will be returned to the client.
      +
      Throws:
      +
      IllegalArgumentException - if status is null.
      +
      Since:
      +
      2.0
      +
      +
      +
      • +
    • +
      +

      WebApplicationException

      +
      public WebApplicationException(Throwable cause)
      +
      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.
      +
      +
      Parameters:
      +
      cause - the underlying cause of the exception.
      +
      +
      +
      • +
    • +
      +

      WebApplicationException

      +
      public WebApplicationException(String message, + Throwable cause)
      +
      Construct a new instance with the supplied message, root cause and default HTTP status code of 500.
      +
      +
      Parameters:
      +
      message - the detail message (which is saved for later retrieval by the Throwable.getMessage() method).
      +
      cause - the underlying cause of the exception.
      +
      Since:
      +
      2.0
      +
      +
      +
      • +
    • +
      +

      WebApplicationException

      +
      public WebApplicationException(Throwable cause, + Response response)
      +
      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.
      +
      +
      Parameters:
      +
      cause - the underlying cause of the exception.
      +
      response - the response that will be returned to the client, a value of null will be replaced with an internal + server error response (status code 500).
      +
      +
      +
      • +
    • +
      +

      WebApplicationException

      +
      public WebApplicationException(String message, + Throwable cause, + Response response)
      +
      Construct a new instance with the supplied message, root cause and response.
      +
      +
      Parameters:
      +
      message - the detail message (which is saved for later retrieval by the Throwable.getMessage() method).
      +
      cause - the underlying cause of the exception.
      +
      response - the response that will be returned to the client, a value of null will be replaced with an internal + server error response (status code 500).
      +
      Since:
      +
      2.0
      +
      +
      +
      • +
    • +
      +

      WebApplicationException

      +
      public WebApplicationException(Throwable cause, + int status)
      +
      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.
      +
      +
      Parameters:
      +
      cause - the underlying cause of the exception.
      +
      status - the HTTP status code that will be returned to the client.
      +
      +
      +
      • +
    • +
      +

      WebApplicationException

      +
      public WebApplicationException(String message, + Throwable cause, + int status)
      +
      Construct a new instance with the supplied message, root cause and HTTP status code.
      +
      +
      Parameters:
      +
      message - the detail message (which is saved for later retrieval by the Throwable.getMessage() method).
      +
      cause - the underlying cause of the exception.
      +
      status - the HTTP status code that will be returned to the client.
      +
      Since:
      +
      2.0
      +
      +
      +
      • +
    • +
      +

      WebApplicationException

      +
      public WebApplicationException(Throwable cause, + Response.Status status) + throws IllegalArgumentException
      +
      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.
      +
      +
      Parameters:
      +
      cause - the underlying cause of the exception.
      +
      status - the HTTP status code that will be returned to the client.
      +
      Throws:
      +
      IllegalArgumentException - if status is null.
      +
      +
      +
      • +
    • +
      +

      WebApplicationException

      +
      public WebApplicationException(String message, + Throwable cause, + Response.Status status) + throws IllegalArgumentException
      +
      Construct a new instance with a the supplied message, root cause and HTTP status code.
      +
      +
      Parameters:
      +
      message - the detail message (which is saved for later retrieval by the Throwable.getMessage() method).
      +
      cause - the underlying cause of the exception.
      +
      status - the HTTP status code that will be returned to the client.
      +
      Throws:
      +
      IllegalArgumentException - if status is null.
      +
      Since:
      +
      2.0
      +
      +
      +
      • +
    +
    +
    • + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      getResponse

      +
      public Response getResponse()
      +
      Get the HTTP response.
      +
      +
      Returns:
      +
      the HTTP response.
      +
      +
      +
      • +
    +
    +
    • +
+
+ +
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/class-use/ApplicationPath.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/class-use/ApplicationPath.html new file mode 100644 index 0000000000..99401058f2 --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/class-use/ApplicationPath.html @@ -0,0 +1,63 @@ + + + + +Uses of Annotation Interface jakarta.ws.rs.ApplicationPath (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Annotation Interface
jakarta.ws.rs.ApplicationPath

+
+No usage of jakarta.ws.rs.ApplicationPath
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/class-use/BadRequestException.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/class-use/BadRequestException.html new file mode 100644 index 0000000000..85e3f323cf --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/class-use/BadRequestException.html @@ -0,0 +1,63 @@ + + + + +Uses of Class jakarta.ws.rs.BadRequestException (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
jakarta.ws.rs.BadRequestException

+
+No usage of jakarta.ws.rs.BadRequestException
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/class-use/BeanParam.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/class-use/BeanParam.html new file mode 100644 index 0000000000..486d9c67d5 --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/class-use/BeanParam.html @@ -0,0 +1,63 @@ + + + + +Uses of Annotation Interface jakarta.ws.rs.BeanParam (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Annotation Interface
jakarta.ws.rs.BeanParam

+
+No usage of jakarta.ws.rs.BeanParam
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/class-use/ClientErrorException.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/class-use/ClientErrorException.html new file mode 100644 index 0000000000..80b69c37b4 --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/class-use/ClientErrorException.html @@ -0,0 +1,128 @@ + + + + +Uses of Class jakarta.ws.rs.ClientErrorException (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
jakarta.ws.rs.ClientErrorException

+
+
Packages that use ClientErrorException
+
+
Package
+
Description
+
jakarta.ws.rs
+
+
High-level interfaces and annotations used to create RESTful service resources.
+
+
+
+ +
+
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/class-use/ConstrainedTo.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/class-use/ConstrainedTo.html new file mode 100644 index 0000000000..d531793742 --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/class-use/ConstrainedTo.html @@ -0,0 +1,63 @@ + + + + +Uses of Annotation Interface jakarta.ws.rs.ConstrainedTo (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Annotation Interface
jakarta.ws.rs.ConstrainedTo

+
+No usage of jakarta.ws.rs.ConstrainedTo
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/class-use/Consumes.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/class-use/Consumes.html new file mode 100644 index 0000000000..716995c142 --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/class-use/Consumes.html @@ -0,0 +1,63 @@ + + + + +Uses of Annotation Interface jakarta.ws.rs.Consumes (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Annotation Interface
jakarta.ws.rs.Consumes

+
+No usage of jakarta.ws.rs.Consumes
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/class-use/CookieParam.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/class-use/CookieParam.html new file mode 100644 index 0000000000..3af8d3b318 --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/class-use/CookieParam.html @@ -0,0 +1,63 @@ + + + + +Uses of Annotation Interface jakarta.ws.rs.CookieParam (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Annotation Interface
jakarta.ws.rs.CookieParam

+
+No usage of jakarta.ws.rs.CookieParam
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/class-use/DELETE.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/class-use/DELETE.html new file mode 100644 index 0000000000..9d637dd965 --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/class-use/DELETE.html @@ -0,0 +1,63 @@ + + + + +Uses of Annotation Interface jakarta.ws.rs.DELETE (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Annotation Interface
jakarta.ws.rs.DELETE

+
+No usage of jakarta.ws.rs.DELETE
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/class-use/DefaultValue.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/class-use/DefaultValue.html new file mode 100644 index 0000000000..05c0a1d9dd --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/class-use/DefaultValue.html @@ -0,0 +1,63 @@ + + + + +Uses of Annotation Interface jakarta.ws.rs.DefaultValue (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Annotation Interface
jakarta.ws.rs.DefaultValue

+
+No usage of jakarta.ws.rs.DefaultValue
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/class-use/Encoded.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/class-use/Encoded.html new file mode 100644 index 0000000000..1330bf7bea --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/class-use/Encoded.html @@ -0,0 +1,63 @@ + + + + +Uses of Annotation Interface jakarta.ws.rs.Encoded (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Annotation Interface
jakarta.ws.rs.Encoded

+
+No usage of jakarta.ws.rs.Encoded
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/class-use/ForbiddenException.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/class-use/ForbiddenException.html new file mode 100644 index 0000000000..cac3d09b08 --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/class-use/ForbiddenException.html @@ -0,0 +1,63 @@ + + + + +Uses of Class jakarta.ws.rs.ForbiddenException (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
jakarta.ws.rs.ForbiddenException

+
+No usage of jakarta.ws.rs.ForbiddenException
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/class-use/FormParam.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/class-use/FormParam.html new file mode 100644 index 0000000000..cfeaf02e10 --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/class-use/FormParam.html @@ -0,0 +1,63 @@ + + + + +Uses of Annotation Interface jakarta.ws.rs.FormParam (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Annotation Interface
jakarta.ws.rs.FormParam

+
+No usage of jakarta.ws.rs.FormParam
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/class-use/GET.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/class-use/GET.html new file mode 100644 index 0000000000..d397aa3200 --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/class-use/GET.html @@ -0,0 +1,63 @@ + + + + +Uses of Annotation Interface jakarta.ws.rs.GET (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Annotation Interface
jakarta.ws.rs.GET

+
+No usage of jakarta.ws.rs.GET
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/class-use/HEAD.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/class-use/HEAD.html new file mode 100644 index 0000000000..cbc7340b4e --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/class-use/HEAD.html @@ -0,0 +1,63 @@ + + + + +Uses of Annotation Interface jakarta.ws.rs.HEAD (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Annotation Interface
jakarta.ws.rs.HEAD

+
+No usage of jakarta.ws.rs.HEAD
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/class-use/HeaderParam.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/class-use/HeaderParam.html new file mode 100644 index 0000000000..357a3a4849 --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/class-use/HeaderParam.html @@ -0,0 +1,63 @@ + + + + +Uses of Annotation Interface jakarta.ws.rs.HeaderParam (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Annotation Interface
jakarta.ws.rs.HeaderParam

+
+No usage of jakarta.ws.rs.HeaderParam
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/class-use/HttpMethod.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/class-use/HttpMethod.html new file mode 100644 index 0000000000..a142aba88b --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/class-use/HttpMethod.html @@ -0,0 +1,122 @@ + + + + +Uses of Annotation Interface jakarta.ws.rs.HttpMethod (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Annotation Interface
jakarta.ws.rs.HttpMethod

+
+
Packages that use HttpMethod
+
+
Package
+
Description
+
jakarta.ws.rs
+
+
High-level interfaces and annotations used to create RESTful service resources.
+
+
+
+
    +
  • +
    +

    Uses of HttpMethod in jakarta.ws.rs

    +
    Classes in jakarta.ws.rs with annotations of type HttpMethod
    +
    +
    Modifier and Type
    +
    Class
    +
    Description
    +
    @interface 
    +
    DELETE
    +
    +
    Indicates that the annotated method responds to HTTP DELETE requests.
    +
    +
    @interface 
    +
    GET
    +
    +
    Indicates that the annotated method responds to HTTP GET requests.
    +
    +
    @interface 
    +
    HEAD
    +
    +
    Indicates that the annotated method responds to HTTP HEAD requests.
    +
    +
    @interface 
    +
    OPTIONS
    +
    +
    Indicates that the annotated method responds to HTTP OPTIONS requests.
    +
    +
    @interface 
    +
    PATCH
    +
    +
    Indicates that the annotated method responds to HTTP PATCH requests.
    +
    +
    @interface 
    +
    POST
    +
    +
    Indicates that the annotated method responds to HTTP POST requests.
    +
    +
    @interface 
    +
    PUT
    +
    +
    Indicates that the annotated method responds to HTTP PUT requests.
    +
    +
    +
    +
    • +
+
+
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/class-use/InternalServerErrorException.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/class-use/InternalServerErrorException.html new file mode 100644 index 0000000000..572991c672 --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/class-use/InternalServerErrorException.html @@ -0,0 +1,63 @@ + + + + +Uses of Class jakarta.ws.rs.InternalServerErrorException (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
jakarta.ws.rs.InternalServerErrorException

+
+No usage of jakarta.ws.rs.InternalServerErrorException
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/class-use/MatrixParam.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/class-use/MatrixParam.html new file mode 100644 index 0000000000..13a4a37c8f --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/class-use/MatrixParam.html @@ -0,0 +1,63 @@ + + + + +Uses of Annotation Interface jakarta.ws.rs.MatrixParam (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Annotation Interface
jakarta.ws.rs.MatrixParam

+
+No usage of jakarta.ws.rs.MatrixParam
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/class-use/NameBinding.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/class-use/NameBinding.html new file mode 100644 index 0000000000..49f0ef93f6 --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/class-use/NameBinding.html @@ -0,0 +1,63 @@ + + + + +Uses of Annotation Interface jakarta.ws.rs.NameBinding (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Annotation Interface
jakarta.ws.rs.NameBinding

+
+No usage of jakarta.ws.rs.NameBinding
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/class-use/NotAcceptableException.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/class-use/NotAcceptableException.html new file mode 100644 index 0000000000..9c14ffbb43 --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/class-use/NotAcceptableException.html @@ -0,0 +1,63 @@ + + + + +Uses of Class jakarta.ws.rs.NotAcceptableException (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
jakarta.ws.rs.NotAcceptableException

+
+No usage of jakarta.ws.rs.NotAcceptableException
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/class-use/NotAllowedException.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/class-use/NotAllowedException.html new file mode 100644 index 0000000000..fb3ef25321 --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/class-use/NotAllowedException.html @@ -0,0 +1,63 @@ + + + + +Uses of Class jakarta.ws.rs.NotAllowedException (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
jakarta.ws.rs.NotAllowedException

+
+No usage of jakarta.ws.rs.NotAllowedException
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/class-use/NotAuthorizedException.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/class-use/NotAuthorizedException.html new file mode 100644 index 0000000000..03f4221a4d --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/class-use/NotAuthorizedException.html @@ -0,0 +1,63 @@ + + + + +Uses of Class jakarta.ws.rs.NotAuthorizedException (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
jakarta.ws.rs.NotAuthorizedException

+
+No usage of jakarta.ws.rs.NotAuthorizedException
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/class-use/NotFoundException.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/class-use/NotFoundException.html new file mode 100644 index 0000000000..fc8aa59087 --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/class-use/NotFoundException.html @@ -0,0 +1,63 @@ + + + + +Uses of Class jakarta.ws.rs.NotFoundException (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
jakarta.ws.rs.NotFoundException

+
+No usage of jakarta.ws.rs.NotFoundException
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/class-use/NotSupportedException.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/class-use/NotSupportedException.html new file mode 100644 index 0000000000..a95b0d3be7 --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/class-use/NotSupportedException.html @@ -0,0 +1,63 @@ + + + + +Uses of Class jakarta.ws.rs.NotSupportedException (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
jakarta.ws.rs.NotSupportedException

+
+No usage of jakarta.ws.rs.NotSupportedException
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/class-use/OPTIONS.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/class-use/OPTIONS.html new file mode 100644 index 0000000000..35169ae9ae --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/class-use/OPTIONS.html @@ -0,0 +1,63 @@ + + + + +Uses of Annotation Interface jakarta.ws.rs.OPTIONS (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Annotation Interface
jakarta.ws.rs.OPTIONS

+
+No usage of jakarta.ws.rs.OPTIONS
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/class-use/PATCH.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/class-use/PATCH.html new file mode 100644 index 0000000000..5ac6942b65 --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/class-use/PATCH.html @@ -0,0 +1,63 @@ + + + + +Uses of Annotation Interface jakarta.ws.rs.PATCH (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Annotation Interface
jakarta.ws.rs.PATCH

+
+No usage of jakarta.ws.rs.PATCH
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/class-use/POST.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/class-use/POST.html new file mode 100644 index 0000000000..1e194d2d03 --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/class-use/POST.html @@ -0,0 +1,63 @@ + + + + +Uses of Annotation Interface jakarta.ws.rs.POST (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Annotation Interface
jakarta.ws.rs.POST

+
+No usage of jakarta.ws.rs.POST
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/class-use/PUT.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/class-use/PUT.html new file mode 100644 index 0000000000..ee035ff2ab --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/class-use/PUT.html @@ -0,0 +1,63 @@ + + + + +Uses of Annotation Interface jakarta.ws.rs.PUT (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Annotation Interface
jakarta.ws.rs.PUT

+
+No usage of jakarta.ws.rs.PUT
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/class-use/Path.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/class-use/Path.html new file mode 100644 index 0000000000..b5a047b02c --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/class-use/Path.html @@ -0,0 +1,63 @@ + + + + +Uses of Annotation Interface jakarta.ws.rs.Path (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Annotation Interface
jakarta.ws.rs.Path

+
+No usage of jakarta.ws.rs.Path
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/class-use/PathParam.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/class-use/PathParam.html new file mode 100644 index 0000000000..7e2fe09590 --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/class-use/PathParam.html @@ -0,0 +1,63 @@ + + + + +Uses of Annotation Interface jakarta.ws.rs.PathParam (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Annotation Interface
jakarta.ws.rs.PathParam

+
+No usage of jakarta.ws.rs.PathParam
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/class-use/Priorities.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/class-use/Priorities.html new file mode 100644 index 0000000000..3d9002d00c --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/class-use/Priorities.html @@ -0,0 +1,63 @@ + + + + +Uses of Class jakarta.ws.rs.Priorities (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
jakarta.ws.rs.Priorities

+
+No usage of jakarta.ws.rs.Priorities
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/class-use/ProcessingException.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/class-use/ProcessingException.html new file mode 100644 index 0000000000..11c2eb4e8a --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/class-use/ProcessingException.html @@ -0,0 +1,92 @@ + + + + +Uses of Class jakarta.ws.rs.ProcessingException (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
jakarta.ws.rs.ProcessingException

+
+
Packages that use ProcessingException
+
+
Package
+
Description
+
jakarta.ws.rs.client
+
+
The JAX-RS client API
+
+
+
+ +
+
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/class-use/Produces.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/class-use/Produces.html new file mode 100644 index 0000000000..28101f4ee3 --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/class-use/Produces.html @@ -0,0 +1,63 @@ + + + + +Uses of Annotation Interface jakarta.ws.rs.Produces (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Annotation Interface
jakarta.ws.rs.Produces

+
+No usage of jakarta.ws.rs.Produces
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/class-use/QueryParam.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/class-use/QueryParam.html new file mode 100644 index 0000000000..7acd976268 --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/class-use/QueryParam.html @@ -0,0 +1,63 @@ + + + + +Uses of Annotation Interface jakarta.ws.rs.QueryParam (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Annotation Interface
jakarta.ws.rs.QueryParam

+
+No usage of jakarta.ws.rs.QueryParam
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/class-use/RedirectionException.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/class-use/RedirectionException.html new file mode 100644 index 0000000000..29de9f4331 --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/class-use/RedirectionException.html @@ -0,0 +1,63 @@ + + + + +Uses of Class jakarta.ws.rs.RedirectionException (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
jakarta.ws.rs.RedirectionException

+
+No usage of jakarta.ws.rs.RedirectionException
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/class-use/RuntimeType.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/class-use/RuntimeType.html new file mode 100644 index 0000000000..747851babb --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/class-use/RuntimeType.html @@ -0,0 +1,118 @@ + + + + +Uses of Enum Class jakarta.ws.rs.RuntimeType (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Enum Class
jakarta.ws.rs.RuntimeType

+
+
Packages that use RuntimeType
+
+
Package
+
Description
+
jakarta.ws.rs
+
+
High-level interfaces and annotations used to create RESTful service resources.
+
+
jakarta.ws.rs.core
+
+
Low-level interfaces and annotations used to create RESTful service resources.
+
+
+
+ +
+
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/class-use/SeBootstrap.Configuration.Builder.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/class-use/SeBootstrap.Configuration.Builder.html new file mode 100644 index 0000000000..b3af4f7e65 --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/class-use/SeBootstrap.Configuration.Builder.html @@ -0,0 +1,158 @@ + + + + +Uses of Interface jakarta.ws.rs.SeBootstrap.Configuration.Builder (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
jakarta.ws.rs.SeBootstrap.Configuration.Builder

+
+
Packages that use SeBootstrap.Configuration.Builder
+
+
Package
+
Description
+
jakarta.ws.rs
+
+
High-level interfaces and annotations used to create RESTful service resources.
+
+
jakarta.ws.rs.ext
+
+
APIs that provide extensions to the types supported by the JAX-RS API.
+
+
+
+ +
+
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/class-use/SeBootstrap.Configuration.SSLClientAuthentication.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/class-use/SeBootstrap.Configuration.SSLClientAuthentication.html new file mode 100644 index 0000000000..eba424de94 --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/class-use/SeBootstrap.Configuration.SSLClientAuthentication.html @@ -0,0 +1,114 @@ + + + + +Uses of Enum Class jakarta.ws.rs.SeBootstrap.Configuration.SSLClientAuthentication (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Enum Class
jakarta.ws.rs.SeBootstrap.Configuration.SSLClientAuthentication

+
+
Packages that use SeBootstrap.Configuration.SSLClientAuthentication
+
+
Package
+
Description
+
jakarta.ws.rs
+
+
High-level interfaces and annotations used to create RESTful service resources.
+
+
+
+ +
+
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/class-use/SeBootstrap.Configuration.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/class-use/SeBootstrap.Configuration.html new file mode 100644 index 0000000000..3d859efdab --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/class-use/SeBootstrap.Configuration.html @@ -0,0 +1,142 @@ + + + + +Uses of Interface jakarta.ws.rs.SeBootstrap.Configuration (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
jakarta.ws.rs.SeBootstrap.Configuration

+
+
Packages that use SeBootstrap.Configuration
+
+
Package
+
Description
+
jakarta.ws.rs
+
+
High-level interfaces and annotations used to create RESTful service resources.
+
+
jakarta.ws.rs.ext
+
+
APIs that provide extensions to the types supported by the JAX-RS API.
+
+
+
+ +
+
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/class-use/SeBootstrap.Instance.StopResult.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/class-use/SeBootstrap.Instance.StopResult.html new file mode 100644 index 0000000000..746b8b9c05 --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/class-use/SeBootstrap.Instance.StopResult.html @@ -0,0 +1,104 @@ + + + + +Uses of Interface jakarta.ws.rs.SeBootstrap.Instance.StopResult (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
jakarta.ws.rs.SeBootstrap.Instance.StopResult

+
+
Packages that use SeBootstrap.Instance.StopResult
+
+
Package
+
Description
+
jakarta.ws.rs
+
+
High-level interfaces and annotations used to create RESTful service resources.
+
+
+
+ +
+
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/class-use/SeBootstrap.Instance.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/class-use/SeBootstrap.Instance.html new file mode 100644 index 0000000000..428448c8a3 --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/class-use/SeBootstrap.Instance.html @@ -0,0 +1,136 @@ + + + + +Uses of Interface jakarta.ws.rs.SeBootstrap.Instance (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
jakarta.ws.rs.SeBootstrap.Instance

+
+
Packages that use SeBootstrap.Instance
+
+
Package
+
Description
+
jakarta.ws.rs
+
+
High-level interfaces and annotations used to create RESTful service resources.
+
+
jakarta.ws.rs.ext
+
+
APIs that provide extensions to the types supported by the JAX-RS API.
+
+
+
+ +
+
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/class-use/SeBootstrap.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/class-use/SeBootstrap.html new file mode 100644 index 0000000000..997a206883 --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/class-use/SeBootstrap.html @@ -0,0 +1,63 @@ + + + + +Uses of Interface jakarta.ws.rs.SeBootstrap (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
jakarta.ws.rs.SeBootstrap

+
+No usage of jakarta.ws.rs.SeBootstrap
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/class-use/ServerErrorException.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/class-use/ServerErrorException.html new file mode 100644 index 0000000000..246182efa6 --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/class-use/ServerErrorException.html @@ -0,0 +1,99 @@ + + + + +Uses of Class jakarta.ws.rs.ServerErrorException (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
jakarta.ws.rs.ServerErrorException

+
+
Packages that use ServerErrorException
+
+
Package
+
Description
+
jakarta.ws.rs
+
+
High-level interfaces and annotations used to create RESTful service resources.
+
+
+
+ +
+
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/class-use/ServiceUnavailableException.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/class-use/ServiceUnavailableException.html new file mode 100644 index 0000000000..339f11279b --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/class-use/ServiceUnavailableException.html @@ -0,0 +1,63 @@ + + + + +Uses of Class jakarta.ws.rs.ServiceUnavailableException (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
jakarta.ws.rs.ServiceUnavailableException

+
+No usage of jakarta.ws.rs.ServiceUnavailableException
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/class-use/WebApplicationException.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/class-use/WebApplicationException.html new file mode 100644 index 0000000000..c765da0539 --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/class-use/WebApplicationException.html @@ -0,0 +1,248 @@ + + + + +Uses of Class jakarta.ws.rs.WebApplicationException (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
jakarta.ws.rs.WebApplicationException

+
+
Packages that use WebApplicationException
+
+
Package
+
Description
+
jakarta.ws.rs
+
+
High-level interfaces and annotations used to create RESTful service resources.
+
+
jakarta.ws.rs.core
+
+
Low-level interfaces and annotations used to create RESTful service resources.
+
+
jakarta.ws.rs.ext
+
+
APIs that provide extensions to the types supported by the JAX-RS API.
+
+
+
+ +
+
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/client/AsyncInvoker.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/client/AsyncInvoker.html new file mode 100644 index 0000000000..cf22d0325b --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/client/AsyncInvoker.html @@ -0,0 +1,1095 @@ + + + + +AsyncInvoker (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Module jakarta.ws.rs
+
Package jakarta.ws.rs.client
+

Interface AsyncInvoker

+
+
+
+
public interface AsyncInvoker
+
Uniform interface for asynchronous invocation of HTTP methods.
+
+
Since:
+
2.0
+
Author:
+
Marek Potociar
+
+
+
+
    + +
  • +
    +

    Method Summary

    +
    +
    +
    +
    +
    Modifier and Type
    +
    Method
    +
    Description
    +
    Future<Response>
    +
    delete()
    +
    +
    Invoke HTTP DELETE method for the current request asynchronously.
    +
    +
    <T> Future<T>
    +
    delete(InvocationCallback<T> callback)
    +
    +
    Invoke HTTP DELETE method for the current request asynchronously.
    +
    +
    <T> Future<T>
    +
    delete(GenericType<T> responseType)
    +
    +
    Invoke HTTP DELETE method for the current request asynchronously.
    +
    +
    <T> Future<T>
    +
    delete(Class<T> responseType)
    +
    +
    Invoke HTTP DELETE method for the current request asynchronously.
    +
    +
    Future<Response>
    +
    get()
    +
    +
    Invoke HTTP GET method for the current request asynchronously.
    +
    +
    <T> Future<T>
    +
    get(InvocationCallback<T> callback)
    +
    +
    Invoke HTTP GET method for the current request asynchronously.
    +
    +
    <T> Future<T>
    +
    get(GenericType<T> responseType)
    +
    +
    Invoke HTTP GET method for the current request asynchronously.
    +
    +
    <T> Future<T>
    +
    get(Class<T> responseType)
    +
    +
    Invoke HTTP GET method for the current request asynchronously.
    +
    +
    Future<Response>
    +
    head()
    +
    +
    Invoke HTTP HEAD method for the current request asynchronously.
    +
    +
    Future<Response>
    +
    head(InvocationCallback<Response> callback)
    +
    +
    Invoke HTTP HEAD method for the current request asynchronously.
    +
    +
    Future<Response>
    +
    method(String name)
    +
    +
    Invoke an arbitrary method for the current request asynchronously.
    +
    +
    Future<Response>
    +
    method(String name, + Entity<?> entity)
    +
    +
    Invoke an arbitrary method for the current request asynchronously.
    +
    +
    <T> Future<T>
    +
    method(String name, + Entity<?> entity, + InvocationCallback<T> callback)
    +
    +
    Invoke an arbitrary method for the current request asynchronously.
    +
    +
    <T> Future<T>
    +
    method(String name, + Entity<?> entity, + GenericType<T> responseType)
    +
    +
    Invoke an arbitrary method for the current request asynchronously.
    +
    +
    <T> Future<T>
    +
    method(String name, + Entity<?> entity, + Class<T> responseType)
    +
    +
    Invoke an arbitrary method for the current request asynchronously.
    +
    +
    <T> Future<T>
    +
    method(String name, + InvocationCallback<T> callback)
    +
    +
    Invoke an arbitrary method for the current request asynchronously.
    +
    +
    <T> Future<T>
    +
    method(String name, + GenericType<T> responseType)
    +
    +
    Invoke an arbitrary method for the current request asynchronously.
    +
    +
    <T> Future<T>
    +
    method(String name, + Class<T> responseType)
    +
    +
    Invoke an arbitrary method for the current request asynchronously.
    +
    +
    Future<Response>
    +
    options()
    +
    +
    Invoke HTTP OPTIONS method for the current request asynchronously.
    +
    +
    <T> Future<T>
    +
    options(InvocationCallback<T> callback)
    +
    +
    Invoke HTTP OPTIONS method for the current request asynchronously.
    +
    +
    <T> Future<T>
    +
    options(GenericType<T> responseType)
    +
    +
    Invoke HTTP OPTIONS method for the current request asynchronously.
    +
    +
    <T> Future<T>
    +
    options(Class<T> responseType)
    +
    +
    Invoke HTTP OPTIONS method for the current request asynchronously.
    +
    +
    Future<Response>
    +
    post(Entity<?> entity)
    +
    +
    Invoke HTTP POST method for the current request asynchronously.
    +
    +
    <T> Future<T>
    +
    post(Entity<?> entity, + InvocationCallback<T> callback)
    +
    +
    Invoke HTTP POST method for the current request asynchronously.
    +
    +
    <T> Future<T>
    +
    post(Entity<?> entity, + GenericType<T> responseType)
    +
    +
    Invoke HTTP POST method for the current request asynchronously.
    +
    +
    <T> Future<T>
    +
    post(Entity<?> entity, + Class<T> responseType)
    +
    +
    Invoke HTTP POST method for the current request asynchronously.
    +
    +
    Future<Response>
    +
    put(Entity<?> entity)
    +
    +
    Invoke HTTP PUT method for the current request asynchronously.
    +
    +
    <T> Future<T>
    +
    put(Entity<?> entity, + InvocationCallback<T> callback)
    +
    +
    Invoke HTTP PUT method for the current request asynchronously.
    +
    +
    <T> Future<T>
    +
    put(Entity<?> entity, + GenericType<T> responseType)
    +
    +
    Invoke HTTP PUT method for the current request asynchronously.
    +
    +
    <T> Future<T>
    +
    put(Entity<?> entity, + Class<T> responseType)
    +
    +
    Invoke HTTP PUT method for the current request asynchronously.
    +
    +
    Future<Response>
    +
    trace()
    +
    +
    Invoke HTTP TRACE method for the current request asynchronously.
    +
    +
    <T> Future<T>
    +
    trace(InvocationCallback<T> callback)
    +
    +
    Invoke HTTP TRACE method for the current request asynchronously.
    +
    +
    <T> Future<T>
    +
    trace(GenericType<T> responseType)
    +
    +
    Invoke HTTP TRACE method for the current request asynchronously.
    +
    +
    <T> Future<T>
    +
    trace(Class<T> responseType)
    +
    +
    Invoke HTTP TRACE method for the current request asynchronously.
    +
    +
    +
    +
    +
    +
    • +
+
+
+
    + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      get

      +
      Future<Response> get()
      +
      Invoke HTTP GET method for the current request asynchronously. +

      + Note that calling the Future.get() method on the returned Future instance may + throw an ExecutionException that wraps a ProcessingException thrown + in case of an invocation processing failure. Note that in case a processing of a properly received response fails, + the wrapped processing exception will be of ResponseProcessingException type and will contain the + Response instance whose processing has failed.

      +
      +
      Returns:
      +
      invocation response future.
      +
      +
      +
      • +
    • +
      +

      get

      +
      <T> Future<T> get(Class<T> responseType)
      +
      Invoke HTTP GET method for the current request asynchronously. +

      + Note that calling the Future.get() method on the returned Future instance may + throw an ExecutionException that wraps either a ProcessingException + thrown in case of an invocation processing failure or a WebApplicationException or one of its subclasses + thrown in case the received response status code is not successful and the specified response type is not Response. In case a processing of a + properly received response fails, the wrapped processing exception will be of ResponseProcessingException + type and will contain the Response instance whose processing has failed.

      +
      +
      Type Parameters:
      +
      T - response entity type.
      +
      Parameters:
      +
      responseType - Java type the response entity will be converted to.
      +
      Returns:
      +
      invocation response future.
      +
      +
      +
      • +
    • +
      +

      get

      +
      <T> Future<T> get(GenericType<T> responseType)
      +
      Invoke HTTP GET method for the current request asynchronously. +

      + Note that calling the Future.get() method on the returned Future instance may + throw an ExecutionException that wraps either a ProcessingException + thrown in case of an invocation processing failure or a WebApplicationException or one of its subclasses + thrown in case the received response status code is not successful and the specified response type is not Response. In case a processing of a + properly received response fails, the wrapped processing exception will be of ResponseProcessingException + type and will contain the Response instance whose processing has failed.

      +
      +
      Type Parameters:
      +
      T - generic response entity type.
      +
      Parameters:
      +
      responseType - representation of a generic Java type the response entity will be converted to.
      +
      Returns:
      +
      invocation response future.
      +
      +
      +
      • +
    • +
      +

      get

      +
      <T> Future<T> get(InvocationCallback<T> callback)
      +
      Invoke HTTP GET method for the current request asynchronously. +

      + Note that calling the Future.get() method on the returned Future instance may + throw an ExecutionException that wraps either a ProcessingException + thrown in case of an invocation processing failure or a WebApplicationException or one of its subclasses + thrown in case the received response status code is not successful and the generic type of the supplied response callback is not Response. In case + a processing of a properly received response fails, the wrapped processing exception will be of + ResponseProcessingException type and will contain the Response instance whose processing has failed.

      +
      +
      Type Parameters:
      +
      T - generic response entity type.
      +
      Parameters:
      +
      callback - asynchronous invocation callback.
      +
      Returns:
      +
      invocation response future.
      +
      +
      +
      • +
    • +
      +

      put

      +
      Future<Response> put(Entity<?> entity)
      +
      Invoke HTTP PUT method for the current request asynchronously. +

      + Note that calling the Future.get() method on the returned Future instance may + throw an ExecutionException that wraps a ProcessingException thrown + in case of an invocation processing failure. In case a processing of a properly received response fails, the wrapped + processing exception will be of ResponseProcessingException type and will contain the Response + instance whose processing has failed.

      +
      +
      Parameters:
      +
      entity - request entity, including it's full Variant information. Any variant-related + HTTP headers previously set (namely Content-Type, Content-Language and Content-Encoding) will + be overwritten using the entity variant information.
      +
      Returns:
      +
      invocation response future.
      +
      +
      +
      • +
    • +
      +

      put

      +
      <T> Future<T> put(Entity<?> entity, + Class<T> responseType)
      +
      Invoke HTTP PUT method for the current request asynchronously. +

      + Note that calling the Future.get() method on the returned Future instance may + throw an ExecutionException that wraps either a ProcessingException + thrown in case of an invocation processing failure or a WebApplicationException or one of its subclasses + thrown in case the received response status code is not successful and the specified response type is not Response. In case a processing of a + properly received response fails, the wrapped processing exception will be of ResponseProcessingException + type and will contain the Response instance whose processing has failed.

      +
      +
      Type Parameters:
      +
      T - response entity type.
      +
      Parameters:
      +
      entity - request entity, including it's full Variant information. Any variant-related + HTTP headers previously set (namely Content-Type, Content-Language and Content-Encoding) will + be overwritten using the entity variant information.
      +
      responseType - Java type the response entity will be converted to.
      +
      Returns:
      +
      invocation response future.
      +
      +
      +
      • +
    • +
      +

      put

      +
      <T> Future<T> put(Entity<?> entity, + GenericType<T> responseType)
      +
      Invoke HTTP PUT method for the current request asynchronously. +

      + Note that calling the Future.get() method on the returned Future instance may + throw an ExecutionException that wraps either a ProcessingException + thrown in case of an invocation processing failure or a WebApplicationException or one of its subclasses + thrown in case the received response status code is not successful and the specified response type is not Response. In case a processing of a + properly received response fails, the wrapped processing exception will be of ResponseProcessingException + type and will contain the Response instance whose processing has failed.

      +
      +
      Type Parameters:
      +
      T - generic response entity type.
      +
      Parameters:
      +
      entity - request entity, including it's full Variant information. Any variant-related + HTTP headers previously set (namely Content-Type, Content-Language and Content-Encoding) will + be overwritten using the entity variant information.
      +
      responseType - representation of a generic Java type the response entity will be converted to.
      +
      Returns:
      +
      invocation response future.
      +
      +
      +
      • +
    • +
      +

      put

      +
      <T> Future<T> put(Entity<?> entity, + InvocationCallback<T> callback)
      +
      Invoke HTTP PUT method for the current request asynchronously. +

      + Note that calling the Future.get() method on the returned Future instance may + throw an ExecutionException that wraps either a ProcessingException + thrown in case of an invocation processing failure or a WebApplicationException or one of its subclasses + thrown in case the received response status code is not successful and the generic type of the supplied response callback is not Response. In case + a processing of a properly received response fails, the wrapped processing exception will be of + ResponseProcessingException type and will contain the Response instance whose processing has failed.

      +
      +
      Type Parameters:
      +
      T - generic response entity type.
      +
      Parameters:
      +
      entity - request entity, including it's full Variant information. Any variant-related + HTTP headers previously set (namely Content-Type, Content-Language and Content-Encoding) will + be overwritten using the entity variant information.
      +
      callback - asynchronous invocation callback.
      +
      Returns:
      +
      invocation response future.
      +
      +
      +
      • +
    • +
      +

      post

      +
      Future<Response> post(Entity<?> entity)
      +
      Invoke HTTP POST method for the current request asynchronously. +

      + Note that calling the Future.get() method on the returned Future instance may + throw an ExecutionException that wraps a ProcessingException thrown + in case of an invocation processing failure. In case a processing of a properly received response fails, the wrapped + processing exception will be of ResponseProcessingException type and will contain the Response + instance whose processing has failed.

      +
      +
      Parameters:
      +
      entity - request entity, including it's full Variant information. Any variant-related + HTTP headers previously set (namely Content-Type, Content-Language and Content-Encoding) will + be overwritten using the entity variant information.
      +
      Returns:
      +
      invocation response future.
      +
      Throws:
      +
      ProcessingException - in case the invocation processing has failed.
      +
      +
      +
      • +
    • +
      +

      post

      +
      <T> Future<T> post(Entity<?> entity, + Class<T> responseType)
      +
      Invoke HTTP POST method for the current request asynchronously. +

      + Note that calling the Future.get() method on the returned Future instance may + throw an ExecutionException that wraps either a ProcessingException + thrown in case of an invocation processing failure or a WebApplicationException or one of its subclasses + thrown in case the received response status code is not successful and the specified response type is not Response. In case a processing of a + properly received response fails, the wrapped processing exception will be of ResponseProcessingException + type and will contain the Response instance whose processing has failed.

      +
      +
      Type Parameters:
      +
      T - response entity type.
      +
      Parameters:
      +
      entity - request entity, including it's full Variant information. Any variant-related + HTTP headers previously set (namely Content-Type, Content-Language and Content-Encoding) will + be overwritten using the entity variant information.
      +
      responseType - Java type the response entity will be converted to.
      +
      Returns:
      +
      invocation response future.
      +
      +
      +
      • +
    • +
      +

      post

      +
      <T> Future<T> post(Entity<?> entity, + GenericType<T> responseType)
      +
      Invoke HTTP POST method for the current request asynchronously. +

      + Note that calling the Future.get() method on the returned Future instance may + throw an ExecutionException that wraps either a ProcessingException + thrown in case of an invocation processing failure or a WebApplicationException or one of its subclasses + thrown in case the received response status code is not successful and the specified response type is not Response. In case a processing of a + properly received response fails, the wrapped processing exception will be of ResponseProcessingException + type and will contain the Response instance whose processing has failed.

      +
      +
      Type Parameters:
      +
      T - generic response entity type.
      +
      Parameters:
      +
      entity - request entity, including it's full Variant information. Any variant-related + HTTP headers previously set (namely Content-Type, Content-Language and Content-Encoding) will + be overwritten using the entity variant information.
      +
      responseType - representation of a generic Java type the response entity will be converted to.
      +
      Returns:
      +
      invocation response future.
      +
      +
      +
      • +
    • +
      +

      post

      +
      <T> Future<T> post(Entity<?> entity, + InvocationCallback<T> callback)
      +
      Invoke HTTP POST method for the current request asynchronously. +

      + Note that calling the Future.get() method on the returned Future instance may + throw an ExecutionException that wraps either a ProcessingException + thrown in case of an invocation processing failure or a WebApplicationException or one of its subclasses + thrown in case the received response status code is not successful and the generic type of the supplied response callback is not Response. In case + a processing of a properly received response fails, the wrapped processing exception will be of + ResponseProcessingException type and will contain the Response instance whose processing has failed.

      +
      +
      Type Parameters:
      +
      T - generic response entity type.
      +
      Parameters:
      +
      entity - request entity, including it's full Variant information. Any variant-related + HTTP headers previously set (namely Content-Type, Content-Language and Content-Encoding) will + be overwritten using the entity variant information.
      +
      callback - asynchronous invocation callback.
      +
      Returns:
      +
      invocation response future.
      +
      +
      +
      • +
    • +
      +

      delete

      +
      Future<Response> delete()
      +
      Invoke HTTP DELETE method for the current request asynchronously. +

      + Note that calling the Future.get() method on the returned Future instance may + throw an ExecutionException that wraps a ProcessingException thrown + in case of an invocation processing failure. In case a processing of a properly received response fails, the wrapped + processing exception will be of ResponseProcessingException type and will contain the Response + instance whose processing has failed.

      +
      +
      Returns:
      +
      invocation response future.
      +
      +
      +
      • +
    • +
      +

      delete

      +
      <T> Future<T> delete(Class<T> responseType)
      +
      Invoke HTTP DELETE method for the current request asynchronously. +

      + Note that calling the Future.get() method on the returned Future instance may + throw an ExecutionException that wraps either a ProcessingException + thrown in case of an invocation processing failure or a WebApplicationException or one of its subclasses + thrown in case the received response status code is not successful and the specified response type is not Response. In case a processing of a + properly received response fails, the wrapped processing exception will be of ResponseProcessingException + type and will contain the Response instance whose processing has failed.

      +
      +
      Type Parameters:
      +
      T - response entity type.
      +
      Parameters:
      +
      responseType - Java type the response entity will be converted to.
      +
      Returns:
      +
      invocation response future.
      +
      +
      +
      • +
    • +
      +

      delete

      +
      <T> Future<T> delete(GenericType<T> responseType)
      +
      Invoke HTTP DELETE method for the current request asynchronously. +

      + Note that calling the Future.get() method on the returned Future instance may + throw an ExecutionException that wraps either a ProcessingException + thrown in case of an invocation processing failure or a WebApplicationException or one of its subclasses + thrown in case the received response status code is not successful and the specified response type is not Response. In case a processing of a + properly received response fails, the wrapped processing exception will be of ResponseProcessingException + type and will contain the Response instance whose processing has failed.

      +
      +
      Type Parameters:
      +
      T - generic response entity type.
      +
      Parameters:
      +
      responseType - representation of a generic Java type the response entity will be converted to.
      +
      Returns:
      +
      invocation response future.
      +
      +
      +
      • +
    • +
      +

      delete

      +
      <T> Future<T> delete(InvocationCallback<T> callback)
      +
      Invoke HTTP DELETE method for the current request asynchronously. +

      + Note that calling the Future.get() method on the returned Future instance may + throw an ExecutionException that wraps either a ProcessingException + thrown in case of an invocation processing failure or a WebApplicationException or one of its subclasses + thrown in case the received response status code is not successful and the generic type of the supplied response callback is not Response. In case + a processing of a properly received response fails, the wrapped processing exception will be of + ResponseProcessingException type and will contain the Response instance whose processing has failed.

      +
      +
      Type Parameters:
      +
      T - generic response entity type.
      +
      Parameters:
      +
      callback - asynchronous invocation callback.
      +
      Returns:
      +
      invocation response future.
      +
      +
      +
      • +
    • +
      +

      head

      +
      Future<Response> head()
      +
      Invoke HTTP HEAD method for the current request asynchronously. +

      + Note that calling the Future.get() method on the returned Future instance may + throw an ExecutionException that wraps a ProcessingException thrown + in case of an invocation processing failure. In case a processing of a properly received response fails, the wrapped + processing exception will be of ResponseProcessingException type and will contain the Response + instance whose processing has failed.

      +
      +
      Returns:
      +
      invocation response future.
      +
      +
      +
      • +
    • +
      +

      head

      +
      Future<Response> head(InvocationCallback<Response> callback)
      +
      Invoke HTTP HEAD method for the current request asynchronously. +

      + Note that calling the Future.get() method on the returned Future instance may + throw an ExecutionException that wraps a ProcessingException thrown + in case of an invocation processing failure. In case a processing of a properly received response fails, the wrapped + processing exception will be of ResponseProcessingException type and will contain the Response + instance whose processing has failed.

      +
      +
      Parameters:
      +
      callback - asynchronous invocation callback.
      +
      Returns:
      +
      invocation response future.
      +
      +
      +
      • +
    • +
      +

      options

      +
      Future<Response> options()
      +
      Invoke HTTP OPTIONS method for the current request asynchronously. +

      + Note that calling the Future.get() method on the returned Future instance may + throw an ExecutionException that wraps a ProcessingException thrown + in case of an invocation processing failure. In case a processing of a properly received response fails, the wrapped + processing exception will be of ResponseProcessingException type and will contain the Response + instance whose processing has failed.

      +
      +
      Returns:
      +
      invocation response future.
      +
      +
      +
      • +
    • +
      +

      options

      +
      <T> Future<T> options(Class<T> responseType)
      +
      Invoke HTTP OPTIONS method for the current request asynchronously. +

      + Note that calling the Future.get() method on the returned Future instance may + throw an ExecutionException that wraps either a ProcessingException + thrown in case of an invocation processing failure or a WebApplicationException or one of its subclasses + thrown in case the received response status code is not successful and the specified response type is not Response. In case a processing of a + properly received response fails, the wrapped processing exception will be of ResponseProcessingException + type and will contain the Response instance whose processing has failed.

      +
      +
      Type Parameters:
      +
      T - response entity type.
      +
      Parameters:
      +
      responseType - Java type the response entity will be converted to.
      +
      Returns:
      +
      invocation response future.
      +
      +
      +
      • +
    • +
      +

      options

      +
      <T> Future<T> options(GenericType<T> responseType)
      +
      Invoke HTTP OPTIONS method for the current request asynchronously. +

      + Note that calling the Future.get() method on the returned Future instance may + throw an ExecutionException that wraps either a ProcessingException + thrown in case of an invocation processing failure or a WebApplicationException or one of its subclasses + thrown in case the received response status code is not successful and the specified response type is not Response. In case a processing of a + properly received response fails, the wrapped processing exception will be of ResponseProcessingException + type and will contain the Response instance whose processing has failed.

      +
      +
      Type Parameters:
      +
      T - generic response entity type.
      +
      Parameters:
      +
      responseType - representation of a generic Java type the response entity will be converted to.
      +
      Returns:
      +
      invocation response future.
      +
      +
      +
      • +
    • +
      +

      options

      +
      <T> Future<T> options(InvocationCallback<T> callback)
      +
      Invoke HTTP OPTIONS method for the current request asynchronously. +

      + Note that calling the Future.get() method on the returned Future instance may + throw an ExecutionException that wraps either a ProcessingException + thrown in case of an invocation processing failure or a WebApplicationException or one of its subclasses + thrown in case the received response status code is not successful and the generic type of the supplied response callback is not Response. In case + a processing of a properly received response fails, the wrapped processing exception will be of + ResponseProcessingException type and will contain the Response instance whose processing has failed.

      +
      +
      Type Parameters:
      +
      T - generic response entity type.
      +
      Parameters:
      +
      callback - asynchronous invocation callback.
      +
      Returns:
      +
      invocation response future.
      +
      +
      +
      • +
    • +
      +

      trace

      +
      Future<Response> trace()
      +
      Invoke HTTP TRACE method for the current request asynchronously. +

      + Note that calling the Future.get() method on the returned Future instance may + throw an ExecutionException that wraps a ProcessingException thrown + in case of an invocation processing failure. In case a processing of a properly received response fails, the wrapped + processing exception will be of ResponseProcessingException type and will contain the Response + instance whose processing has failed.

      +
      +
      Returns:
      +
      invocation response future.
      +
      +
      +
      • +
    • +
      +

      trace

      +
      <T> Future<T> trace(Class<T> responseType)
      +
      Invoke HTTP TRACE method for the current request asynchronously. +

      + Note that calling the Future.get() method on the returned Future instance may + throw an ExecutionException that wraps either a ProcessingException + thrown in case of an invocation processing failure or a WebApplicationException or one of its subclasses + thrown in case the received response status code is not successful and the specified response type is not Response. In case a processing of a + properly received response fails, the wrapped processing exception will be of ResponseProcessingException + type and will contain the Response instance whose processing has failed.

      +
      +
      Type Parameters:
      +
      T - response entity type.
      +
      Parameters:
      +
      responseType - Java type the response entity will be converted to.
      +
      Returns:
      +
      invocation response future.
      +
      +
      +
      • +
    • +
      +

      trace

      +
      <T> Future<T> trace(GenericType<T> responseType)
      +
      Invoke HTTP TRACE method for the current request asynchronously. +

      + Note that calling the Future.get() method on the returned Future instance may + throw an ExecutionException that wraps either a ProcessingException + thrown in case of an invocation processing failure or a WebApplicationException or one of its subclasses + thrown in case the received response status code is not successful and the specified response type is not Response. In case a processing of a + properly received response fails, the wrapped processing exception will be of ResponseProcessingException + type and will contain the Response instance whose processing has failed.

      +
      +
      Type Parameters:
      +
      T - generic response entity type.
      +
      Parameters:
      +
      responseType - representation of a generic Java type the response entity will be converted to.
      +
      Returns:
      +
      invocation response future.
      +
      +
      +
      • +
    • +
      +

      trace

      +
      <T> Future<T> trace(InvocationCallback<T> callback)
      +
      Invoke HTTP TRACE method for the current request asynchronously. +

      + Note that calling the Future.get() method on the returned Future instance may + throw an ExecutionException that wraps either a ProcessingException + thrown in case of an invocation processing failure or a WebApplicationException or one of its subclasses + thrown in case the received response status code is not successful and the generic type of the supplied response callback is not Response. In case + a processing of a properly received response fails, the wrapped processing exception will be of + ResponseProcessingException type and will contain the Response instance whose processing has failed.

      +
      +
      Type Parameters:
      +
      T - generic response entity type.
      +
      Parameters:
      +
      callback - asynchronous invocation callback.
      +
      Returns:
      +
      invocation response future.
      +
      +
      +
      • +
    • +
      +

      method

      +
      Future<Response> method(String name)
      +
      Invoke an arbitrary method for the current request asynchronously. +

      + Note that calling the Future.get() method on the returned Future instance may + throw an ExecutionException that wraps a ProcessingException thrown + in case of an invocation processing failure. In case a processing of a properly received response fails, the wrapped + processing exception will be of ResponseProcessingException type and will contain the Response + instance whose processing has failed.

      +
      +
      Parameters:
      +
      name - method name.
      +
      Returns:
      +
      invocation response future.
      +
      +
      +
      • +
    • +
      +

      method

      +
      <T> Future<T> method(String name, + Class<T> responseType)
      +
      Invoke an arbitrary method for the current request asynchronously. +

      + Note that calling the Future.get() method on the returned Future instance may + throw an ExecutionException that wraps either a ProcessingException + thrown in case of an invocation processing failure or a WebApplicationException or one of its subclasses + thrown in case the received response status code is not successful and the specified response type is not Response. In case a processing of a + properly received response fails, the wrapped processing exception will be of ResponseProcessingException + type and will contain the Response instance whose processing has failed.

      +
      +
      Type Parameters:
      +
      T - response entity type.
      +
      Parameters:
      +
      name - method name.
      +
      responseType - Java type the response entity will be converted to.
      +
      Returns:
      +
      invocation response future.
      +
      +
      +
      • +
    • +
      +

      method

      +
      <T> Future<T> method(String name, + GenericType<T> responseType)
      +
      Invoke an arbitrary method for the current request asynchronously. +

      + Note that calling the Future.get() method on the returned Future instance may + throw an ExecutionException that wraps either a ProcessingException + thrown in case of an invocation processing failure or a WebApplicationException or one of its subclasses + thrown in case the received response status code is not successful and the specified response type is not Response. In case a processing of a + properly received response fails, the wrapped processing exception will be of ResponseProcessingException + type and will contain the Response instance whose processing has failed.

      +
      +
      Type Parameters:
      +
      T - generic response entity type.
      +
      Parameters:
      +
      name - method name.
      +
      responseType - representation of a generic Java type the response entity will be converted to.
      +
      Returns:
      +
      invocation response future.
      +
      +
      +
      • +
    • +
      +

      method

      +
      <T> Future<T> method(String name, + InvocationCallback<T> callback)
      +
      Invoke an arbitrary method for the current request asynchronously. +

      + Note that calling the Future.get() method on the returned Future instance may + throw an ExecutionException that wraps either a ProcessingException + thrown in case of an invocation processing failure or a WebApplicationException or one of its subclasses + thrown in case the received response status code is not successful and the generic type of the supplied response callback is not Response. In case + a processing of a properly received response fails, the wrapped processing exception will be of + ResponseProcessingException type and will contain the Response instance whose processing has failed.

      +
      +
      Type Parameters:
      +
      T - generic response entity type.
      +
      Parameters:
      +
      name - method name.
      +
      callback - asynchronous invocation callback.
      +
      Returns:
      +
      invocation response future.
      +
      +
      +
      • +
    • +
      +

      method

      +
      Future<Response> method(String name, + Entity<?> entity)
      +
      Invoke an arbitrary method for the current request asynchronously. +

      + Note that calling the Future.get() method on the returned Future instance may + throw an ExecutionException that wraps a ProcessingException thrown + in case of an invocation processing failure. In case a processing of a properly received response fails, the wrapped + processing exception will be of ResponseProcessingException type and will contain the Response + instance whose processing has failed.

      +
      +
      Parameters:
      +
      name - method name.
      +
      entity - request entity, including it's full Variant information. Any variant-related + HTTP headers previously set (namely Content-Type, Content-Language and Content-Encoding) will + be overwritten using the entity variant information.
      +
      Returns:
      +
      invocation response future.
      +
      +
      +
      • +
    • +
      +

      method

      +
      <T> Future<T> method(String name, + Entity<?> entity, + Class<T> responseType)
      +
      Invoke an arbitrary method for the current request asynchronously. +

      + Note that calling the Future.get() method on the returned Future instance may + throw an ExecutionException that wraps either a ProcessingException + thrown in case of an invocation processing failure or a WebApplicationException or one of its subclasses + thrown in case the received response status code is not successful and the specified response type is not Response. In case a processing of a + properly received response fails, the wrapped processing exception will be of ResponseProcessingException + type and will contain the Response instance whose processing has failed.

      +
      +
      Type Parameters:
      +
      T - response entity type.
      +
      Parameters:
      +
      name - method name.
      +
      entity - request entity, including it's full Variant information. Any variant-related + HTTP headers previously set (namely Content-Type, Content-Language and Content-Encoding) will + be overwritten using the entity variant information.
      +
      responseType - Java type the response entity will be converted to.
      +
      Returns:
      +
      invocation response future.
      +
      +
      +
      • +
    • +
      +

      method

      +
      <T> Future<T> method(String name, + Entity<?> entity, + GenericType<T> responseType)
      +
      Invoke an arbitrary method for the current request asynchronously. +

      + Note that calling the Future.get() method on the returned Future instance may + throw an ExecutionException that wraps either a ProcessingException + thrown in case of an invocation processing failure or a WebApplicationException or one of its subclasses + thrown in case the received response status code is not successful and the specified response type is not Response. In case a processing of a + properly received response fails, the wrapped processing exception will be of ResponseProcessingException + type and will contain the Response instance whose processing has failed.

      +
      +
      Type Parameters:
      +
      T - generic response entity type.
      +
      Parameters:
      +
      name - method name.
      +
      entity - request entity, including it's full Variant information. Any variant-related + HTTP headers previously set (namely Content-Type, Content-Language and Content-Encoding) will + be overwritten using the entity variant information.
      +
      responseType - representation of a generic Java type the response entity will be converted to.
      +
      Returns:
      +
      invocation response future.
      +
      +
      +
      • +
    • +
      +

      method

      +
      <T> Future<T> method(String name, + Entity<?> entity, + InvocationCallback<T> callback)
      +
      Invoke an arbitrary method for the current request asynchronously. +

      + Note that calling the Future.get() method on the returned Future instance may + throw an ExecutionException that wraps either a ProcessingException + thrown in case of an invocation processing failure or a WebApplicationException or one of its subclasses + thrown in case the received response status code is not successful and the generic type of the supplied response callback is not Response. In case + a processing of a properly received response fails, the wrapped processing exception will be of + ResponseProcessingException type and will contain the Response instance whose processing has failed.

      +
      +
      Type Parameters:
      +
      T - generic response entity type.
      +
      Parameters:
      +
      name - method name.
      +
      entity - request entity, including it's full Variant information. Any variant-related + HTTP headers previously set (namely Content-Type, Content-Language and Content-Encoding) will + be overwritten using the entity variant information.
      +
      callback - asynchronous invocation callback.
      +
      Returns:
      +
      invocation response future.
      +
      +
      +
      • +
    +
    +
    • +
+
+ +
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/client/Client.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/client/Client.html new file mode 100644 index 0000000000..df7ef2d267 --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/client/Client.html @@ -0,0 +1,325 @@ + + + + +Client (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Module jakarta.ws.rs
+
Package jakarta.ws.rs.client
+

Interface Client

+
+
+
+
All Superinterfaces:
+
AutoCloseable, Configurable<Client>
+
+
+
public interface Client +extends Configurable<Client>, AutoCloseable
+

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

+ Clients are heavy-weight objects that manage the client-side communication infrastructure. Initialization as well as + disposal of a Client instance may be a rather expensive operation. It is therefore advised to construct only + a small number of Client instances in the application. Client instances must be properly + closed before being disposed to avoid leaking resources.
+
+
Since:
+
2.0
+
Author:
+
Marek Potociar
+
See Also:
+
+ +
+
+
+
+ +
+
+
    + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      close

      +
      void close()
      +

      + Close client instance and all it's associated resources. Subsequent calls have no effect and are ignored. Once the + client is closed, invoking any other method on the client instance would result in an IllegalStateException + being thrown. +

      + Calling this method effectively invalidates all resource targets produced by the client instance. + Invoking any method on such targets once the client is closed would result in an IllegalStateException being + thrown.
      +
      +
      Specified by:
      +
      close in interface AutoCloseable
      +
      +
      +
      • +
    • +
      +

      target

      +
      WebTarget target(String uri)
      +
      Build a new web resource target.
      +
      +
      Parameters:
      +
      uri - web resource URI. May contain template parameters. Must not be null.
      +
      Returns:
      +
      web resource target bound to the provided URI.
      +
      Throws:
      +
      IllegalArgumentException - in case the supplied string is not a valid URI template.
      +
      NullPointerException - in case the supplied argument is null.
      +
      +
      +
      • +
    • +
      +

      target

      +
      WebTarget target(URI uri)
      +
      Build a new web resource target.
      +
      +
      Parameters:
      +
      uri - web resource URI. Must not be null.
      +
      Returns:
      +
      web resource target bound to the provided URI.
      +
      Throws:
      +
      NullPointerException - in case the supplied argument is null.
      +
      +
      +
      • +
    • +
      +

      target

      +
      WebTarget target(UriBuilder uriBuilder)
      +
      Build a new web resource target.
      +
      +
      Parameters:
      +
      uriBuilder - web resource URI represented as URI builder. Must not be null.
      +
      Returns:
      +
      web resource target bound to the provided URI.
      +
      Throws:
      +
      NullPointerException - in case the supplied argument is null.
      +
      +
      +
      • +
    • +
      +

      target

      +
      WebTarget target(Link link)
      +
      Build a new web resource target.
      +
      +
      Parameters:
      +
      link - link to a web resource. Must not be null.
      +
      Returns:
      +
      web resource target bound to the linked web resource.
      +
      Throws:
      +
      NullPointerException - in case the supplied argument is null.
      +
      +
      +
      • +
    • +
      +

      invocation

      +
      Invocation.Builder invocation(Link link)
      +

      + Build an invocation builder from a link. It uses the URI and the type of the link to initialize the invocation + builder. The type is used as the initial value for the HTTP Accept header, if present. +

      +
      +
      Parameters:
      +
      link - link to build invocation from. Must not be null.
      +
      Returns:
      +
      newly created invocation builder.
      +
      Throws:
      +
      NullPointerException - in case link is null.
      +
      +
      +
      • +
    • +
      +

      getSslContext

      +
      SSLContext getSslContext()
      +
      Get the SSL context configured to be used with the current client run-time.
      +
      +
      Returns:
      +
      SSL context configured to be used with the current client run-time.
      +
      +
      +
      • +
    • +
      +

      getHostnameVerifier

      +
      HostnameVerifier getHostnameVerifier()
      +
      Get the hostname verifier configured in the client or null in case no hostname verifier has been configured.
      +
      +
      Returns:
      +
      client hostname verifier or null if not set.
      +
      +
      +
      • +
    +
    +
    • +
+
+ +
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/client/ClientBuilder.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/client/ClientBuilder.html new file mode 100644 index 0000000000..15e0d6480b --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/client/ClientBuilder.html @@ -0,0 +1,620 @@ + + + + +ClientBuilder (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Module jakarta.ws.rs
+
Package jakarta.ws.rs.client
+

Class ClientBuilder

+
+
java.lang.Object +
jakarta.ws.rs.client.ClientBuilder
+
+
+
+
All Implemented Interfaces:
+
Configurable<ClientBuilder>
+
+
+
public abstract class ClientBuilder +extends Object +implements Configurable<ClientBuilder>
+
Main entry point to the client API used to bootstrap Client instances.
+
+
Since:
+
2.0
+
Author:
+
Marek Potociar
+
+
+
+ +
+
+
    + +
  • +
    +

    Field Details

    +
      +
    • +
      +

      JAXRS_DEFAULT_CLIENT_BUILDER_PROPERTY

      +
      public static final String JAXRS_DEFAULT_CLIENT_BUILDER_PROPERTY
      +
      Name of the property identifying the ClientBuilder implementation to be returned from + newBuilder().
      +
      +
      See Also:
      +
      + +
      +
      +
      +
      • +
    +
    +
    • + +
  • +
    +

    Constructor Details

    +
      +
    • +
      +

      ClientBuilder

      +
      protected ClientBuilder()
      +
      Allows custom implementations to extend the ClientBuilder class.
      +
      +
      • +
    +
    +
    • + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      newBuilder

      +
      public static ClientBuilder newBuilder()
      +
      Create a new ClientBuilder instance using the default client builder implementation class provided by the + JAX-RS implementation provider.
      +
      +
      Returns:
      +
      new client builder instance.
      +
      +
      +
      • +
    • +
      +

      newClient

      +
      public static Client newClient()
      +
      Create a new Client instance using the default client builder implementation class provided by the JAX-RS + implementation provider.
      +
      +
      Returns:
      +
      new client instance.
      +
      +
      +
      • +
    • +
      +

      newClient

      +
      public static Client newClient(Configuration configuration)
      +
      Create a new custom-configured Client instance using the default client builder implementation class provided + by the JAX-RS implementation provider.
      +
      +
      Parameters:
      +
      configuration - data used to provide initial configuration for the new client instance.
      +
      Returns:
      +
      new configured client instance.
      +
      +
      +
      • +
    • +
      +

      withConfig

      +
      public abstract ClientBuilder withConfig(Configuration config)
      +
      Set the internal configuration state to an externally provided configuration state.
      +
      +
      Parameters:
      +
      config - external configuration state to replace the configuration of this configurable instance.
      +
      Returns:
      +
      the updated client builder instance.
      +
      +
      +
      • +
    • +
      +

      sslContext

      +
      public abstract ClientBuilder sslContext(SSLContext sslContext)
      +
      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. The SSL context is + expected to have all the security infrastructure initialized, including the key and trust managers. +

      + Setting a SSL context instance resets any key store or + trust store values previously specified. +

      +
      +
      Parameters:
      +
      sslContext - secure socket protocol implementation which acts as a factory for secure socket factories or + SSL engines. Must not be null.
      +
      Returns:
      +
      an updated client builder instance.
      +
      Throws:
      +
      NullPointerException - in case the sslContext parameter is null.
      +
      See Also:
      +
      + +
      +
      +
      +
      • +
    • +
      +

      keyStore

      +
      public abstract ClientBuilder keyStore(KeyStore keyStore, + char[] password)
      +
      Set the client-side key store. Key store contains client's private keys, and the certificates with their + corresponding public keys. +

      + Setting a key store instance resets any SSL context instance value + previously specified. +

      +

      + Note that a custom key store is only required if you want to enable a custom setup of a 2-way SSL connections (client + certificate authentication). +

      +
      +
      Parameters:
      +
      keyStore - client-side key store. Must not be null.
      +
      password - client key password. Must not be null.
      +
      Returns:
      +
      an updated client builder instance.
      +
      Throws:
      +
      NullPointerException - in case any of the supplied parameters is null.
      +
      See Also:
      +
      + +
      +
      +
      +
      • +
    • +
      +

      keyStore

      +
      public ClientBuilder keyStore(KeyStore keyStore, + String password)
      +
      Set the client-side key store. Key store contains client's private keys, and the certificates with their + corresponding public keys. +

      + Setting a key store instance resets any SSL context instance value + previously specified. +

      +

      + Note that for improved security of working with password data and avoid storing passwords in Java string objects, the + keyStore(java.security.KeyStore, char[]) version of the method can be utilized. Also note that a custom key + store is only required if you want to enable a custom setup of a 2-way SSL connections (client certificate + authentication). +

      +
      +
      Parameters:
      +
      keyStore - client-side key store. Must not be null.
      +
      password - client key password. Must not be null.
      +
      Returns:
      +
      an updated client builder instance.
      +
      Throws:
      +
      NullPointerException - in case any of the supplied parameters is null.
      +
      See Also:
      +
      + +
      +
      +
      +
      • +
    • +
      +

      trustStore

      +
      public abstract ClientBuilder trustStore(KeyStore trustStore)
      +
      Set the client-side trust store. Trust store is expected to contain certificates from other parties the client is you + expect to communicate with, or from Certificate Authorities that are trusted to identify other parties. +

      + Setting a trust store instance resets any SSL context instance value + previously specified. +

      +

      + In case a custom trust store or custom SSL context is not specified, the trust management will be configured to use + the default Java runtime settings. +

      +
      +
      Parameters:
      +
      trustStore - client-side trust store. Must not be null.
      +
      Returns:
      +
      an updated client builder instance.
      +
      Throws:
      +
      NullPointerException - in case the supplied trust store parameter is null.
      +
      See Also:
      +
      + +
      +
      +
      +
      • +
    • +
      +

      hostnameVerifier

      +
      public abstract ClientBuilder hostnameVerifier(HostnameVerifier verifier)
      +
      Set the hostname verifier to be used by the client to verify the endpoint's hostname against it's identification + information.
      +
      +
      Parameters:
      +
      verifier - hostname verifier.
      +
      Returns:
      +
      an updated client builder instance.
      +
      +
      +
      • +
    • +
      +

      executorService

      +
      public abstract ClientBuilder executorService(ExecutorService executorService)
      +
      Set the client-side ExecutorService. +

      + Provided executor service will be used for executing asynchronous tasks. +

      + When running in a Jakarta EE container, implementations are required to use the container-managed executor service by + default. In Java SE, the default is implementation-specific. In either case, calling this method will override the + default.

      +
      +
      Parameters:
      +
      executorService - executor service to be used for async invocations.
      +
      Returns:
      +
      an updated client builder instance.
      +
      Since:
      +
      2.1
      +
      See Also:
      +
      + +
      +
      +
      +
      • +
    • +
      +

      scheduledExecutorService

      +
      public abstract ClientBuilder scheduledExecutorService(ScheduledExecutorService scheduledExecutorService)
      +
      Set the client-side ScheduledExecutorService. +

      + Provided executor service will be used for executing scheduled asynchronous tasks. +

      + When running in a Jakarta EE container, implementations are required to use the container-managed scheduled executor + service by default. In Java SE the default is implementation-specific. In either case, calling this method will + override the default.

      +
      +
      Parameters:
      +
      scheduledExecutorService - executor service to be used for scheduled async invocations.
      +
      Returns:
      +
      an updated client builder instance.
      +
      Since:
      +
      2.1
      +
      See Also:
      +
      + +
      +
      +
      +
      • +
    • +
      +

      connectTimeout

      +
      public abstract ClientBuilder connectTimeout(long timeout, + TimeUnit unit)
      +
      Set the connect timeout. +

      + Value 0 represents infinity. Negative values are not allowed.

      +
      +
      Parameters:
      +
      timeout - the maximum time to wait.
      +
      unit - the time unit of the timeout argument.
      +
      Returns:
      +
      an updated client builder instance.
      +
      Throws:
      +
      IllegalArgumentException - when the value is negative.
      +
      Since:
      +
      2.1
      +
      +
      +
      • +
    • +
      +

      readTimeout

      +
      public abstract ClientBuilder readTimeout(long timeout, + TimeUnit unit)
      +
      Set the read timeout. +

      + The value is the timeout to read a response. If the server doesn't respond within the defined timeframe, + ProcessingException is thrown with TimeoutException as a cause. +

      + Value 0 represents infinity. Negative values are not allowed.

      +
      +
      Parameters:
      +
      timeout - the maximum time to wait.
      +
      unit - the time unit of the timeout argument.
      +
      Returns:
      +
      an updated client builder instance.
      +
      Throws:
      +
      IllegalArgumentException - when the value is negative.
      +
      Since:
      +
      2.1
      +
      +
      +
      • +
    • +
      +

      build

      +
      public abstract Client build()
      +
      Build a new client instance using all the configuration previously specified in this client builder.
      +
      +
      Returns:
      +
      a new client instance.
      +
      +
      +
      • +
    +
    +
    • +
+
+ +
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/client/ClientRequestContext.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/client/ClientRequestContext.html new file mode 100644 index 0000000000..8577cc8dd9 --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/client/ClientRequestContext.html @@ -0,0 +1,864 @@ + + + + +ClientRequestContext (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Module jakarta.ws.rs
+
Package jakarta.ws.rs.client
+

Interface ClientRequestContext

+
+
+
+
public interface ClientRequestContext
+
Client request filter context. + + A mutable class that provides request-specific information for the filter, such as request URI, message headers, + message entity or request-scoped properties. The exposed setters allow modification of the exposed request-specific + information.
+
+
Since:
+
2.0
+
Author:
+
Marek Potociar
+
+
+
+ +
+
+
    + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      getProperty

      +
      Object getProperty(String name)
      +
      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. +

      + A property allows a JAX-RS filters and interceptors to exchange additional custom information not already provided by + this interface. +

      +

      + A list of supported properties can be retrieved using getPropertyNames(). Custom property names should + follow the same convention as package names. +

      +
      +
      Parameters:
      +
      name - a String specifying the name of the property.
      +
      Returns:
      +
      an Object containing the value of the property, or null if no property exists matching the + given name.
      +
      See Also:
      +
      + +
      +
      +
      +
      • +
    • +
      +

      getPropertyNames

      +
      Collection<String> getPropertyNames()
      +
      Returns an immutable collection containing the property names available within the context of the + current request/response exchange context. +

      + Use the getProperty(java.lang.String) method with a property name to get the value of a property. +

      +
      +
      Returns:
      +
      an immutable collection of property names.
      +
      See Also:
      +
      + +
      +
      +
      +
      • +
    • +
      +

      hasProperty

      +
      default boolean hasProperty(String name)
      +
      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. +

      + Use the getProperty(java.lang.String) method with a property name to get the value of a property. +

      +
      +
      Parameters:
      +
      name - a String specifying the name of the property.
      +
      Returns:
      +
      true if this property is registered in the context, or false if no property exists matching + the given name.
      +
      See Also:
      +
      + +
      +
      +
      +
      • +
    • +
      +

      setProperty

      +
      void setProperty(String name, + Object object)
      +
      Binds an object to a given property name in the current request/response exchange context. If the name specified is + already used for a property, this method will replace the value of the property with the new value. +

      + A property allows a JAX-RS filters and interceptors to exchange additional custom information not already provided by + this interface. +

      +

      + A list of supported properties can be retrieved using getPropertyNames(). Custom property names should + follow the same convention as package names. +

      +

      + If a null value is passed, the effect is the same as calling the removeProperty(String) method. +

      +
      +
      Parameters:
      +
      name - a String specifying the name of the property.
      +
      object - an Object representing the property to be bound.
      +
      +
      +
      • +
    • +
      +

      removeProperty

      +
      void removeProperty(String name)
      +
      Removes a property with the given name from the current request/response exchange context. After removal, subsequent + calls to getProperty(java.lang.String) to retrieve the property value will return null.
      +
      +
      Parameters:
      +
      name - a String specifying the name of the property to be removed.
      +
      +
      +
      • +
    • +
      +

      getUri

      +
      URI getUri()
      +
      Get the request URI.
      +
      +
      Returns:
      +
      request URI.
      +
      +
      +
      • +
    • +
      +

      setUri

      +
      void setUri(URI uri)
      +
      Set a new request URI.
      +
      +
      Parameters:
      +
      uri - new request URI.
      +
      +
      +
      • +
    • +
      +

      getMethod

      +
      String getMethod()
      +
      Get the request method.
      +
      +
      Returns:
      +
      the request method.
      +
      See Also:
      +
      + +
      +
      +
      +
      • +
    • +
      +

      setMethod

      +
      void setMethod(String method)
      +
      Set the request method.
      +
      +
      Parameters:
      +
      method - new request method.
      +
      See Also:
      +
      + +
      +
      +
      +
      • +
    • +
      +

      getHeaders

      +
      MultivaluedMap<String,Object> getHeaders()
      +
      Get the mutable request headers multivalued map.
      +
      +
      Returns:
      +
      mutable multivalued map of request headers.
      +
      See Also:
      +
      + +
      +
      +
      +
      • +
    • +
      +

      getStringHeaders

      +
      MultivaluedMap<String,String> getStringHeaders()
      +
      Get a string view of header values associated with the message. + + Changes in the underlying headers map are reflected in this view. +

      + The method converts the non-string header values to strings using a + RuntimeDelegate.HeaderDelegate if one is available via + RuntimeDelegate.createHeaderDelegate(java.lang.Class) for the class of the value or using the + values toString method if a header delegate is not available. +

      +
      +
      Returns:
      +
      response headers as a string view of header values.
      +
      See Also:
      +
      + +
      +
      +
      +
      • +
    • +
      +

      getHeaderString

      +
      String getHeaderString(String name)
      +
      Get a message header as a single string value. + + Each single non-string header value is converted to String using a RuntimeDelegate.HeaderDelegate if one + is available via RuntimeDelegate.createHeaderDelegate(java.lang.Class) for the header value + class or using its toString method if a header delegate is not available.
      +
      +
      Parameters:
      +
      name - the message header.
      +
      Returns:
      +
      the message header value. If the message header is not present then null is returned. If the message + header is present but has no value then the empty string is returned. If the message header is present more than once + then the values of joined together and separated by a ',' character.
      +
      See Also:
      +
      + +
      +
      +
      +
      • +
    • +
      +

      containsHeaderString

      +
      boolean containsHeaderString(String name, + String valueSeparatorRegex, + Predicate<String> valuePredicate)
      +
      Checks whether a header with a specific name and value (or item of the token-separated value list) exists. + + Each single non-string header value is converted to String using a RuntimeDelegate.HeaderDelegate if one + is available via RuntimeDelegate.createHeaderDelegate(java.lang.Class) for the header value + class or using its toString method if a header delegate is not available. + +

      + For example: containsHeaderString("cache-control", ",", "no-store"::equalsIgnoreCase) will return true if + a Cache-Control header exists that has the value no-store, the value No-Store or the value + Max-Age, NO-STORE, no-transform, but false when it has the value no-store;no-transform + (missing comma), or the value no - store (whitespace within value).

      +
      +
      Parameters:
      +
      name - the message header.
      +
      valueSeparatorRegex - Regular expression that separates the header value into single values. + null does not split.
      +
      valuePredicate - value must fulfil this predicate.
      +
      Returns:
      +
      true if and only if a header with the given name exists, having either a whitespace-trimmed value + matching the predicate, or having at least one whitespace-trimmed single value in a token-separated list of single values.
      +
      Since:
      +
      4.0
      +
      See Also:
      +
      + +
      +
      +
      +
      • +
    • +
      +

      containsHeaderString

      +
      default boolean containsHeaderString(String name, + Predicate<String> valuePredicate)
      +
      Checks whether a header with a specific name and value (or item of the comma-separated value list) exists. + + Each single non-string header value is converted to String using a RuntimeDelegate.HeaderDelegate if one + is available via RuntimeDelegate.createHeaderDelegate(java.lang.Class) for the header value + class or using its toString method if a header delegate is not available. + +

      + For example: containsHeaderString("cache-control", "no-store"::equalsIgnoreCase) will return true if + a Cache-Control header exists that has the value no-store, the value No-Store or the value + Max-Age, NO-STORE, no-transform, but false when it has the value no-store;no-transform + (missing comma), or the value no - store (whitespace within value).

      +
      +
      Parameters:
      +
      name - the message header.
      +
      valuePredicate - value must fulfil this predicate.
      +
      Returns:
      +
      true if and only if a header with the given name exists, having either a whitespace-trimmed value + matching the predicate, or having at least one whitespace-trimmed single value in a comma-separated list of single values.
      +
      Since:
      +
      4.0
      +
      See Also:
      +
      + +
      +
      +
      +
      • +
    • +
      +

      getDate

      +
      Date getDate()
      +
      Get message date.
      +
      +
      Returns:
      +
      the message date, otherwise null if not present.
      +
      +
      +
      • +
    • +
      +

      getLanguage

      +
      Locale getLanguage()
      +
      Get the language of the entity.
      +
      +
      Returns:
      +
      the language of the entity or null if not specified
      +
      +
      +
      • +
    • +
      +

      getMediaType

      +
      MediaType getMediaType()
      +
      Get the media type of the entity.
      +
      +
      Returns:
      +
      the media type or null if not specified (e.g. there's no request entity).
      +
      +
      +
      • +
    • +
      +

      getAcceptableMediaTypes

      +
      List<MediaType> getAcceptableMediaTypes()
      +
      Get a list of media types that are acceptable for the response.
      +
      +
      Returns:
      +
      a read-only list of requested response media types sorted according to their q-value, with highest preference + first.
      +
      +
      +
      • +
    • +
      +

      getAcceptableLanguages

      +
      List<Locale> getAcceptableLanguages()
      +
      Get a list of languages that are acceptable for the response.
      +
      +
      Returns:
      +
      a read-only list of acceptable languages sorted according to their q-value, with highest preference first.
      +
      +
      +
      • +
    • +
      +

      getCookies

      +
      Map<String,Cookie> getCookies()
      +
      Get any cookies that accompanied the request.
      +
      +
      Returns:
      +
      a read-only map of cookie name (String) to Cookie.
      +
      +
      +
      • +
    • +
      +

      hasEntity

      +
      boolean hasEntity()
      +
      Check if there is an entity available in the request. + + The method returns true if the entity is present, returns false otherwise.
      +
      +
      Returns:
      +
      true if there is an entity present in the message, false otherwise.
      +
      +
      +
      • +
    • +
      +

      getEntity

      +
      Object getEntity()
      +
      Get the message entity Java instance. + + Returns null if the message does not contain an entity.
      +
      +
      Returns:
      +
      the message entity or null if message does not contain an entity body.
      +
      +
      +
      • +
    • +
      +

      getEntityClass

      +
      Class<?> getEntityClass()
      +
      Get the raw entity type information.
      +
      +
      Returns:
      +
      raw entity type.
      +
      +
      +
      • +
    • +
      +

      getEntityType

      +
      Type getEntityType()
      +
      Get the generic entity type information.
      +
      +
      Returns:
      +
      generic entity type.
      +
      +
      +
      • +
    • +
      +

      setEntity

      +
      void setEntity(Object entity)
      +
      Set a new message entity. The existing entity annotations and media type are preserved. +

      + It is the callers responsibility to wrap the actual entity with GenericEntity if + preservation of its generic type is required. +

      +
      +
      Parameters:
      +
      entity - entity object.
      +
      See Also:
      +
      + +
      +
      +
      +
      • +
    • +
      +

      setEntity

      +
      void setEntity(Object entity, + Annotation[] annotations, + MediaType mediaType)
      +
      Set a new message entity, including the attached annotations and the media type. +

      + It is the callers responsibility to wrap the actual entity with GenericEntity if + preservation of its generic type is required. +

      +
      +
      Parameters:
      +
      entity - entity object.
      +
      annotations - annotations attached to the entity instance.
      +
      mediaType - entity media type.
      +
      See Also:
      +
      + +
      +
      +
      +
      • +
    • +
      +

      getEntityAnnotations

      +
      Annotation[] getEntityAnnotations()
      +
      Get the annotations attached to the entity instance. +

      + Note that the returned annotations array contains only those annotations explicitly attached to entity instance (such + as the ones attached using + Entity(Object, jakarta.ws.rs.core.MediaType, java.lang.annotation.Annotation[]) method). The entity + instance annotations array does not include annotations declared on the entity implementation class or its ancestors. +

      +
      +
      Returns:
      +
      annotations attached to the entity instance.
      +
      +
      +
      • +
    • +
      +

      getEntityStream

      +
      OutputStream getEntityStream()
      +
      Get the entity output stream. The JAX-RS runtime is responsible for closing the output stream.
      +
      +
      Returns:
      +
      entity output stream.
      +
      +
      +
      • +
    • +
      +

      setEntityStream

      +
      void setEntityStream(OutputStream outputStream)
      +
      Set a new entity output stream. The JAX-RS runtime is responsible for closing the output stream.
      +
      +
      Parameters:
      +
      outputStream - new entity output stream.
      +
      +
      +
      • +
    • +
      +

      getClient

      +
      Client getClient()
      +
      Get the client instance associated with the request.
      +
      +
      Returns:
      +
      client instance associated with the request.
      +
      +
      +
      • +
    • +
      +

      getConfiguration

      +
      Configuration getConfiguration()
      +
      Get the immutable configuration of the request.
      +
      +
      Returns:
      +
      immutable request configuration.
      +
      +
      +
      • +
    • +
      +

      abortWith

      +
      void abortWith(Response response)
      +
      Abort the filter chain with a response. + + This method breaks the filter chain processing and returns the provided response back to the client. The provided + response goes through the chain of applicable response filters.
      +
      +
      Parameters:
      +
      response - response to be sent back to the client.
      +
      +
      +
      • +
    +
    +
    • +
+
+ +
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/client/ClientRequestFilter.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/client/ClientRequestFilter.html new file mode 100644 index 0000000000..197f53c532 --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/client/ClientRequestFilter.html @@ -0,0 +1,174 @@ + + + + +ClientRequestFilter (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Module jakarta.ws.rs
+
Package jakarta.ws.rs.client
+

Interface ClientRequestFilter

+
+
+
+
public interface ClientRequestFilter
+
An extension interface implemented by client request filters. + + Filters implementing this interface MUST be annotated with @Provider to be + discovered by the JAX-RS runtime. This type of filters is supported only as part of the Client API.
+
+
Since:
+
2.0
+
Author:
+
Marek Potociar, Santiago Pericas-Geertsen
+
See Also:
+
+ +
+
+
+
+
    + +
  • +
    +

    Method Summary

    +
    +
    +
    +
    +
    Modifier and Type
    +
    Method
    +
    Description
    +
    void
    +
    filter(ClientRequestContext requestContext)
    +
    +
    Filter method called before a request has been dispatched to a client transport layer.
    +
    +
    +
    +
    +
    +
    • +
+
+
+
    + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      filter

      +
      void filter(ClientRequestContext requestContext) + throws IOException
      +
      Filter method called before a request has been dispatched to a client transport layer. + + Filters in the filter chain are ordered according to their jakarta.annotation.Priority class-level annotation + value.
      +
      +
      Parameters:
      +
      requestContext - request context.
      +
      Throws:
      +
      IOException - if an I/O exception occurs.
      +
      +
      +
      • +
    +
    +
    • +
+
+ +
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/client/ClientResponseContext.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/client/ClientResponseContext.html new file mode 100644 index 0000000000..397d582688 --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/client/ClientResponseContext.html @@ -0,0 +1,600 @@ + + + + +ClientResponseContext (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Module jakarta.ws.rs
+
Package jakarta.ws.rs.client
+

Interface ClientResponseContext

+
+
+
+
public interface ClientResponseContext
+
Client response filter context. + + A mutable class that provides response-specific information for the filter, such as message headers, message entity + or request-scoped properties. The exposed setters allow modification of the exposed response-specific information.
+
+
Since:
+
2.0
+
Author:
+
Marek Potociar
+
+
+
+ +
+
+
    + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      getStatus

      +
      int getStatus()
      +
      Get the status code associated with the response.
      +
      +
      Returns:
      +
      the response status code or -1 if the status was not set.
      +
      +
      +
      • +
    • +
      +

      setStatus

      +
      void setStatus(int code)
      +
      Set a new response status code.
      +
      +
      Parameters:
      +
      code - new status code.
      +
      +
      +
      • +
    • +
      +

      getStatusInfo

      +
      Response.StatusType getStatusInfo()
      +
      Get the complete status information associated with the response.
      +
      +
      Returns:
      +
      the response status information or null if the status was not set.
      +
      +
      +
      • +
    • +
      +

      setStatusInfo

      +
      void setStatusInfo(Response.StatusType statusInfo)
      +
      Set the complete status information (status code and reason phrase) associated with the response.
      +
      +
      Parameters:
      +
      statusInfo - the response status information.
      +
      +
      +
      • +
    • +
      +

      getHeaders

      +
      MultivaluedMap<String,String> getHeaders()
      +
      Get the mutable response headers multivalued map.
      +
      +
      Returns:
      +
      mutable multivalued map of response headers.
      +
      See Also:
      +
      + +
      +
      +
      +
      • +
    • +
      +

      getHeaderString

      +
      String getHeaderString(String name)
      +
      Get a message header as a single string value.
      +
      +
      Parameters:
      +
      name - the message header.
      +
      Returns:
      +
      the message header value. If the message header is not present then null is returned. If the message + header is present but has no value then the empty string is returned. If the message header is present more than once + then the values of joined together and separated by a ',' character.
      +
      See Also:
      +
      + +
      +
      +
      +
      • +
    • +
      +

      containsHeaderString

      +
      boolean containsHeaderString(String name, + String valueSeparatorRegex, + Predicate<String> valuePredicate)
      +
      Checks whether a header with a specific name and value (or item of the token-separated value list) exists. + +

      + For example: containsHeaderString("cache-control", ",", "no-store"::equalsIgnoreCase) will return true if + a Cache-Control header exists that has the value no-store, the value No-Store or the value + Max-Age, NO-STORE, no-transform, but false when it has the value no-store;no-transform + (missing comma), or the value no - store (whitespace within value).

      +
      +
      Parameters:
      +
      name - the message header.
      +
      valueSeparatorRegex - Regular expression that separates the header value into single values. + null does not split.
      +
      valuePredicate - value must fulfil this predicate.
      +
      Returns:
      +
      true if and only if a header with the given name exists, having either a whitespace-trimmed value + matching the predicate, or having at least one whitespace-trimmed single value in a token-separated list of single values.
      +
      Since:
      +
      4.0
      +
      See Also:
      +
      + +
      +
      +
      +
      • +
    • +
      +

      containsHeaderString

      +
      default boolean containsHeaderString(String name, + Predicate<String> valuePredicate)
      +
      Checks whether a header with a specific name and value (or item of the comma-separated value list) exists. + +

      + For example: containsHeaderString("cache-control", "no-store"::equalsIgnoreCase) will return true if + a Cache-Control header exists that has the value no-store, the value No-Store or the value + Max-Age, NO-STORE, no-transform, but false when it has the value no-store;no-transform + (missing comma), or the value no - store (whitespace within value).

      +
      +
      Parameters:
      +
      name - the message header.
      +
      valuePredicate - value must fulfil this predicate.
      +
      Returns:
      +
      true if and only if a header with the given name exists, having either a whitespace-trimmed value + matching the predicate, or having at least one whitespace-trimmed single value in a comma-separated list of single values.
      +
      Since:
      +
      4.0
      +
      See Also:
      +
      + +
      +
      +
      +
      • +
    • +
      +

      getAllowedMethods

      +
      Set<String> getAllowedMethods()
      +
      Get the allowed HTTP methods from the Allow HTTP header.
      +
      +
      Returns:
      +
      the allowed HTTP methods, all methods will returned as upper case strings.
      +
      +
      +
      • +
    • +
      +

      getDate

      +
      Date getDate()
      +
      Get message date.
      +
      +
      Returns:
      +
      the message date, otherwise null if not present.
      +
      +
      +
      • +
    • +
      +

      getLanguage

      +
      Locale getLanguage()
      +
      Get the language of the entity.
      +
      +
      Returns:
      +
      the language of the entity or null if not specified
      +
      +
      +
      • +
    • +
      +

      getLength

      +
      int getLength()
      +
      Get Content-Length value.
      +
      +
      Returns:
      +
      Content-Length as integer if present and valid number. In other cases returns -1.
      +
      +
      +
      • +
    • +
      +

      getMediaType

      +
      MediaType getMediaType()
      +
      Get the media type of the entity.
      +
      +
      Returns:
      +
      the media type or null if not specified (e.g. there's no response entity).
      +
      +
      +
      • +
    • +
      +

      getCookies

      +
      Map<String,NewCookie> getCookies()
      +
      Get any new cookies set on the response message.
      +
      +
      Returns:
      +
      a read-only map of cookie name (String) to a new cookie.
      +
      +
      +
      • +
    • +
      +

      getEntityTag

      +
      EntityTag getEntityTag()
      +
      Get the entity tag.
      +
      +
      Returns:
      +
      the entity tag, otherwise null if not present.
      +
      +
      +
      • +
    • +
      +

      getLastModified

      +
      Date getLastModified()
      +
      Get the last modified date.
      +
      +
      Returns:
      +
      the last modified date, otherwise null if not present.
      +
      +
      +
      • +
    • +
      +

      getLocation

      +
      URI getLocation()
      +
      Get the location.
      +
      +
      Returns:
      +
      the location URI, otherwise null if not present.
      +
      +
      +
      • +
    • +
      +

      getLinks

      +
      Set<Link> getLinks()
      +
      Get the links attached to the message as header.
      +
      +
      Returns:
      +
      links, may return empty Set if no links are present. Never returns null.
      +
      +
      +
      • +
    • +
      +

      hasLink

      +
      boolean hasLink(String relation)
      +
      Check if link for relation exists.
      +
      +
      Parameters:
      +
      relation - link relation.
      +
      Returns:
      +
      true if the for the relation link exists, false otherwise.
      +
      +
      +
      • +
    • +
      +

      getLink

      +
      Link getLink(String relation)
      +
      Get the link for the relation.
      +
      +
      Parameters:
      +
      relation - link relation.
      +
      Returns:
      +
      the link for the relation, otherwise null if not present.
      +
      +
      +
      • +
    • +
      +

      getLinkBuilder

      +
      Link.Builder getLinkBuilder(String relation)
      +
      Convenience method that returns a Link.Builder for the relation.
      +
      +
      Parameters:
      +
      relation - link relation.
      +
      Returns:
      +
      the link builder for the relation, otherwise null if not present.
      +
      +
      +
      • +
    • +
      +

      hasEntity

      +
      boolean hasEntity()
      +
      Check if there is a non-empty entity input stream is available in the response message. + + The method returns true if the entity is present, returns false otherwise.
      +
      +
      Returns:
      +
      true if there is an entity present in the message, false otherwise.
      +
      +
      +
      • +
    • +
      +

      getEntityStream

      +
      InputStream getEntityStream()
      +
      Get the entity input stream. The JAX-RS runtime is responsible for closing the input stream.
      +
      +
      Returns:
      +
      entity input stream.
      +
      +
      +
      • +
    • +
      +

      setEntityStream

      +
      void setEntityStream(InputStream input)
      +
      Set a new entity input stream. The JAX-RS runtime is responsible for closing the input stream.
      +
      +
      Parameters:
      +
      input - new entity input stream.
      +
      +
      +
      • +
    +
    +
    • +
+
+ +
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/client/ClientResponseFilter.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/client/ClientResponseFilter.html new file mode 100644 index 0000000000..f26866d042 --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/client/ClientResponseFilter.html @@ -0,0 +1,179 @@ + + + + +ClientResponseFilter (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Module jakarta.ws.rs
+
Package jakarta.ws.rs.client
+

Interface ClientResponseFilter

+
+
+
+
public interface ClientResponseFilter
+
An extension interface implemented by client response filters. + + Filters implementing this interface MUST be annotated with @Provider to be + discovered by the JAX-RS runtime. This type of filters is supported only as part of the Client API.
+
+
Since:
+
2.0
+
Author:
+
Marek Potociar, Santiago Pericas-Geertsen
+
See Also:
+
+ +
+
+
+
+
    + +
  • +
    +

    Method Summary

    +
    +
    +
    +
    +
    Modifier and Type
    +
    Method
    +
    Description
    +
    void
    +
    filter(ClientRequestContext requestContext, + ClientResponseContext responseContext)
    +
    +
    Filter method called after a response has been provided for a request (either by a request + filter or when the HTTP invocation returns).
    +
    +
    +
    +
    +
    +
    • +
+
+
+
    + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      filter

      +
      void filter(ClientRequestContext requestContext, + ClientResponseContext responseContext) + throws IOException
      +
      Filter method called after a response has been provided for a request (either by a request + filter or when the HTTP invocation returns). + + Filters in the filter chain are ordered according to their jakarta.annotation.Priority class-level annotation + value.
      +
      +
      Parameters:
      +
      requestContext - request context.
      +
      responseContext - response context.
      +
      Throws:
      +
      IOException - if an I/O exception occurs.
      +
      +
      +
      • +
    +
    +
    • +
+
+ +
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/client/CompletionStageRxInvoker.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/client/CompletionStageRxInvoker.html new file mode 100644 index 0000000000..452aff4e77 --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/client/CompletionStageRxInvoker.html @@ -0,0 +1,746 @@ + + + + +CompletionStageRxInvoker (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Module jakarta.ws.rs
+
Package jakarta.ws.rs.client
+

Interface CompletionStageRxInvoker

+
+
+
+
All Superinterfaces:
+
RxInvoker<CompletionStage>
+
+
+
public interface CompletionStageRxInvoker +extends RxInvoker<CompletionStage>
+
Reactive invoker based CompletionStage.
+
+
Since:
+
2.1
+
Author:
+
Marek Potociar, Santiago Pericas-Geertsen
+
+
+
+ +
+
+
    + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      get

      +
      CompletionStage<Response> get()
      +
      Description copied from interface: RxInvoker
      +
      Invoke HTTP GET method for the current request.
      +
      +
      Specified by:
      +
      get in interface RxInvoker<CompletionStage>
      +
      Returns:
      +
      invocation response wrapped in the completion aware type.
      +
      +
      +
      • +
    • +
      +

      get

      +
      <T> CompletionStage<T> get(Class<T> responseType)
      +
      Description copied from interface: RxInvoker
      +
      Invoke HTTP GET method for the current request.
      +
      +
      Specified by:
      +
      get in interface RxInvoker<CompletionStage>
      +
      Type Parameters:
      +
      T - response entity type.
      +
      Parameters:
      +
      responseType - Java type the response entity will be converted to.
      +
      Returns:
      +
      invocation response wrapped in the completion aware type.
      +
      +
      +
      • +
    • +
      +

      get

      +
      <T> CompletionStage<T> get(GenericType<T> responseType)
      +
      Description copied from interface: RxInvoker
      +
      Invoke HTTP GET method for the current request.
      +
      +
      Specified by:
      +
      get in interface RxInvoker<CompletionStage>
      +
      Type Parameters:
      +
      T - generic response entity type.
      +
      Parameters:
      +
      responseType - representation of a generic Java type the response entity will be converted to.
      +
      Returns:
      +
      invocation response wrapped in the completion aware type.
      +
      +
      +
      • +
    • +
      +

      put

      +
      CompletionStage<Response> put(Entity<?> entity)
      +
      Description copied from interface: RxInvoker
      +
      Invoke HTTP PUT method for the current request.
      +
      +
      Specified by:
      +
      put in interface RxInvoker<CompletionStage>
      +
      Parameters:
      +
      entity - request entity, including it's full Variant information. Any variant-related + HTTP headers previously set (namely Content-Type, Content-Language and Content-Encoding) will + be overwritten using the entity variant information.
      +
      Returns:
      +
      invocation response wrapped in the completion aware type.
      +
      +
      +
      • +
    • +
      +

      put

      +
      <T> CompletionStage<T> put(Entity<?> entity, + Class<T> clazz)
      +
      Description copied from interface: RxInvoker
      +
      Invoke HTTP PUT method for the current request.
      +
      +
      Specified by:
      +
      put in interface RxInvoker<CompletionStage>
      +
      Type Parameters:
      +
      T - response entity type.
      +
      Parameters:
      +
      entity - request entity, including it's full Variant information. Any variant-related + HTTP headers previously set (namely Content-Type, Content-Language and Content-Encoding) will + be overwritten using the entity variant information.
      +
      clazz - Java type the response entity will be converted to.
      +
      Returns:
      +
      invocation response wrapped in the completion aware type.
      +
      +
      +
      • +
    • +
      +

      put

      +
      <T> CompletionStage<T> put(Entity<?> entity, + GenericType<T> type)
      +
      Description copied from interface: RxInvoker
      +
      Invoke HTTP PUT method for the current request.
      +
      +
      Specified by:
      +
      put in interface RxInvoker<CompletionStage>
      +
      Type Parameters:
      +
      T - generic response entity type.
      +
      Parameters:
      +
      entity - request entity, including it's full Variant information. Any variant-related + HTTP headers previously set (namely Content-Type, Content-Language and Content-Encoding) will + be overwritten using the entity variant information.
      +
      type - representation of a generic Java type the response entity will be converted to.
      +
      Returns:
      +
      invocation response wrapped in the completion aware type.
      +
      +
      +
      • +
    • +
      +

      post

      +
      CompletionStage<Response> post(Entity<?> entity)
      +
      Description copied from interface: RxInvoker
      +
      Invoke HTTP POST method for the current request.
      +
      +
      Specified by:
      +
      post in interface RxInvoker<CompletionStage>
      +
      Parameters:
      +
      entity - request entity, including it's full Variant information. Any variant-related + HTTP headers previously set (namely Content-Type, Content-Language and Content-Encoding) will + be overwritten using the entity variant information.
      +
      Returns:
      +
      invocation response wrapped in the completion aware type.
      +
      +
      +
      • +
    • +
      +

      post

      +
      <T> CompletionStage<T> post(Entity<?> entity, + Class<T> clazz)
      +
      Description copied from interface: RxInvoker
      +
      Invoke HTTP POST method for the current request.
      +
      +
      Specified by:
      +
      post in interface RxInvoker<CompletionStage>
      +
      Type Parameters:
      +
      T - response entity type.
      +
      Parameters:
      +
      entity - request entity, including it's full Variant information. Any variant-related + HTTP headers previously set (namely Content-Type, Content-Language and Content-Encoding) will + be overwritten using the entity variant information.
      +
      clazz - Java type the response entity will be converted to.
      +
      Returns:
      +
      invocation response wrapped in the completion aware type.
      +
      +
      +
      • +
    • +
      +

      post

      +
      <T> CompletionStage<T> post(Entity<?> entity, + GenericType<T> type)
      +
      Description copied from interface: RxInvoker
      +
      Invoke HTTP POST method for the current request.
      +
      +
      Specified by:
      +
      post in interface RxInvoker<CompletionStage>
      +
      Type Parameters:
      +
      T - generic response entity type.
      +
      Parameters:
      +
      entity - request entity, including it's full Variant information. Any variant-related + HTTP headers previously set (namely Content-Type, Content-Language and Content-Encoding) will + be overwritten using the entity variant information.
      +
      type - representation of a generic Java type the response entity will be converted to.
      +
      Returns:
      +
      invocation response wrapped in the completion aware type.
      +
      +
      +
      • +
    • +
      +

      delete

      +
      CompletionStage<Response> delete()
      +
      Description copied from interface: RxInvoker
      +
      Invoke HTTP DELETE method for the current request.
      +
      +
      Specified by:
      +
      delete in interface RxInvoker<CompletionStage>
      +
      Returns:
      +
      invocation response wrapped in the completion aware type.
      +
      +
      +
      • +
    • +
      +

      delete

      +
      <T> CompletionStage<T> delete(Class<T> responseType)
      +
      Description copied from interface: RxInvoker
      +
      Invoke HTTP DELETE method for the current request.
      +
      +
      Specified by:
      +
      delete in interface RxInvoker<CompletionStage>
      +
      Type Parameters:
      +
      T - response entity type.
      +
      Parameters:
      +
      responseType - Java type the response entity will be converted to.
      +
      Returns:
      +
      invocation response wrapped in the completion aware type.
      +
      +
      +
      • +
    • +
      +

      delete

      +
      <T> CompletionStage<T> delete(GenericType<T> responseType)
      +
      Description copied from interface: RxInvoker
      +
      Invoke HTTP DELETE method for the current request.
      +
      +
      Specified by:
      +
      delete in interface RxInvoker<CompletionStage>
      +
      Type Parameters:
      +
      T - generic response entity type.
      +
      Parameters:
      +
      responseType - representation of a generic Java type the response entity will be converted to.
      +
      Returns:
      +
      invocation response wrapped in the completion aware type.
      +
      +
      +
      • +
    • +
      +

      head

      +
      CompletionStage<Response> head()
      +
      Description copied from interface: RxInvoker
      +
      Invoke HTTP HEAD method for the current request.
      +
      +
      Specified by:
      +
      head in interface RxInvoker<CompletionStage>
      +
      Returns:
      +
      invocation response wrapped in the completion aware type.
      +
      +
      +
      • +
    • +
      +

      options

      +
      CompletionStage<Response> options()
      +
      Description copied from interface: RxInvoker
      +
      Invoke HTTP OPTIONS method for the current request.
      +
      +
      Specified by:
      +
      options in interface RxInvoker<CompletionStage>
      +
      Returns:
      +
      invocation response wrapped in the completion aware type.
      +
      +
      +
      • +
    • +
      +

      options

      +
      <T> CompletionStage<T> options(Class<T> responseType)
      +
      Description copied from interface: RxInvoker
      +
      Invoke HTTP OPTIONS method for the current request.
      +
      +
      Specified by:
      +
      options in interface RxInvoker<CompletionStage>
      +
      Type Parameters:
      +
      T - response entity type.
      +
      Parameters:
      +
      responseType - Java type the response entity will be converted to.
      +
      Returns:
      +
      invocation response wrapped in the completion aware type.
      +
      +
      +
      • +
    • +
      +

      options

      +
      <T> CompletionStage<T> options(GenericType<T> responseType)
      +
      Description copied from interface: RxInvoker
      +
      Invoke HTTP OPTIONS method for the current request.
      +
      +
      Specified by:
      +
      options in interface RxInvoker<CompletionStage>
      +
      Type Parameters:
      +
      T - generic response entity type.
      +
      Parameters:
      +
      responseType - representation of a generic Java type the response entity will be converted to.
      +
      Returns:
      +
      invocation response wrapped in the completion aware type.
      +
      +
      +
      • +
    • +
      +

      trace

      +
      CompletionStage<Response> trace()
      +
      Description copied from interface: RxInvoker
      +
      Invoke HTTP TRACE method for the current request.
      +
      +
      Specified by:
      +
      trace in interface RxInvoker<CompletionStage>
      +
      Returns:
      +
      invocation response wrapped in the completion aware type.
      +
      +
      +
      • +
    • +
      +

      trace

      +
      <T> CompletionStage<T> trace(Class<T> responseType)
      +
      Description copied from interface: RxInvoker
      +
      Invoke HTTP TRACE method for the current request.
      +
      +
      Specified by:
      +
      trace in interface RxInvoker<CompletionStage>
      +
      Type Parameters:
      +
      T - response entity type.
      +
      Parameters:
      +
      responseType - Java type the response entity will be converted to.
      +
      Returns:
      +
      invocation response wrapped in the completion aware type.
      +
      +
      +
      • +
    • +
      +

      trace

      +
      <T> CompletionStage<T> trace(GenericType<T> responseType)
      +
      Description copied from interface: RxInvoker
      +
      Invoke HTTP TRACE method for the current request.
      +
      +
      Specified by:
      +
      trace in interface RxInvoker<CompletionStage>
      +
      Type Parameters:
      +
      T - generic response entity type.
      +
      Parameters:
      +
      responseType - representation of a generic Java type the response entity will be converted to.
      +
      Returns:
      +
      invocation response wrapped in the completion aware type.
      +
      +
      +
      • +
    • +
      +

      method

      +
      CompletionStage<Response> method(String name)
      +
      Description copied from interface: RxInvoker
      +
      Invoke an arbitrary method for the current request.
      +
      +
      Specified by:
      +
      method in interface RxInvoker<CompletionStage>
      +
      Parameters:
      +
      name - method name.
      +
      Returns:
      +
      invocation response wrapped in the completion aware type..
      +
      +
      +
      • +
    • +
      +

      method

      +
      <T> CompletionStage<T> method(String name, + Class<T> responseType)
      +
      Description copied from interface: RxInvoker
      +
      Invoke an arbitrary method for the current request.
      +
      +
      Specified by:
      +
      method in interface RxInvoker<CompletionStage>
      +
      Type Parameters:
      +
      T - response entity type.
      +
      Parameters:
      +
      name - method name.
      +
      responseType - Java type the response entity will be converted to.
      +
      Returns:
      +
      invocation response wrapped in the completion aware type..
      +
      +
      +
      • +
    • +
      +

      method

      +
      <T> CompletionStage<T> method(String name, + GenericType<T> responseType)
      +
      Description copied from interface: RxInvoker
      +
      Invoke an arbitrary method for the current request.
      +
      +
      Specified by:
      +
      method in interface RxInvoker<CompletionStage>
      +
      Type Parameters:
      +
      T - generic response entity type.
      +
      Parameters:
      +
      name - method name.
      +
      responseType - representation of a generic Java type the response entity will be converted to.
      +
      Returns:
      +
      invocation response wrapped in the completion aware type..
      +
      +
      +
      • +
    • +
      +

      method

      +
      CompletionStage<Response> method(String name, + Entity<?> entity)
      +
      Description copied from interface: RxInvoker
      +
      Invoke an arbitrary method for the current request.
      +
      +
      Specified by:
      +
      method in interface RxInvoker<CompletionStage>
      +
      Parameters:
      +
      name - method name.
      +
      entity - request entity, including it's full Variant information. Any variant-related + HTTP headers previously set (namely Content-Type, Content-Language and Content-Encoding) will + be overwritten using the entity variant information.
      +
      Returns:
      +
      invocation response wrapped in the completion aware type..
      +
      +
      +
      • +
    • +
      +

      method

      +
      <T> CompletionStage<T> method(String name, + Entity<?> entity, + Class<T> responseType)
      +
      Description copied from interface: RxInvoker
      +
      Invoke an arbitrary method for the current request.
      +
      +
      Specified by:
      +
      method in interface RxInvoker<CompletionStage>
      +
      Type Parameters:
      +
      T - response entity type.
      +
      Parameters:
      +
      name - method name.
      +
      entity - request entity, including it's full Variant information. Any variant-related + HTTP headers previously set (namely Content-Type, Content-Language and Content-Encoding) will + be overwritten using the entity variant information.
      +
      responseType - Java type the response entity will be converted to.
      +
      Returns:
      +
      invocation response wrapped in the completion aware type..
      +
      +
      +
      • +
    • +
      +

      method

      +
      <T> CompletionStage<T> method(String name, + Entity<?> entity, + GenericType<T> responseType)
      +
      Description copied from interface: RxInvoker
      +
      Invoke an arbitrary method for the current request.
      +
      +
      Specified by:
      +
      method in interface RxInvoker<CompletionStage>
      +
      Type Parameters:
      +
      T - generic response entity type.
      +
      Parameters:
      +
      name - method name.
      +
      entity - request entity, including it's full Variant information. Any variant-related + HTTP headers previously set (namely Content-Type, Content-Language and Content-Encoding) will + be overwritten using the entity variant information.
      +
      responseType - representation of a generic Java type the response entity will be converted to.
      +
      Returns:
      +
      invocation response wrapped in the completion aware type..
      +
      +
      +
      • +
    +
    +
    • +
+
+ +
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/client/Entity.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/client/Entity.html new file mode 100644 index 0000000000..965a97a6d6 --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/client/Entity.html @@ -0,0 +1,546 @@ + + + + +Entity (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Module jakarta.ws.rs
+
Package jakarta.ws.rs.client
+

Class Entity<T>

+
+
java.lang.Object +
jakarta.ws.rs.client.Entity<T>
+
+
+
+
Type Parameters:
+
T - entity type.
+
+
+
public final class Entity<T> +extends Object
+
Encapsulates message entity including the associated variant information.
+
+
Author:
+
Marek Potociar
+
+
+
+ +
+
+
    + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      entity

      +
      public static <T> Entity<T> entity(T entity, + MediaType mediaType)
      +
      Create an entity using a supplied content media type.
      +
      +
      Type Parameters:
      +
      T - entity Java type.
      +
      Parameters:
      +
      entity - entity data.
      +
      mediaType - entity content type.
      +
      Returns:
      +
      entity instance.
      +
      +
      +
      • +
    • +
      +

      entity

      +
      public static <T> Entity<T> entity(T entity, + MediaType mediaType, + Annotation[] annotations)
      +
      Create an entity using a supplied content media type.
      +
      +
      Type Parameters:
      +
      T - entity Java type.
      +
      Parameters:
      +
      entity - entity data.
      +
      mediaType - entity content type.
      +
      annotations - entity annotations.
      +
      Returns:
      +
      entity instance.
      +
      +
      +
      • +
    • +
      +

      entity

      +
      public static <T> Entity<T> entity(T entity, + String mediaType)
      +
      Create an entity using a supplied content media type.
      +
      +
      Type Parameters:
      +
      T - entity Java type.
      +
      Parameters:
      +
      entity - entity data.
      +
      mediaType - entity content type.
      +
      Returns:
      +
      entity instance.
      +
      Throws:
      +
      IllegalArgumentException - if the supplied string cannot be parsed or is null.
      +
      +
      +
      • +
    • +
      +

      entity

      +
      public static <T> Entity<T> entity(T entity, + Variant variant)
      +
      Create an entity using a supplied content media type.
      +
      +
      Type Parameters:
      +
      T - entity Java type.
      +
      Parameters:
      +
      entity - entity data.
      +
      variant - entity variant information.
      +
      Returns:
      +
      entity instance.
      +
      +
      +
      • +
    • +
      +

      entity

      +
      public static <T> Entity<T> entity(T entity, + Variant variant, + Annotation[] annotations)
      +
      Create an entity using a supplied content media type.
      +
      +
      Type Parameters:
      +
      T - entity Java type.
      +
      Parameters:
      +
      entity - entity data.
      +
      variant - entity variant information.
      +
      annotations - entity annotations.
      +
      Returns:
      +
      entity instance.
      +
      +
      +
      • +
    • +
      +

      text

      +
      public static <T> Entity<T> text(T entity)
      +
      Create a "text/plain" entity.
      +
      +
      Type Parameters:
      +
      T - entity Java type.
      +
      Parameters:
      +
      entity - entity data.
      +
      Returns:
      +
      "text/plain" entity instance.
      +
      +
      +
      • +
    • +
      +

      xml

      +
      public static <T> Entity<T> xml(T entity)
      +
      Create an "application/xml" entity.
      +
      +
      Type Parameters:
      +
      T - entity Java type.
      +
      Parameters:
      +
      entity - entity data.
      +
      Returns:
      +
      "application/xml" entity instance.
      +
      +
      +
      • +
    • +
      +

      json

      +
      public static <T> Entity<T> json(T entity)
      +
      Create an "application/json" entity.
      +
      +
      Type Parameters:
      +
      T - entity Java type.
      +
      Parameters:
      +
      entity - entity data.
      +
      Returns:
      +
      "application/json" entity instance.
      +
      +
      +
      • +
    • +
      +

      html

      +
      public static <T> Entity<T> html(T entity)
      +
      Create a "text/html" entity.
      +
      +
      Type Parameters:
      +
      T - entity Java type.
      +
      Parameters:
      +
      entity - entity data.
      +
      Returns:
      +
      "text/html" entity instance.
      +
      +
      +
      • +
    • +
      +

      xhtml

      +
      public static <T> Entity<T> xhtml(T entity)
      +
      Create an "application/xhtml+xml" entity.
      +
      +
      Type Parameters:
      +
      T - entity Java type.
      +
      Parameters:
      +
      entity - entity data.
      +
      Returns:
      +
      "application/xhtml+xml" entity instance.
      +
      +
      +
      • +
    • +
      +

      form

      +
      public static Entity<Form> form(Form form)
      +
      Create an "application/x-www-form-urlencoded" form entity.
      +
      +
      Parameters:
      +
      form - form data.
      +
      Returns:
      +
      "application/x-www-form-urlencoded" form entity instance.
      +
      +
      +
      • +
    • +
      +

      form

      +
      public static Entity<Form> form(MultivaluedMap<String,String> formData)
      +
      Create an "application/x-www-form-urlencoded" form entity.
      +
      +
      Parameters:
      +
      formData - multivalued map representing the form data.
      +
      Returns:
      +
      "application/x-www-form-urlencoded" form entity instance.
      +
      +
      +
      • +
    • +
      +

      getVariant

      +
      public Variant getVariant()
      +
      Get entity variant information.
      +
      +
      Returns:
      +
      entity variant information.
      +
      +
      +
      • +
    • +
      +

      getMediaType

      +
      public MediaType getMediaType()
      +
      Get entity media type.
      +
      +
      Returns:
      +
      entity media type.
      +
      +
      +
      • +
    • +
      +

      getEncoding

      +
      public String getEncoding()
      +
      Get entity encoding.
      +
      +
      Returns:
      +
      entity encoding.
      +
      +
      +
      • +
    • +
      +

      getLanguage

      +
      public Locale getLanguage()
      +
      Get entity language.
      +
      +
      Returns:
      +
      entity language.
      +
      +
      +
      • +
    • +
      +

      getEntity

      +
      public T getEntity()
      +
      Get entity data.
      +
      +
      Returns:
      +
      entity data.
      +
      +
      +
      • +
    • +
      +

      getAnnotations

      +
      public Annotation[] getAnnotations()
      +
      Get the entity annotations.
      +
      +
      Returns:
      +
      entity annotations if set, an empty annotation array if no entity annotations have been specified.
      +
      +
      +
      • +
    • +
      +

      equals

      +
      public boolean equals(Object o)
      +
      +
      Overrides:
      +
      equals in class Object
      +
      +
      +
      • +
    • +
      +

      hashCode

      +
      public int hashCode()
      +
      +
      Overrides:
      +
      hashCode in class Object
      +
      +
      +
      • +
    • +
      +

      toString

      +
      public String toString()
      +
      +
      Overrides:
      +
      toString in class Object
      +
      +
      +
      • +
    +
    +
    • +
+
+ +
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/client/Invocation.Builder.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/client/Invocation.Builder.html new file mode 100644 index 0000000000..f98083c49c --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/client/Invocation.Builder.html @@ -0,0 +1,601 @@ + + + + +Invocation.Builder (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Module jakarta.ws.rs
+
Package jakarta.ws.rs.client
+

Interface Invocation.Builder

+
+
+
+
All Superinterfaces:
+
SyncInvoker
+
+
+
Enclosing interface:
+
Invocation
+
+
+
public static interface Invocation.Builder +extends SyncInvoker
+
A client request invocation builder. + + The builder, obtained via a call to one of the request(...) methods on a resource target, + provides methods for preparing a client request invocation. Once the request is prepared the invocation builder can + be either used to build an Invocation with a generic execution interface: + + 
+ Client client = ClientBuilder.newClient();
+ WebTarget resourceTarget = client.target("http://examples.jaxrs.com/");
+
+ // Build a HTTP GET request that accepts "text/plain" response type
+ // and contains a custom HTTP header entry "Foo: bar".
+ Invocation invocation = resourceTarget.request("text/plain")
+         .header("Foo", "bar").buildGet();
+
+ // Invoke the request using generic interface
+ String response = invocation.invoke(String.class);
+
+ + Alternatively, one of the inherited synchronous invocation methods can be used to invoke the + prepared request and return the server response in a single step, e.g.: + + 
+ Client client = ClientBuilder.newClient();
+ WebTarget resourceTarget = client.target("http://examples.jaxrs.com/");
+
+ // Build and invoke the get request in a single step
+ String response = resourceTarget.request("text/plain")
+         .header("Foo", "bar").get(String.class);
+
+ + Once the request is fully prepared for invoking, switching to an asynchronous invocation mode is + possible by calling the async() method on the builder, e.g.: + + 
+ Client client = ClientBuilder.newClient();
+ WebTarget resourceTarget = client.target("http://examples.jaxrs.com/");
+
+ // Build and invoke the get request asynchronously in a single step
+ Future<String> response = resourceTarget.request("text/plain")
+         .header("Foo", "bar").async().get(String.class);
+
+
+
+ +
+
+
    + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      build

      +
      Invocation build(String method)
      +
      Build a request invocation using an arbitrary request method name.
      +
      +
      Parameters:
      +
      method - request method name.
      +
      Returns:
      +
      invocation encapsulating the built request.
      +
      +
      +
      • +
    • +
      +

      build

      +
      Invocation build(String method, + Entity<?> entity)
      +
      Build a request invocation using an arbitrary request method name and request entity.
      +
      +
      Parameters:
      +
      method - request method name.
      +
      entity - request entity, including it's full Variant information. Any variant-related + HTTP headers previously set (namely Content-Type, Content-Language and Content-Encoding) will + be overwritten using the entity variant information.
      +
      Returns:
      +
      invocation encapsulating the built request.
      +
      +
      +
      • +
    • +
      +

      buildGet

      +
      Invocation buildGet()
      +
      Build a GET request invocation.
      +
      +
      Returns:
      +
      invocation encapsulating the built GET request.
      +
      +
      +
      • +
    • +
      +

      buildDelete

      +
      Invocation buildDelete()
      +
      Build a DELETE request invocation.
      +
      +
      Returns:
      +
      invocation encapsulating the built DELETE request.
      +
      +
      +
      • +
    • +
      +

      buildPost

      +
      Invocation buildPost(Entity<?> entity)
      +
      Build a POST request invocation.
      +
      +
      Parameters:
      +
      entity - request entity, including it's full Variant information. Any variant-related + HTTP headers previously set (namely Content-Type, Content-Language and Content-Encoding) will + be overwritten using the entity variant information.
      +
      Returns:
      +
      invocation encapsulating the built POST request.
      +
      +
      +
      • +
    • +
      +

      buildPut

      +
      Invocation buildPut(Entity<?> entity)
      +
      Build a PUT request invocation.
      +
      +
      Parameters:
      +
      entity - request entity, including it's full Variant information. Any variant-related + HTTP headers previously set (namely Content-Type, Content-Language and Content-Encoding) will + be overwritten using the entity variant information.
      +
      Returns:
      +
      invocation encapsulating the built PUT request.
      +
      +
      +
      • +
    • +
      +

      async

      +
      AsyncInvoker async()
      +
      Access the asynchronous uniform request invocation interface to asynchronously invoke the built request.
      +
      +
      Returns:
      +
      asynchronous uniform request invocation interface.
      +
      +
      +
      • +
    • +
      +

      accept

      +
      Invocation.Builder accept(String... mediaTypes)
      +
      Add the accepted response media types.
      +
      +
      Parameters:
      +
      mediaTypes - accepted response media types.
      +
      Returns:
      +
      the updated builder.
      +
      +
      +
      • +
    • +
      +

      accept

      +
      Invocation.Builder accept(MediaType... mediaTypes)
      +
      Add the accepted response media types.
      +
      +
      Parameters:
      +
      mediaTypes - accepted response media types.
      +
      Returns:
      +
      the updated builder.
      +
      +
      +
      • +
    • +
      +

      acceptLanguage

      +
      Invocation.Builder acceptLanguage(Locale... locales)
      +
      Add acceptable languages.
      +
      +
      Parameters:
      +
      locales - an array of the acceptable languages.
      +
      Returns:
      +
      the updated builder.
      +
      +
      +
      • +
    • +
      +

      acceptLanguage

      +
      Invocation.Builder acceptLanguage(String... locales)
      +
      Add acceptable languages.
      +
      +
      Parameters:
      +
      locales - an array of the acceptable languages.
      +
      Returns:
      +
      the updated builder.
      +
      +
      +
      • +
    • +
      +

      acceptEncoding

      +
      Invocation.Builder acceptEncoding(String... encodings)
      +
      Add acceptable encodings.
      +
      +
      Parameters:
      +
      encodings - an array of the acceptable encodings.
      +
      Returns:
      +
      the updated builder.
      +
      +
      +
      • +
    • +
      +

      cookie

      +
      Invocation.Builder cookie(Cookie cookie)
      +
      Add a cookie to be set.
      +
      +
      Parameters:
      +
      cookie - to be set.
      +
      Returns:
      +
      the updated builder.
      +
      +
      +
      • +
    • +
      +

      cookie

      +
      Invocation.Builder cookie(String name, + String value)
      +
      Add a cookie to be set.
      +
      +
      Parameters:
      +
      name - the name of the cookie.
      +
      value - the value of the cookie.
      +
      Returns:
      +
      the updated builder.
      +
      +
      +
      • +
    • +
      +

      cacheControl

      +
      Invocation.Builder cacheControl(CacheControl cacheControl)
      +
      Set the cache control data of the message.
      +
      +
      Parameters:
      +
      cacheControl - the cache control directives, if null any existing cache control directives will be + removed.
      +
      Returns:
      +
      the updated builder.
      +
      +
      +
      • +
    • +
      +

      header

      +
      Invocation.Builder header(String name, + Object value)
      +
      Add an arbitrary header.
      +
      +
      Parameters:
      +
      name - the name of the header
      +
      value - the value of the header, the header will be serialized using a + RuntimeDelegate.HeaderDelegate if one is available via + RuntimeDelegate.createHeaderDelegate(java.lang.Class) for the class of value or using + its toString method if a header delegate is not available. If value is null then all current + headers of the same name will be removed.
      +
      Returns:
      +
      the updated builder.
      +
      +
      +
      • +
    • +
      +

      headers

      +
      Invocation.Builder headers(MultivaluedMap<String,Object> headers)
      +
      Replaces all existing headers with the newly supplied headers.
      +
      +
      Parameters:
      +
      headers - new headers to be set, if null all existing headers will be removed.
      +
      Returns:
      +
      the updated builder.
      +
      +
      +
      • +
    • +
      +

      property

      +
      Invocation.Builder property(String name, + Object value)
      +
      Set a new property in the context of a request represented by this invocation builder. +

      + The property is available for a later retrieval via ClientRequestContext.getProperty(String) or + InterceptorContext.getProperty(String). If a property with a given name is already set in the + request context, the existing value of the property will be updated. Setting a null value into a property + effectively removes the property from the request property bag. +

      +
      +
      Parameters:
      +
      name - property name.
      +
      value - (new) property value. null value removes the property with the given name.
      +
      Returns:
      +
      the updated builder.
      +
      See Also:
      +
      + +
      +
      +
      +
      • +
    • +
      +

      rx

      +
      CompletionStageRxInvoker rx()
      +
      Access the default reactive invoker based on CompletionStage.
      +
      +
      Returns:
      +
      default reactive invoker instance.
      +
      Since:
      +
      2.1
      +
      See Also:
      +
      + +
      +
      +
      +
      • +
    • +
      +

      rx

      +
      <T extends RxInvoker> T rx(Class<T> clazz)
      +
      Access a reactive invoker based on a RxInvoker subclass provider. Note that corresponding + RxInvokerProvider must be registered in the client runtime. +

      + This method is an extension point for JAX-RS implementations to support other types representing asynchronous + computations.

      +
      +
      Type Parameters:
      +
      T - generic invoker type.
      +
      Parameters:
      +
      clazz - RxInvoker subclass.
      +
      Returns:
      +
      reactive invoker instance.
      +
      Throws:
      +
      IllegalStateException - when provider for given class is not registered.
      +
      Since:
      +
      2.1
      +
      See Also:
      +
      + +
      +
      +
      +
      • +
    +
    +
    • +
+
+ +
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/client/Invocation.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/client/Invocation.html new file mode 100644 index 0000000000..e83195917a --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/client/Invocation.html @@ -0,0 +1,387 @@ + + + + +Invocation (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Module jakarta.ws.rs
+
Package jakarta.ws.rs.client
+

Interface Invocation

+
+
+
+
public interface Invocation
+
A client request invocation. + + An invocation is a request that has been prepared and is ready for execution. Invocations provide a generic (command) + interface that enables a separation of concerns between the creator and the submitter. In particular, the submitter + does not need to know how the invocation was prepared, but only how it should be executed (synchronously or + asynchronously) and when.
+
+
Author:
+
Marek Potociar, Santiago Pericas-Geertsen
+
See Also:
+
+ +
+
+
+
+
    + +
  • +
    +

    Nested Class Summary

    +
    Nested Classes
    +
    +
    Modifier and Type
    +
    Interface
    +
    Description
    +
    static interface 
    +
    Invocation.Builder
    +
    +
    A client request invocation builder.
    +
    +
    +
    +
    • + +
  • +
    +

    Method Summary

    +
    +
    +
    +
    +
    Modifier and Type
    +
    Method
    +
    Description
    +
    Response
    +
    invoke()
    +
    +
    Synchronously invoke the request and receive a response back.
    +
    +
    <T> T
    +
    invoke(GenericType<T> responseType)
    +
    +
    Synchronously invoke the request and receive a response of the specified generic type back.
    +
    +
    <T> T
    +
    invoke(Class<T> responseType)
    +
    +
    Synchronously invoke the request and receive a response of the specified type back.
    +
    +
    Invocation
    +
    property(String name, + Object value)
    +
    +
    Set a new property in the context of a request represented by this invocation.
    +
    +
    Future<Response>
    +
    submit()
    +
    +
    Submit the request for an asynchronous invocation and receive a future response back.
    +
    +
    <T> Future<T>
    +
    submit(InvocationCallback<T> callback)
    +
    +
    Submit the request for an asynchronous invocation and register an InvocationCallback to process the future + result of the invocation.
    +
    +
    <T> Future<T>
    +
    submit(GenericType<T> responseType)
    +
    +
    Submit the request for an asynchronous invocation and receive a future response of the specified generic type back.
    +
    +
    <T> Future<T>
    +
    submit(Class<T> responseType)
    +
    +
    Submit the request for an asynchronous invocation and receive a future response of the specified type back.
    +
    +
    +
    +
    +
    +
    • +
+
+
+
    + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      property

      +
      Invocation property(String name, + Object value)
      +
      Set a new property in the context of a request represented by this invocation. +

      + The property is available for a later retrieval via ClientRequestContext.getProperty(String) or + InterceptorContext.getProperty(String). If a property with a given name is already set in the + request context, the existing value of the property will be updated. Setting a null value into a property + effectively removes the property from the request property bag. +

      +
      +
      Parameters:
      +
      name - property name.
      +
      value - (new) property value. null value removes the property with the given name.
      +
      Returns:
      +
      the updated invocation.
      +
      See Also:
      +
      + +
      +
      +
      +
      • +
    • +
      +

      invoke

      +
      Response invoke()
      +
      Synchronously invoke the request and receive a response back.
      +
      +
      Returns:
      +
      response object as a result of the request invocation.
      +
      Throws:
      +
      ResponseProcessingException - in case processing of a received HTTP response fails (e.g. in a filter or during + conversion of the response entity data to an instance of a particular Java type).
      +
      ProcessingException - in case the request processing or subsequent I/O operation fails.
      +
      +
      +
      • +
    • +
      +

      invoke

      +
      <T> T invoke(Class<T> responseType)
      +
      Synchronously invoke the request and receive a response of the specified type back.
      +
      +
      Type Parameters:
      +
      T - response type
      +
      Parameters:
      +
      responseType - Java type the response should be converted into.
      +
      Returns:
      +
      response object of the specified type as a result of the request invocation.
      +
      Throws:
      +
      ResponseProcessingException - in case processing of a received HTTP response fails (e.g. in a filter or during + conversion of the response entity data to an instance of a particular Java type).
      +
      ProcessingException - in case the request processing or subsequent I/O operation fails.
      +
      WebApplicationException - in case the response status code of the response returned by the server is not + successful and the specified response type is not + Response.
      +
      +
      +
      • +
    • +
      +

      invoke

      +
      <T> T invoke(GenericType<T> responseType)
      +
      Synchronously invoke the request and receive a response of the specified generic type back.
      +
      +
      Type Parameters:
      +
      T - generic response type
      +
      Parameters:
      +
      responseType - type literal representing a generic Java type the response should be converted into.
      +
      Returns:
      +
      response object of the specified generic type as a result of the request invocation.
      +
      Throws:
      +
      ResponseProcessingException - in case processing of a received HTTP response fails (e.g. in a filter or during + conversion of the response entity data to an instance of a particular Java type).
      +
      ProcessingException - in case the request processing or subsequent I/O operation fails.
      +
      WebApplicationException - in case the response status code of the response returned by the server is not + successful.
      +
      +
      +
      • +
    • +
      +

      submit

      +
      Future<Response> submit()
      +
      Submit the request for an asynchronous invocation and receive a future response back. +

      + Note that calling the Future.get() method on the returned Future instance may + throw an ExecutionException that wraps a ProcessingException thrown in case of + an invocation processing failure. In case a processing of a properly received response fails, the wrapped processing + exception will be of ResponseProcessingException type and will contain the Response instance whose + processing has failed. +

      +
      +
      Returns:
      +
      future response object as a result of the request invocation.
      +
      +
      +
      • +
    • +
      +

      submit

      +
      <T> Future<T> submit(Class<T> responseType)
      +
      Submit the request for an asynchronous invocation and receive a future response of the specified type back. +

      + Note that calling the Future.get() method on the returned Future instance may + throw an ExecutionException that wraps either a ProcessingException thrown in + case of an invocation processing failure or a WebApplicationException or one of its subclasses thrown in case + the received response status code is not successful and + the specified response type is not Response. In case a processing of a properly received + response fails, the wrapped processing exception will be of ResponseProcessingException type and will contain + the Response instance whose processing has failed. +

      +
      +
      Type Parameters:
      +
      T - response type
      +
      Parameters:
      +
      responseType - Java type the response should be converted into.
      +
      Returns:
      +
      future response object of the specified type as a result of the request invocation.
      +
      +
      +
      • +
    • +
      +

      submit

      +
      <T> Future<T> submit(GenericType<T> responseType)
      +
      Submit the request for an asynchronous invocation and receive a future response of the specified generic type back. +

      + Note that calling the Future.get() method on the returned Future instance may + throw an ExecutionException that wraps either a ProcessingException thrown in + case of an invocation processing failure or a WebApplicationException or one of its subclasses thrown in case + the received response status code is not successful and + the specified response type is not Response. In case a processing of a properly received + response fails, the wrapped processing exception will be of ResponseProcessingException type and will contain + the Response instance whose processing has failed. +

      +
      +
      Type Parameters:
      +
      T - generic response type
      +
      Parameters:
      +
      responseType - type literal representing a generic Java type the response should be converted into.
      +
      Returns:
      +
      future response object of the specified generic type as a result of the request invocation.
      +
      +
      +
      • +
    • +
      +

      submit

      +
      <T> Future<T> submit(InvocationCallback<T> callback)
      +
      Submit the request for an asynchronous invocation and register an InvocationCallback to process the future + result of the invocation. +

      + Note that calling the Future.get() method on the returned Future instance may + throw an ExecutionException that wraps either a ProcessingException thrown in + case of an invocation processing failure or a WebApplicationException or one of its subclasses thrown in case + the received response status code is not successful and + the generic type of the supplied response callback is not Response. In case a processing of + a properly received response fails, the wrapped processing exception will be of ResponseProcessingException + type and will contain the Response instance whose processing has failed. +

      +
      +
      Type Parameters:
      +
      T - response type
      +
      Parameters:
      +
      callback - invocation callback for asynchronous processing of the request invocation result.
      +
      Returns:
      +
      future response object of the specified type as a result of the request invocation.
      +
      +
      +
      • +
    +
    +
    • +
+
+ +
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/client/InvocationCallback.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/client/InvocationCallback.html new file mode 100644 index 0000000000..d90c4a2b19 --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/client/InvocationCallback.html @@ -0,0 +1,200 @@ + + + + +InvocationCallback (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Module jakarta.ws.rs
+
Package jakarta.ws.rs.client
+

Interface InvocationCallback<RESPONSE>

+
+
+
+
Type Parameters:
+
RESPONSE - response type. It can be either a general-purpose Response or the + anticipated response entity type.
+
+
+
public interface InvocationCallback<RESPONSE>
+
Callback that can be implemented to receive the asynchronous processing events from the invocation processing.
+
+
Since:
+
2.0
+
Author:
+
Marek Potociar
+
+
+
+
    + +
  • +
    +

    Method Summary

    +
    +
    +
    +
    +
    Modifier and Type
    +
    Method
    +
    Description
    +
    void
    +
    completed(RESPONSE response)
    +
    +
    Called when the invocation was successfully completed.
    +
    +
    void
    +
    failed(Throwable throwable)
    +
    +
    Called when the invocation has failed for any reason.
    +
    +
    +
    +
    +
    +
    • +
+
+
+
    + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      completed

      +
      void completed(RESPONSE response)
      +
      Called when the invocation was successfully completed. Note that this does not necessarily mean the response has bean + fully read, which depends on the parameterized invocation callback response type. +

      + Once this invocation callback method returns, the underlying Response instance will be + automatically closed by the runtime. +

      +
      +
      Parameters:
      +
      response - response data.
      +
      +
      +
      • +
    • +
      +

      failed

      +
      void failed(Throwable throwable)
      +
      Called when the invocation has failed for any reason. +

      + Note that the provided Throwable may be a ProcessingException in case the invocation + processing failure has been caused by a client-side runtime component error. The Throwable may also be a + WebApplicationException or one of its subclasses in case the response status code is not + successful and the generic callback type is not + Response. In case a processing of a properly received response fails, the wrapped processing + exception will be of ResponseProcessingException type and will contain the Response + instance whose processing has failed. A CancellationException would be indicate that the + invocation has been cancelled. An InterruptedException would indicate that the thread executing the + invocation has been interrupted. +

      +

      + Once this invocation callback method returns, the underlying Response instance will be + automatically closed by the runtime. +

      +
      +
      Parameters:
      +
      throwable - contains failure details.
      +
      +
      +
      • +
    +
    +
    • +
+
+ +
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/client/ResponseProcessingException.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/client/ResponseProcessingException.html new file mode 100644 index 0000000000..be1fef239b --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/client/ResponseProcessingException.html @@ -0,0 +1,278 @@ + + + + +ResponseProcessingException (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Module jakarta.ws.rs
+
Package jakarta.ws.rs.client
+

Class ResponseProcessingException

+
+
java.lang.Object +
java.lang.Throwable +
java.lang.Exception +
java.lang.RuntimeException +
jakarta.ws.rs.ProcessingException +
jakarta.ws.rs.client.ResponseProcessingException
+
+
+
+
+
+
+
+
All Implemented Interfaces:
+
Serializable
+
+
+
public class ResponseProcessingException +extends ProcessingException
+
JAX-RS client-side runtime processing exception thrown to indicate that response processing has failed (e.g. in a + filter chain or during message entity de-serialization). The exception contains the nested Response instance + for which the runtime response processing failed.
+
+
Since:
+
2.0
+
Author:
+
Marek Potociar (marek.potociar at oracle.com)
+
See Also:
+
+ +
+
+
+
+ +
+
+
    + +
  • +
    +

    Constructor Details

    +
      +
    • +
      +

      ResponseProcessingException

      +
      public ResponseProcessingException(Response response, + Throwable cause)
      +
      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). This constructor is useful for runtime exceptions that are little more + than wrappers for other throwables.
      +
      +
      Parameters:
      +
      response - the response instance for which the processing failed.
      +
      cause - the cause (which is saved for later retrieval by the Throwable.getCause() method). (A null value + is permitted, and indicates that the cause is nonexistent or unknown.)
      +
      +
      +
      • +
    • +
      +

      ResponseProcessingException

      +
      public ResponseProcessingException(Response response, + String message, + Throwable cause)
      +

      + Constructs a new JAX-RS runtime response processing exception with the specified detail message and cause. +

      + Note that the detail message associated with cause is not automatically incorporated in this runtime + exception's detail message.
      +
      +
      Parameters:
      +
      response - the response instance for which the processing failed.
      +
      message - the detail message (which is saved for later retrieval by the Throwable.getMessage() method).
      +
      cause - the cause (which is saved for later retrieval by the Throwable.getCause() method). (A null value + is permitted, and indicates that the cause is nonexistent or unknown.)
      +
      +
      +
      • +
    • +
      +

      ResponseProcessingException

      +
      public ResponseProcessingException(Response response, + String message)
      +
      Constructs a new JAX-RS runtime processing exception with the specified detail message. The cause is not initialized, + and may subsequently be initialized by a call to Throwable.initCause(java.lang.Throwable).
      +
      +
      Parameters:
      +
      response - the response instance for which the processing failed.
      +
      message - the detail message (which is saved for later retrieval by the Throwable.getMessage() method).
      +
      +
      +
      • +
    +
    +
    • + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      getResponse

      +
      public Response getResponse()
      +
      Get the HTTP response for which the processing has failed.
      +
      +
      Returns:
      +
      the HTTP response.
      +
      +
      +
      • +
    +
    +
    • +
+
+ +
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/client/RxInvoker.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/client/RxInvoker.html new file mode 100644 index 0000000000..774252a1a4 --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/client/RxInvoker.html @@ -0,0 +1,830 @@ + + + + +RxInvoker (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Module jakarta.ws.rs
+
Package jakarta.ws.rs.client
+

Interface RxInvoker<T>

+
+
+
+
Type Parameters:
+
T - a type representing the asynchronous computation.
+
+
+
All Known Subinterfaces:
+
CompletionStageRxInvoker
+
+
+
public interface RxInvoker<T>
+
Uniform interface for reactive invocation of HTTP methods. All reactive invokers in JAX-RS must implement this + interface. The type parameter T represents the Java type of an asynchronous computation. All JAX-RS + implementations MUST support the default reactive invoker based on CompletionStage.
+
+
Since:
+
2.1
+
Author:
+
Marek Potociar, Santiago Pericas-Geertsen
+
See Also:
+
+ +
+
+
+
+
    + +
  • +
    +

    Method Summary

    +
    +
    +
    +
    +
    Modifier and Type
    +
    Method
    +
    Description
    +
    T
    +
    delete()
    +
    +
    Invoke HTTP DELETE method for the current request.
    +
    +
    <R> T
    +
    delete(GenericType<R> responseType)
    +
    +
    Invoke HTTP DELETE method for the current request.
    +
    +
    <R> T
    +
    delete(Class<R> responseType)
    +
    +
    Invoke HTTP DELETE method for the current request.
    +
    +
    T
    +
    get()
    +
    +
    Invoke HTTP GET method for the current request.
    +
    +
    <R> T
    +
    get(GenericType<R> responseType)
    +
    +
    Invoke HTTP GET method for the current request.
    +
    +
    <R> T
    +
    get(Class<R> responseType)
    +
    +
    Invoke HTTP GET method for the current request.
    +
    +
    T
    +
    head()
    +
    +
    Invoke HTTP HEAD method for the current request.
    +
    +
    T
    +
    method(String name)
    +
    +
    Invoke an arbitrary method for the current request.
    +
    +
    T
    +
    method(String name, + Entity<?> entity)
    +
    +
    Invoke an arbitrary method for the current request.
    +
    +
    <R> T
    +
    method(String name, + Entity<?> entity, + GenericType<R> responseType)
    +
    +
    Invoke an arbitrary method for the current request.
    +
    +
    <R> T
    +
    method(String name, + Entity<?> entity, + Class<R> responseType)
    +
    +
    Invoke an arbitrary method for the current request.
    +
    +
    <R> T
    +
    method(String name, + GenericType<R> responseType)
    +
    +
    Invoke an arbitrary method for the current request.
    +
    +
    <R> T
    +
    method(String name, + Class<R> responseType)
    +
    +
    Invoke an arbitrary method for the current request.
    +
    +
    T
    +
    options()
    +
    +
    Invoke HTTP OPTIONS method for the current request.
    +
    +
    <R> T
    +
    options(GenericType<R> responseType)
    +
    +
    Invoke HTTP OPTIONS method for the current request.
    +
    +
    <R> T
    +
    options(Class<R> responseType)
    +
    +
    Invoke HTTP OPTIONS method for the current request.
    +
    +
    T
    +
    post(Entity<?> entity)
    +
    +
    Invoke HTTP POST method for the current request.
    +
    +
    <R> T
    +
    post(Entity<?> entity, + GenericType<R> responseType)
    +
    +
    Invoke HTTP POST method for the current request.
    +
    +
    <R> T
    +
    post(Entity<?> entity, + Class<R> responseType)
    +
    +
    Invoke HTTP POST method for the current request.
    +
    +
    T
    +
    put(Entity<?> entity)
    +
    +
    Invoke HTTP PUT method for the current request.
    +
    +
    <R> T
    +
    put(Entity<?> entity, + GenericType<R> responseType)
    +
    +
    Invoke HTTP PUT method for the current request.
    +
    +
    <R> T
    +
    put(Entity<?> entity, + Class<R> responseType)
    +
    +
    Invoke HTTP PUT method for the current request.
    +
    +
    T
    +
    trace()
    +
    +
    Invoke HTTP TRACE method for the current request.
    +
    +
    <R> T
    +
    trace(GenericType<R> responseType)
    +
    +
    Invoke HTTP TRACE method for the current request.
    +
    +
    <R> T
    +
    trace(Class<R> responseType)
    +
    +
    Invoke HTTP TRACE method for the current request.
    +
    +
    +
    +
    +
    +
    • +
+
+
+
    + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      get

      +
      T get()
      +
      Invoke HTTP GET method for the current request.
      +
      +
      Returns:
      +
      invocation response wrapped in the completion aware type.
      +
      Throws:
      +
      ResponseProcessingException - in case processing of a received HTTP response fails (e.g. in + a filter or during conversion of the response entity data to an instance of a particular Java type).
      +
      ProcessingException - in case the request processing or subsequent I/O operation fails.
      +
      +
      +
      • +
    • +
      +

      get

      +
      <R> T get(Class<R> responseType)
      +
      Invoke HTTP GET method for the current request.
      +
      +
      Type Parameters:
      +
      R - response entity type.
      +
      Parameters:
      +
      responseType - Java type the response entity will be converted to.
      +
      Returns:
      +
      invocation response wrapped in the completion aware type.
      +
      Throws:
      +
      ResponseProcessingException - in case processing of a received HTTP response fails (e.g. in + a filter or during conversion of the response entity data to an instance of a particular Java type).
      +
      ProcessingException - in case the request processing or subsequent I/O operation fails.
      +
      WebApplicationException - in case the response status code of the response returned by the server + is not successful and the specified response type is not + Response.
      +
      +
      +
      • +
    • +
      +

      get

      +
      <R> T get(GenericType<R> responseType)
      +
      Invoke HTTP GET method for the current request.
      +
      +
      Type Parameters:
      +
      R - generic response entity type.
      +
      Parameters:
      +
      responseType - representation of a generic Java type the response entity will be converted to.
      +
      Returns:
      +
      invocation response wrapped in the completion aware type.
      +
      Throws:
      +
      ResponseProcessingException - in case processing of a received HTTP response fails (e.g. in + a filter or during conversion of the response entity data to an instance of a particular Java type).
      +
      ProcessingException - in case the request processing or subsequent I/O operation fails.
      +
      WebApplicationException - in case the response status code of the response returned by the server + is not successful and the specified response type is not + Response.
      +
      +
      +
      • +
    • +
      +

      put

      +
      T put(Entity<?> entity)
      +
      Invoke HTTP PUT method for the current request.
      +
      +
      Parameters:
      +
      entity - request entity, including it's full Variant information. Any variant-related + HTTP headers previously set (namely Content-Type, Content-Language and Content-Encoding) will + be overwritten using the entity variant information.
      +
      Returns:
      +
      invocation response wrapped in the completion aware type.
      +
      Throws:
      +
      ResponseProcessingException - in case processing of a received HTTP response fails (e.g. in + a filter or during conversion of the response entity data to an instance of a particular Java type).
      +
      ProcessingException - in case the request processing or subsequent I/O operation fails.
      +
      +
      +
      • +
    • +
      +

      put

      +
      <R> T put(Entity<?> entity, + Class<R> responseType)
      +
      Invoke HTTP PUT method for the current request.
      +
      +
      Type Parameters:
      +
      R - response entity type.
      +
      Parameters:
      +
      entity - request entity, including it's full Variant information. Any variant-related + HTTP headers previously set (namely Content-Type, Content-Language and Content-Encoding) will + be overwritten using the entity variant information.
      +
      responseType - Java type the response entity will be converted to.
      +
      Returns:
      +
      invocation response wrapped in the completion aware type.
      +
      Throws:
      +
      ResponseProcessingException - in case processing of a received HTTP response fails (e.g. in + a filter or during conversion of the response entity data to an instance of a particular Java type).
      +
      ProcessingException - in case the request processing or subsequent I/O operation fails.
      +
      WebApplicationException - in case the response status code of the response returned by the server + is not successful and the specified response type is not + Response.
      +
      +
      +
      • +
    • +
      +

      put

      +
      <R> T put(Entity<?> entity, + GenericType<R> responseType)
      +
      Invoke HTTP PUT method for the current request.
      +
      +
      Type Parameters:
      +
      R - generic response entity type.
      +
      Parameters:
      +
      entity - request entity, including it's full Variant information. Any variant-related + HTTP headers previously set (namely Content-Type, Content-Language and Content-Encoding) will + be overwritten using the entity variant information.
      +
      responseType - representation of a generic Java type the response entity will be converted to.
      +
      Returns:
      +
      invocation response wrapped in the completion aware type.
      +
      Throws:
      +
      ResponseProcessingException - in case processing of a received HTTP response fails (e.g. in + a filter or during conversion of the response entity data to an instance of a particular Java type).
      +
      ProcessingException - in case the request processing or subsequent I/O operation fails.
      +
      WebApplicationException - in case the response status code of the response returned by the server + is not successful and the specified response type is not + Response.
      +
      +
      +
      • +
    • +
      +

      post

      +
      T post(Entity<?> entity)
      +
      Invoke HTTP POST method for the current request.
      +
      +
      Parameters:
      +
      entity - request entity, including it's full Variant information. Any variant-related + HTTP headers previously set (namely Content-Type, Content-Language and Content-Encoding) will + be overwritten using the entity variant information.
      +
      Returns:
      +
      invocation response wrapped in the completion aware type.
      +
      Throws:
      +
      ResponseProcessingException - in case processing of a received HTTP response fails (e.g. in + a filter or during conversion of the response entity data to an instance of a particular Java type).
      +
      ProcessingException - in case the request processing or subsequent I/O operation fails.
      +
      +
      +
      • +
    • +
      +

      post

      +
      <R> T post(Entity<?> entity, + Class<R> responseType)
      +
      Invoke HTTP POST method for the current request.
      +
      +
      Type Parameters:
      +
      R - response entity type.
      +
      Parameters:
      +
      entity - request entity, including it's full Variant information. Any variant-related + HTTP headers previously set (namely Content-Type, Content-Language and Content-Encoding) will + be overwritten using the entity variant information.
      +
      responseType - Java type the response entity will be converted to.
      +
      Returns:
      +
      invocation response wrapped in the completion aware type.
      +
      Throws:
      +
      ResponseProcessingException - in case processing of a received HTTP response fails (e.g. in + a filter or during conversion of the response entity data to an instance of a particular Java type).
      +
      ProcessingException - in case the request processing or subsequent I/O operation fails.
      +
      WebApplicationException - in case the response status code of the response returned by the server + is not successful and the specified response type is not + Response.
      +
      +
      +
      • +
    • +
      +

      post

      +
      <R> T post(Entity<?> entity, + GenericType<R> responseType)
      +
      Invoke HTTP POST method for the current request.
      +
      +
      Type Parameters:
      +
      R - generic response entity type.
      +
      Parameters:
      +
      entity - request entity, including it's full Variant information. Any variant-related + HTTP headers previously set (namely Content-Type, Content-Language and Content-Encoding) will + be overwritten using the entity variant information.
      +
      responseType - representation of a generic Java type the response entity will be converted to.
      +
      Returns:
      +
      invocation response wrapped in the completion aware type.
      +
      Throws:
      +
      ResponseProcessingException - in case processing of a received HTTP response fails (e.g. in + a filter or during conversion of the response entity data to an instance of a particular Java type).
      +
      ProcessingException - in case the request processing or subsequent I/O operation fails.
      +
      WebApplicationException - in case the response status code of the response returned by the server + is not successful and the specified response type is not + Response.
      +
      +
      +
      • +
    • +
      +

      delete

      +
      T delete()
      +
      Invoke HTTP DELETE method for the current request.
      +
      +
      Returns:
      +
      invocation response wrapped in the completion aware type.
      +
      Throws:
      +
      ResponseProcessingException - in case processing of a received HTTP response fails (e.g. in + a filter or during conversion of the response entity data to an instance of a particular Java type).
      +
      ProcessingException - in case the request processing or subsequent I/O operation fails.
      +
      +
      +
      • +
    • +
      +

      delete

      +
      <R> T delete(Class<R> responseType)
      +
      Invoke HTTP DELETE method for the current request.
      +
      +
      Type Parameters:
      +
      R - response entity type.
      +
      Parameters:
      +
      responseType - Java type the response entity will be converted to.
      +
      Returns:
      +
      invocation response wrapped in the completion aware type.
      +
      Throws:
      +
      ResponseProcessingException - in case processing of a received HTTP response fails (e.g. in + a filter or during conversion of the response entity data to an instance of a particular Java type).
      +
      ProcessingException - in case the request processing or subsequent I/O operation fails.
      +
      WebApplicationException - in case the response status code of the response returned by the server + is not successful and the specified response type is not + Response.
      +
      +
      +
      • +
    • +
      +

      delete

      +
      <R> T delete(GenericType<R> responseType)
      +
      Invoke HTTP DELETE method for the current request.
      +
      +
      Type Parameters:
      +
      R - generic response entity type.
      +
      Parameters:
      +
      responseType - representation of a generic Java type the response entity will be converted to.
      +
      Returns:
      +
      invocation response wrapped in the completion aware type.
      +
      Throws:
      +
      ResponseProcessingException - in case processing of a received HTTP response fails (e.g. in + a filter or during conversion of the response entity data to an instance of a particular Java type).
      +
      ProcessingException - in case the request processing or subsequent I/O operation fails.
      +
      WebApplicationException - in case the response status code of the response returned by the server + is not successful and the specified response type is not + Response.
      +
      +
      +
      • +
    • +
      +

      head

      +
      T head()
      +
      Invoke HTTP HEAD method for the current request.
      +
      +
      Returns:
      +
      invocation response wrapped in the completion aware type.
      +
      Throws:
      +
      ResponseProcessingException - in case processing of a received HTTP response fails (e.g. in + a filter or during conversion of the response entity data to an instance of a particular Java type).
      +
      ProcessingException - in case the request processing or subsequent I/O operation fails.
      +
      +
      +
      • +
    • +
      +

      options

      +
      T options()
      +
      Invoke HTTP OPTIONS method for the current request.
      +
      +
      Returns:
      +
      invocation response wrapped in the completion aware type.
      +
      Throws:
      +
      ResponseProcessingException - in case processing of a received HTTP response fails (e.g. in + a filter or during conversion of the response entity data to an instance of a particular Java type).
      +
      ProcessingException - in case the request processing or subsequent I/O operation fails.
      +
      +
      +
      • +
    • +
      +

      options

      +
      <R> T options(Class<R> responseType)
      +
      Invoke HTTP OPTIONS method for the current request.
      +
      +
      Type Parameters:
      +
      R - response entity type.
      +
      Parameters:
      +
      responseType - Java type the response entity will be converted to.
      +
      Returns:
      +
      invocation response wrapped in the completion aware type.
      +
      Throws:
      +
      ResponseProcessingException - in case processing of a received HTTP response fails (e.g. in + a filter or during conversion of the response entity data to an instance of a particular Java type).
      +
      ProcessingException - in case the request processing or subsequent I/O operation fails.
      +
      WebApplicationException - in case the response status code of the response returned by the server + is not successful and the specified response type is not + Response.
      +
      +
      +
      • +
    • +
      +

      options

      +
      <R> T options(GenericType<R> responseType)
      +
      Invoke HTTP OPTIONS method for the current request.
      +
      +
      Type Parameters:
      +
      R - generic response entity type.
      +
      Parameters:
      +
      responseType - representation of a generic Java type the response entity will be converted to.
      +
      Returns:
      +
      invocation response wrapped in the completion aware type.
      +
      Throws:
      +
      ResponseProcessingException - in case processing of a received HTTP response fails (e.g. in + a filter or during conversion of the response entity data to an instance of a particular Java type).
      +
      ProcessingException - in case the request processing or subsequent I/O operation fails.
      +
      WebApplicationException - in case the response status code of the response returned by the server + is not successful and the specified response type is not + Response.
      +
      +
      +
      • +
    • +
      +

      trace

      +
      T trace()
      +
      Invoke HTTP TRACE method for the current request.
      +
      +
      Returns:
      +
      invocation response wrapped in the completion aware type.
      +
      Throws:
      +
      ResponseProcessingException - in case processing of a received HTTP response fails (e.g. in + a filter or during conversion of the response entity data to an instance of a particular Java type).
      +
      ProcessingException - in case the request processing or subsequent I/O operation fails.
      +
      +
      +
      • +
    • +
      +

      trace

      +
      <R> T trace(Class<R> responseType)
      +
      Invoke HTTP TRACE method for the current request.
      +
      +
      Type Parameters:
      +
      R - response entity type.
      +
      Parameters:
      +
      responseType - Java type the response entity will be converted to.
      +
      Returns:
      +
      invocation response wrapped in the completion aware type.
      +
      Throws:
      +
      ResponseProcessingException - in case processing of a received HTTP response fails (e.g. in + a filter or during conversion of the response entity data to an instance of a particular Java type).
      +
      ProcessingException - in case the request processing or subsequent I/O operation fails.
      +
      WebApplicationException - in case the response status code of the response returned by the server + is not successful and the specified response type is not + Response.
      +
      +
      +
      • +
    • +
      +

      trace

      +
      <R> T trace(GenericType<R> responseType)
      +
      Invoke HTTP TRACE method for the current request.
      +
      +
      Type Parameters:
      +
      R - generic response entity type.
      +
      Parameters:
      +
      responseType - representation of a generic Java type the response entity will be converted to.
      +
      Returns:
      +
      invocation response wrapped in the completion aware type.
      +
      Throws:
      +
      ResponseProcessingException - in case processing of a received HTTP response fails (e.g. in + a filter or during conversion of the response entity data to an instance of a particular Java type).
      +
      ProcessingException - in case the request processing or subsequent I/O operation fails.
      +
      WebApplicationException - in case the response status code of the response returned by the server + is not successful and the specified response type is not + Response.
      +
      +
      +
      • +
    • +
      +

      method

      +
      T method(String name)
      +
      Invoke an arbitrary method for the current request.
      +
      +
      Parameters:
      +
      name - method name.
      +
      Returns:
      +
      invocation response wrapped in the completion aware type..
      +
      Throws:
      +
      ResponseProcessingException - in case processing of a received HTTP response fails (e.g. in + a filter or during conversion of the response entity data to an instance of a particular Java type).
      +
      ProcessingException - in case the request processing or subsequent I/O operation fails.
      +
      +
      +
      • +
    • +
      +

      method

      +
      <R> T method(String name, + Class<R> responseType)
      +
      Invoke an arbitrary method for the current request.
      +
      +
      Type Parameters:
      +
      R - response entity type.
      +
      Parameters:
      +
      name - method name.
      +
      responseType - Java type the response entity will be converted to.
      +
      Returns:
      +
      invocation response wrapped in the completion aware type..
      +
      Throws:
      +
      ResponseProcessingException - in case processing of a received HTTP response fails (e.g. in + a filter or during conversion of the response entity data to an instance of a particular Java type).
      +
      ProcessingException - in case the request processing or subsequent I/O operation fails.
      +
      WebApplicationException - in case the response status code of the response returned by the server + is not successful and the specified response type is not + Response.
      +
      +
      +
      • +
    • +
      +

      method

      +
      <R> T method(String name, + GenericType<R> responseType)
      +
      Invoke an arbitrary method for the current request.
      +
      +
      Type Parameters:
      +
      R - generic response entity type.
      +
      Parameters:
      +
      name - method name.
      +
      responseType - representation of a generic Java type the response entity will be converted to.
      +
      Returns:
      +
      invocation response wrapped in the completion aware type..
      +
      Throws:
      +
      ResponseProcessingException - in case processing of a received HTTP response fails (e.g. in + a filter or during conversion of the response entity data to an instance of a particular Java type).
      +
      ProcessingException - in case the request processing or subsequent I/O operation fails.
      +
      WebApplicationException - in case the response status code of the response returned by the server + is not successful and the specified response type is not + Response.
      +
      +
      +
      • +
    • +
      +

      method

      +
      T method(String name, + Entity<?> entity)
      +
      Invoke an arbitrary method for the current request.
      +
      +
      Parameters:
      +
      name - method name.
      +
      entity - request entity, including it's full Variant information. Any variant-related + HTTP headers previously set (namely Content-Type, Content-Language and Content-Encoding) will + be overwritten using the entity variant information.
      +
      Returns:
      +
      invocation response wrapped in the completion aware type..
      +
      Throws:
      +
      ResponseProcessingException - in case processing of a received HTTP response fails (e.g. in + a filter or during conversion of the response entity data to an instance of a particular Java type).
      +
      ProcessingException - in case the request processing or subsequent I/O operation fails.
      +
      +
      +
      • +
    • +
      +

      method

      +
      <R> T method(String name, + Entity<?> entity, + Class<R> responseType)
      +
      Invoke an arbitrary method for the current request.
      +
      +
      Type Parameters:
      +
      R - response entity type.
      +
      Parameters:
      +
      name - method name.
      +
      entity - request entity, including it's full Variant information. Any variant-related + HTTP headers previously set (namely Content-Type, Content-Language and Content-Encoding) will + be overwritten using the entity variant information.
      +
      responseType - Java type the response entity will be converted to.
      +
      Returns:
      +
      invocation response wrapped in the completion aware type..
      +
      Throws:
      +
      ResponseProcessingException - in case processing of a received HTTP response fails (e.g. in + a filter or during conversion of the response entity data to an instance of a particular Java type).
      +
      ProcessingException - in case the request processing or subsequent I/O operation fails.
      +
      WebApplicationException - in case the response status code of the response returned by the server + is not successful and the specified response type is not + Response.
      +
      +
      +
      • +
    • +
      +

      method

      +
      <R> T method(String name, + Entity<?> entity, + GenericType<R> responseType)
      +
      Invoke an arbitrary method for the current request.
      +
      +
      Type Parameters:
      +
      R - generic response entity type.
      +
      Parameters:
      +
      name - method name.
      +
      entity - request entity, including it's full Variant information. Any variant-related + HTTP headers previously set (namely Content-Type, Content-Language and Content-Encoding) will + be overwritten using the entity variant information.
      +
      responseType - representation of a generic Java type the response entity will be converted to.
      +
      Returns:
      +
      invocation response wrapped in the completion aware type..
      +
      Throws:
      +
      ResponseProcessingException - in case processing of a received HTTP response fails (e.g. in + a filter or during conversion of the response entity data to an instance of a particular Java type).
      +
      ProcessingException - in case the request processing or subsequent I/O operation fails.
      +
      WebApplicationException - in case the response status code of the response returned by the server + is not successful and the specified response type is not + Response.
      +
      +
      +
      • +
    +
    +
    • +
+
+ +
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/client/RxInvokerProvider.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/client/RxInvokerProvider.html new file mode 100644 index 0000000000..3615757188 --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/client/RxInvokerProvider.html @@ -0,0 +1,199 @@ + + + + +RxInvokerProvider (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Module jakarta.ws.rs
+
Package jakarta.ws.rs.client
+

Interface RxInvokerProvider<T extends RxInvoker>

+
+
+
+
Type Parameters:
+
T - RxInvoker subclass type.
+
+
+
public interface RxInvokerProvider<T extends RxInvoker>
+
RxInvoker provider. +

+ RxInvokerProvider must be registered in the client runtime using Configurable.register(Class). It provides + a way to plug-in support for other reactive implementations, see Invocation.Builder.rx(Class).

+
+
Since:
+
2.1
+
Author:
+
Pavel Bucek, Santiago Pericas-Geertsen
+
+
+
+ +
+
+
    + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      isProviderFor

      +
      boolean isProviderFor(Class<?> clazz)
      +
      Determine if this is a provider for the given RxInvoker subclass.
      +
      +
      Parameters:
      +
      clazz - RxInvoker subclass.
      +
      Returns:
      +
      true when this provider provides given RxInvoker subclass, false otherwise.
      +
      +
      +
      • +
    • +
      +

      getRxInvoker

      +
      T getRxInvoker(SyncInvoker syncInvoker, + ExecutorService executorService)
      +
      Get RxInvoker implementation instance. +

      + The returned instance has to be thread safe.

      +
      +
      Parameters:
      +
      syncInvoker - SyncInvoker used to execute current request.
      +
      executorService - executor service, which should be used for executing reactive callbacks invocations. It can be + null; in that case it's up to the implementation to choose the best ExecutorService in given + environment.
      +
      Returns:
      +
      instance of the RxInvoker subclass.
      +
      See Also:
      +
      + +
      +
      +
      +
      • +
    +
    +
    • +
+
+ +
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/client/SyncInvoker.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/client/SyncInvoker.html new file mode 100644 index 0000000000..3c73cdb96e --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/client/SyncInvoker.html @@ -0,0 +1,816 @@ + + + + +SyncInvoker (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Module jakarta.ws.rs
+
Package jakarta.ws.rs.client
+

Interface SyncInvoker

+
+
+
+
All Known Subinterfaces:
+
Invocation.Builder
+
+
+
public interface SyncInvoker
+
Uniform interface for synchronous invocation of HTTP methods.
+
+
Since:
+
2.0
+
Author:
+
Marek Potociar
+
+
+
+
    + +
  • +
    +

    Method Summary

    +
    +
    +
    +
    +
    Modifier and Type
    +
    Method
    +
    Description
    +
    Response
    +
    delete()
    +
    +
    Invoke HTTP DELETE method for the current request synchronously.
    +
    +
    <T> T
    +
    delete(GenericType<T> responseType)
    +
    +
    Invoke HTTP DELETE method for the current request synchronously.
    +
    +
    <T> T
    +
    delete(Class<T> responseType)
    +
    +
    Invoke HTTP DELETE method for the current request synchronously.
    +
    +
    Response
    +
    get()
    +
    +
    Invoke HTTP GET method for the current request synchronously.
    +
    +
    <T> T
    +
    get(GenericType<T> responseType)
    +
    +
    Invoke HTTP GET method for the current request synchronously.
    +
    +
    <T> T
    +
    get(Class<T> responseType)
    +
    +
    Invoke HTTP GET method for the current request synchronously.
    +
    +
    Response
    +
    head()
    +
    +
    Invoke HTTP HEAD method for the current request synchronously.
    +
    +
    Response
    +
    method(String name)
    +
    +
    Invoke an arbitrary method for the current request synchronously.
    +
    +
    Response
    +
    method(String name, + Entity<?> entity)
    +
    +
    Invoke an arbitrary method for the current request synchronously.
    +
    +
    <T> T
    +
    method(String name, + Entity<?> entity, + GenericType<T> responseType)
    +
    +
    Invoke an arbitrary method for the current request synchronously.
    +
    +
    <T> T
    +
    method(String name, + Entity<?> entity, + Class<T> responseType)
    +
    +
    Invoke an arbitrary method for the current request synchronously.
    +
    +
    <T> T
    +
    method(String name, + GenericType<T> responseType)
    +
    +
    Invoke an arbitrary method for the current request synchronously.
    +
    +
    <T> T
    +
    method(String name, + Class<T> responseType)
    +
    +
    Invoke an arbitrary method for the current request synchronously.
    +
    +
    Response
    +
    options()
    +
    +
    Invoke HTTP OPTIONS method for the current request synchronously.
    +
    +
    <T> T
    +
    options(GenericType<T> responseType)
    +
    +
    Invoke HTTP OPTIONS method for the current request synchronously.
    +
    +
    <T> T
    +
    options(Class<T> responseType)
    +
    +
    Invoke HTTP OPTIONS method for the current request synchronously.
    +
    +
    Response
    +
    post(Entity<?> entity)
    +
    +
    Invoke HTTP POST method for the current request synchronously.
    +
    +
    <T> T
    +
    post(Entity<?> entity, + GenericType<T> responseType)
    +
    +
    Invoke HTTP POST method for the current request synchronously.
    +
    +
    <T> T
    +
    post(Entity<?> entity, + Class<T> responseType)
    +
    +
    Invoke HTTP POST method for the current request synchronously.
    +
    +
    Response
    +
    put(Entity<?> entity)
    +
    +
    Invoke HTTP PUT method for the current request synchronously.
    +
    +
    <T> T
    +
    put(Entity<?> entity, + GenericType<T> responseType)
    +
    +
    Invoke HTTP PUT method for the current request synchronously.
    +
    +
    <T> T
    +
    put(Entity<?> entity, + Class<T> responseType)
    +
    +
    Invoke HTTP PUT method for the current request synchronously.
    +
    +
    Response
    +
    trace()
    +
    +
    Invoke HTTP TRACE method for the current request synchronously.
    +
    +
    <T> T
    +
    trace(GenericType<T> responseType)
    +
    +
    Invoke HTTP TRACE method for the current request synchronously.
    +
    +
    <T> T
    +
    trace(Class<T> responseType)
    +
    +
    Invoke HTTP TRACE method for the current request synchronously.
    +
    +
    +
    +
    +
    +
    • +
+
+
+
    + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      get

      +
      Response get()
      +
      Invoke HTTP GET method for the current request synchronously.
      +
      +
      Returns:
      +
      invocation response.
      +
      Throws:
      +
      ProcessingException - in case the invocation processing has failed.
      +
      +
      +
      • +
    • +
      +

      get

      +
      <T> T get(Class<T> responseType)
      +
      Invoke HTTP GET method for the current request synchronously.
      +
      +
      Type Parameters:
      +
      T - response entity type.
      +
      Parameters:
      +
      responseType - Java type the response entity will be converted to.
      +
      Returns:
      +
      invocation response.
      +
      Throws:
      +
      ResponseProcessingException - in case processing of a received HTTP response fails (e.g. in a filter or during + conversion of the response entity data to an instance of a particular Java type).
      +
      ProcessingException - in case the request processing or subsequent I/O operation fails.
      +
      WebApplicationException - in case the response status code of the response returned by the server is not + successful and the specified response type is not + Response.
      +
      +
      +
      • +
    • +
      +

      get

      +
      <T> T get(GenericType<T> responseType)
      +
      Invoke HTTP GET method for the current request synchronously.
      +
      +
      Type Parameters:
      +
      T - generic response entity type.
      +
      Parameters:
      +
      responseType - representation of a generic Java type the response entity will be converted to.
      +
      Returns:
      +
      invocation response.
      +
      Throws:
      +
      ResponseProcessingException - in case processing of a received HTTP response fails (e.g. in a filter or during + conversion of the response entity data to an instance of a particular Java type).
      +
      ProcessingException - in case the request processing or subsequent I/O operation fails.
      +
      WebApplicationException - in case the response status code of the response returned by the server is not + successful and the specified generic response type does + not represent Response
      +
      +
      +
      • +
    • +
      +

      put

      +
      Response put(Entity<?> entity)
      +
      Invoke HTTP PUT method for the current request synchronously.
      +
      +
      Parameters:
      +
      entity - request entity, including it's full Variant information. Any variant-related + HTTP headers previously set (namely Content-Type, Content-Language and Content-Encoding) will + be overwritten using the entity variant information.
      +
      Returns:
      +
      invocation response.
      +
      Throws:
      +
      ResponseProcessingException - in case processing of a received HTTP response fails (e.g. in a filter or during + conversion of the response entity data to an instance of a particular Java type).
      +
      ProcessingException - in case the request processing or subsequent I/O operation fails.
      +
      +
      +
      • +
    • +
      +

      put

      +
      <T> T put(Entity<?> entity, + Class<T> responseType)
      +
      Invoke HTTP PUT method for the current request synchronously.
      +
      +
      Type Parameters:
      +
      T - response entity type.
      +
      Parameters:
      +
      entity - request entity, including it's full Variant information. Any variant-related + HTTP headers previously set (namely Content-Type, Content-Language and Content-Encoding) will + be overwritten using the entity variant information.
      +
      responseType - Java type the response entity will be converted to.
      +
      Returns:
      +
      invocation response.
      +
      Throws:
      +
      ResponseProcessingException - in case processing of a received HTTP response fails (e.g. in a filter or during + conversion of the response entity data to an instance of a particular Java type).
      +
      ProcessingException - in case the request processing or subsequent I/O operation fails.
      +
      WebApplicationException - in case the response status code of the response returned by the server is not + successful and the specified response type is not + Response.
      +
      +
      +
      • +
    • +
      +

      put

      +
      <T> T put(Entity<?> entity, + GenericType<T> responseType)
      +
      Invoke HTTP PUT method for the current request synchronously.
      +
      +
      Type Parameters:
      +
      T - generic response entity type.
      +
      Parameters:
      +
      entity - request entity, including it's full Variant information. Any variant-related + HTTP headers previously set (namely Content-Type, Content-Language and Content-Encoding) will + be overwritten using the entity variant information.
      +
      responseType - representation of a generic Java type the response entity will be converted to.
      +
      Returns:
      +
      invocation response.
      +
      Throws:
      +
      ResponseProcessingException - in case processing of a received HTTP response fails (e.g. in a filter or during + conversion of the response entity data to an instance of a particular Java type).
      +
      ProcessingException - in case the request processing or subsequent I/O operation fails.
      +
      WebApplicationException - in case the response status code of the response returned by the server is not + successful and the specified generic response type does + not represent Response.
      +
      +
      +
      • +
    • +
      +

      post

      +
      Response post(Entity<?> entity)
      +
      Invoke HTTP POST method for the current request synchronously.
      +
      +
      Parameters:
      +
      entity - request entity, including it's full Variant information. Any variant-related + HTTP headers previously set (namely Content-Type, Content-Language and Content-Encoding) will + be overwritten using the entity variant information.
      +
      Returns:
      +
      invocation response.
      +
      Throws:
      +
      ResponseProcessingException - in case processing of a received HTTP response fails (e.g. in a filter or during + conversion of the response entity data to an instance of a particular Java type).
      +
      ProcessingException - in case the request processing or subsequent I/O operation fails.
      +
      +
      +
      • +
    • +
      +

      post

      +
      <T> T post(Entity<?> entity, + Class<T> responseType)
      +
      Invoke HTTP POST method for the current request synchronously.
      +
      +
      Type Parameters:
      +
      T - response entity type.
      +
      Parameters:
      +
      entity - request entity, including it's full Variant information. Any variant-related + HTTP headers previously set (namely Content-Type, Content-Language and Content-Encoding) will + be overwritten using the entity variant information.
      +
      responseType - Java type the response entity will be converted to.
      +
      Returns:
      +
      invocation response.
      +
      Throws:
      +
      ResponseProcessingException - in case processing of a received HTTP response fails (e.g. in a filter or during + conversion of the response entity data to an instance of a particular Java type).
      +
      ProcessingException - in case the request processing or subsequent I/O operation fails.
      +
      WebApplicationException - in case the response status code of the response returned by the server is not + successful and the specified response type is not + Response.
      +
      +
      +
      • +
    • +
      +

      post

      +
      <T> T post(Entity<?> entity, + GenericType<T> responseType)
      +
      Invoke HTTP POST method for the current request synchronously.
      +
      +
      Type Parameters:
      +
      T - generic response entity type.
      +
      Parameters:
      +
      entity - request entity, including it's full Variant information. Any variant-related + HTTP headers previously set (namely Content-Type, Content-Language and Content-Encoding) will + be overwritten using the entity variant information.
      +
      responseType - representation of a generic Java type the response entity will be converted to.
      +
      Returns:
      +
      invocation response.
      +
      Throws:
      +
      ResponseProcessingException - in case processing of a received HTTP response fails (e.g. in a filter or during + conversion of the response entity data to an instance of a particular Java type).
      +
      ProcessingException - in case the request processing or subsequent I/O operation fails.
      +
      WebApplicationException - in case the response status code of the response returned by the server is not + successful and the specified generic response type does + not represent Response.
      +
      +
      +
      • +
    • +
      +

      delete

      +
      Response delete()
      +
      Invoke HTTP DELETE method for the current request synchronously.
      +
      +
      Returns:
      +
      invocation response.
      +
      Throws:
      +
      ResponseProcessingException - in case processing of a received HTTP response fails (e.g. in a filter or during + conversion of the response entity data to an instance of a particular Java type).
      +
      ProcessingException - in case the request processing or subsequent I/O operation fails.
      +
      +
      +
      • +
    • +
      +

      delete

      +
      <T> T delete(Class<T> responseType)
      +
      Invoke HTTP DELETE method for the current request synchronously.
      +
      +
      Type Parameters:
      +
      T - response entity type.
      +
      Parameters:
      +
      responseType - Java type the response entity will be converted to.
      +
      Returns:
      +
      invocation response.
      +
      Throws:
      +
      ResponseProcessingException - in case processing of a received HTTP response fails (e.g. in a filter or during + conversion of the response entity data to an instance of a particular Java type).
      +
      ProcessingException - in case the request processing or subsequent I/O operation fails.
      +
      WebApplicationException - in case the response status code of the response returned by the server is not + successful and the specified response type is not + Response.
      +
      +
      +
      • +
    • +
      +

      delete

      +
      <T> T delete(GenericType<T> responseType)
      +
      Invoke HTTP DELETE method for the current request synchronously.
      +
      +
      Type Parameters:
      +
      T - generic response entity type.
      +
      Parameters:
      +
      responseType - representation of a generic Java type the response entity will be converted to.
      +
      Returns:
      +
      invocation response.
      +
      Throws:
      +
      ResponseProcessingException - in case processing of a received HTTP response fails (e.g. in a filter or during + conversion of the response entity data to an instance of a particular Java type).
      +
      ProcessingException - in case the request processing or subsequent I/O operation fails.
      +
      WebApplicationException - in case the response status code of the response returned by the server is not + successful and the specified generic response type does + not represent Response.
      +
      +
      +
      • +
    • +
      +

      head

      +
      Response head()
      +
      Invoke HTTP HEAD method for the current request synchronously.
      +
      +
      Returns:
      +
      invocation response.
      +
      Throws:
      +
      ResponseProcessingException - in case processing of a received HTTP response fails (e.g. in a filter or during + conversion of the response entity data to an instance of a particular Java type).
      +
      ProcessingException - in case the request processing or subsequent I/O operation fails.
      +
      +
      +
      • +
    • +
      +

      options

      +
      Response options()
      +
      Invoke HTTP OPTIONS method for the current request synchronously.
      +
      +
      Returns:
      +
      invocation response.
      +
      Throws:
      +
      ResponseProcessingException - in case processing of a received HTTP response fails (e.g. in a filter or during + conversion of the response entity data to an instance of a particular Java type).
      +
      ProcessingException - in case the request processing or subsequent I/O operation fails.
      +
      +
      +
      • +
    • +
      +

      options

      +
      <T> T options(Class<T> responseType)
      +
      Invoke HTTP OPTIONS method for the current request synchronously.
      +
      +
      Type Parameters:
      +
      T - response entity type.
      +
      Parameters:
      +
      responseType - Java type the response entity will be converted to.
      +
      Returns:
      +
      invocation response.
      +
      Throws:
      +
      ResponseProcessingException - in case processing of a received HTTP response fails (e.g. in a filter or during + conversion of the response entity data to an instance of a particular Java type).
      +
      ProcessingException - in case the request processing or subsequent I/O operation fails.
      +
      WebApplicationException - in case the response status code of the response returned by the server is not + successful and the specified response type is not + Response.
      +
      +
      +
      • +
    • +
      +

      options

      +
      <T> T options(GenericType<T> responseType)
      +
      Invoke HTTP OPTIONS method for the current request synchronously.
      +
      +
      Type Parameters:
      +
      T - generic response entity type.
      +
      Parameters:
      +
      responseType - representation of a generic Java type the response entity will be converted to.
      +
      Returns:
      +
      invocation response.
      +
      Throws:
      +
      ResponseProcessingException - in case processing of a received HTTP response fails (e.g. in a filter or during + conversion of the response entity data to an instance of a particular Java type).
      +
      ProcessingException - in case the request processing or subsequent I/O operation fails.
      +
      WebApplicationException - in case the response status code of the response returned by the server is not + successful and the specified generic response type does + not represent Response.
      +
      +
      +
      • +
    • +
      +

      trace

      +
      Response trace()
      +
      Invoke HTTP TRACE method for the current request synchronously.
      +
      +
      Returns:
      +
      invocation response.
      +
      Throws:
      +
      ResponseProcessingException - in case processing of a received HTTP response fails (e.g. in a filter or during + conversion of the response entity data to an instance of a particular Java type).
      +
      ProcessingException - in case the request processing or subsequent I/O operation fails.
      +
      +
      +
      • +
    • +
      +

      trace

      +
      <T> T trace(Class<T> responseType)
      +
      Invoke HTTP TRACE method for the current request synchronously.
      +
      +
      Type Parameters:
      +
      T - response entity type.
      +
      Parameters:
      +
      responseType - Java type the response entity will be converted to.
      +
      Returns:
      +
      invocation response.
      +
      Throws:
      +
      ResponseProcessingException - in case processing of a received HTTP response fails (e.g. in a filter or during + conversion of the response entity data to an instance of a particular Java type).
      +
      ProcessingException - in case the request processing or subsequent I/O operation fails.
      +
      WebApplicationException - in case the response status code of the response returned by the server is not + successful and the specified response type is not + Response.
      +
      +
      +
      • +
    • +
      +

      trace

      +
      <T> T trace(GenericType<T> responseType)
      +
      Invoke HTTP TRACE method for the current request synchronously.
      +
      +
      Type Parameters:
      +
      T - generic response entity type.
      +
      Parameters:
      +
      responseType - representation of a generic Java type the response entity will be converted to.
      +
      Returns:
      +
      invocation response.
      +
      Throws:
      +
      ResponseProcessingException - in case processing of a received HTTP response fails (e.g. in a filter or during + conversion of the response entity data to an instance of a particular Java type).
      +
      ProcessingException - in case the request processing or subsequent I/O operation fails.
      +
      WebApplicationException - in case the response status code of the response returned by the server is not + successful and the specified generic response type does + not represent Response.
      +
      +
      +
      • +
    • +
      +

      method

      +
      Response method(String name)
      +
      Invoke an arbitrary method for the current request synchronously.
      +
      +
      Parameters:
      +
      name - method name.
      +
      Returns:
      +
      invocation response.
      +
      Throws:
      +
      ResponseProcessingException - in case processing of a received HTTP response fails (e.g. in a filter or during + conversion of the response entity data to an instance of a particular Java type).
      +
      ProcessingException - in case the request processing or subsequent I/O operation fails.
      +
      +
      +
      • +
    • +
      +

      method

      +
      <T> T method(String name, + Class<T> responseType)
      +
      Invoke an arbitrary method for the current request synchronously.
      +
      +
      Type Parameters:
      +
      T - response entity type.
      +
      Parameters:
      +
      name - method name.
      +
      responseType - Java type the response entity will be converted to.
      +
      Returns:
      +
      invocation response.
      +
      Throws:
      +
      ResponseProcessingException - in case processing of a received HTTP response fails (e.g. in a filter or during + conversion of the response entity data to an instance of a particular Java type).
      +
      ProcessingException - in case the request processing or subsequent I/O operation fails.
      +
      WebApplicationException - in case the response status code of the response returned by the server is not + successful and the specified response type is not + Response.
      +
      +
      +
      • +
    • +
      +

      method

      +
      <T> T method(String name, + GenericType<T> responseType)
      +
      Invoke an arbitrary method for the current request synchronously.
      +
      +
      Type Parameters:
      +
      T - generic response entity type.
      +
      Parameters:
      +
      name - method name.
      +
      responseType - representation of a generic Java type the response entity will be converted to.
      +
      Returns:
      +
      invocation response.
      +
      Throws:
      +
      ResponseProcessingException - in case processing of a received HTTP response fails (e.g. in a filter or during + conversion of the response entity data to an instance of a particular Java type).
      +
      ProcessingException - in case the request processing or subsequent I/O operation fails.
      +
      WebApplicationException - in case the response status code of the response returned by the server is not + successful and the specified generic response type does + not represent Response.
      +
      +
      +
      • +
    • +
      +

      method

      +
      Response method(String name, + Entity<?> entity)
      +
      Invoke an arbitrary method for the current request synchronously.
      +
      +
      Parameters:
      +
      name - method name.
      +
      entity - request entity, including it's full Variant information. Any variant-related + HTTP headers previously set (namely Content-Type, Content-Language and Content-Encoding) will + be overwritten using the entity variant information.
      +
      Returns:
      +
      invocation response.
      +
      Throws:
      +
      ResponseProcessingException - in case processing of a received HTTP response fails (e.g. in a filter or during + conversion of the response entity data to an instance of a particular Java type).
      +
      ProcessingException - in case the request processing or subsequent I/O operation fails.
      +
      +
      +
      • +
    • +
      +

      method

      +
      <T> T method(String name, + Entity<?> entity, + Class<T> responseType)
      +
      Invoke an arbitrary method for the current request synchronously.
      +
      +
      Type Parameters:
      +
      T - response entity type.
      +
      Parameters:
      +
      name - method name.
      +
      entity - request entity, including it's full Variant information. Any variant-related + HTTP headers previously set (namely Content-Type, Content-Language and Content-Encoding) will + be overwritten using the entity variant information.
      +
      responseType - Java type the response entity will be converted to.
      +
      Returns:
      +
      invocation response.
      +
      Throws:
      +
      ResponseProcessingException - in case processing of a received HTTP response fails (e.g. in a filter or during + conversion of the response entity data to an instance of a particular Java type).
      +
      ProcessingException - in case the request processing or subsequent I/O operation fails.
      +
      WebApplicationException - in case the response status code of the response returned by the server is not + successful and the specified response type is not + Response.
      +
      +
      +
      • +
    • +
      +

      method

      +
      <T> T method(String name, + Entity<?> entity, + GenericType<T> responseType)
      +
      Invoke an arbitrary method for the current request synchronously.
      +
      +
      Type Parameters:
      +
      T - generic response entity type.
      +
      Parameters:
      +
      name - method name.
      +
      entity - request entity, including it's full Variant information. Any variant-related + HTTP headers previously set (namely Content-Type, Content-Language and Content-Encoding) will + be overwritten using the entity variant information.
      +
      responseType - representation of a generic Java type the response entity will be converted to.
      +
      Returns:
      +
      invocation response.
      +
      Throws:
      +
      ResponseProcessingException - in case processing of a received HTTP response fails (e.g. in a filter or during + conversion of the response entity data to an instance of a particular Java type).
      +
      ProcessingException - in case the request processing or subsequent I/O operation fails.
      +
      WebApplicationException - in case the response status code of the response returned by the server is not + successful and the specified generic response type does + not represent Response.
      +
      +
      +
      • +
    +
    +
    • +
+
+ +
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/client/WebTarget.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/client/WebTarget.html new file mode 100644 index 0000000000..5c81d6e70a --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/client/WebTarget.html @@ -0,0 +1,553 @@ + + + + +WebTarget (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Module jakarta.ws.rs
+
Package jakarta.ws.rs.client
+

Interface WebTarget

+
+
+
+
All Superinterfaces:
+
Configurable<WebTarget>
+
+
+
public interface WebTarget +extends Configurable<WebTarget>
+
A resource target identified by the resource URI.
+
+
Since:
+
2.0
+
Author:
+
Marek Potociar
+
+
+
+
    + +
  • +
    +

    Method Summary

    +
    +
    +
    +
    +
    Modifier and Type
    +
    Method
    +
    Description
    +
    URI
    +
    getUri()
    +
    +
    Get the URI identifying the resource.
    +
    +
    UriBuilder
    +
    getUriBuilder()
    +
    +
    Get the URI builder initialized with the URI of the current resource target.
    +
    +
    WebTarget
    +
    matrixParam(String name, + Object... values)
    +
    +
    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.
    +
    +
    WebTarget
    +
    path(String path)
    +
    +
    Create a new WebTarget instance by appending path to the URI of the current target instance.
    +
    +
    WebTarget
    +
    queryParam(String name, + Object... values)
    +
    +
    Create a new WebTarget instance by configuring a query parameter on the URI of the current target instance.
    +
    +
    Invocation.Builder
    +
    request()
    +
    +
    Start building a request to the targeted web resource.
    +
    +
    Invocation.Builder
    +
    request(MediaType... acceptedResponseTypes)
    +
    +
    Start building a request to the targeted web resource and define the accepted response media types.
    +
    +
    Invocation.Builder
    +
    request(String... acceptedResponseTypes)
    +
    +
    Start building a request to the targeted web resource and define the accepted response media types.
    +
    +
    WebTarget
    +
    resolveTemplate(String name, + Object value)
    +
    +
    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.
    +
    +
    WebTarget
    +
    resolveTemplate(String name, + Object value, + boolean encodeSlashInPath)
    +
    +
    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.
    +
    +
    WebTarget
    +
    resolveTemplateFromEncoded(String name, + Object value)
    +
    +
    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.
    +
    +
    WebTarget
    +
    resolveTemplates(Map<String,Object> templateValues)
    +
    +
    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.
    +
    +
    WebTarget
    +
    resolveTemplates(Map<String,Object> templateValues, + boolean encodeSlashInPath)
    +
    +
    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.
    +
    +
    WebTarget
    +
    resolveTemplatesFromEncoded(Map<String,Object> templateValues)
    +
    +
    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.
    +
    +
    +
    +
    +
    +

    Methods inherited from interface jakarta.ws.rs.core.Configurable

    +getConfiguration, property, register, register, register, register, register, register, register, register
    +
    +
    • +
+
+
+
    + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      getUri

      +
      URI getUri()
      +
      Get the URI identifying the resource.
      +
      +
      Returns:
      +
      the resource URI.
      +
      +
      +
      • +
    • +
      +

      getUriBuilder

      +
      UriBuilder getUriBuilder()
      +
      Get the URI builder initialized with the URI of the current resource target. The returned URI builder is + detached from the target, i.e. any updates in the URI builder MUST NOT have any effects on the URI of the originating + target.
      +
      +
      Returns:
      +
      the initialized URI builder.
      +
      +
      +
      • +
    • +
      +

      path

      +
      WebTarget path(String path)
      +
      Create a new WebTarget instance by appending path to the URI of the current target instance. +

      + When constructing the final path, a '/' separator will be inserted between the existing path and the supplied path if + necessary. Existing '/' characters are preserved thus a single value can represent multiple URI path segments. +

      +

      + A snapshot of the present configuration of the current (parent) target instance is taken and is inherited by the + newly constructed (child) target instance. +

      +
      +
      Parameters:
      +
      path - the path, may contain URI template parameters.
      +
      Returns:
      +
      a new target instance.
      +
      Throws:
      +
      NullPointerException - if path is null.
      +
      +
      +
      • +
    • +
      +

      resolveTemplate

      +
      WebTarget resolveTemplate(String name, + Object value)
      +
      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. + + In case a null template name or value is entered a NullPointerException is thrown. +

      + A snapshot of the present configuration of the current (parent) target instance is taken and is inherited by the + newly constructed (child) target instance. +

      +
      +
      Parameters:
      +
      name - name of the URI template.
      +
      value - value to be used to resolve the template.
      +
      Returns:
      +
      a new target instance.
      +
      Throws:
      +
      NullPointerException - if the resolved template name or value is null.
      +
      +
      +
      • +
    • +
      +

      resolveTemplate

      +
      WebTarget resolveTemplate(String name, + Object value, + boolean encodeSlashInPath)
      +
      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. + + In case a null template name or value is entered a NullPointerException is thrown. +

      + A snapshot of the present configuration of the current (parent) target instance is taken and is inherited by the + newly constructed (child) target instance. +

      +
      +
      Parameters:
      +
      name - name of the URI template.
      +
      value - value to be used to resolve the template.
      +
      encodeSlashInPath - if true, the slash ('/') characters in template values will be encoded if + the template is placed in the URI path component, otherwise the slash characters will not be encoded in path + templates.
      +
      Returns:
      +
      a new target instance.
      +
      Throws:
      +
      NullPointerException - if the resolved template name or value is null.
      +
      +
      +
      • +
    • +
      +

      resolveTemplateFromEncoded

      +
      WebTarget resolveTemplateFromEncoded(String name, + Object value)
      +
      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. + + A template with a matching name will be replaced by the supplied value. Value is converted to String using + its toString() method and is then encoded to match the rules of the URI component to which they pertain. All + % characters in the stringified values that are not followed by two hexadecimal numbers will be encoded. + + In case a null template name or value is entered a NullPointerException is thrown. +

      + A snapshot of the present configuration of the current (parent) target instance is taken and is inherited by the + newly constructed (child) target instance. +

      +
      +
      Parameters:
      +
      name - name of the URI template.
      +
      value - encoded value to be used to resolve the template.
      +
      Returns:
      +
      a new target instance.
      +
      Throws:
      +
      NullPointerException - if the resolved template name or value is null.
      +
      +
      +
      • +
    • +
      +

      resolveTemplates

      +
      WebTarget resolveTemplates(Map<String,Object> templateValues)
      +
      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. + + A call to the method with an empty parameter map is ignored, i.e. same WebTarget instance is returned. +

      + A snapshot of the present configuration of the current (parent) target instance is taken and is inherited by the + newly constructed (child) target instance. +

      +
      +
      Parameters:
      +
      templateValues - a map of URI template names and their values.
      +
      Returns:
      +
      a new target instance or the same target instance in case the input name-value map is empty.
      +
      Throws:
      +
      NullPointerException - if the name-value map or any of the names or values in the map is null.
      +
      +
      +
      • +
    • +
      +

      resolveTemplates

      +
      WebTarget resolveTemplates(Map<String,Object> templateValues, + boolean encodeSlashInPath)
      +
      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. + + A call to the method with an empty parameter map is ignored, i.e. same WebTarget instance is returned. +

      + A snapshot of the present configuration of the current (parent) target instance is taken and is inherited by the + newly constructed (child) target instance. +

      +
      +
      Parameters:
      +
      templateValues - a map of URI template names and their values.
      +
      encodeSlashInPath - if true, the slash ('/') characters in template values will be encoded if + the template is placed in the URI path component, otherwise the slash characters will not be encoded in path + templates.
      +
      Returns:
      +
      a new target instance or the same target instance in case the input name-value map is empty.
      +
      Throws:
      +
      NullPointerException - if the name-value map or any of the names or values in the map is null.
      +
      +
      +
      • +
    • +
      +

      resolveTemplatesFromEncoded

      +
      WebTarget resolveTemplatesFromEncoded(Map<String,Object> templateValues)
      +
      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. + + All templates with their name matching one of the keys in the supplied map will be replaced by the value in the + supplied map. Values are converted to String using their toString() method and are then encoded to + match the rules of the URI component to which they pertain. All % characters in the stringified values that are not + followed by two hexadecimal numbers will be encoded. + + A call to the method with an empty parameter map is ignored, i.e. same WebTarget instance is returned. +

      + A snapshot of the present configuration of the current (parent) target instance is taken and is inherited by the + newly constructed (child) target instance. +

      +
      +
      Parameters:
      +
      templateValues - a map of URI template names and their encoded values.
      +
      Returns:
      +
      a new target instance or the same target instance in case the input name-value map is empty.
      +
      Throws:
      +
      NullPointerException - if the name-value map or any of the names or encoded values in the map is null.
      +
      +
      +
      • +
    • +
      +

      matrixParam

      +
      WebTarget matrixParam(String name, + Object... values)
      +
      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. + + If multiple values are supplied the parameter will be added once per value. In case a single null value is + entered, all parameters with that name in the current final path segment are removed (if present) from the collection + of last segment matrix parameters inherited from the current target. +

      + Note that the matrix parameters are tied to a particular path segment; appending a value to an existing matrix + parameter name will not affect the position of the matrix parameter in the URI path. +

      +

      + A snapshot of the present configuration of the current (parent) target instance is taken and is inherited by the + newly constructed (child) target instance. +

      +
      +
      Parameters:
      +
      name - the matrix parameter name, may contain URI template parameters.
      +
      values - the matrix parameter value(s), each object will be converted to a String using its + toString() method. Stringified values may contain URI template parameters.
      +
      Returns:
      +
      a new target instance.
      +
      Throws:
      +
      NullPointerException - if the parameter name is null or if there are multiple values present and any of + those values is null.
      +
      See Also:
      +
      + +
      +
      +
      +
      • +
    • +
      +

      queryParam

      +
      WebTarget queryParam(String name, + Object... values)
      +
      Create a new WebTarget instance by configuring a query parameter on the URI of the current target instance. + + If multiple values are supplied the parameter will be added once per value. In case a single null value is + entered, all parameters with that name are removed (if present) from the collection of query parameters inherited + from the current target. +

      + A snapshot of the present configuration of the current (parent) target instance is taken and is inherited by the + newly constructed (child) target instance. +

      +
      +
      Parameters:
      +
      name - the query parameter name, may contain URI template parameters
      +
      values - the query parameter value(s), each object will be converted to a String using its + toString() method. Stringified values may contain URI template parameters.
      +
      Returns:
      +
      a new target instance.
      +
      Throws:
      +
      NullPointerException - if the parameter name is null or if there are multiple values present and any of + those values is null.
      +
      +
      +
      • +
    • +
      +

      request

      +
      Invocation.Builder request()
      +
      Start building a request to the targeted web resource.
      +
      +
      Returns:
      +
      builder for a request targeted at the URI referenced by this target instance.
      +
      +
      +
      • +
    • +
      +

      request

      +
      Invocation.Builder request(String... acceptedResponseTypes)
      +
      Start building a request to the targeted web resource and define the accepted response media types. +

      + Invoking this method is identical to: +

      + + 
      + webTarget.request().accept(types);
+
      +
      +
      Parameters:
      +
      acceptedResponseTypes - accepted response media types.
      +
      Returns:
      +
      builder for a request targeted at the URI referenced by this target instance.
      +
      +
      +
      • +
    • +
      +

      request

      +
      Invocation.Builder request(MediaType... acceptedResponseTypes)
      +
      Start building a request to the targeted web resource and define the accepted response media types. +

      + Invoking this method is identical to: +

      + + 
      + webTarget.request().accept(types);
+
      +
      +
      Parameters:
      +
      acceptedResponseTypes - accepted response media types.
      +
      Returns:
      +
      builder for a request targeted at the URI referenced by this target instance.
      +
      +
      +
      • +
    +
    +
    • +
+
+ +
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/client/class-use/AsyncInvoker.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/client/class-use/AsyncInvoker.html new file mode 100644 index 0000000000..b902cc6944 --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/client/class-use/AsyncInvoker.html @@ -0,0 +1,92 @@ + + + + +Uses of Interface jakarta.ws.rs.client.AsyncInvoker (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
jakarta.ws.rs.client.AsyncInvoker

+
+
Packages that use AsyncInvoker
+
+
Package
+
Description
+
jakarta.ws.rs.client
+
+
The JAX-RS client API
+
+
+
+ +
+
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/client/class-use/Client.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/client/class-use/Client.html new file mode 100644 index 0000000000..ef849e2c12 --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/client/class-use/Client.html @@ -0,0 +1,109 @@ + + + + +Uses of Interface jakarta.ws.rs.client.Client (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
jakarta.ws.rs.client.Client

+
+
Packages that use Client
+
+
Package
+
Description
+
jakarta.ws.rs.client
+
+
The JAX-RS client API
+
+
+
+
    +
  • +
    +

    Uses of Client in jakarta.ws.rs.client

    +
    Methods in jakarta.ws.rs.client that return Client
    +
    +
    Modifier and Type
    +
    Method
    +
    Description
    +
    abstract Client
    +
    ClientBuilder.build()
    +
    +
    Build a new client instance using all the configuration previously specified in this client builder.
    +
    +
    Client
    +
    ClientRequestContext.getClient()
    +
    +
    Get the client instance associated with the request.
    +
    +
    static Client
    +
    ClientBuilder.newClient()
    +
    +
    Create a new Client instance using the default client builder implementation class provided by the JAX-RS + implementation provider.
    +
    +
    static Client
    +
    ClientBuilder.newClient(Configuration configuration)
    +
    +
    Create a new custom-configured Client instance using the default client builder implementation class provided + by the JAX-RS implementation provider.
    +
    +
    +
    +
    • +
+
+
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/client/class-use/ClientBuilder.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/client/class-use/ClientBuilder.html new file mode 100644 index 0000000000..88c902a9bf --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/client/class-use/ClientBuilder.html @@ -0,0 +1,149 @@ + + + + +Uses of Class jakarta.ws.rs.client.ClientBuilder (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
jakarta.ws.rs.client.ClientBuilder

+
+
Packages that use ClientBuilder
+
+
Package
+
Description
+
jakarta.ws.rs.client
+
+
The JAX-RS client API
+
+
+
+ +
+
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/client/class-use/ClientRequestContext.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/client/class-use/ClientRequestContext.html new file mode 100644 index 0000000000..e5607c3e81 --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/client/class-use/ClientRequestContext.html @@ -0,0 +1,99 @@ + + + + +Uses of Interface jakarta.ws.rs.client.ClientRequestContext (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
jakarta.ws.rs.client.ClientRequestContext

+
+
Packages that use ClientRequestContext
+
+
Package
+
Description
+
jakarta.ws.rs.client
+
+
The JAX-RS client API
+
+
+
+ +
+
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/client/class-use/ClientRequestFilter.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/client/class-use/ClientRequestFilter.html new file mode 100644 index 0000000000..fb09ee6608 --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/client/class-use/ClientRequestFilter.html @@ -0,0 +1,63 @@ + + + + +Uses of Interface jakarta.ws.rs.client.ClientRequestFilter (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
jakarta.ws.rs.client.ClientRequestFilter

+
+No usage of jakarta.ws.rs.client.ClientRequestFilter
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/client/class-use/ClientResponseContext.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/client/class-use/ClientResponseContext.html new file mode 100644 index 0000000000..e6c1426d13 --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/client/class-use/ClientResponseContext.html @@ -0,0 +1,94 @@ + + + + +Uses of Interface jakarta.ws.rs.client.ClientResponseContext (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
jakarta.ws.rs.client.ClientResponseContext

+
+
Packages that use ClientResponseContext
+
+
Package
+
Description
+
jakarta.ws.rs.client
+
+
The JAX-RS client API
+
+
+
+ +
+
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/client/class-use/ClientResponseFilter.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/client/class-use/ClientResponseFilter.html new file mode 100644 index 0000000000..eee8c19503 --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/client/class-use/ClientResponseFilter.html @@ -0,0 +1,63 @@ + + + + +Uses of Interface jakarta.ws.rs.client.ClientResponseFilter (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
jakarta.ws.rs.client.ClientResponseFilter

+
+No usage of jakarta.ws.rs.client.ClientResponseFilter
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/client/class-use/CompletionStageRxInvoker.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/client/class-use/CompletionStageRxInvoker.html new file mode 100644 index 0000000000..245612566f --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/client/class-use/CompletionStageRxInvoker.html @@ -0,0 +1,92 @@ + + + + +Uses of Interface jakarta.ws.rs.client.CompletionStageRxInvoker (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
jakarta.ws.rs.client.CompletionStageRxInvoker

+
+
Packages that use CompletionStageRxInvoker
+
+
Package
+
Description
+
jakarta.ws.rs.client
+
+
The JAX-RS client API
+
+
+
+ +
+
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/client/class-use/Entity.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/client/class-use/Entity.html new file mode 100644 index 0000000000..896bece2df --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/client/class-use/Entity.html @@ -0,0 +1,393 @@ + + + + +Uses of Class jakarta.ws.rs.client.Entity (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
jakarta.ws.rs.client.Entity

+
+
Packages that use Entity
+
+
Package
+
Description
+
jakarta.ws.rs.client
+
+
The JAX-RS client API
+
+
+
+ +
+
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/client/class-use/Invocation.Builder.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/client/class-use/Invocation.Builder.html new file mode 100644 index 0000000000..c413922d8d --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/client/class-use/Invocation.Builder.html @@ -0,0 +1,166 @@ + + + + +Uses of Interface jakarta.ws.rs.client.Invocation.Builder (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
jakarta.ws.rs.client.Invocation.Builder

+
+
Packages that use Invocation.Builder
+
+
Package
+
Description
+
jakarta.ws.rs.client
+
+
The JAX-RS client API
+
+
+
+ +
+
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/client/class-use/Invocation.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/client/class-use/Invocation.html new file mode 100644 index 0000000000..b2b0eb7c77 --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/client/class-use/Invocation.html @@ -0,0 +1,124 @@ + + + + +Uses of Interface jakarta.ws.rs.client.Invocation (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
jakarta.ws.rs.client.Invocation

+
+
Packages that use Invocation
+
+
Package
+
Description
+
jakarta.ws.rs.client
+
+
The JAX-RS client API
+
+
+
+ +
+
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/client/class-use/InvocationCallback.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/client/class-use/InvocationCallback.html new file mode 100644 index 0000000000..6bc57981f3 --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/client/class-use/InvocationCallback.html @@ -0,0 +1,143 @@ + + + + +Uses of Interface jakarta.ws.rs.client.InvocationCallback (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
jakarta.ws.rs.client.InvocationCallback

+
+
Packages that use InvocationCallback
+
+
Package
+
Description
+
jakarta.ws.rs.client
+
+
The JAX-RS client API
+
+
+
+ +
+
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/client/class-use/ResponseProcessingException.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/client/class-use/ResponseProcessingException.html new file mode 100644 index 0000000000..1f6df69525 --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/client/class-use/ResponseProcessingException.html @@ -0,0 +1,63 @@ + + + + +Uses of Class jakarta.ws.rs.client.ResponseProcessingException (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
jakarta.ws.rs.client.ResponseProcessingException

+
+No usage of jakarta.ws.rs.client.ResponseProcessingException
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/client/class-use/RxInvoker.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/client/class-use/RxInvoker.html new file mode 100644 index 0000000000..f2365397b0 --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/client/class-use/RxInvoker.html @@ -0,0 +1,114 @@ + + + + +Uses of Interface jakarta.ws.rs.client.RxInvoker (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
jakarta.ws.rs.client.RxInvoker

+
+
Packages that use RxInvoker
+
+
Package
+
Description
+
jakarta.ws.rs.client
+
+
The JAX-RS client API
+
+
+
+ +
+
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/client/class-use/RxInvokerProvider.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/client/class-use/RxInvokerProvider.html new file mode 100644 index 0000000000..4c30956325 --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/client/class-use/RxInvokerProvider.html @@ -0,0 +1,63 @@ + + + + +Uses of Interface jakarta.ws.rs.client.RxInvokerProvider (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
jakarta.ws.rs.client.RxInvokerProvider

+
+No usage of jakarta.ws.rs.client.RxInvokerProvider
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/client/class-use/SyncInvoker.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/client/class-use/SyncInvoker.html new file mode 100644 index 0000000000..d1fb391834 --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/client/class-use/SyncInvoker.html @@ -0,0 +1,104 @@ + + + + +Uses of Interface jakarta.ws.rs.client.SyncInvoker (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
jakarta.ws.rs.client.SyncInvoker

+
+
Packages that use SyncInvoker
+
+
Package
+
Description
+
jakarta.ws.rs.client
+
+
The JAX-RS client API
+
+
+
+ +
+
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/client/class-use/WebTarget.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/client/class-use/WebTarget.html new file mode 100644 index 0000000000..b8a22862f0 --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/client/class-use/WebTarget.html @@ -0,0 +1,192 @@ + + + + +Uses of Interface jakarta.ws.rs.client.WebTarget (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
jakarta.ws.rs.client.WebTarget

+
+
Packages that use WebTarget
+
+
Package
+
Description
+
jakarta.ws.rs.client
+
+
The JAX-RS client API
+
+
jakarta.ws.rs.sse
+
+
Server-Sent Events related API.
+
+
+
+ +
+
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/client/package-summary.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/client/package-summary.html new file mode 100644 index 0000000000..ae1352ad69 --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/client/package-summary.html @@ -0,0 +1,279 @@ + + + + +jakarta.ws.rs.client (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+
Module jakarta.ws.rs
+

Package jakarta.ws.rs.client

+
+
+
package jakarta.ws.rs.client
+
+

The JAX-RS client API

+

+ The JAX-RS client API is a Java based API used to access Web resources. It is not restricted to resources implemented + using JAX-RS. It provides a higher-level abstraction compared to a plain HTTP + communication API as well as integration with the JAX-RS extension providers, in order to enable concise and + efficient implementation of reusable client-side solutions that leverage existing and well established client-side + implementations of HTTP-based communication. +

+ The JAX-RS Client API encapsulates the Uniform Interface Constraint – a key constraint of the REST + architectural style – and associated data elements as client-side Java artifacts and supports a pluggable + architecture by defining multiple extension points. + +

Client API Bootstrapping and Configuration

The main entry point to the API is a + ClientBuilder that is used to bootstrap Client instances - + configurable, heavy-weight objects that manage the underlying communication + infrastructure and serve as the root objects for accessing any Web resource. The following example illustrates the + bootstrapping and configuration of a Client instance: + + 
+ Client client = ClientBuilder.newClient();
+
+ client.property("MyProperty", "MyValue")
+         .register(MyProvider.class)
+         .register(MyFeature.class);
+
+ +

Accessing Web Resources

A Web resource can be accessed using a fluent API in which method invocations are + chained to configure and ultimately submit an HTTP request. The following example gets a text/plain + representation of the resource identified by "http://example.org/hello": + + 
+ Client client = ClientBuilder.newClient();
+ Response res = client.target("http://example.org/hello").request("text/plain").get();
+
+ + Conceptually, the steps required to submit a request are the following: +
    +
  1. obtain an Client instance
    2. +
  2. create a WebTarget pointing at a Web resource
    3. +
  3. build a request
    4. +
  4. submit a request to directly retrieve a response or get a prepared Invocation for + later submission
    5. +
+ + As illustrated above, individual Web resources are in the JAX-RS Client API represented as resource targets. Each + WebTarget instance is bound to a concrete URI, e.g. "http://example.org/messages/123", or a URI + template, e.g. "http://example.org/messages/{id}". That way a single target can either point at a particular + resource or represent a larger group of resources (that e.g. share a common configuration) from which concrete + resources can be later derived: + + 
+ // Parent target for all messages
+ WebTarget messages = client.target("http://example.org/messages/{id}");
+
+ // New target for http://example.org/messages/123
+ WebTarget msg123 = messages.resolveTemplate("id", 123);
+
+ // New target for http://example.org/messages/456
+ WebTarget msg456 = messages.resolveTemplate("id", 456);
+
+ +

Generic Invocations

An Invocation is a request that has been prepared and is + ready for execution. Invocations provide a generic interface that enables a separation of concerns between the + creator and the submitter. In particular, the submitter does not need to know how the invocation was prepared, but + only whether it should be executed synchronously or asynchronously. + + 
+   Invocation inv1 = client.target("http://example.org/atm/balance")
+       .queryParam("card", "111122223333").queryParam("pin", "9876")
+       .request("text/plain").buildGet();
+   Invocation inv2 = client.target("http://example.org/atm/withdrawal")
+       .queryParam("card", "111122223333").queryParam("pin", "9876")
+       .request().buildPost(text("50.0")));
+
+   Collection<Invocation> invs = Arrays.asList(inv1, inv2);
+   // Executed by the submitter
+   Collection<Response> ress = Collections.transform(invs, new F<Invocation, Response>() {
+      public Response apply(Invocation inv) {return inv.invoke(); }
+   });
+
+
+
+
    +
  • + +
    • +
  • +
    +
    +
    +
    +
    Class
    +
    Description
    +
    AsyncInvoker
    +
    +
    Uniform interface for asynchronous invocation of HTTP methods.
    +
    +
    Client
    +
    +
    + Client is the main entry point to the fluent API used to build and execute client requests in order to consume + responses returned.
    +
    +
    ClientBuilder
    +
    +
    Main entry point to the client API used to bootstrap Client instances.
    +
    +
    ClientRequestContext
    +
    +
    Client request filter context.
    +
    +
    ClientRequestFilter
    +
    +
    An extension interface implemented by client request filters.
    +
    +
    ClientResponseContext
    +
    +
    Client response filter context.
    +
    +
    ClientResponseFilter
    +
    +
    An extension interface implemented by client response filters.
    +
    +
    CompletionStageRxInvoker
    +
    +
    Reactive invoker based CompletionStage.
    +
    +
    Entity<T>
    +
    +
    Encapsulates message entity including the associated variant information.
    +
    +
    Invocation
    +
    +
    A client request invocation.
    +
    +
    Invocation.Builder
    +
    +
    A client request invocation builder.
    +
    +
    InvocationCallback<RESPONSE>
    +
    +
    Callback that can be implemented to receive the asynchronous processing events from the invocation processing.
    +
    +
    ResponseProcessingException
    +
    +
    JAX-RS client-side runtime processing exception thrown to indicate that response processing has failed (e.g.
    +
    +
    RxInvoker<T>
    +
    +
    Uniform interface for reactive invocation of HTTP methods.
    +
    +
    RxInvokerProvider<T extends RxInvoker>
    +
    +
    RxInvoker provider.
    +
    +
    SyncInvoker
    +
    +
    Uniform interface for synchronous invocation of HTTP methods.
    +
    +
    WebTarget
    +
    +
    A resource target identified by the resource URI.
    +
    +
    +
    +
    +
    • +
+
+
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/client/package-tree.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/client/package-tree.html new file mode 100644 index 0000000000..6682617f91 --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/client/package-tree.html @@ -0,0 +1,129 @@ + + + + +jakarta.ws.rs.client Class Hierarchy (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Hierarchy For Package jakarta.ws.rs.client

+
+Package Hierarchies: + +
+

Class Hierarchy

+ +
+
+

Interface Hierarchy

+ +
+
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/client/package-use.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/client/package-use.html new file mode 100644 index 0000000000..c8f543ed8d --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/client/package-use.html @@ -0,0 +1,156 @@ + + + + +Uses of Package jakarta.ws.rs.client (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Package
jakarta.ws.rs.client

+
+
Packages that use jakarta.ws.rs.client
+
+
Package
+
Description
+
jakarta.ws.rs.client
+
+
The JAX-RS client API
+
+
jakarta.ws.rs.sse
+
+
Server-Sent Events related API.
+
+
+
+ +
+
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/container/AsyncResponse.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/container/AsyncResponse.html new file mode 100644 index 0000000000..88ed246921 --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/container/AsyncResponse.html @@ -0,0 +1,653 @@ + + + + +AsyncResponse (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Module jakarta.ws.rs
+
Package jakarta.ws.rs.container
+

Interface AsyncResponse

+
+
+
+
public interface AsyncResponse
+
An injectable JAX-RS asynchronous response that provides means for asynchronous server side response processing. +

+ A new instance of AsyncResponse may be injected into a resource or sub-resource + method parameter using the @Suspended annotation. +

+ Each asynchronous response instance is bound to the running request and can be used to asynchronously provide the + request processing result or otherwise manipulate the suspended client connection. The available operations include: +
    +
  • updating suspended state data (time-out value, response ...)
    • +
  • resuming the suspended request processing
    • +
  • canceling the suspended request processing
    • +
+

+ Following example demonstrates the use of the AsyncResponse for asynchronous HTTP request processing: +

+ + 
+ @Path("/messages/next")
+ public class MessagingResource {
+     private static final BlockingQueue<AsyncResponse> suspended = new ArrayBlockingQueue<AsyncResponse>(5);
+
+     @GET
+     public void readMessage(@Suspended AsyncResponse ar) throws InterruptedException {
+         suspended.put(ar);
+     }
+
+     @POST
+     public String postMessage(final String message) throws InterruptedException {
+         final AsyncResponse ar = suspended.take();
+         ar.resume(message); // resumes the processing of one GET request
+         return "Message sent";
+     }
+ }
+
+

+ If the asynchronous response was suspended with a positive timeout value, and has not been explicitly resumed before + the timeout has expired, the processing will be resumed once the specified timeout threshold is reached, provided a + positive timeout value was set on the response. +

+

+ By default a timed-out asynchronous response is resumed with a WebApplicationException that has + HTTP 503 (Service unavailable) error response status + code set. This default behavior may be overridden by setting + a custom time-out handler. +

+
+
Since:
+
2.0
+
Author:
+
Marek Potociar
+
+
+
+
    + +
  • +
    +

    Field Summary

    +
    Fields
    +
    +
    Modifier and Type
    +
    Field
    +
    Description
    +
    static final long
    +
    NO_TIMEOUT
    +
    +
    Constant specifying no suspend timeout value.
    +
    +
    +
    +
    • + +
  • +
    +

    Method Summary

    +
    +
    +
    +
    +
    Modifier and Type
    +
    Method
    +
    Description
    +
    boolean
    +
    cancel()
    +
    +
    Cancel the suspended request processing.
    +
    +
    boolean
    +
    cancel(int retryAfter)
    +
    +
    Cancel the suspended request processing.
    +
    +
    boolean
    +
    cancel(Date retryAfter)
    +
    +
    Cancel the suspended request processing.
    +
    +
    boolean
    +
    isCancelled()
    +
    +
    Check if the asynchronous response instance has been cancelled.
    +
    +
    boolean
    +
    isDone()
    +
    +
    Check if the processing of a request this asynchronous response instance belongs to has finished.
    +
    +
    boolean
    +
    isSuspended()
    +
    +
    Check if the asynchronous response instance is in a suspended state.
    +
    +
    Collection<Class<?>>
    +
    register(Class<?> callback)
    +
    +
    Register an asynchronous processing lifecycle callback class to receive lifecycle events for the asynchronous + response based on the implemented callback interfaces.
    +
    +
    Map<Class<?>,Collection<Class<?>>>
    +
    register(Class<?> callback, + Class<?>... callbacks)
    +
    +
    Register asynchronous processing lifecycle callback classes to receive lifecycle events for the asynchronous response + based on the implemented callback interfaces.
    +
    +
    Collection<Class<?>>
    +
    register(Object callback)
    +
    +
    Register an asynchronous processing lifecycle callback instance to receive lifecycle events for the asynchronous + response based on the implemented callback interfaces.
    +
    +
    Map<Class<?>,Collection<Class<?>>>
    +
    register(Object callback, + Object... callbacks)
    +
    +
    Register an asynchronous processing lifecycle callback instances to receive lifecycle events for the asynchronous + response based on the implemented callback interfaces.
    +
    +
    boolean
    +
    resume(Object response)
    +
    +
    Resume the suspended request processing using the provided response data.
    +
    +
    boolean
    +
    resume(Throwable response)
    +
    +
    Resume the suspended request processing using the provided throwable.
    +
    +
    boolean
    +
    setTimeout(long time, + TimeUnit unit)
    +
    +
    Set/update the suspend timeout.
    +
    +
    void
    +
    setTimeoutHandler(TimeoutHandler handler)
    +
    +
    Set/replace a time-out handler for the suspended asynchronous response.
    +
    +
    +
    +
    +
    +
    • +
+
+
+
    + +
  • +
    +

    Field Details

    +
      +
    • +
      +

      NO_TIMEOUT

      +
      static final long NO_TIMEOUT
      +
      Constant specifying no suspend timeout value.
      +
      +
      See Also:
      +
      + +
      +
      +
      +
      • +
    +
    +
    • + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      resume

      +
      boolean resume(Object response)
      +
      Resume the suspended request processing using the provided response data. + + The provided response data can be of any Java type that can be returned from a JAX-RS + resource method. +

      + The asynchronous response must be still in a suspended state for this method to succeed. +

      +

      + By executing this method, the request is guaranteed to complete either successfully or with an error. The data + processing by the JAX-RS runtime follows the same path as it would for the response data returned synchronously by a + JAX-RS resource, except that unmapped exceptions are not re-thrown by JAX-RS runtime to be handled by a hosting I/O + container. Instead, any unmapped exceptions are propagated to the hosting I/O container via a container-specific + callback mechanism. Depending on the container implementation, propagated unmapped exceptions typically result in an + error status being sent to the client and/or the connection being closed. +

      +
      +
      Parameters:
      +
      response - data to be sent back in response to the suspended request.
      +
      Returns:
      +
      true if the request processing has been resumed, returns false in case the request processing + is not suspended and could not be resumed.
      +
      See Also:
      +
      + +
      +
      +
      +
      • +
    • +
      +

      resume

      +
      boolean resume(Throwable response)
      +
      Resume the suspended request processing using the provided throwable. + + For the provided throwable same rules apply as for an exception thrown by a JAX-RS + resource method. +

      + By executing this method, the request is guaranteed to complete either successfully or with an error. The throwable + processing by the JAX-RS runtime follows the same path as it would for the response data returned synchronously by a + JAX-RS resource, except that unmapped exceptions are not re-thrown by JAX-RS runtime to be handled by a hosting I/O + container. Instead, any unmapped exceptions are propagated to the hosting I/O container via a container-specific + callback mechanism. Depending on the container implementation, propagated unmapped exceptions typically result in an + error status being sent to the client and/or the connection being closed. +

      +
      +
      Parameters:
      +
      response - an exception to be raised in response to the suspended request.
      +
      Returns:
      +
      true if the response has been resumed, returns false in case the response is not + suspended and could not be resumed.
      +
      See Also:
      +
      + +
      +
      +
      +
      • +
    • +
      +

      cancel

      +
      boolean cancel()
      +
      Cancel the suspended request processing. +

      + When a request processing is cancelled using this method, the JAX-RS implementation MUST indicate to the client that + the request processing has been cancelled by sending back a + HTTP 503 (Service unavailable) error response. +

      +

      + Invoking a cancel(...) method multiple times to cancel request processing has the same effect as canceling + the request processing only once. Invoking a cancel(...) method on an asynchronous response instance that has + already been cancelled or resumed has no effect and the method call is ignored while returning true, in case + the request has been cancelled previously. Otherwise, in case the request has been resumed regularly (using a + resume(...) method) or resumed due to a time-out, method returns false. +

      +
      +
      Returns:
      +
      true if the request processing has been cancelled, returns false in case the request + processing is not suspended and could not be cancelled and is not cancelled already.
      +
      See Also:
      +
      + +
      +
      +
      +
      • +
    • +
      +

      cancel

      +
      boolean cancel(int retryAfter)
      +
      Cancel the suspended request processing. +

      + When a request processing is cancelled using this method, the JAX-RS implementation MUST indicate to the client that + the request processing has been cancelled by sending back a + HTTP 503 (Service unavailable) error response with a + Retry-After header set to the value provided by the method parameter. +

      +

      + Invoking a cancel(...) method multiple times to cancel request processing has the same effect as canceling + the request processing only once. Invoking a cancel(...) method on an asynchronous response instance that has + already been cancelled or resumed has no effect and the method call is ignored while returning true, in case + the request has been cancelled previously. Otherwise, in case the request has been resumed regularly (using a + resume(...) method) or resumed due to a time-out, method returns false. +

      +
      +
      Parameters:
      +
      retryAfter - a decimal integer number of seconds after the response is sent to the client that indicates how + long the service is expected to be unavailable to the requesting client.
      +
      Returns:
      +
      true if the request processing has been cancelled, returns false in case the request + processing is not suspended and could not be cancelled and is not cancelled already.
      +
      See Also:
      +
      + +
      +
      +
      +
      • +
    • +
      +

      cancel

      +
      boolean cancel(Date retryAfter)
      +
      Cancel the suspended request processing. +

      + When a request processing is cancelled using this method, the JAX-RS implementation MUST indicate to the client that + the request processing has been cancelled by sending back a + HTTP 503 (Service unavailable) error response with a + Retry-After header set to the value provided by the method parameter. +

      +

      + Invoking a cancel(...) method multiple times to cancel request processing has the same effect as canceling + the request processing only once. Invoking a cancel(...) method on an asynchronous response instance that has + already been cancelled or resumed has no effect and the method call is ignored while returning true, in case + the request has been cancelled previously. Otherwise, in case the request has been resumed regularly (using a + resume(...) method) or resumed due to a time-out, method returns false. +

      +
      +
      Parameters:
      +
      retryAfter - a date that indicates how long the service is expected to be unavailable to the requesting client.
      +
      Returns:
      +
      true if the request processing has been cancelled, returns false in case the request + processing is not suspended and could not be cancelled and is not cancelled already.
      +
      See Also:
      +
      + +
      +
      +
      +
      • +
    • +
      +

      isSuspended

      +
      boolean isSuspended()
      +
      Check if the asynchronous response instance is in a suspended state. + + Method returns true if this asynchronous response is still suspended and has not finished processing yet + (either by resuming or canceling the response).
      +
      +
      Returns:
      +
      true if this asynchronous response is in a suspend state, false otherwise.
      +
      See Also:
      +
      + +
      +
      +
      +
      • +
    • +
      +

      isCancelled

      +
      boolean isCancelled()
      +
      Check if the asynchronous response instance has been cancelled. + + Method returns true if this asynchronous response has been canceled before completion.
      +
      +
      Returns:
      +
      true if this task was canceled before completion.
      +
      See Also:
      +
      + +
      +
      +
      +
      • +
    • +
      +

      isDone

      +
      boolean isDone()
      +
      Check if the processing of a request this asynchronous response instance belongs to has finished. + + Method returns true if the processing of a request this asynchronous response is bound to is finished. +

      + The request processing may be finished due to a normal termination, a suspend timeout, or cancellation -- in all of + these cases, this method will return true. +

      +
      +
      Returns:
      +
      true if this execution context has finished processing.
      +
      See Also:
      +
      + +
      +
      +
      +
      • +
    • +
      +

      setTimeout

      +
      boolean setTimeout(long time, + TimeUnit unit)
      +
      Set/update the suspend timeout. +

      + The new suspend timeout values override any timeout value previously specified. The asynchronous response must be + still in a suspended state for this method to succeed. +

      +
      +
      Parameters:
      +
      time - suspend timeout value in the give time unit. Value lower or equal to 0 causes the context to + suspend indefinitely.
      +
      unit - suspend timeout value time unit.
      +
      Returns:
      +
      true if the suspend time out has been set, returns false in case the request processing is + not in the suspended state.
      +
      +
      +
      • +
    • +
      +

      setTimeoutHandler

      +
      void setTimeoutHandler(TimeoutHandler handler)
      +
      Set/replace a time-out handler for the suspended asynchronous response. +

      + The time-out handler will be invoked when the suspend period of this asynchronous response times out. The job of the + time-out handler is to resolve the time-out situation by either +

      +
        +
      • resuming the suspended response
        • +
      • cancelling the suspended response
        • +
      • extending the suspend period by setting a new suspend time-out
        • +
      +

      + Note that in case the response is suspended indefinitely, the time-out handler may never be + invoked. +

      +
      +
      Parameters:
      +
      handler - response time-out handler.
      +
      +
      +
      • +
    • +
      +

      register

      +
      Collection<Class<?>> register(Class<?> callback)
      +
      Register an asynchronous processing lifecycle callback class to receive lifecycle events for the asynchronous + response based on the implemented callback interfaces.
      +
      +
      Parameters:
      +
      callback - callback class.
      +
      Returns:
      +
      collection of registered callback interfaces. If the callback class does not implement any recognized + callback interfaces, the returned collection will be empty.
      +
      Throws:
      +
      NullPointerException - in case the callback class is null.
      +
      +
      +
      • +
    • +
      +

      register

      +
      Map<Class<?>,Collection<Class<?>>> register(Class<?> callback, + Class<?>... callbacks)
      +
      Register asynchronous processing lifecycle callback classes to receive lifecycle events for the asynchronous response + based on the implemented callback interfaces.
      +
      +
      Parameters:
      +
      callback - callback class.
      +
      callbacks - additional callback classes.
      +
      Returns:
      +
      map of registered classes and the callback interfaces registered for each class. If a callback class does not + implement any recognized callback interfaces, the associated collection of registered interfaces for the class will + be empty.
      +
      Throws:
      +
      NullPointerException - in case any of the callback classes is null.
      +
      +
      +
      • +
    • +
      +

      register

      +
      Collection<Class<?>> register(Object callback)
      +
      Register an asynchronous processing lifecycle callback instance to receive lifecycle events for the asynchronous + response based on the implemented callback interfaces.
      +
      +
      Parameters:
      +
      callback - callback instance implementing one or more of the recognized callback interfaces.
      +
      Returns:
      +
      collection of registered callback interfaces. If the callback class does not implement any recognized + callback interfaces, the returned collection will be empty.
      +
      Throws:
      +
      NullPointerException - in case the callback instance is null.
      +
      +
      +
      • +
    • +
      +

      register

      +
      Map<Class<?>,Collection<Class<?>>> register(Object callback, + Object... callbacks)
      +
      Register an asynchronous processing lifecycle callback instances to receive lifecycle events for the asynchronous + response based on the implemented callback interfaces.
      +
      +
      Parameters:
      +
      callback - callback instance.
      +
      callbacks - additional callback instances.
      +
      Returns:
      +
      map of registered classes and the callback interfaces registered for each class. If a callback class does not + implement any recognized callback interfaces, the associated collection of registered interfaces for the class will + be empty.
      +
      Throws:
      +
      NullPointerException - in case any of the callback instances is null.
      +
      +
      +
      • +
    +
    +
    • +
+
+ +
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/container/CompletionCallback.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/container/CompletionCallback.html new file mode 100644 index 0000000000..723c97ff1b --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/container/CompletionCallback.html @@ -0,0 +1,169 @@ + + + + +CompletionCallback (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Module jakarta.ws.rs
+
Package jakarta.ws.rs.container
+

Interface CompletionCallback

+
+
+
+
public interface CompletionCallback
+
A request processing callback that receives request processing completion events. +

+ A completion callback is always invoked when the whole request processing is over, i.e. once a response for the request has + been processed and sent back to the client (including processing by a custom exception mapper) or when an unmapped + exception or error is being propagated to the default exception mapper. +

+
+
Since:
+
2.0
+
Author:
+
Marek Potociar
+
+
+
+
    + +
  • +
    +

    Method Summary

    +
    +
    +
    +
    +
    Modifier and Type
    +
    Method
    +
    Description
    +
    void
    +
    onComplete(Throwable throwable)
    +
    +
    An unmapped throwable is propagated to the default exception mapper in case no exception mapper has been found for a request processing failure.
    +
    +
    +
    +
    +
    +
    • +
+
+
+
    + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      onComplete

      +
      void onComplete(Throwable throwable)
      +
      An unmapped throwable is propagated to the default exception mapper in case no exception mapper has been found for a request processing failure. In this case a non-null unmapped throwable + instance is passed to the method. Note that the throwable instance represents the actual unmapped exception thrown during + the request processing before it has been mapped to the response by the default exception mapper.
      +
      +
      Parameters:
      +
      throwable - is null, if the request processing has completed with a response that has been sent to the + client (including processing by a custom exception mapper). In case the request processing resulted in an unmapped + exception or error that has yet to be propagated to the default exception mapper, this parameter contains the unmapped + exception instance.
      +
      +
      +
      • +
    +
    +
    • +
+
+ +
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/container/ConnectionCallback.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/container/ConnectionCallback.html new file mode 100644 index 0000000000..d5b8b3f3a3 --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/container/ConnectionCallback.html @@ -0,0 +1,165 @@ + + + + +ConnectionCallback (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Module jakarta.ws.rs
+
Package jakarta.ws.rs.container
+

Interface ConnectionCallback

+
+
+
+
public interface ConnectionCallback
+
Asynchronous request processing lifecycle callback that receives connection related asynchronous + response lifecycle events. +

+ Support for this type of callback by JAX-RS runtime is OPTIONAL. +

+
+
Since:
+
2.0
+
Author:
+
Marek Potociar
+
+
+
+
    + +
  • +
    +

    Method Summary

    +
    +
    +
    +
    +
    Modifier and Type
    +
    Method
    +
    Description
    +
    void
    +
    onDisconnect(AsyncResponse disconnected)
    +
    +
    This callback notification method is invoked in case the container detects that the remote client connection + associated with the asynchronous response has been disconnected.
    +
    +
    +
    +
    +
    +
    • +
+
+
+
    + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      onDisconnect

      +
      void onDisconnect(AsyncResponse disconnected)
      +
      This callback notification method is invoked in case the container detects that the remote client connection + associated with the asynchronous response has been disconnected.
      +
      +
      Parameters:
      +
      disconnected - asynchronous response for which the remote client connection has been lost.
      +
      +
      +
      • +
    +
    +
    • +
+
+ +
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/container/ContainerRequestContext.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/container/ContainerRequestContext.html new file mode 100644 index 0000000000..779d735ec4 --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/container/ContainerRequestContext.html @@ -0,0 +1,808 @@ + + + + +ContainerRequestContext (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Module jakarta.ws.rs
+
Package jakarta.ws.rs.container
+

Interface ContainerRequestContext

+
+
+
+
public interface ContainerRequestContext
+
Container request filter context. + + A mutable class that provides request-specific information for the filter, such as request URI, message headers, + message entity or request-scoped properties. The exposed setters allow modification of the exposed request-specific + information.
+
+
Since:
+
2.0
+
Author:
+
Marek Potociar
+
+
+
+ +
+
+
    + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      getProperty

      +
      Object getProperty(String name)
      +
      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. +

      + A property allows a JAX-RS filters and interceptors to exchange additional custom information not already provided by + this interface. +

      +

      + A list of supported properties can be retrieved using getPropertyNames(). Custom property names should + follow the same convention as package names. +

      +

      + In a Servlet container, the properties are synchronized with the ServletRequest and expose all the attributes + available in the ServletRequest. Any modifications of the properties are also reflected in the set of + properties of the associated ServletRequest. +

      +
      +
      Parameters:
      +
      name - a String specifying the name of the property.
      +
      Returns:
      +
      an Object containing the value of the property, or null if no property exists matching the + given name.
      +
      See Also:
      +
      + +
      +
      +
      +
      • +
    • +
      +

      hasProperty

      +
      default boolean hasProperty(String name)
      +
      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. +

      + Use the getProperty(java.lang.String) method with a property name to get the value of a property. +

      +
      +
      Parameters:
      +
      name - a String specifying the name of the property.
      +
      Returns:
      +
      true if this property is registered in the context, or false if no property exists matching + the given name.
      +
      See Also:
      +
      + +
      +
      +
      +
      • +
    • +
      +

      getPropertyNames

      +
      Collection<String> getPropertyNames()
      +
      Returns an immutable collection containing the property names available within the + context of the current request/response exchange context. +

      + Use the getProperty(java.lang.String) method with a property name to get the value of a property. +

      +

      + In a Servlet container, the properties are synchronized with the ServletRequest and expose all the attributes + available in the ServletRequest. Any modifications of the properties are also reflected in the set of + properties of the associated ServletRequest. +

      +
      +
      Returns:
      +
      an immutable collection of property names.
      +
      See Also:
      +
      + +
      +
      +
      +
      • +
    • +
      +

      setProperty

      +
      void setProperty(String name, + Object object)
      +
      Binds an object to a given property name in the current request/response exchange context. If the name specified is + already used for a property, this method will replace the value of the property with the new value. +

      + A property allows a JAX-RS filters and interceptors to exchange additional custom information not already provided by + this interface. +

      +

      + A list of supported properties can be retrieved using getPropertyNames(). Custom property names should + follow the same convention as package names. +

      +

      + If a null value is passed, the effect is the same as calling the removeProperty(String) method. +

      +

      + In a Servlet container, the properties are synchronized with the ServletRequest and expose all the attributes + available in the ServletRequest. Any modifications of the properties are also reflected in the set of + properties of the associated ServletRequest. +

      +
      +
      Parameters:
      +
      name - a String specifying the name of the property.
      +
      object - an Object representing the property to be bound.
      +
      +
      +
      • +
    • +
      +

      removeProperty

      +
      void removeProperty(String name)
      +
      Removes a property with the given name from the current request/response exchange context. After removal, subsequent + calls to getProperty(java.lang.String) to retrieve the property value will return null. +

      + In a Servlet container, the properties are synchronized with the ServletRequest and expose all the attributes + available in the ServletRequest. Any modifications of the properties are also reflected in the set of + properties of the associated ServletRequest. +

      +
      +
      Parameters:
      +
      name - a String specifying the name of the property to be removed.
      +
      +
      +
      • +
    • +
      +

      getUriInfo

      +
      UriInfo getUriInfo()
      +
      Get request URI information. + + The returned object contains "live" view of the request URI information in a sense that any changes made to the + request URI using one of the setRequestUri(...) methods will be reflected in the previously returned + UriInfo instance.
      +
      +
      Returns:
      +
      request URI information.
      +
      +
      +
      • +
    • +
      +

      setRequestUri

      +
      void setRequestUri(URI requestUri)
      +
      Set a new request URI using the current base URI of the application to resolve the application-specific request URI + part. +

      + Note that the method is usable only in pre-matching filters, prior to the resource matching occurs. Trying to invoke + the method in a filter bound to a resource method results in an IllegalStateException being thrown. +

      +
      +
      Parameters:
      +
      requestUri - new URI of the request.
      +
      Throws:
      +
      IllegalStateException - in case the method is not invoked from a pre-matching request + filter.
      +
      See Also:
      +
      + +
      +
      +
      +
      • +
    • +
      +

      setRequestUri

      +
      void setRequestUri(URI baseUri, + URI requestUri)
      +
      Set a new request URI using a new base URI to resolve the application-specific request URI part. +

      + Note that the method is usable only in pre-matching filters, prior to the resource matching occurs. Trying to invoke + the method in a filter bound to a resource method results in an IllegalStateException being thrown. +

      +
      +
      Parameters:
      +
      baseUri - base URI that will be used to resolve the application-specific part of the request URI.
      +
      requestUri - new URI of the request.
      +
      Throws:
      +
      IllegalStateException - in case the method is not invoked from a pre-matching request + filter.
      +
      See Also:
      +
      + +
      +
      +
      +
      • +
    • +
      +

      getRequest

      +
      Request getRequest()
      +
      Get the injectable request information.
      +
      +
      Returns:
      +
      injectable request information.
      +
      +
      +
      • +
    • +
      +

      getMethod

      +
      String getMethod()
      +
      Get the request method.
      +
      +
      Returns:
      +
      the request method.
      +
      See Also:
      +
      + +
      +
      +
      +
      • +
    • +
      +

      setMethod

      +
      void setMethod(String method)
      +
      Set the request method. +

      + Note that the method is usable only in pre-matching filters, prior to the resource matching occurs. Trying to invoke + the method in a filter bound to a resource method results in an IllegalStateException being thrown. +

      +
      +
      Parameters:
      +
      method - new request method.
      +
      Throws:
      +
      IllegalStateException - in case the method is not invoked from a pre-matching request + filter.
      +
      See Also:
      +
      + +
      +
      +
      +
      • +
    • +
      +

      getHeaders

      +
      MultivaluedMap<String,String> getHeaders()
      +
      Get the mutable request headers multivalued map.
      +
      +
      Returns:
      +
      mutable multivalued map of request headers.
      +
      See Also:
      +
      + +
      +
      +
      +
      • +
    • +
      +

      getHeaderString

      +
      String getHeaderString(String name)
      +
      Get a message header as a single string value.
      +
      +
      Parameters:
      +
      name - the message header.
      +
      Returns:
      +
      the message header value. If the message header is not present then null is returned. If the message + header is present but has no value then the empty string is returned. If the message header is present more than once + then the values of joined together and separated by a ',' character.
      +
      See Also:
      +
      + +
      +
      +
      +
      • +
    • +
      +

      containsHeaderString

      +
      boolean containsHeaderString(String name, + String valueSeparatorRegex, + Predicate<String> valuePredicate)
      +
      Checks whether a header with a specific name and value (or item of the token-separated value list) exists. + +

      + For example: containsHeaderString("cache-control", ",", "no-store"::equalsIgnoreCase) will return true if + a Cache-Control header exists that has the value no-store, the value No-Store or the value + Max-Age, NO-STORE, no-transform, but false when it has the value no-store;no-transform + (missing comma), or the value no - store (whitespace within value).

      +
      +
      Parameters:
      +
      name - the message header.
      +
      valueSeparatorRegex - Regular expression that separates the header value into single values. null does not split.
      +
      valuePredicate - value must fulfil this predicate.
      +
      Returns:
      +
      true if and only if a header with the given name exists, having either a whitespace-trimmed value + matching the predicate, or having at least one whitespace-trimmed single value in a token-separated list of single values.
      +
      Since:
      +
      4.0
      +
      See Also:
      +
      + +
      +
      +
      +
      • +
    • +
      +

      containsHeaderString

      +
      default boolean containsHeaderString(String name, + Predicate<String> valuePredicate)
      +
      Checks whether a header with a specific name and value (or item of the comma-separated value list) exists. + +

      + For example: containsHeaderString("cache-control", "no-store"::equalsIgnoreCase) will return true if + a Cache-Control header exists that has the value no-store, the value No-Store or the value + Max-Age, NO-STORE, no-transform, but false when it has the value no-store;no-transform + (missing comma), or the value no - store (whitespace within value).

      +
      +
      Parameters:
      +
      name - the message header.
      +
      valuePredicate - value must fulfil this predicate.
      +
      Returns:
      +
      true if and only if a header with the given name exists, having either a whitespace-trimmed value + matching the predicate, or having at least one whitespace-trimmed single value in a comma-separated list of single values.
      +
      Since:
      +
      4.0
      +
      See Also:
      +
      + +
      +
      +
      +
      • +
    • +
      +

      getDate

      +
      Date getDate()
      +
      Get message date.
      +
      +
      Returns:
      +
      the message date, otherwise null if not present.
      +
      +
      +
      • +
    • +
      +

      getLanguage

      +
      Locale getLanguage()
      +
      Get the language of the entity.
      +
      +
      Returns:
      +
      the language of the entity or null if not specified
      +
      +
      +
      • +
    • +
      +

      getLength

      +
      int getLength()
      +
      Get Content-Length value.
      +
      +
      Returns:
      +
      Content-Length as integer if present and valid number. In other cases returns -1.
      +
      +
      +
      • +
    • +
      +

      getMediaType

      +
      MediaType getMediaType()
      +
      Get the media type of the entity.
      +
      +
      Returns:
      +
      the media type or null if not specified (e.g. there's no request entity).
      +
      +
      +
      • +
    • +
      +

      getAcceptableMediaTypes

      +
      List<MediaType> getAcceptableMediaTypes()
      +
      Get a list of media types that are acceptable for the response.
      +
      +
      Returns:
      +
      a read-only list of requested response media types sorted according to their q-value, with highest preference + first.
      +
      +
      +
      • +
    • +
      +

      getAcceptableLanguages

      +
      List<Locale> getAcceptableLanguages()
      +
      Get a list of languages that are acceptable for the response.
      +
      +
      Returns:
      +
      a read-only list of acceptable languages sorted according to their q-value, with highest preference first.
      +
      +
      +
      • +
    • +
      +

      getCookies

      +
      Map<String,Cookie> getCookies()
      +
      Get any cookies that accompanied the request.
      +
      +
      Returns:
      +
      a read-only map of cookie name (String) to Cookie.
      +
      +
      +
      • +
    • +
      +

      hasEntity

      +
      boolean hasEntity()
      +
      Check if there is a non-empty entity input stream available in the request message. + + The method returns true if the entity is present, returns false otherwise.
      +
      +
      Returns:
      +
      true if there is an entity present in the message, false otherwise.
      +
      +
      +
      • +
    • +
      +

      getEntityStream

      +
      InputStream getEntityStream()
      +
      Get the entity input stream. The JAX-RS runtime is responsible for closing the input stream.
      +
      +
      Returns:
      +
      entity input stream.
      +
      +
      +
      • +
    • +
      +

      setEntityStream

      +
      void setEntityStream(InputStream input)
      +
      Set a new entity input stream. The JAX-RS runtime is responsible for closing the input stream.
      +
      +
      Parameters:
      +
      input - new entity input stream.
      +
      Throws:
      +
      IllegalStateException - in case the method is invoked from a response filter.
      +
      +
      +
      • +
    • +
      +

      getSecurityContext

      +
      SecurityContext getSecurityContext()
      +
      Get the injectable security context information for the current request. + + The SecurityContext.getUserPrincipal() must return null if the current request has not been + authenticated.
      +
      +
      Returns:
      +
      injectable request security context information.
      +
      +
      +
      • +
    • +
      +

      setSecurityContext

      +
      void setSecurityContext(SecurityContext context)
      +
      Set a new injectable security context information for the current request. + + The SecurityContext.getUserPrincipal() must return null if the current request has not been + authenticated.
      +
      +
      Parameters:
      +
      context - new injectable request security context information.
      +
      Throws:
      +
      IllegalStateException - in case the method is invoked from a response filter.
      +
      +
      +
      • +
    • +
      +

      abortWith

      +
      void abortWith(Response response)
      +
      Abort the filter chain with a response. + + This method breaks the filter chain processing and returns the provided response back to the client. The provided + response goes through the chain of applicable response filters.
      +
      +
      Parameters:
      +
      response - response to be sent back to the client.
      +
      Throws:
      +
      IllegalStateException - in case the method is invoked from a response filter.
      +
      +
      +
      • +
    +
    +
    • +
+
+ +
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/container/ContainerRequestFilter.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/container/ContainerRequestFilter.html new file mode 100644 index 0000000000..546502b914 --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/container/ContainerRequestFilter.html @@ -0,0 +1,207 @@ + + + + +ContainerRequestFilter (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Module jakarta.ws.rs
+
Package jakarta.ws.rs.container
+

Interface ContainerRequestFilter

+
+
+
+
public interface ContainerRequestFilter
+
An extension interface implemented by container request filters. +

+ By default, i.e. if no name binding is applied to the filter implementation class, + the filter instance is applied globally, however only after the incoming request has been matched to a particular + resource by JAX-RS runtime. If there is a @NameBinding annotation applied to the + filter, the filter will also be executed at the post-match request extension point, but only in case the + matched resource or sub-resource method is bound to the same name-binding annotation. +

+

+ In case the filter should be applied at the pre-match extension point, i.e. before any request matching has + been performed by JAX-RS runtime, the filter MUST be annotated with a @PreMatching + annotation. +

+

+ Use a pre-match request filter to update the input to the JAX-RS matching algorithm, e.g., the HTTP method, Accept + header, return cached responses etc. Otherwise, the use of a request filter invoked at the post-match request + extension point (after a successful resource method matching) is recommended. +

+

+ Filters implementing this interface must be annotated with @Provider to be + discovered by the JAX-RS runtime. Container request filter instances may also be discovered and bound + dynamically to particular resource methods. +

+
+
Since:
+
2.0
+
Author:
+
Marek Potociar, Santiago Pericas-Geertsen
+
See Also:
+
+ +
+
+
+
+
    + +
  • +
    +

    Method Summary

    +
    +
    +
    +
    +
    Modifier and Type
    +
    Method
    +
    Description
    +
    void
    +
    filter(ContainerRequestContext requestContext)
    +
    +
    Filter method called before a request has been dispatched to a resource.
    +
    +
    +
    +
    +
    +
    • +
+
+
+
    + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      filter

      +
      void filter(ContainerRequestContext requestContext) + throws IOException
      +
      Filter method called before a request has been dispatched to a resource. + +

      + Filters in the filter chain are ordered according to their jakarta.annotation.Priority class-level annotation + value. If a request filter produces a response by calling ContainerRequestContext.abortWith(jakarta.ws.rs.core.Response) method, the + execution of the (either pre-match or post-match) request filter chain is stopped and the response is passed to the + corresponding response filter chain (either pre-match or post-match). For example, a pre-match caching filter may + produce a response in this way, which would effectively skip any post-match request filters as well as post-match + response filters. Note however that a responses produced in this manner would still be processed by the pre-match + response filter chain. +

      +
      +
      Parameters:
      +
      requestContext - request context.
      +
      Throws:
      +
      IOException - if an I/O exception occurs.
      +
      See Also:
      +
      + +
      +
      +
      +
      • +
    +
    +
    • +
+
+ +
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/container/ContainerResponseContext.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/container/ContainerResponseContext.html new file mode 100644 index 0000000000..a974fe8da0 --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/container/ContainerResponseContext.html @@ -0,0 +1,830 @@ + + + + +ContainerResponseContext (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Module jakarta.ws.rs
+
Package jakarta.ws.rs.container
+

Interface ContainerResponseContext

+
+
+
+
public interface ContainerResponseContext
+
Container response filter context. + + A mutable class that provides response-specific information for the filter, such as message headers, message entity + or request-scoped properties. The exposed setters allow modification of the exposed response-specific information.
+
+
Since:
+
2.0
+
Author:
+
Marek Potociar
+
+
+
+ +
+
+
    + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      getStatus

      +
      int getStatus()
      +
      Get the status code associated with the response.
      +
      +
      Returns:
      +
      the response status code or -1 if the status was not set.
      +
      +
      +
      • +
    • +
      +

      setStatus

      +
      void setStatus(int code)
      +
      Set a new response status code.
      +
      +
      Parameters:
      +
      code - new status code.
      +
      +
      +
      • +
    • +
      +

      getStatusInfo

      +
      Response.StatusType getStatusInfo()
      +
      Get the complete status information associated with the response.
      +
      +
      Returns:
      +
      the response status information or null if the status was not set.
      +
      +
      +
      • +
    • +
      +

      setStatusInfo

      +
      void setStatusInfo(Response.StatusType statusInfo)
      +
      Set the complete status information (status code and reason phrase) associated with the response.
      +
      +
      Parameters:
      +
      statusInfo - the response status information.
      +
      +
      +
      • +
    • +
      +

      getHeaders

      +
      MultivaluedMap<String,Object> getHeaders()
      +
      Get the mutable response headers multivalued map.
      +
      +
      Returns:
      +
      mutable multivalued map of response headers.
      +
      See Also:
      +
      + +
      +
      +
      +
      • +
    • +
      +

      getStringHeaders

      +
      MultivaluedMap<String,String> getStringHeaders()
      +
      Get a string view of header values associated with the message. + + Changes in the underlying headers map are reflected in this view. +

      + The method converts the non-string header values to strings using a + RuntimeDelegate.HeaderDelegate if one is available via + RuntimeDelegate.createHeaderDelegate(java.lang.Class) for the class of the value or using the + values toString method if a header delegate is not available. +

      +
      +
      Returns:
      +
      response headers as a string view of header values.
      +
      See Also:
      +
      + +
      +
      +
      +
      • +
    • +
      +

      getHeaderString

      +
      String getHeaderString(String name)
      +
      Get a message header as a single string value. + + Each single non-string header value is converted to String using a RuntimeDelegate.HeaderDelegate if one + is available via RuntimeDelegate.createHeaderDelegate(java.lang.Class) for the header value + class or using its toString method if a header delegate is not available.
      +
      +
      Parameters:
      +
      name - the message header.
      +
      Returns:
      +
      the message header value. If the message header is not present then null is returned. If the message + header is present but has no value then the empty string is returned. If the message header is present more than once + then the values of joined together and separated by a ',' character.
      +
      See Also:
      +
      + +
      +
      +
      +
      • +
    • +
      +

      containsHeaderString

      +
      boolean containsHeaderString(String name, + String valueSeparatorRegex, + Predicate<String> valuePredicate)
      +
      Checks whether a header with a specific name and value (or item of the token-separated value list) exists. + + Each single non-string header value is converted to String using a RuntimeDelegate.HeaderDelegate if one + is available via RuntimeDelegate.createHeaderDelegate(java.lang.Class) for the header value + class or using its toString method if a header delegate is not available. + +

      + For example: containsHeaderString("cache-control", ",", "no-store"::equalsIgnoreCase) will return true if + a Cache-Control header exists that has the value no-store, the value No-Store or the value + Max-Age, NO-STORE, no-transform, but false when it has the value no-store;no-transform + (missing comma), or the value no - store (whitespace within value).

      +
      +
      Parameters:
      +
      name - the message header.
      +
      valueSeparatorRegex - Regular expression that separates the header value into single values. null does not split.
      +
      valuePredicate - value must fulfil this predicate.
      +
      Returns:
      +
      true if and only if a header with the given name exists, having either a whitespace-trimmed value + matching the predicate, or having at least one whitespace-trimmed single value in a token-separated list of single values.
      +
      Since:
      +
      4.0
      +
      See Also:
      +
      + +
      +
      +
      +
      • +
    • +
      +

      containsHeaderString

      +
      default boolean containsHeaderString(String name, + Predicate<String> valuePredicate)
      +
      Checks whether a header with a specific name and value (or item of the comma-separated value list) exists. + + Each single non-string header value is converted to String using a RuntimeDelegate.HeaderDelegate if one + is available via RuntimeDelegate.createHeaderDelegate(java.lang.Class) for the header value + class or using its toString method if a header delegate is not available. + +

      + For example: containsHeaderString("cache-control", "no-store"::equalsIgnoreCase) will return true if + a Cache-Control header exists that has the value no-store, the value No-Store or the value + Max-Age, NO-STORE, no-transform, but false when it has the value no-store;no-transform + (missing comma), or the value no - store (whitespace within value).

      +
      +
      Parameters:
      +
      name - the message header.
      +
      valuePredicate - value must fulfil this predicate.
      +
      Returns:
      +
      true if and only if a header with the given name exists, having either a whitespace-trimmed value + matching the predicate, or having at least one whitespace-trimmed single value in a comma-separated list of single values.
      +
      Since:
      +
      4.0
      +
      See Also:
      +
      + +
      +
      +
      +
      • +
    • +
      +

      getAllowedMethods

      +
      Set<String> getAllowedMethods()
      +
      Get the allowed HTTP methods from the Allow HTTP header.
      +
      +
      Returns:
      +
      the allowed HTTP methods, all methods will returned as upper case strings.
      +
      +
      +
      • +
    • +
      +

      getDate

      +
      Date getDate()
      +
      Get message date.
      +
      +
      Returns:
      +
      the message date, otherwise null if not present.
      +
      +
      +
      • +
    • +
      +

      getLanguage

      +
      Locale getLanguage()
      +
      Get the language of the entity.
      +
      +
      Returns:
      +
      the language of the entity or null if not specified
      +
      +
      +
      • +
    • +
      +

      getLength

      +
      int getLength()
      +
      Get Content-Length value.
      +
      +
      Returns:
      +
      Content-Length as integer if present and valid number. In other cases returns -1.
      +
      +
      +
      • +
    • +
      +

      getMediaType

      +
      MediaType getMediaType()
      +
      Get the media type of the entity.
      +
      +
      Returns:
      +
      the media type or null if not specified (e.g. there's no response entity).
      +
      +
      +
      • +
    • +
      +

      getCookies

      +
      Map<String,NewCookie> getCookies()
      +
      Get any new cookies set on the response message.
      +
      +
      Returns:
      +
      a read-only map of cookie name (String) to a new cookie.
      +
      +
      +
      • +
    • +
      +

      getEntityTag

      +
      EntityTag getEntityTag()
      +
      Get the entity tag.
      +
      +
      Returns:
      +
      the entity tag, otherwise null if not present.
      +
      +
      +
      • +
    • +
      +

      getLastModified

      +
      Date getLastModified()
      +
      Get the last modified date.
      +
      +
      Returns:
      +
      the last modified date, otherwise null if not present.
      +
      +
      +
      • +
    • +
      +

      getLocation

      +
      URI getLocation()
      +
      Get the location.
      +
      +
      Returns:
      +
      the location URI, otherwise null if not present.
      +
      +
      +
      • +
    • +
      +

      getLinks

      +
      Set<Link> getLinks()
      +
      Get the links attached to the message as header.
      +
      +
      Returns:
      +
      links, may return empty Set if no links are present. Never returns null.
      +
      +
      +
      • +
    • +
      +

      hasLink

      +
      boolean hasLink(String relation)
      +
      Check if link for relation exists.
      +
      +
      Parameters:
      +
      relation - link relation.
      +
      Returns:
      +
      true if the for the relation link exists, false otherwise.
      +
      +
      +
      • +
    • +
      +

      getLink

      +
      Link getLink(String relation)
      +
      Get the link for the relation.
      +
      +
      Parameters:
      +
      relation - link relation.
      +
      Returns:
      +
      the link for the relation, otherwise null if not present.
      +
      +
      +
      • +
    • +
      +

      getLinkBuilder

      +
      Link.Builder getLinkBuilder(String relation)
      +
      Convenience method that returns a Link.Builder for the relation.
      +
      +
      Parameters:
      +
      relation - link relation.
      +
      Returns:
      +
      the link builder for the relation, otherwise null if not present.
      +
      +
      +
      • +
    • +
      +

      hasEntity

      +
      boolean hasEntity()
      +
      Check if there is an entity available in the response. + + The method returns true if the entity is present, returns false otherwise.
      +
      +
      Returns:
      +
      true if there is an entity present in the message, false otherwise.
      +
      +
      +
      • +
    • +
      +

      getEntity

      +
      Object getEntity()
      +
      Get the message entity Java instance. + + Returns null if the message does not contain an entity.
      +
      +
      Returns:
      +
      the message entity or null if message does not contain an entity body.
      +
      +
      +
      • +
    • +
      +

      getEntityClass

      +
      Class<?> getEntityClass()
      +
      Get the raw entity type information.
      +
      +
      Returns:
      +
      raw entity type.
      +
      +
      +
      • +
    • +
      +

      getEntityType

      +
      Type getEntityType()
      +
      Get the generic entity type information.
      +
      +
      Returns:
      +
      declared generic entity type.
      +
      +
      +
      • +
    • +
      +

      setEntity

      +
      void setEntity(Object entity)
      +
      Set a new message entity. The existing entity annotations and media type are preserved. +

      + It is the callers responsibility to wrap the actual entity with GenericEntity if + preservation of its generic type is required. +

      +
      +
      Parameters:
      +
      entity - entity object.
      +
      See Also:
      +
      + +
      +
      +
      +
      • +
    • +
      +

      setEntity

      +
      void setEntity(Object entity, + Annotation[] annotations, + MediaType mediaType)
      +
      Set a new message entity, including the attached annotations and the media type. +

      + It is the callers responsibility to wrap the actual entity with GenericEntity if + preservation of its generic type is required. +

      +
      +
      Parameters:
      +
      entity - entity object.
      +
      annotations - annotations attached to the entity instance.
      +
      mediaType - entity media type.
      +
      See Also:
      +
      + +
      +
      +
      +
      • +
    • +
      +

      getEntityAnnotations

      +
      Annotation[] getEntityAnnotations()
      +
      Get the annotations attached to the entity instance. +

      + Note that the returned annotations array contains only those annotations explicitly attached to entity instance (such + as the ones attached using + Response.ResponseBuilder.entity(Object, java.lang.annotation.Annotation[]) method as well as + the ones attached to the resource method that has returned the response). The entity instance annotations array does + not include annotations declared on the entity implementation class or its ancestors. +

      +

      + Note that container response filters invoked earlier in the filter chain may modify the entity annotations value, in + which case this getter method would return the last annotations value set by a container response filter invoked + earlier in the filter chain. +

      +

      + For example: +

      + + 
      + @Path("my-resource")
+ public class MyResource {
+   private final Annotations[] extras = ... ;
+
+   @GET
+   @Custom
+   public String getAnnotatedMe() {
+     return Response.ok().entity("Annotated me", extras).build();
+   }
+   ...
+ }
+
      +

      + The container response context for a response returned from the getMe() method above would contain all the + annotations declared on the getAnnotatedMe() method (@GET, @Custom) as well as all the + annotations from the extras field, provided this value has not been replaced by any container response filter + invoked earlier. +

      +

      + Similarly: +

      + + 
      + @Custom
+ public class AnnotatedMe { ... }
+
+ @Path("my-resource")
+ public class MyResource {
+   private final Annotations[] extras = ... ;
+
+   @GET
+   public AnnotatedMe getMe() {
+     return Response.ok().entity(new AnnotatedMe(), extras).build();
+   }
+   ...
+ }
+
      +

      + Provided that the value has not been replaced by any container response filter invoked earlier, the container + response context for a response returned from the getMe() method above would contain all the annotations on + the getMe() method (@GET) as well as all the annotations from the extras field. It would + however not contain any annotations declared on the AnnotatedMe class. +

      +
      +
      Returns:
      +
      annotations attached to the entity instance.
      +
      +
      +
      • +
    • +
      +

      getEntityStream

      +
      OutputStream getEntityStream()
      +
      Get the entity output stream. The JAX-RS runtime is responsible for closing the output stream.
      +
      +
      Returns:
      +
      entity output stream.
      +
      +
      +
      • +
    • +
      +

      setEntityStream

      +
      void setEntityStream(OutputStream outputStream)
      +
      Set a new entity output stream. The JAX-RS runtime is responsible for closing the output stream.
      +
      +
      Parameters:
      +
      outputStream - new entity output stream.
      +
      +
      +
      • +
    +
    +
    • +
+
+ +
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/container/ContainerResponseFilter.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/container/ContainerResponseFilter.html new file mode 100644 index 0000000000..6f14b26d59 --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/container/ContainerResponseFilter.html @@ -0,0 +1,192 @@ + + + + +ContainerResponseFilter (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Module jakarta.ws.rs
+
Package jakarta.ws.rs.container
+

Interface ContainerResponseFilter

+
+
+
+
public interface ContainerResponseFilter
+
An extension interface implemented by container response filters. +

+ By default, i.e. if no name binding is applied to the filter implementation class, + the filter instance is applied globally to any outgoing response. If there is a @NameBinding annotation + applied to the filter, the filter will only be executed for a response for which the request has been matched to a + resource or sub-resource method AND the method or the whole custom + JAX-RS Application class is bound to the same name-binding annotation. +

+

+ Implement a name-bound response filter in cases when you want limit the filter functionality to a matched resource or + resource method. In other cases, when the filter should be applied globally to any outgoing response, implement an + unbound, global response filter. +

+

+ Filters implementing this interface must be annotated with @Provider to be + discovered by the JAX-RS runtime. Container response filter instances may also be discovered and bound + dynamically to particular resource methods. +

+
+
Since:
+
2.0
+
Author:
+
Marek Potociar, Santiago Pericas-Geertsen
+
See Also:
+
+ +
+
+
+
+
    + +
  • +
    +

    Method Summary

    +
    +
    +
    +
    +
    Modifier and Type
    +
    Method
    +
    Description
    +
    void
    +
    filter(ContainerRequestContext requestContext, + ContainerResponseContext responseContext)
    +
    +
    Filter method called after a response has been provided for a request (either by a request filter or by a matched resource method.
    +
    +
    +
    +
    +
    +
    • +
+
+
+
    + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      filter

      +
      void filter(ContainerRequestContext requestContext, + ContainerResponseContext responseContext) + throws IOException
      +
      Filter method called after a response has been provided for a request (either by a request filter or by a matched resource method. +

      + Filters in the filter chain are ordered according to their jakarta.annotation.Priority class-level annotation + value. +

      +
      +
      Parameters:
      +
      requestContext - request context.
      +
      responseContext - response context.
      +
      Throws:
      +
      IOException - if an I/O exception occurs.
      +
      +
      +
      • +
    +
    +
    • +
+
+ +
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/container/DynamicFeature.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/container/DynamicFeature.html new file mode 100644 index 0000000000..9cc888893d --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/container/DynamicFeature.html @@ -0,0 +1,205 @@ + + + + +DynamicFeature (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Module jakarta.ws.rs
+
Package jakarta.ws.rs.container
+

Interface DynamicFeature

+
+
+
+
public interface DynamicFeature
+
A JAX-RS meta-provider for dynamic registration of post-matching providers during a JAX-RS application setup + at deployment time. + + Dynamic feature is used by JAX-RS runtime to register providers that shall be applied to a particular resource class + and method and overrides any annotation-based binding definitions defined on any registered resource filter or + interceptor instance. +

+ Providers implementing this interface MAY be annotated with @Provider annotation + in order to be discovered by JAX-RS runtime when scanning for resources and providers. This provider types is + supported only as part of the Server API. +

+
+
Since:
+
2.0
+
Author:
+
Santiago Pericas-Geertsen, Bill Burke, Marek Potociar
+
See Also:
+
+ +
+
+
+
+ +
+
+
    + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      configure

      +
      void configure(ResourceInfo resourceInfo, + FeatureContext context)
      +
      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. the providers that should be dynamically bound + to the method. +

      + The registered provider instances or classes are expected to be implementing one or more of the following interfaces: +

      + +

      + A provider instance or class that does not implement any of the interfaces above may be ignored by the JAX-RS + implementation. In such case a warning message must be logged. JAX-RS + implementations may support additional provider contracts that can be registered using a dynamic feature concept. +

      +

      + Conceptually, this callback method is called during a resource or sub-resource method + discovery phase (typically once per each discovered resource or sub-resource method) to register provider instances + or classes in a configuration scope of each particular method identified by the supplied resource information. The responsibility of the feature is to properly update the supplied configuration + context. +

      +
      +
      Parameters:
      +
      resourceInfo - resource class and method information.
      +
      context - configurable resource or sub-resource method-level runtime context associated with the + resourceInfo in which the feature
      +
      +
      +
      • +
    +
    +
    • +
+
+ +
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/container/PreMatching.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/container/PreMatching.html new file mode 100644 index 0000000000..92a92c34b6 --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/container/PreMatching.html @@ -0,0 +1,115 @@ + + + + +PreMatching (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Module jakarta.ws.rs
+
Package jakarta.ws.rs.container
+

Annotation Interface PreMatching

+
+
+
+
@Target(TYPE) +@Retention(RUNTIME) +@Documented +public @interface PreMatching
+
Global binding annotation that can be applied to a container request filter to + indicate that such filter should be applied globally on all resources in the application before the actual resource + matching occurs. +

+ The JAX-RS runtime will apply the filters marked with the @PreMatching annotation globally to all resources, + before the incoming request has been matched to a particular resource method. Any named binding annotations will be ignored on a component annotated with the @PreMatching annotation. +

+
+
Author:
+
Marek Potociar
+
+
+
+ +
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/container/ResourceContext.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/container/ResourceContext.html new file mode 100644 index 0000000000..9082f988c7 --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/container/ResourceContext.html @@ -0,0 +1,197 @@ + + + + +ResourceContext (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Module jakarta.ws.rs
+
Package jakarta.ws.rs.container
+

Interface ResourceContext

+
+
+
+
public interface ResourceContext
+
The resource context provides access to instances of resource classes. +

+ This interface can be injected using the Context annotation. +

+

+ The resource context can be utilized when instances of managed resource classes are to be returned by sub-resource + locator methods. Such instances will be injected and managed within the declared scope just like instances of root + resource classes. +

+
+
Author:
+
Marek Potociar
+
+
+
+
    + +
  • +
    +

    Method Summary

    +
    +
    +
    +
    +
    Modifier and Type
    +
    Method
    +
    Description
    +
    <T> T
    +
    getResource(Class<T> resourceClass)
    +
    +
    Get a resolved instance of a resource or sub-resource class.
    +
    +
    <T> T
    +
    initResource(T resource)
    +
    +
    Initialize the resource or sub-resource instance.
    +
    +
    +
    +
    +
    +
    • +
+
+
+
    + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      getResource

      +
      <T> T getResource(Class<T> resourceClass)
      +
      Get a resolved instance of a resource or sub-resource class. +

      + The resolved resource instance is properly initialized in the context of the current request processing scope. The + scope of the resolved resource instance depends on the managing container. For resources managed by JAX-RS container + the default scope is per-request. +

      +
      +
      Type Parameters:
      +
      T - the type of the resource class.
      +
      Parameters:
      +
      resourceClass - the resource class.
      +
      Returns:
      +
      an instance if it could be resolved, otherwise null.
      +
      +
      +
      • +
    • +
      +

      initResource

      +
      <T> T initResource(T resource)
      +
      Initialize the resource or sub-resource instance. + + All JAX-RS injectable fields in the resource instance will be properly initialized in the context of the current + request processing scope.
      +
      +
      Type Parameters:
      +
      T - resource instance type.
      +
      Parameters:
      +
      resource - resource instance.
      +
      Returns:
      +
      initialized (same) resource instance.
      +
      +
      +
      • +
    +
    +
    • +
+
+ +
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/container/ResourceInfo.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/container/ResourceInfo.html new file mode 100644 index 0000000000..6120c33112 --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/container/ResourceInfo.html @@ -0,0 +1,189 @@ + + + + +ResourceInfo (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Module jakarta.ws.rs
+
Package jakarta.ws.rs.container
+

Interface ResourceInfo

+
+
+
+
public interface ResourceInfo
+
An injectable class to access the resource class and resource method matched by the current request. Methods in this + class MAY return null if a resource class and method have not been matched, e.g. in a standalone, + pre-matching ContainerRequestFilter that was not provided by a post-matching PreMatching.
+
+
Since:
+
2.0
+
Author:
+
Santiago Pericas-Geertsen
+
+
+
+
    + +
  • +
    +

    Method Summary

    +
    +
    +
    +
    +
    Modifier and Type
    +
    Method
    +
    Description
    +
    Class<?>
    +
    getResourceClass()
    +
    +
    Get the resource class that is the target of a request, or null if this information is not available.
    +
    +
    Method
    +
    getResourceMethod()
    +
    +
    Get the resource method that is the target of a request, or null if this information is not available.
    +
    +
    +
    +
    +
    +
    • +
+
+
+
    + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      getResourceMethod

      +
      Method getResourceMethod()
      +
      Get the resource method that is the target of a request, or null if this information is not available.
      +
      +
      Returns:
      +
      resource method instance or null
      +
      See Also:
      +
      + +
      +
      +
      +
      • +
    • +
      +

      getResourceClass

      +
      Class<?> getResourceClass()
      +
      Get the resource class that is the target of a request, or null if this information is not available.
      +
      +
      Returns:
      +
      resource class instance or null
      +
      See Also:
      +
      + +
      +
      +
      +
      • +
    +
    +
    • +
+
+ +
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/container/Suspended.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/container/Suspended.html new file mode 100644 index 0000000000..acb784e08b --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/container/Suspended.html @@ -0,0 +1,159 @@ + + + + +Suspended (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Module jakarta.ws.rs
+
Package jakarta.ws.rs.container
+

Annotation Interface Suspended

+
+
+
+
@Target(PARAMETER) +@Retention(RUNTIME) +@Documented +public @interface Suspended
+
Inject a suspended AsyncResponse into a parameter of an invoked JAX-RS resource + or sub-resource method. + + The injected AsyncResponse instance is bound to the processing of the active request and can be used to + resume the request processing when a response is available. +

+ By default there is no suspend timeout set and the asynchronous response is + suspended indefinitely. The suspend timeout as well as a custom timeout handler can be + specified programmatically using the AsyncResponse.setTimeout(long, TimeUnit) and + AsyncResponse.setTimeoutHandler(TimeoutHandler) methods. For example: +

+ + 
+  @Stateless
+  @Path("/")
+  public class MyEjbResource {
+    …
+    @GET
+    @Asynchronous
+    public void longRunningOperation(@Suspended AsyncResponse ar) {
+      ar.setTimeoutHandler(customHandler);
+      ar.setTimeout(10, TimeUnit.SECONDS);
+      final String result = executeLongRunningOperation();
+      ar.resume(result);
+    }
+
+    private String executeLongRunningOperation() { … }
+  }
+
+

+ A resource or sub-resource method that injects a suspended instance of an AsyncResponse using the + @Suspended annotation is expected be declared to return void type. Methods that inject asynchronous + response instance using the @Suspended annotation and declare a return type other than void MUST be + detected by the JAX-RS runtime and a warning message MUST be logged. Any response value returned from such resource + or sub-resource method MUST be ignored by the framework: +

+ + 
+ @Path("/messages/next")
+ public class MessagingResource {
+     …
+     @GET
+     public String readMessage(@Suspended AsyncResponse ar) {
+         suspended.put(ar);
+         return "This response will be ignored.";
+     }
+     …
+ }
+
+
+
Since:
+
2.0
+
Author:
+
Marek Potociar
+
+
+
+ +
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/container/TimeoutHandler.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/container/TimeoutHandler.html new file mode 100644 index 0000000000..8ab5684d18 --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/container/TimeoutHandler.html @@ -0,0 +1,226 @@ + + + + +TimeoutHandler (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Module jakarta.ws.rs
+
Package jakarta.ws.rs.container
+

Interface TimeoutHandler

+
+
+
+
public interface TimeoutHandler
+
Asynchronous response suspend time-out handler. + + JAX-RS users may utilize this callback interface to provide custom resolution of time-out events. +

+ By default, JAX-RS runtime generates a WebApplicationException with a + HTTP 503 (Service unavailable) error response status + code. A custom time-out handler may be set on an asynchronous + response instance to provide custom time-out event resolution. +

+

+ In case of a suspend time-out event, a custom time-out handler takes typically one of the following actions: +

+ +

+ If the registered time-out handler does not take any of the actions above, the default time-out event processing + continues and the response is resumed with a generated WebApplicationException containing the HTTP 503 status + code. +

+

+ Following example illustrates the use of a custom TimeoutHandler: +

+ + 
+ public class MyTimeoutHandler implements TimeoutHandler {
+     …
+     public void handleTimeout(AsyncResponse ar) {
+         if (keepSuspended) {
+             ar.setTimeout(10, SECONDS);
+         } else if (cancel) {
+             ar.cancel(retryPeriod);
+         } else {
+             ar.resume(defaultResponse);
+         }
+     }
+     …
+ }
+
+ @Path("/messages/next")
+ public class MessagingResource {
+     …
+     @GET
+     public void readMessage(@Suspended AsyncResponse ar) {
+         ar.setTimeoutHandler(new MyTimeoutHandler());
+         suspended.put(ar);
+     }
+     …
+ }
+
+
+
Since:
+
2.0
+
Author:
+
Marek Potociar
+
+
+
+
    + +
  • +
    +

    Method Summary

    +
    +
    +
    +
    +
    Modifier and Type
    +
    Method
    +
    Description
    +
    void
    +
    handleTimeout(AsyncResponse asyncResponse)
    +
    +
    Invoked when the suspended asynchronous response is about to time out.
    +
    +
    +
    +
    +
    +
    • +
+
+
+
    + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      handleTimeout

      +
      void handleTimeout(AsyncResponse asyncResponse)
      +
      Invoked when the suspended asynchronous response is about to time out. + + Implementing time-out handlers may use the callback method to change the default time-out strategy defined by JAX-RS + specification (see AsyncResponse API documentation). +

      + A custom time-out handler may decide to either +

      +
        +
      • resume the suspended response using one of it's resume(...) methods,
        • +
      • cancel the suspended response using one of it's cancel(...) methods, or
        • +
      • extend the suspend period by setting a new + suspend time-out
        • +
      + In case the time-out handler does not take any of the actions mentioned above, a default time-out strategy is + executed by the JAX-RS runtime.
      +
      +
      Parameters:
      +
      asyncResponse - suspended asynchronous response that is timing out.
      +
      +
      +
      • +
    +
    +
    • +
+
+ +
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/container/class-use/AsyncResponse.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/container/class-use/AsyncResponse.html new file mode 100644 index 0000000000..25b1304c3a --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/container/class-use/AsyncResponse.html @@ -0,0 +1,98 @@ + + + + +Uses of Interface jakarta.ws.rs.container.AsyncResponse (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
jakarta.ws.rs.container.AsyncResponse

+
+
Packages that use AsyncResponse
+
+
Package
+
Description
+
jakarta.ws.rs.container
+
+
Container-specific JAX-RS API.
+
+
+
+ +
+
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/container/class-use/CompletionCallback.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/container/class-use/CompletionCallback.html new file mode 100644 index 0000000000..b9cae2ddce --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/container/class-use/CompletionCallback.html @@ -0,0 +1,63 @@ + + + + +Uses of Interface jakarta.ws.rs.container.CompletionCallback (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
jakarta.ws.rs.container.CompletionCallback

+
+No usage of jakarta.ws.rs.container.CompletionCallback
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/container/class-use/ConnectionCallback.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/container/class-use/ConnectionCallback.html new file mode 100644 index 0000000000..00f6471e8a --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/container/class-use/ConnectionCallback.html @@ -0,0 +1,63 @@ + + + + +Uses of Interface jakarta.ws.rs.container.ConnectionCallback (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
jakarta.ws.rs.container.ConnectionCallback

+
+No usage of jakarta.ws.rs.container.ConnectionCallback
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/container/class-use/ContainerRequestContext.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/container/class-use/ContainerRequestContext.html new file mode 100644 index 0000000000..efe9935789 --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/container/class-use/ContainerRequestContext.html @@ -0,0 +1,98 @@ + + + + +Uses of Interface jakarta.ws.rs.container.ContainerRequestContext (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
jakarta.ws.rs.container.ContainerRequestContext

+
+
Packages that use ContainerRequestContext
+
+
Package
+
Description
+
jakarta.ws.rs.container
+
+
Container-specific JAX-RS API.
+
+
+
+ +
+
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/container/class-use/ContainerRequestFilter.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/container/class-use/ContainerRequestFilter.html new file mode 100644 index 0000000000..8cf29e61fa --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/container/class-use/ContainerRequestFilter.html @@ -0,0 +1,63 @@ + + + + +Uses of Interface jakarta.ws.rs.container.ContainerRequestFilter (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
jakarta.ws.rs.container.ContainerRequestFilter

+
+No usage of jakarta.ws.rs.container.ContainerRequestFilter
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/container/class-use/ContainerResponseContext.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/container/class-use/ContainerResponseContext.html new file mode 100644 index 0000000000..c84ee684d5 --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/container/class-use/ContainerResponseContext.html @@ -0,0 +1,93 @@ + + + + +Uses of Interface jakarta.ws.rs.container.ContainerResponseContext (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
jakarta.ws.rs.container.ContainerResponseContext

+
+
Packages that use ContainerResponseContext
+
+
Package
+
Description
+
jakarta.ws.rs.container
+
+
Container-specific JAX-RS API.
+
+
+
+ +
+
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/container/class-use/ContainerResponseFilter.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/container/class-use/ContainerResponseFilter.html new file mode 100644 index 0000000000..3ba6e8b711 --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/container/class-use/ContainerResponseFilter.html @@ -0,0 +1,63 @@ + + + + +Uses of Interface jakarta.ws.rs.container.ContainerResponseFilter (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
jakarta.ws.rs.container.ContainerResponseFilter

+
+No usage of jakarta.ws.rs.container.ContainerResponseFilter
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/container/class-use/DynamicFeature.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/container/class-use/DynamicFeature.html new file mode 100644 index 0000000000..2d183d9a4e --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/container/class-use/DynamicFeature.html @@ -0,0 +1,63 @@ + + + + +Uses of Interface jakarta.ws.rs.container.DynamicFeature (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
jakarta.ws.rs.container.DynamicFeature

+
+No usage of jakarta.ws.rs.container.DynamicFeature
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/container/class-use/PreMatching.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/container/class-use/PreMatching.html new file mode 100644 index 0000000000..bb706912a1 --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/container/class-use/PreMatching.html @@ -0,0 +1,63 @@ + + + + +Uses of Annotation Interface jakarta.ws.rs.container.PreMatching (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Annotation Interface
jakarta.ws.rs.container.PreMatching

+
+No usage of jakarta.ws.rs.container.PreMatching
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/container/class-use/ResourceContext.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/container/class-use/ResourceContext.html new file mode 100644 index 0000000000..026f958d7b --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/container/class-use/ResourceContext.html @@ -0,0 +1,63 @@ + + + + +Uses of Interface jakarta.ws.rs.container.ResourceContext (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
jakarta.ws.rs.container.ResourceContext

+
+No usage of jakarta.ws.rs.container.ResourceContext
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/container/class-use/ResourceInfo.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/container/class-use/ResourceInfo.html new file mode 100644 index 0000000000..877d255c18 --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/container/class-use/ResourceInfo.html @@ -0,0 +1,95 @@ + + + + +Uses of Interface jakarta.ws.rs.container.ResourceInfo (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
jakarta.ws.rs.container.ResourceInfo

+
+
Packages that use ResourceInfo
+
+
Package
+
Description
+
jakarta.ws.rs.container
+
+
Container-specific JAX-RS API.
+
+
+
+ +
+
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/container/class-use/Suspended.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/container/class-use/Suspended.html new file mode 100644 index 0000000000..a042178124 --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/container/class-use/Suspended.html @@ -0,0 +1,63 @@ + + + + +Uses of Annotation Interface jakarta.ws.rs.container.Suspended (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Annotation Interface
jakarta.ws.rs.container.Suspended

+
+No usage of jakarta.ws.rs.container.Suspended
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/container/class-use/TimeoutHandler.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/container/class-use/TimeoutHandler.html new file mode 100644 index 0000000000..47e28079a0 --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/container/class-use/TimeoutHandler.html @@ -0,0 +1,92 @@ + + + + +Uses of Interface jakarta.ws.rs.container.TimeoutHandler (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
jakarta.ws.rs.container.TimeoutHandler

+
+
Packages that use TimeoutHandler
+
+
Package
+
Description
+
jakarta.ws.rs.container
+
+
Container-specific JAX-RS API.
+
+
+
+ +
+
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/container/package-summary.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/container/package-summary.html new file mode 100644 index 0000000000..a1c0dbcaa1 --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/container/package-summary.html @@ -0,0 +1,187 @@ + + + + +jakarta.ws.rs.container (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+
Module jakarta.ws.rs
+

Package jakarta.ws.rs.container

+
+
+
package jakarta.ws.rs.container
+
+
Container-specific JAX-RS API.
+
+
+
    +
  • + +
    • +
  • +
    +
    +
    +
    +
    Class
    +
    Description
    +
    AsyncResponse
    +
    +
    An injectable JAX-RS asynchronous response that provides means for asynchronous server side response processing.
    +
    +
    CompletionCallback
    +
    +
    A request processing callback that receives request processing completion events.
    +
    +
    ConnectionCallback
    +
    +
    Asynchronous request processing lifecycle callback that receives connection related asynchronous + response lifecycle events.
    +
    +
    ContainerRequestContext
    +
    +
    Container request filter context.
    +
    +
    ContainerRequestFilter
    +
    +
    An extension interface implemented by container request filters.
    +
    +
    ContainerResponseContext
    +
    +
    Container response filter context.
    +
    +
    ContainerResponseFilter
    +
    +
    An extension interface implemented by container response filters.
    +
    +
    DynamicFeature
    +
    +
    A JAX-RS meta-provider for dynamic registration of post-matching providers during a JAX-RS application setup + at deployment time.
    +
    +
    PreMatching
    +
    +
    Global binding annotation that can be applied to a container request filter to + indicate that such filter should be applied globally on all resources in the application before the actual resource + matching occurs.
    +
    +
    ResourceContext
    +
    +
    The resource context provides access to instances of resource classes.
    +
    +
    ResourceInfo
    +
    +
    An injectable class to access the resource class and resource method matched by the current request.
    +
    +
    Suspended
    +
    +
    Inject a suspended AsyncResponse into a parameter of an invoked JAX-RS resource + or sub-resource method.
    +
    +
    TimeoutHandler
    +
    +
    Asynchronous response suspend time-out handler.
    +
    +
    +
    +
    +
    • +
+
+
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/container/package-tree.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/container/package-tree.html new file mode 100644 index 0000000000..f589f84cc1 --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/container/package-tree.html @@ -0,0 +1,90 @@ + + + + +jakarta.ws.rs.container Class Hierarchy (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Hierarchy For Package jakarta.ws.rs.container

+
+Package Hierarchies: + +
+

Interface Hierarchy

+ +
+
+

Annotation Interface Hierarchy

+ +
+
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/container/package-use.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/container/package-use.html new file mode 100644 index 0000000000..3b456c2add --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/container/package-use.html @@ -0,0 +1,105 @@ + + + + +Uses of Package jakarta.ws.rs.container (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Package
jakarta.ws.rs.container

+
+
Packages that use jakarta.ws.rs.container
+
+
Package
+
Description
+
jakarta.ws.rs.container
+
+
Container-specific JAX-RS API.
+
+
+
+ +
+
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/AbstractMultivaluedMap.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/AbstractMultivaluedMap.html new file mode 100644 index 0000000000..6c263584ff --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/AbstractMultivaluedMap.html @@ -0,0 +1,715 @@ + + + + +AbstractMultivaluedMap (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Module jakarta.ws.rs
+
Package jakarta.ws.rs.core
+

Class AbstractMultivaluedMap<K,V>

+
+
java.lang.Object +
jakarta.ws.rs.core.AbstractMultivaluedMap<K,V>
+
+
+
+
Type Parameters:
+
K - the type of keys maintained by this map.
+
V - the type of mapped values.
+
+
+
All Implemented Interfaces:
+
MultivaluedMap<K,V>, Serializable, Map<K,List<V>>
+
+
+
Direct Known Subclasses:
+
MultivaluedHashMap
+
+
+
public abstract class AbstractMultivaluedMap<K,V> +extends Object +implements MultivaluedMap<K,V>, Serializable
+
Abstract skeleton implementation of a MultivaluedMap that is backed by a [key, multi-value] store represented + as a Map<K, List<V>>.
+
+
Author:
+
Marek Potociar
+
See Also:
+
+ +
+
+
+
+ +
+
+
    + +
  • +
    +

    Field Details

    +
      +
    • +
      +

      store

      +
      protected final Map<K,List<V>> store
      +
      Backing store for the [key, multi-value] pairs.
      +
      +
      • +
    +
    +
    • + +
  • +
    +

    Constructor Details

    +
      +
    • +
      +

      AbstractMultivaluedMap

      +
      public AbstractMultivaluedMap(Map<K,List<V>> store)
      +
      Initialize the backing store in the abstract parent multivalued map implementation.
      +
      +
      Parameters:
      +
      store - the backing Map to be used as a [key, multi-value] store. Must not be null.
      +
      Throws:
      +
      NullPointerException - in case the underlying store parameter is null.
      +
      +
      +
      • +
    +
    +
    • + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      putSingle

      +
      public final void putSingle(K key, + V value)
      +

      + Set the value for the key to be a one item list consisting of the supplied value. Any existing values will be + replaced. +

      + NOTE: This implementation ignores null values; A supplied value of null is ignored and not added to + the purged value list. As a result of such operation, empty value list would be registered for the supplied key. + Overriding implementations may modify this behavior by redefining the addNull(java.util.List) method.
      +
      +
      Specified by:
      +
      putSingle in interface MultivaluedMap<K,V>
      +
      Parameters:
      +
      key - the key
      +
      value - the single value of the key. If the value is null it will be ignored.
      +
      +
      +
      • +
    • +
      +

      addNull

      +
      protected void addNull(List<V> values)
      +

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

      + Default implementation is a no-op, i.e. the null values are ignored. Overriding implementations may modify + this behavior by providing their own definitions of this method.
      +
      +
      Parameters:
      +
      values - value list where the null value addition is being requested.
      +
      +
      +
      • +
    • +
      +

      addFirstNull

      +
      protected void addFirstNull(List<V> values)
      +

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

      + Default implementation is a no-op, i.e. the null values are ignored. Overriding implementations may modify + this behavior by providing their own definitions of this method.
      +
      +
      Parameters:
      +
      values - value list where the null value addition is being requested.
      +
      +
      +
      • +
    • +
      +

      add

      +
      public final void add(K key, + V value)
      +

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

      + NOTE: This implementation ignores null values; A supplied value of null is ignored and not added to + the value list. Overriding implementations may modify this behavior by redefining the + addNull(java.util.List) method.
      +
      +
      Specified by:
      +
      add in interface MultivaluedMap<K,V>
      +
      Parameters:
      +
      key - the key
      +
      value - the value to be added.
      +
      +
      +
      • +
    • +
      +

      addAll

      +
      public final void addAll(K key, + V... newValues)
      +

      + Add multiple values to the current list of values for the supplied key. If the supplied array of new values is empty, + method returns immediately. Method throws a NullPointerException if the supplied array of values is + null. +

      + NOTE: This implementation ignores null values; Any of the supplied values of null is ignored and not + added to the value list. Overriding implementations may modify this behavior by redefining the + addNull(java.util.List) method.
      +
      +
      Specified by:
      +
      addAll in interface MultivaluedMap<K,V>
      +
      Parameters:
      +
      key - the key.
      +
      newValues - the values to be added.
      +
      Throws:
      +
      NullPointerException - if the supplied array of new values is null.
      +
      +
      +
      • +
    • +
      +

      addAll

      +
      public final void addAll(K key, + List<V> valueList)
      +

      + Add all the values from the supplied value list to the current list of values for the supplied key. If the supplied + value list is empty, method returns immediately. Method throws a NullPointerException if the supplied array + of values is null. +

      + NOTE: This implementation ignores null values; Any null value in the supplied value list is ignored + and not added to the value list. Overriding implementations may modify this behavior by redefining the + addNull(java.util.List) method.
      +
      +
      Specified by:
      +
      addAll in interface MultivaluedMap<K,V>
      +
      Parameters:
      +
      key - the key.
      +
      valueList - the list of values to be added.
      +
      Throws:
      +
      NullPointerException - if the supplied value list is null.
      +
      +
      +
      • +
    • +
      +

      getFirst

      +
      public final V getFirst(K key)
      +
      Description copied from interface: MultivaluedMap
      +
      A shortcut to get the first value of the supplied key.
      +
      +
      Specified by:
      +
      getFirst in interface MultivaluedMap<K,V>
      +
      Parameters:
      +
      key - the key
      +
      Returns:
      +
      the first value for the specified key or null if the key is not in the map.
      +
      +
      +
      • +
    • +
      +

      addFirst

      +
      public final void addFirst(K key, + V value)
      +

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

      + NOTE: This implementation ignores null values; A supplied value of null is ignored and not added to + the purged value list. Overriding implementations may modify this behavior by redefining the + addFirstNull(java.util.List) method.
      +
      +
      Specified by:
      +
      addFirst in interface MultivaluedMap<K,V>
      +
      Parameters:
      +
      key - the key
      +
      value - the value to be added.
      +
      +
      +
      • +
    • +
      +

      getValues

      +
      protected final List<V> getValues(K key)
      +

      + Return a non-null list of values for a given key. The returned list may be empty. +

      + If there is no entry for the key in the map, a new empty List instance is created, registered within the map + to hold the values of the key and returned from the method.
      +
      +
      Parameters:
      +
      key - the key.
      +
      Returns:
      +
      value list registered with the key. The method is guaranteed to never return null.
      +
      +
      +
      • +
    • +
      +

      toString

      +
      public String toString()
      +
      +
      Overrides:
      +
      toString in class Object
      +
      +
      +
      • +
    • +
      +

      hashCode

      +
      public int hashCode()
      +
      +

      + This implementation delegates the method call to to the the underlying [key, multi-value] store. +

      +
      +
      Specified by:
      +
      hashCode in interface Map<K,V>
      +
      Overrides:
      +
      hashCode in class Object
      +
      Returns:
      +
      a hash code value for the underlying [key, multi-value] store.
      +
      +
      +
      • +
    • +
      +

      equals

      +
      public boolean equals(Object o)
      +
      +

      + This implementation delegates the method call to to the the underlying [key, multi-value] store. +

      +
      +
      Specified by:
      +
      equals in interface Map<K,V>
      +
      Overrides:
      +
      equals in class Object
      +
      Returns:
      +
      true if the specified object is equal to the underlying [key, multi-value] store, false + otherwise.
      +
      +
      +
      • +
    • +
      +

      values

      +
      public Collection<List<V>> values()
      +
      +
      Specified by:
      +
      values in interface Map<K,V>
      +
      +
      +
      • +
    • +
      +

      size

      +
      public int size()
      +
      +
      Specified by:
      +
      size in interface Map<K,V>
      +
      +
      +
      • +
    • +
      +

      remove

      +
      public List<V> remove(Object key)
      +
      +
      Specified by:
      +
      remove in interface Map<K,V>
      +
      +
      +
      • +
    • +
      +

      putAll

      +
      public void putAll(Map<? extends K,? extends List<V>> m)
      +
      +
      Specified by:
      +
      putAll in interface Map<K,V>
      +
      +
      +
      • +
    • +
      +

      put

      +
      public List<V> put(K key, + List<V> value)
      +
      +
      Specified by:
      +
      put in interface Map<K,V>
      +
      +
      +
      • +
    • +
      +

      keySet

      +
      public Set<K> keySet()
      +
      +
      Specified by:
      +
      keySet in interface Map<K,V>
      +
      +
      +
      • +
    • +
      +

      isEmpty

      +
      public boolean isEmpty()
      +
      +
      Specified by:
      +
      isEmpty in interface Map<K,V>
      +
      +
      +
      • +
    • +
      +

      get

      +
      public List<V> get(Object key)
      +
      +
      Specified by:
      +
      get in interface Map<K,V>
      +
      +
      +
      • +
    • +
      +

      entrySet

      +
      public Set<Map.Entry<K,List<V>>> entrySet()
      +
      +
      Specified by:
      +
      entrySet in interface Map<K,V>
      +
      +
      +
      • +
    • +
      +

      containsValue

      +
      public boolean containsValue(Object value)
      +
      +
      Specified by:
      +
      containsValue in interface Map<K,V>
      +
      +
      +
      • +
    • +
      +

      containsKey

      +
      public boolean containsKey(Object key)
      +
      +
      Specified by:
      +
      containsKey in interface Map<K,V>
      +
      +
      +
      • +
    • +
      +

      clear

      +
      public void clear()
      +
      +
      Specified by:
      +
      clear in interface Map<K,V>
      +
      +
      +
      • +
    • +
      +

      equalsIgnoreValueOrder

      +
      public boolean equalsIgnoreValueOrder(MultivaluedMap<K,V> omap)
      +
      Description copied from interface: MultivaluedMap
      +
      Compare the specified map with this map for equality modulo the order of values for each key. Specifically, the + values associated with each key are compared as if they were ordered lists.
      +
      +
      Specified by:
      +
      equalsIgnoreValueOrder in interface MultivaluedMap<K,V>
      +
      Parameters:
      +
      omap - map to be compared to this one.
      +
      Returns:
      +
      true if the maps are equal modulo value ordering.
      +
      +
      +
      • +
    +
    +
    • +
+
+ +
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/Application.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/Application.html new file mode 100644 index 0000000000..0d87041079 --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/Application.html @@ -0,0 +1,280 @@ + + + + +Application (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Module jakarta.ws.rs
+
Package jakarta.ws.rs.core
+

Class Application

+
+
java.lang.Object +
jakarta.ws.rs.core.Application
+
+
+
+
public class Application +extends Object
+
Defines the components of a JAX-RS application and supplies additional meta-data. A JAX-RS application or + implementation supplies a concrete subclass of this abstract class. +

+ The implementation-created instance of an Application subclass may be injected into resource classes and providers + using Context. +

+

+ In case any of the Application subclass methods or it's constructor throws a RuntimeException, the + deployment of the application SHOULD be aborted with a failure. +

+
+
Since:
+
1.0
+
Author:
+
Paul Sandoz, Marc Hadley, Marek Potociar
+
+
+
+ +
+
+
    + +
  • +
    +

    Constructor Details

    +
      +
    • +
      +

      Application

      +
      public Application()
      +
      +
      • +
    +
    +
    • + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      getClasses

      +
      public Set<Class<?>> getClasses()
      +
      Get a set of root resource, provider and feature classes. + + The default life-cycle for resource class instances is per-request. The default life-cycle for providers (registered + directly or via a feature) is singleton. +

      + Implementations should warn about and ignore classes that do not conform to the requirements of root resource or + provider/feature classes. Implementations should warn about and ignore classes for which getSingletons() + returns an instance. Implementations MUST NOT modify the returned set. +

      +

      + The default implementation returns an empty set. +

      +
      +
      Returns:
      +
      a set of root resource and provider classes. Returning null is equivalent to returning an empty set.
      +
      +
      +
      • +
    • +
      +

      getSingletons

      +
      @Deprecated +public Set<Object> getSingletons()
      +
      Deprecated. +
      Automatic discovery of resources and providers or the getClasses method is preferred over + getSingletons.
      +
      +
      Get a set of root resource, provider and feature instances. + + Fields and properties of returned instances are injected with their declared dependencies (see Context) by + the runtime prior to use. +

      + Implementations should warn about and ignore classes that do not conform to the requirements of root resource or + provider classes. Implementations should flag an error if the returned set includes more than one instance of the + same class. Implementations MUST NOT modify the returned set. +

      +

      + The default implementation returns an empty set. +

      +
      +
      Returns:
      +
      a set of root resource and provider instances. Returning null is equivalent to returning an empty + set.
      +
      +
      +
      • +
    • +
      +

      getProperties

      +
      public Map<String,Object> getProperties()
      +
      Get a map of custom application-wide properties. +

      + The returned properties are reflected in the application configuration passed to the + server-side features or injected into server-side JAX-RS components. +

      +

      + The set of returned properties may be further extended or customized at deployment time using container-specific + features and deployment descriptors. For example, in a Servlet-based deployment scenario, web application's + <context-param> and Servlet <init-param> values may be used to extend or override values of the + properties programmatically returned by this method. +

      +

      + The default implementation returns an empty set. +

      +
      +
      Returns:
      +
      a map of custom application-wide properties. Returning null is equivalent to returning an empty set.
      +
      Since:
      +
      2.0
      +
      +
      +
      • +
    +
    +
    • +
+
+ +
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/CacheControl.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/CacheControl.html new file mode 100644 index 0000000000..bd887954fd --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/CacheControl.html @@ -0,0 +1,723 @@ + + + + +CacheControl (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Module jakarta.ws.rs
+
Package jakarta.ws.rs.core
+

Class CacheControl

+
+
java.lang.Object +
jakarta.ws.rs.core.CacheControl
+
+
+
+
public class CacheControl +extends Object
+
An abstraction for the value of a HTTP Cache-Control response header.
+
+
Since:
+
1.0
+
Author:
+
Paul Sandoz, Marc Hadley
+
See Also:
+
+ +
+
+
+
+
    + +
  • +
    +

    Constructor Summary

    +
    Constructors
    +
    +
    Constructor
    +
    Description
    +
    CacheControl()
    +
    +
    Create a new instance of CacheControl.
    +
    +
    +
    +
    • + +
  • +
    +

    Method Summary

    +
    +
    +
    +
    +
    Modifier and Type
    +
    Method
    +
    Description
    +
    boolean
    +
    equals(Object obj)
    +
    +
    Compares object argument to this cache control to see if they are the same considering all property values.
    +
    +
    Map<String,String>
    +
    getCacheExtension()
    +
    +
    Corresponds to a set of extension cache control directives.
    +
    +
    int
    +
    getMaxAge()
    +
    +
    Corresponds to the max-age cache control directive.
    +
    +
    List<String>
    +
    getNoCacheFields()
    +
    +
    Corresponds to the value of the no-cache cache control directive.
    +
    +
    List<String>
    +
    getPrivateFields()
    +
    +
    Corresponds to the value of the private cache control directive.
    +
    +
    int
    +
    getSMaxAge()
    +
    +
    Corresponds to the s-maxage cache control directive.
    +
    +
    int
    +
    hashCode()
    +
    +
    Generate hash code from cache control properties.
    +
    +
    boolean
    +
    isMustRevalidate()
    +
    +
    Corresponds to the must-revalidate cache control directive.
    +
    +
    boolean
    +
    isNoCache()
    +
    +
    Corresponds to the no-cache cache control directive.
    +
    +
    boolean
    +
    isNoStore()
    +
    +
    Corresponds to the no-store cache control directive.
    +
    +
    boolean
    +
    isNoTransform()
    +
    +
    Corresponds to the no-transform cache control directive.
    +
    +
    boolean
    +
    isPrivate()
    +
    +
    Corresponds to the private cache control directive.
    +
    +
    boolean
    +
    isProxyRevalidate()
    +
    +
    Corresponds to the proxy-revalidate cache control directive.
    +
    +
    void
    +
    setMaxAge(int maxAge)
    +
    +
    Corresponds to the max-age cache control directive.
    +
    +
    void
    +
    setMustRevalidate(boolean mustRevalidate)
    +
    +
    Corresponds to the must-revalidate cache control directive.
    +
    +
    void
    +
    setNoCache(boolean noCache)
    +
    +
    Corresponds to the no-cache cache control directive.
    +
    +
    void
    +
    setNoStore(boolean noStore)
    +
    +
    Corresponds to the no-store cache control directive.
    +
    +
    void
    +
    setNoTransform(boolean noTransform)
    +
    +
    Corresponds to the no-transform cache control directive.
    +
    +
    void
    +
    setPrivate(boolean flag)
    +
    +
    Corresponds to the private cache control directive.
    +
    +
    void
    +
    setProxyRevalidate(boolean proxyRevalidate)
    +
    +
    Corresponds to the must-revalidate cache control directive.
    +
    +
    void
    +
    setSMaxAge(int smaxAge)
    +
    +
    Corresponds to the s-maxage cache control directive.
    +
    +
    String
    +
    toString()
    +
    +
    Deprecated. +
    The format of the toString() method is subject to change in a future version.
    +
    +
    +
    static CacheControl
    +
    valueOf(String value)
    +
    +
    Deprecated. +
    This method will be removed in a future version.
    +
    +
    +
    +
    +
    +
    +

    Methods inherited from class java.lang.Object

    +clone, finalize, getClass, notify, notifyAll, wait, wait, wait
    +
    +
    • +
+
+
+
    + +
  • +
    +

    Constructor Details

    +
      +
    • +
      +

      CacheControl

      +
      public CacheControl()
      +
      Create a new instance of CacheControl. The new instance will have the following default settings: + +
        +
      • private = false
        • +
      • noCache = false
        • +
      • noStore = false
        • +
      • noTransform = true
        • +
      • mustRevalidate = false
        • +
      • proxyRevalidate = false
        • +
      • An empty list of private fields
        • +
      • An empty list of no-cache fields
        • +
      • An empty map of cache extensions
        • +
      +
      +
      • +
    +
    +
    • + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      valueOf

      +
      @Deprecated +public static CacheControl valueOf(String value)
      +
      Deprecated. +
      This method will be removed in a future version. Please use + RuntimeDelegate.getInstance().createHeaderDelegate(CacheControl.class).fromString(value) instead.
      +
      +
      Creates a new instance of CacheControl by parsing the supplied string.
      +
      +
      Parameters:
      +
      value - the cache control string
      +
      Returns:
      +
      the newly created CacheControl
      +
      Throws:
      +
      IllegalArgumentException - if the supplied string cannot be parsed or is null
      +
      +
      +
      • +
    • +
      +

      isMustRevalidate

      +
      public boolean isMustRevalidate()
      +
      Corresponds to the must-revalidate cache control directive.
      +
      +
      Returns:
      +
      true if the must-revalidate cache control directive will be included in the response, false otherwise.
      +
      See Also:
      +
      + +
      +
      +
      +
      • +
    • +
      +

      setMustRevalidate

      +
      public void setMustRevalidate(boolean mustRevalidate)
      +
      Corresponds to the must-revalidate cache control directive.
      +
      +
      Parameters:
      +
      mustRevalidate - true if the must-revalidate cache control directive should be included in the response, false + otherwise.
      +
      See Also:
      +
      + +
      +
      +
      +
      • +
    • +
      +

      isProxyRevalidate

      +
      public boolean isProxyRevalidate()
      +
      Corresponds to the proxy-revalidate cache control directive.
      +
      +
      Returns:
      +
      true if the proxy-revalidate cache control directive will be included in the response, false otherwise.
      +
      See Also:
      +
      + +
      +
      +
      +
      • +
    • +
      +

      setProxyRevalidate

      +
      public void setProxyRevalidate(boolean proxyRevalidate)
      +
      Corresponds to the must-revalidate cache control directive.
      +
      +
      Parameters:
      +
      proxyRevalidate - true if the proxy-revalidate cache control directive should be included in the response, false + otherwise.
      +
      See Also:
      +
      + +
      +
      +
      +
      • +
    • +
      +

      getMaxAge

      +
      public int getMaxAge()
      +
      Corresponds to the max-age cache control directive.
      +
      +
      Returns:
      +
      the value of the max-age cache control directive, -1 if the directive is disabled.
      +
      See Also:
      +
      + +
      +
      +
      +
      • +
    • +
      +

      setMaxAge

      +
      public void setMaxAge(int maxAge)
      +
      Corresponds to the max-age cache control directive.
      +
      +
      Parameters:
      +
      maxAge - the value of the max-age cache control directive, a value of -1 will disable the directive.
      +
      See Also:
      +
      + +
      +
      +
      +
      • +
    • +
      +

      getSMaxAge

      +
      public int getSMaxAge()
      +
      Corresponds to the s-maxage cache control directive.
      +
      +
      Returns:
      +
      the value of the s-maxage cache control directive, -1 if the directive is disabled.
      +
      See Also:
      +
      + +
      +
      +
      +
      • +
    • +
      +

      setSMaxAge

      +
      public void setSMaxAge(int smaxAge)
      +
      Corresponds to the s-maxage cache control directive.
      +
      +
      Parameters:
      +
      smaxAge - the value of the s-maxage cache control directive, a value of -1 will disable the directive.
      +
      See Also:
      +
      + +
      +
      +
      +
      • +
    • +
      +

      getNoCacheFields

      +
      public List<String> getNoCacheFields()
      +
      Corresponds to the value of the no-cache cache control directive.
      +
      +
      Returns:
      +
      a mutable list of field-names that will form the value of the no-cache cache control directive. An empty list + results in a bare no-cache directive.
      +
      See Also:
      +
      + +
      +
      +
      +
      • +
    • +
      +

      setNoCache

      +
      public void setNoCache(boolean noCache)
      +
      Corresponds to the no-cache cache control directive.
      +
      +
      Parameters:
      +
      noCache - true if the no-cache cache control directive should be included in the response, false otherwise.
      +
      See Also:
      +
      + +
      +
      +
      +
      • +
    • +
      +

      isNoCache

      +
      public boolean isNoCache()
      +
      Corresponds to the no-cache cache control directive.
      +
      +
      Returns:
      +
      true if the no-cache cache control directive will be included in the response, false otherwise.
      +
      See Also:
      +
      + +
      +
      +
      +
      • +
    • +
      +

      isPrivate

      +
      public boolean isPrivate()
      +
      Corresponds to the private cache control directive.
      +
      +
      Returns:
      +
      true if the private cache control directive will be included in the response, false otherwise.
      +
      See Also:
      +
      + +
      +
      +
      +
      • +
    • +
      +

      getPrivateFields

      +
      public List<String> getPrivateFields()
      +
      Corresponds to the value of the private cache control directive.
      +
      +
      Returns:
      +
      a mutable list of field-names that will form the value of the private cache control directive. An empty list + results in a bare no-cache directive.
      +
      See Also:
      +
      + +
      +
      +
      +
      • +
    • +
      +

      setPrivate

      +
      public void setPrivate(boolean flag)
      +
      Corresponds to the private cache control directive.
      +
      +
      Parameters:
      +
      flag - true if the private cache control directive should be included in the response, false otherwise.
      +
      See Also:
      +
      + +
      +
      +
      +
      • +
    • +
      +

      isNoTransform

      +
      public boolean isNoTransform()
      +
      Corresponds to the no-transform cache control directive.
      +
      +
      Returns:
      +
      true if the no-transform cache control directive will be included in the response, false otherwise.
      +
      See Also:
      +
      + +
      +
      +
      +
      • +
    • +
      +

      setNoTransform

      +
      public void setNoTransform(boolean noTransform)
      +
      Corresponds to the no-transform cache control directive.
      +
      +
      Parameters:
      +
      noTransform - true if the no-transform cache control directive should be included in the response, false + otherwise.
      +
      See Also:
      +
      + +
      +
      +
      +
      • +
    • +
      +

      isNoStore

      +
      public boolean isNoStore()
      +
      Corresponds to the no-store cache control directive.
      +
      +
      Returns:
      +
      true if the no-store cache control directive will be included in the response, false otherwise.
      +
      See Also:
      +
      + +
      +
      +
      +
      • +
    • +
      +

      setNoStore

      +
      public void setNoStore(boolean noStore)
      +
      Corresponds to the no-store cache control directive.
      +
      +
      Parameters:
      +
      noStore - true if the no-store cache control directive should be included in the response, false otherwise.
      +
      See Also:
      +
      + +
      +
      +
      +
      • +
    • +
      +

      getCacheExtension

      +
      public Map<String,String> getCacheExtension()
      +
      Corresponds to a set of extension cache control directives.
      +
      +
      Returns:
      +
      a mutable map of cache control extension names and their values. If a key has a null value, it will appear as + a bare directive. If a key has a value that contains no whitespace then the directive will appear as a simple + name=value pair. If a key has a value that contains whitespace then the directive will appear as a quoted + name="value" pair.
      +
      See Also:
      +
      + +
      +
      +
      +
      • +
    • +
      +

      toString

      +
      @Deprecated +public String toString()
      +
      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.
      +
      +
      Convert the cache control to a string suitable for use as the value of the corresponding HTTP header.
      +
      +
      Overrides:
      +
      toString in class Object
      +
      Returns:
      +
      a stringified cache control
      +
      +
      +
      • +
    • +
      +

      hashCode

      +
      public int hashCode()
      +
      Generate hash code from cache control properties.
      +
      +
      Overrides:
      +
      hashCode in class Object
      +
      Returns:
      +
      the hashCode
      +
      +
      +
      • +
    • +
      +

      equals

      +
      public boolean equals(Object obj)
      +
      Compares object argument to this cache control to see if they are the same considering all property values.
      +
      +
      Overrides:
      +
      equals in class Object
      +
      Parameters:
      +
      obj - the object to compare to
      +
      Returns:
      +
      true if the two cache controls are the same, false otherwise.
      +
      +
      +
      • +
    +
    +
    • +
+
+ +
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/Configurable.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/Configurable.html new file mode 100644 index 0000000000..561c270c3e --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/Configurable.html @@ -0,0 +1,563 @@ + + + + +Configurable (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Module jakarta.ws.rs
+
Package jakarta.ws.rs.core
+

Interface Configurable<C extends Configurable>

+
+
+
+
Type Parameters:
+
C - generic configurable Java type
+
+
+
All Known Subinterfaces:
+
Client, FeatureContext, WebTarget
+
+
+
All Known Implementing Classes:
+
ClientBuilder
+
+
+
public interface Configurable<C extends Configurable>
+
Represents a client or server-side configurable context in JAX-RS. + + A configurable context can be used to define the JAX-RS components as well as additional meta-data that should be + used in the scope of the configured context. The modification of the context typically involves setting properties or + registering custom JAX-RS components, such as providers and/or features. All modifications of a Configurable + context are reflected in the associated Configuration state which is exposed via getConfiguration() + method. +

+ A configurable context can be either indirectly associated with a particular JAX-RS component (such as application or + resource method configurable context passed to a Feature or DynamicFeature + meta-providers) or can be directly represented by a concrete JAX-RS component implementing the Configurable + interface (such as Client or WebTarget). As such, the exact + scope of a configuration context is typically determined by a use case scenario in which the context is accessed. +

+

Setting properties.

+

+ New properties can be set using the property(java.lang.String, java.lang.Object) method. Similarly, updating a value of an existing property can + be achieved using the same method. Information about the configured set of properties is available via the underlying + Configuration object. An existing property can be removed by assigning a null value to the property. +

+

Registering JAX-RS components.

+

+ Registered custom JAX-RS component classes and instances are important part of the contextual configuration + information as these are the main factors that determine the capabilities of a configured runtime. Implementations + SHOULD warn about and ignore registrations that do not conform to the requirements of supported JAX-RS components in + a given configurable context. +

+

+ In most cases, when registering a JAX-RS component, the simplest form of methods (register(Class) or + register(Object)) of the available registration API is sufficient. +

+

+ For example: +

+ + 
+ config.register(HtmlDocumentReader.class);
+ config.register(new HtmlDocumentWriter(writerConfig));
+
+

+ In some situations a JAX-RS component class or instance may implement multiple provider contracts recognized by a + JAX-RS implementation (e.g. filter, interceptor or entity provider). By default, the JAX-RS implementation MUST + register the new component class or instance as a provider for all the recognized provider contracts implemented by + the component class. +

+

+ For example: +

+ + 
+ @Priority(ENTITY_CODER)
+ public class GzipInterceptor
+         implements ReaderInterceptor, WriterInterceptor { ... }
+
+ ...
+
+ // register GzipInterceptor as a ReaderInterceptor
+ // as well as a WriterInterceptor
+ config.register(GzipInterceptor.class);
+
+

+ There are however situations when the default registration of a JAX-RS component to all the recognized provider + contracts is not desirable. In such cases users may use other versions of the register(...) method to + explicitly specify the collection of the provider contracts for which the JAX-RS component should be registered + and/or the priority of each registered provider contract. +

+

+ For example: +

+ + 
+ @Priority(USER)
+ public class ClientLoggingFilter
+         implements ClientRequestFilter, ClientResponseFilter { ... }
+
+ @Priority(ENTITY_CODER)
+ public class GzipInterceptor
+         implements ReaderInterceptor, WriterInterceptor { ... }
+
+ ...
+
+ // register ClientLoggingFilter as a ClientResponseFilter only
+ config.register(ClientLoggingFilter.class, ClientResponseFilter.class);
+
+ // override the priority of registered GzipInterceptor
+ // and both of it's provider contracts
+ config.register(GzipInterceptor.class, 6500);
+
+

+ As a general rule, for each JAX-RS component class there can be at most one registration — class-based or + instance-based — configured at any given moment. Implementations MUST reject any attempts to configure a new + registration for a provider class that has been already registered in the given configurable context earlier. + Implementations SHOULD also raise a warning to inform the user about the rejected component registration. +

+

+ For example: +

+ + 
+ config.register(GzipInterceptor.class, WriterInterceptor.class);
+ config.register(GzipInterceptor.class); // Rejected by runtime.
+ config.register(new GzipInterceptor()); // Rejected by runtime.
+ config.register(GzipInterceptor.class, 6500); // Rejected by runtime.
+
+ config.register(new ClientLoggingFilter());
+ config.register(ClientLoggingFilter.class); // rejected by runtime.
+ config.register(ClientLoggingFilter.class,
+         ClientResponseFilter.class); // Rejected by runtime.
+
+
+
Since:
+
2.0
+
Author:
+
Marek Potociar
+
+
+
+
    + +
  • +
    +

    Method Summary

    +
    +
    +
    +
    +
    Modifier and Type
    +
    Method
    +
    Description
    +
    Configuration
    +
    getConfiguration()
    +
    +
    Get a live view of an internal configuration state of this configurable instance.
    +
    +
    C
    +
    property(String name, + Object value)
    +
    +
    Set the new configuration property, if already set, the existing value of the property will be updated.
    +
    +
    C
    +
    register(Class<?> componentClass)
    +
    +
    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.
    +
    +
    C
    +
    register(Class<?> componentClass, + int priority)
    +
    +
    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.
    +
    +
    C
    +
    register(Class<?> componentClass, + Class<?>... contracts)
    +
    +
    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.
    +
    +
    C
    +
    register(Class<?> componentClass, + Map<Class<?>,Integer> contracts)
    +
    +
    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.
    +
    +
    C
    +
    register(Object component)
    +
    +
    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.
    +
    +
    C
    +
    register(Object component, + int priority)
    +
    +
    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.
    +
    +
    C
    +
    register(Object component, + Class<?>... contracts)
    +
    +
    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.
    +
    +
    C
    +
    register(Object component, + Map<Class<?>,Integer> contracts)
    +
    +
    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.
    +
    +
    +
    +
    +
    +
    • +
+
+
+
    + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      getConfiguration

      +
      Configuration getConfiguration()
      +
      Get a live view of an internal configuration state of this configurable instance. + + Any changes made using methods of this Configurable instance will be reflected in the returned + Configuration instance. +

      + The returned Configuration instance and the collection data it provides are not thread-safe wrt. modification + made using methods on the parent configurable object. +

      +
      +
      Returns:
      +
      configuration live view of the internal configuration state.
      +
      +
      +
      • +
    • +
      +

      property

      +
      C property(String name, + Object value)
      +
      Set the new configuration property, if already set, the existing value of the property will be updated. Setting a + null value into a property effectively removes the property from the property bag.
      +
      +
      Parameters:
      +
      name - property name.
      +
      value - (new) property value. null value removes the property with the given name.
      +
      Returns:
      +
      the updated configurable instance.
      +
      +
      +
      • +
    • +
      +

      register

      +
      C register(Class<?> componentClass)
      +
      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. + + Implementations SHOULD warn about and ignore registrations that do not conform to the requirements of supported + JAX-RS component types in the given configurable context. Any subsequent registration attempts for a component type, + for which a class or instance-based registration already exists in the system MUST be rejected by the JAX-RS + implementation and a warning SHOULD be raised to inform the user about the rejected registration. + + The registered JAX-RS component class is registered as a contract provider of all the recognized JAX-RS or + implementation-specific extension contracts including meta-provider contracts, such as Feature or + DynamicFeature. +

      + As opposed to component instances registered via register(Object) method, the lifecycle of components + registered using this class-based register(...) method is fully managed by the JAX-RS implementation or any + underlying IoC container supported by the implementation. +

      +
      +
      Parameters:
      +
      componentClass - JAX-RS component class to be configured in the scope of this configurable context.
      +
      Returns:
      +
      the updated configurable context.
      +
      +
      +
      • +
    • +
      +

      register

      +
      C register(Class<?> componentClass, + int priority)
      +
      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. +

      + This registration method provides the same functionality as register(Class) except that any priority + specified on the registered JAX-RS component class via jakarta.annotation.Priority annotation is overridden + with the supplied priority value. +

      +

      + Note that in case the priority is not applicable to a particular provider contract implemented by the class of the + registered component, the supplied priority value will be ignored for that contract. +

      +
      +
      Parameters:
      +
      componentClass - JAX-RS component class to be configured in the scope of this configurable context.
      +
      priority - the overriding priority for the registered component and all the provider contracts the component + implements.
      +
      Returns:
      +
      the updated configurable context.
      +
      +
      +
      • +
    • +
      +

      register

      +
      C register(Class<?> componentClass, + Class<?>... contracts)
      +
      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. +

      + This registration method provides the same functionality as register(Class) except the JAX-RS component + class is only registered as a provider of the listed extension provider or meta-provider contracts. All + explicitly enumerated contract types must represent a class or an interface implemented or extended by the registered + component. Contracts that are not assignable from the registered component + class MUST be ignored and implementations SHOULD raise a warning to inform users about the ignored contract(s). +

      +
      +
      Parameters:
      +
      componentClass - JAX-RS component class to be configured in the scope of this configurable context.
      +
      contracts - the specific extension provider or meta-provider contracts implemented by the component for which + the component should be registered. Implementations MUST ignore attempts to register a component class for an empty + or null collection of contracts via this method and SHOULD raise a warning about such event.
      +
      Returns:
      +
      the updated configurable context.
      +
      +
      +
      • +
    • +
      +

      register

      +
      C register(Class<?> componentClass, + Map<Class<?>,Integer> contracts)
      +
      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. +

      + This registration method provides same functionality as register(Class, Class[]) except that any priority + specified on the registered JAX-RS component class via jakarta.annotation.Priority annotation is overridden for + each extension provider contract type separately with an integer priority value specified as a value in the supplied + map of [contract type, priority] pairs. +

      +

      + Note that in case a priority is not applicable to a provider contract registered for the JAX-RS component, the + supplied priority value is ignored for such contract. +

      +
      +
      Parameters:
      +
      componentClass - JAX-RS component class to be configured in the scope of this configurable context.
      +
      contracts - map of the specific extension provider and meta-provider contracts and their associated priorities + for which the JAX-RS component is registered. All contracts in the map must represent a class or an interface + implemented or extended by the JAX-RS component. Contracts that are not assignable from the registered component class MUST be ignored and implementations SHOULD raise a warning to inform + users about the ignored contract(s).
      +
      Returns:
      +
      the updated configurable context.
      +
      +
      +
      • +
    • +
      +

      register

      +
      C register(Object component)
      +
      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. + + Implementations SHOULD warn about and ignore registrations that do not conform to the requirements of supported + JAX-RS component types in the given configurable context. Any subsequent registration attempts for a component type, + for which a class or instance-based registration already exists in the system MUST be rejected by the JAX-RS + implementation and a warning SHOULD be raised to inform the user about the rejected registration. + + The registered JAX-RS component is registered as a contract provider of all the recognized JAX-RS or + implementation-specific extension contracts including meta-provider contracts, such as Feature or + DynamicFeature. +

      + As opposed to components registered via register(Class) method, the lifecycle of providers registered using + this instance-based register(...) is not managed by JAX-RS runtime. The same registered component instance is + used during the whole lifespan of the configurable context. Fields and properties of all registered JAX-RS component + instances are injected with their declared dependencies (see Context) by the JAX-RS runtime prior to use. +

      +
      +
      Parameters:
      +
      component - JAX-RS component instance to be configured in the scope of this configurable context.
      +
      Returns:
      +
      the updated configurable context.
      +
      +
      +
      • +
    • +
      +

      register

      +
      C register(Object component, + int priority)
      +
      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. +

      + This registration method provides the same functionality as register(Object) except that any priority + specified on the registered JAX-RS component class via jakarta.annotation.Priority annotation is overridden + with the supplied priority value. +

      +

      + Note that in case the priority is not applicable to a particular provider contract implemented by the class of the + registered component, the supplied priority value will be ignored for that contract. +

      +
      +
      Parameters:
      +
      component - JAX-RS component instance to be configured in the scope of this configurable context.
      +
      priority - the overriding priority for the registered component and all the provider contracts the component + implements.
      +
      Returns:
      +
      the updated configurable context.
      +
      +
      +
      • +
    • +
      +

      register

      +
      C register(Object component, + Class<?>... contracts)
      +
      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. +

      + This registration method provides the same functionality as register(Object) except the JAX-RS component + class is only registered as a provider of the listed extension provider or meta-provider contracts. All + explicitly enumerated contract types must represent a class or an interface implemented or extended by the registered + component. Contracts that are not assignable from the registered component + class MUST be ignored and implementations SHOULD raise a warning to inform users about the ignored contract(s). +

      +
      +
      Parameters:
      +
      component - JAX-RS component instance to be configured in the scope of this configurable context.
      +
      contracts - the specific extension provider or meta-provider contracts implemented by the component for which + the component should be registered. Implementations MUST ignore attempts to register a component class for an empty + or null collection of contracts via this method and SHOULD raise a warning about such event.
      +
      Returns:
      +
      the updated configurable context.
      +
      +
      +
      • +
    • +
      +

      register

      +
      C register(Object component, + Map<Class<?>,Integer> contracts)
      +
      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. +

      + This registration method provides same functionality as register(Object, Class[]) except that any priority + specified on the registered JAX-RS component class via jakarta.annotation.Priority annotation is overridden for + each extension provider contract type separately with an integer priority value specified as a value in the supplied + map of [contract type, priority] pairs. +

      +

      + Note that in case a priority is not applicable to a provider contract registered for the JAX-RS component, the + supplied priority value is ignored for such contract. +

      +
      +
      Parameters:
      +
      component - JAX-RS component instance to be configured in the scope of this configurable context.
      +
      contracts - map of the specific extension provider and meta-provider contracts and their associated priorities + for which the JAX-RS component is registered. All contracts in the map must represent a class or an interface + implemented or extended by the JAX-RS component. Contracts that are not assignable from the registered component class MUST be ignored and implementations SHOULD raise a warning to inform + users about the ignored contract(s).
      +
      Returns:
      +
      the updated configurable context.
      +
      +
      +
      • +
    +
    +
    • +
+
+ +
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/Configuration.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/Configuration.html new file mode 100644 index 0000000000..e11d82372c --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/Configuration.html @@ -0,0 +1,444 @@ + + + + +Configuration (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Module jakarta.ws.rs
+
Package jakarta.ws.rs.core
+

Interface Configuration

+
+
+
+
public interface Configuration
+
A configuration state associated with a configurable JAX-RS context. Defines the components as + well as additional meta-data for the configured context. +

+ A configuration state may be used to retrieve configuration information about of the associated JAX-RS context (e.g. + application, resource method, etc.) or component (e.g. Client, + WebTarget, etc.). Configuration information consists of properties, registered JAX-RS + component classes and/or instances. +

+

+ This interface can be injected using the Context annotation. +

+
+
Since:
+
2.0
+
Author:
+
Marek Potociar
+
+
+
+
    + +
  • +
    +

    Method Summary

    +
    +
    +
    +
    +
    Modifier and Type
    +
    Method
    +
    Description
    +
    Set<Class<?>>
    +
    getClasses()
    +
    +
    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.
    +
    +
    Map<Class<?>,Integer>
    +
    getContracts(Class<?> componentClass)
    +
    +
    Get the extension contract registration information for a component of a given class.
    +
    +
    Set<Object>
    +
    getInstances()
    +
    +
    Get the immutable set of registered JAX-RS component (such as provider or feature) instances to be + utilized by the configurable instance.
    +
    +
    Map<String,Object>
    +
    getProperties()
    +
    +
    Get the immutable bag of configuration properties.
    +
    +
    Object
    +
    getProperty(String name)
    +
    +
    Get the value for the property with a given name.
    +
    +
    Collection<String>
    +
    getPropertyNames()
    +
    +
    Returns an immutable collection containing the property names available within the + context of the current configuration instance.
    +
    +
    RuntimeType
    +
    getRuntimeType()
    +
    +
    Get the runtime type of this configuration context.
    +
    +
    default boolean
    +
    hasProperty(String name)
    +
    +
    Check whether the property with a given name is configured.
    +
    +
    boolean
    +
    isEnabled(Feature feature)
    +
    +
    Check if a particular feature instance has been previously enabled in the runtime configuration + context.
    +
    +
    boolean
    +
    isEnabled(Class<? extends Feature> featureClass)
    +
    +
    Check if a feature instance of featureClass class has been previously enabled in the runtime + configuration context.
    +
    +
    boolean
    +
    isRegistered(Class<?> componentClass)
    +
    +
    Check if a JAX-RS component of the supplied componentClass class has been previously registered in the + runtime configuration context.
    +
    +
    boolean
    +
    isRegistered(Object component)
    +
    +
    Check if a particular JAX-RS component instance (such as providers or features) has been + previously registered in the runtime configuration context.
    +
    +
    +
    +
    +
    +
    • +
+
+
+
    + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      getRuntimeType

      +
      RuntimeType getRuntimeType()
      +
      Get the runtime type of this configuration context.
      +
      +
      Returns:
      +
      configuration context runtime type.
      +
      +
      +
      • +
    • +
      +

      getProperties

      +
      Map<String,Object> getProperties()
      +
      Get the immutable bag of configuration properties.
      +
      +
      Returns:
      +
      the immutable view of configuration properties.
      +
      +
      +
      • +
    • +
      +

      getProperty

      +
      Object getProperty(String name)
      +
      Get the value for the property with a given name.
      +
      +
      Parameters:
      +
      name - property name.
      +
      Returns:
      +
      the property value for the specified property name or null if the property with such name is not + configured.
      +
      +
      +
      • +
    • +
      +

      hasProperty

      +
      default boolean hasProperty(String name)
      +
      Check whether the property with a given name is configured.
      +
      +
      Parameters:
      +
      name - property name.
      +
      Returns:
      +
      false if the property with such name is not configured, true otherwise.
      +
      +
      +
      • +
    • +
      +

      getPropertyNames

      +
      Collection<String> getPropertyNames()
      +
      Returns an immutable collection containing the property names available within the + context of the current configuration instance. +

      + Use the getProperty(java.lang.String) method with a property name to get the value of a property. +

      +
      +
      Returns:
      +
      an immutable collection of property names.
      +
      See Also:
      +
      + +
      +
      +
      +
      • +
    • +
      +

      isEnabled

      +
      boolean isEnabled(Feature feature)
      +
      Check if a particular feature instance has been previously enabled in the runtime configuration + context. +

      + Method returns true only in case an instance equal to the feature instance is already present among + the features previously successfully enabled in the configuration context. +

      +
      +
      Parameters:
      +
      feature - a feature instance to test for.
      +
      Returns:
      +
      true if the feature instance has been previously enabled in this configuration context, false + otherwise.
      +
      +
      +
      • +
    • +
      +

      isEnabled

      +
      boolean isEnabled(Class<? extends Feature> featureClass)
      +
      Check if a feature instance of featureClass class has been previously enabled in the runtime + configuration context. +

      + Method returns true in case any instance of the featureClass class is already present among the + features previously successfully enabled in the configuration context. +

      +
      +
      Parameters:
      +
      featureClass - a feature class to test for.
      +
      Returns:
      +
      true if a feature of a given class has been previously enabled in this configuration context, + false otherwise.
      +
      +
      +
      • +
    • +
      +

      isRegistered

      +
      boolean isRegistered(Object component)
      +
      Check if a particular JAX-RS component instance (such as providers or features) has been + previously registered in the runtime configuration context. +

      + Method returns true only in case an instance equal to the component instance is already present among + the components previously registered in the configuration context. +

      +
      +
      Parameters:
      +
      component - a component instance to test for.
      +
      Returns:
      +
      true if the component instance has been previously registered in this configuration context, + false otherwise.
      +
      See Also:
      +
      + +
      +
      +
      +
      • +
    • +
      +

      isRegistered

      +
      boolean isRegistered(Class<?> componentClass)
      +
      Check if a JAX-RS component of the supplied componentClass class has been previously registered in the + runtime configuration context. +

      + Method returns true in case a component of the supplied componentClass class is already present among + the previously registered component classes or instances in the configuration context. +

      +
      +
      Parameters:
      +
      componentClass - a component class to test for.
      +
      Returns:
      +
      true if a component of a given class has been previously registered in this configuration context, + false otherwise.
      +
      See Also:
      +
      + +
      +
      +
      +
      • +
    • +
      +

      getContracts

      +
      Map<Class<?>,Integer> getContracts(Class<?> componentClass)
      +
      Get the extension contract registration information for a component of a given class. + + For component classes that are not configured in this configuration context the method returns an empty Map. + Method does not return null.
      +
      +
      Parameters:
      +
      componentClass - a component class for which to get contracts.
      +
      Returns:
      +
      map of extension contracts and their priorities for which the component class is registered. May return an + empty map in case the component has not been registered for any extension contract supported by the implementation.
      +
      +
      +
      • +
    • +
      +

      getClasses

      +
      Set<Class<?>> getClasses()
      +
      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. In contrast to + Application.getClasses() this method returns a complete runtime view and therefore also includes + auto-discovered components. +

      + For each component type, there can be only a single class-based or instance-based registration present in the + configuration context at any given time. +

      +
      +
      Returns:
      +
      the immutable set of registered JAX-RS component classes. The returned value may be empty but will never be + null.
      +
      See Also:
      +
      + +
      +
      +
      +
      • +
    • +
      +

      getInstances

      +
      Set<Object> getInstances()
      +
      Get the immutable set of registered JAX-RS component (such as provider or feature) instances to be + utilized by the configurable instance. Fields and properties of returned instances are injected with their declared + dependencies (see Context) by the runtime prior to use. +

      + For each component type, there can be only a single class-based or instance-based registration present in the + configuration context at any given time. +

      +
      +
      Returns:
      +
      the immutable set of registered JAX-RS component instances. The returned value may be empty but will never be + null.
      +
      See Also:
      +
      + +
      +
      +
      +
      • +
    +
    +
    • +
+
+ +
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/Context.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/Context.html new file mode 100644 index 0000000000..05d943b2ef --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/Context.html @@ -0,0 +1,126 @@ + + + + +Context (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Module jakarta.ws.rs
+
Package jakarta.ws.rs.core
+

Annotation Interface Context

+
+
+
+
@Target({PARAMETER,METHOD,FIELD}) +@Retention(RUNTIME) +@Documented +public @interface Context
+

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

+ +

Note that future versions of this API will stop supporting injection via + Context as part of a tighter integration and alignment with + Jakarta CDI.

+
+
Since:
+
1.0
+
Author:
+
Paul Sandoz, Marc Hadley
+
See Also:
+
+ +
+
+
+
+ +
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/Cookie.AbstractCookieBuilder.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/Cookie.AbstractCookieBuilder.html new file mode 100644 index 0000000000..0fc35c09d5 --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/Cookie.AbstractCookieBuilder.html @@ -0,0 +1,284 @@ + + + + +Cookie.AbstractCookieBuilder (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Module jakarta.ws.rs
+
Package jakarta.ws.rs.core
+

Class Cookie.AbstractCookieBuilder<T extends Cookie.AbstractCookieBuilder<T>>

+
+
java.lang.Object +
jakarta.ws.rs.core.Cookie.AbstractCookieBuilder<T>
+
+
+
+
Type Parameters:
+
T - the current AbstractCookieBuilder type.
+
+
+
Direct Known Subclasses:
+
Cookie.Builder, NewCookie.AbstractNewCookieBuilder
+
+
+
Enclosing class:
+
Cookie
+
+
+
public abstract static class Cookie.AbstractCookieBuilder<T extends Cookie.AbstractCookieBuilder<T>> +extends Object
+
JAX-RS abstract Cookie builder class.
+
+
Since:
+
3.1
+
+
+
+ +
+
+
    + +
  • +
    +

    Constructor Details

    +
      +
    • +
      +

      AbstractCookieBuilder

      +
      public AbstractCookieBuilder(String name)
      +
      Create a new instance.
      +
      +
      Parameters:
      +
      name - the name of the cookie.
      +
      +
      +
      • +
    +
    +
    • + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      value

      +
      public T value(String value)
      +
      Set the value of the cookie.
      +
      +
      Parameters:
      +
      value - the value of the cookie.
      +
      Returns:
      +
      the updated builder instance.
      +
      +
      +
      • +
    • +
      +

      version

      +
      public T version(int version)
      +
      Set the version of the cookie. Defaults to Cookie.DEFAULT_VERSION
      +
      +
      Parameters:
      +
      version - the version of the specification to which the cookie complies.
      +
      Returns:
      +
      the updated builder instance.
      +
      +
      +
      • +
    • +
      +

      path

      +
      public T path(String path)
      +
      Set the path of the cookie.
      +
      +
      Parameters:
      +
      path - the URI path for which the cookie is valid.
      +
      Returns:
      +
      the updated builder instance.
      +
      +
      +
      • +
    • +
      +

      domain

      +
      public T domain(String domain)
      +
      Set the domain of the cookie.
      +
      +
      Parameters:
      +
      domain - the host domain for which the cookie is valid.
      +
      Returns:
      +
      the updated builder instance.
      +
      +
      +
      • +
    • +
      +

      build

      +
      public abstract Cookie build()
      +
      Build a new Cookie instance using all the configuration previously specified in this builder.
      +
      +
      Returns:
      +
      a new Cookie instance.
      +
      Throws:
      +
      IllegalArgumentException - if name is null.
      +
      +
      +
      • +
    +
    +
    • +
+
+ +
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/Cookie.Builder.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/Cookie.Builder.html new file mode 100644 index 0000000000..1c1f79cc59 --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/Cookie.Builder.html @@ -0,0 +1,222 @@ + + + + +Cookie.Builder (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Module jakarta.ws.rs
+
Package jakarta.ws.rs.core
+

Class Cookie.Builder

+
+
java.lang.Object +
jakarta.ws.rs.core.Cookie.AbstractCookieBuilder<Cookie.Builder> +
jakarta.ws.rs.core.Cookie.Builder
+
+
+
+
+
Enclosing class:
+
Cookie
+
+
+
public static class Cookie.Builder +extends Cookie.AbstractCookieBuilder<Cookie.Builder>
+
JAX-RS Cookie builder class. +

+ Cookie builder provides methods that let you conveniently configure and subsequently build a new + Cookie instance. +

+ For example: + + 
+ Cookie cookie = new Cookie.Builder("name")
+         .path("/")
+         .domain("domain.com")
+         .build();
+
+
+
Since:
+
3.1
+
+
+
+ +
+
+
    + +
  • +
    +

    Constructor Details

    +
      +
    • +
      +

      Builder

      +
      public Builder(String name)
      +
      Create a new instance.
      +
      +
      Parameters:
      +
      name - the name of the cookie.
      +
      +
      +
      • +
    +
    +
    • + +
  • +
    +

    Method Details

    + +
    +
    • +
+
+ +
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/Cookie.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/Cookie.html new file mode 100644 index 0000000000..da9fcc30a9 --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/Cookie.html @@ -0,0 +1,535 @@ + + + + +Cookie (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Module jakarta.ws.rs
+
Package jakarta.ws.rs.core
+

Class Cookie

+
+
java.lang.Object +
jakarta.ws.rs.core.Cookie
+
+
+
+
Direct Known Subclasses:
+
NewCookie
+
+
+
public class Cookie +extends Object
+
Represents the value of a HTTP cookie, transferred in a request. RFC 2109 specifies the legal characters for name, + value, path and domain. The default version of 1 corresponds to RFC 2109.
+
+
Since:
+
1.0
+
Author:
+
Paul Sandoz, Marc Hadley
+
See Also:
+
+ +
+
+
+
+ +
+
+
    + +
  • +
    +

    Field Details

    +
      +
    • +
      +

      DEFAULT_VERSION

      +
      public static final int DEFAULT_VERSION
      +
      Cookies using the default version correspond to RFC 2109.
      +
      +
      See Also:
      +
      + +
      +
      +
      +
      • +
    +
    +
    • + +
  • +
    +

    Constructor Details

    + +
    +
    • + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      valueOf

      +
      @Deprecated +public static Cookie valueOf(String value)
      +
      Deprecated. +
      This method will be removed in a future version. Please use + RuntimeDelegate.getInstance().createHeaderDelegate(Cookie.class).fromString(value) instead.
      +
      +
      Creates a new instance of Cookie by parsing the supplied string.
      +
      +
      Parameters:
      +
      value - the cookie string.
      +
      Returns:
      +
      the newly created Cookie.
      +
      Throws:
      +
      IllegalArgumentException - if the supplied string cannot be parsed or is null.
      +
      +
      +
      • +
    • +
      +

      getName

      +
      public String getName()
      +
      Get the name of the cookie.
      +
      +
      Returns:
      +
      the cookie name.
      +
      +
      +
      • +
    • +
      +

      getValue

      +
      public String getValue()
      +
      Get the value of the cookie.
      +
      +
      Returns:
      +
      the cookie value.
      +
      +
      +
      • +
    • +
      +

      getVersion

      +
      public int getVersion()
      +
      Get the version of the cookie.
      +
      +
      Returns:
      +
      the cookie version.
      +
      +
      +
      • +
    • +
      +

      getDomain

      +
      public String getDomain()
      +
      Get the domain of the cookie.
      +
      +
      Returns:
      +
      the cookie domain.
      +
      +
      +
      • +
    • +
      +

      getPath

      +
      public String getPath()
      +
      Get the path of the cookie.
      +
      +
      Returns:
      +
      the cookie path.
      +
      +
      +
      • +
    • +
      +

      toString

      +
      @Deprecated +public String toString()
      +
      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.
      +
      +
      Convert the cookie to a string suitable for use as the value of the corresponding HTTP header.
      +
      +
      Overrides:
      +
      toString in class Object
      +
      Returns:
      +
      a stringified cookie.
      +
      +
      +
      • +
    • +
      +

      hashCode

      +
      public int hashCode()
      +
      Generate a hash code by hashing all of the cookies properties.
      +
      +
      Overrides:
      +
      hashCode in class Object
      +
      Returns:
      +
      the cookie hash code.
      +
      +
      +
      • +
    • +
      +

      equals

      +
      public boolean equals(Object obj)
      +
      Compare for equality.
      +
      +
      Overrides:
      +
      equals in class Object
      +
      Parameters:
      +
      obj - the object to compare to.
      +
      Returns:
      +
      true, if the object is a Cookie with the same value for all properties, false + otherwise.
      +
      +
      +
      • +
    +
    +
    • +
+
+ +
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/EntityPart.Builder.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/EntityPart.Builder.html new file mode 100644 index 0000000000..3d00244c79 --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/EntityPart.Builder.html @@ -0,0 +1,461 @@ + + + + +EntityPart.Builder (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Module jakarta.ws.rs
+
Package jakarta.ws.rs.core
+

Interface EntityPart.Builder

+
+
+
+
Enclosing interface:
+
EntityPart
+
+
+
public static interface EntityPart.Builder
+
Builder for EntityPart instances.
+
+
Since:
+
3.1
+
+
+
+ +
+
+ +
+ +
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/EntityPart.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/EntityPart.html new file mode 100644 index 0000000000..719e2f3008 --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/EntityPart.html @@ -0,0 +1,438 @@ + + + + +EntityPart (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Module jakarta.ws.rs
+
Package jakarta.ws.rs.core
+

Interface EntityPart

+
+
+
+
public interface EntityPart
+
A EntityPart is one part of a multipart entity. As defined in + RFC 7578, a multipart + request or response must have a content type of "multipart/form-data" with a + boundary parameter indicating where one part ends the next may begin. +

+ Multipart entities may be received in a resource method as a collection of + parts (e.g. List<EntityPart>) or as a form parameter (ex: + @FormParam("part1Name") EntityPart part1). +

+

+ Likewise, a client may receive a multipart response by reading the returned + entity as a collection of EntityParts (ex: response.readEntity(new + GenericType<List<EntityPart>>() {})). +

+

+ In order to send a multipart entity either as a client request or a response + from a resource method, you may create the Lists using + EntityPart.Builder. For example: +

+ + 
+ Client c = ClientBuilder.newClient();
+WebTarget target = c.target(someURL);
+List<EntityPart> parts = Arrays.asList(
+     EntityPart.withName("name1").fileName("file1.doc").content(stream1).build(),
+     EntityPart.withName("name2").fileName("file2.doc").content(stream2).build(),
+     EntityPart.withName("name3").fileName("file3.xml").content(myObject, MyClass.class).mediaType("application/xml").build());
+GenericEntity<List<EntityPart>> genericEntity = new GenericEntity<>(parts){};
+Entity entity = Entity.entity(genericEntity, MediaType.MULTIPART_FORM_DATA);
+Response r = target.request().post(entity);
+
+ + Note that when building a EntityPart, the name and content are required. + Other properties such as headers, file name, and media type are optional. + + It is the responsibility of the implementation code to close the content + input streams when sending the multipart content. Closing the stream before + the implementation has sent it could result in unexpected exceptions. It is + the responsibility of the calling code to close the stream when receiving the + multipart content.
+
+
Since:
+
3.1
+
+
+
+
    + +
  • +
    +

    Nested Class Summary

    +
    Nested Classes
    +
    +
    Modifier and Type
    +
    Interface
    +
    Description
    +
    static interface 
    +
    EntityPart.Builder
    +
    +
    Builder for EntityPart instances.
    +
    +
    +
    +
    • + +
  • +
    +

    Method Summary

    +
    +
    +
    +
    +
    Modifier and Type
    +
    Method
    +
    Description
    +
    InputStream
    +
    getContent()
    +
    +
    Returns the input stream for this part.
    +
    +
    <T> T
    +
    getContent(GenericType<T> type)
    +
    +
    Converts the content stream for this part to the specified type and returns + it.
    +
    +
    <T> T
    +
    getContent(Class<T> type)
    +
    +
    Converts the content stream for this part to the specified class and returns + it.
    +
    +
    Optional<String>
    +
    getFileName()
    +
    +
    Returns the filename of this part.
    +
    +
    MultivaluedMap<String,String>
    +
    getHeaders()
    +
    +
    Returns an immutable multivalued map of headers for this specific part.
    +
    +
    MediaType
    +
    getMediaType()
    +
    +
    Returns the content type of this part, and equivalent to calling + MediaType.valueOf(part.getHeaders().getFirst(HttpHeaders.CONTENT_TYPE)).
    +
    +
    String
    +
    getName()
    +
    +
    Returns the name of this part within the multipart entity.
    +
    +
    static EntityPart.Builder
    +
    withFileName(String partAndFileName)
    +
    +
    Creates a new EntityPart.Builder instance that sets the part + name and fileName to the passed in partAndFileName + value.
    +
    +
    static EntityPart.Builder
    +
    withName(String partName)
    +
    +
    Creates a new EntityPart.Builder instance.
    +
    +
    +
    +
    +
    +
    • +
+
+
+ +
+ +
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/EntityTag.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/EntityTag.html new file mode 100644 index 0000000000..19c68fa26a --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/EntityTag.html @@ -0,0 +1,335 @@ + + + + +EntityTag (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Module jakarta.ws.rs
+
Package jakarta.ws.rs.core
+

Class EntityTag

+
+
java.lang.Object +
jakarta.ws.rs.core.EntityTag
+
+
+
+
public class EntityTag +extends Object
+
An abstraction for the value of a HTTP Entity Tag, used as the value of an ETag response header.
+
+
Since:
+
1.0
+
Author:
+
Paul Sandoz, Marc Hadley
+
See Also:
+
+ +
+
+
+
+
    + +
  • +
    +

    Constructor Summary

    +
    Constructors
    +
    +
    Constructor
    +
    Description
    +
    EntityTag(String value)
    +
    +
    Creates a new instance of a strong EntityTag.
    +
    +
    EntityTag(String value, + boolean weak)
    +
    +
    Creates a new instance of an EntityTag.
    +
    +
    +
    +
    • + +
  • +
    +

    Method Summary

    +
    +
    +
    +
    +
    Modifier and Type
    +
    Method
    +
    Description
    +
    boolean
    +
    equals(Object obj)
    +
    +
    Compares obj to this tag to see if they are the same considering weakness and value.
    +
    +
    String
    +
    getValue()
    +
    +
    Get the value of an EntityTag.
    +
    +
    int
    +
    hashCode()
    +
    +
    Generate hashCode based on value and weakness.
    +
    +
    boolean
    +
    isWeak()
    +
    +
    Check the strength of an EntityTag.
    +
    +
    String
    +
    toString()
    +
    +
    Deprecated. +
    The format of the toString() method is subject to change in a future version.
    +
    +
    +
    static EntityTag
    +
    valueOf(String value)
    +
    +
    Deprecated. +
    This method will be removed in a future version.
    +
    +
    +
    +
    +
    +
    +

    Methods inherited from class java.lang.Object

    +clone, finalize, getClass, notify, notifyAll, wait, wait, wait
    +
    +
    • +
+
+
+
    + +
  • +
    +

    Constructor Details

    +
      +
    • +
      +

      EntityTag

      +
      public EntityTag(String value)
      +
      Creates a new instance of a strong EntityTag.
      +
      +
      Parameters:
      +
      value - the value of the tag, quotes not included.
      +
      Throws:
      +
      IllegalArgumentException - if value is null.
      +
      +
      +
      • +
    • +
      +

      EntityTag

      +
      public EntityTag(String value, + boolean weak)
      +
      Creates a new instance of an EntityTag.
      +
      +
      Parameters:
      +
      value - the value of the tag, quotes not included.
      +
      weak - true if this represents a weak tag, false otherwise.
      +
      Throws:
      +
      IllegalArgumentException - if value is null.
      +
      +
      +
      • +
    +
    +
    • + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      valueOf

      +
      @Deprecated +public static EntityTag valueOf(String value)
      +
      Deprecated. +
      This method will be removed in a future version. Please use + RuntimeDelegate.getInstance().createHeaderDelegate(EntityTag.class).fromString(value) instead.
      +
      +
      Creates a new instance of EntityTag by parsing the supplied string.
      +
      +
      Parameters:
      +
      value - the entity tag string.
      +
      Returns:
      +
      the newly created entity tag.
      +
      Throws:
      +
      IllegalArgumentException - if the supplied string cannot be parsed or is null.
      +
      +
      +
      • +
    • +
      +

      isWeak

      +
      public boolean isWeak()
      +
      Check the strength of an EntityTag.
      +
      +
      Returns:
      +
      true if this represents a weak tag, false otherwise.
      +
      +
      +
      • +
    • +
      +

      getValue

      +
      public String getValue()
      +
      Get the value of an EntityTag.
      +
      +
      Returns:
      +
      the value of the tag.
      +
      +
      +
      • +
    • +
      +

      equals

      +
      public boolean equals(Object obj)
      +
      Compares obj to this tag to see if they are the same considering weakness and value.
      +
      +
      Overrides:
      +
      equals in class Object
      +
      Parameters:
      +
      obj - the object to compare to.
      +
      Returns:
      +
      true if the two tags are the same, false otherwise.
      +
      +
      +
      • +
    • +
      +

      hashCode

      +
      public int hashCode()
      +
      Generate hashCode based on value and weakness.
      +
      +
      Overrides:
      +
      hashCode in class Object
      +
      Returns:
      +
      the entity tag hash code.
      +
      +
      +
      • +
    • +
      +

      toString

      +
      @Deprecated +public String toString()
      +
      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.
      +
      +
      Convert the entity tag to a string suitable for use as the value of the corresponding HTTP header.
      +
      +
      Overrides:
      +
      toString in class Object
      +
      Returns:
      +
      a string version of the entity tag.
      +
      +
      +
      • +
    +
    +
    • +
+
+ +
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/Feature.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/Feature.html new file mode 100644 index 0000000000..ebd0130ed2 --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/Feature.html @@ -0,0 +1,187 @@ + + + + +Feature (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Module jakarta.ws.rs
+
Package jakarta.ws.rs.core
+

Interface Feature

+
+
+
+
public interface Feature
+
A feature extension contract. + + Typically encapsulates a concept or facility that involves configuration of multiple providers (e.g. filters or + interceptors) and/or properties. +

+ A Feature is a special type of JAX-RS configuration meta-provider. Once a feature is registered, its + configure(FeatureContext) method is invoked during JAX-RS runtime configuration and bootstrapping phase + allowing the feature to further configure the runtime context in which it has been registered. From within the + invoked configure(...) method a feature may provide additional runtime configuration for the facility or + conceptual domain it represents, such as registering additional contract providers, including nested features and/or + specifying domain-specific properties. +

+

+ Features implementing this interface MAY be annotated with the @Provider + annotation in order to be discovered by the JAX-RS runtime when scanning for resources and providers. Please note + that this will only work for server side features. Features for the JAX-RS client must be registered + programmatically. +

+
+
Since:
+
2.0
+
Author:
+
Marek Potociar
+
+
+
+
    + +
  • +
    +

    Method Summary

    +
    +
    +
    +
    +
    Modifier and Type
    +
    Method
    +
    Description
    +
    boolean
    +
    configure(FeatureContext context)
    +
    +
    A call-back method called when the feature is to be enabled in a given runtime configuration scope.
    +
    +
    +
    +
    +
    +
    • +
+
+
+
    + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      configure

      +
      boolean configure(FeatureContext context)
      +
      A call-back method called when the feature is to be enabled in a given runtime configuration scope. + + The responsibility of the feature is to properly update the supplied runtime configuration context and return + true if the feature was successfully enabled or false otherwise. +

      + Note that under some circumstances the feature may decide not to enable itself, which is indicated by returning + false. In such case the configuration context does not add the feature to the collection of enabled features + and a subsequent call to Configuration.isEnabled(Feature) or Configuration.isEnabled(Class) method + would return false. +

      +
      +
      Parameters:
      +
      context - configurable context in which the feature should be enabled.
      +
      Returns:
      +
      true if the feature was successfully enabled, false otherwise.
      +
      +
      +
      • +
    +
    +
    • +
+
+ +
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/FeatureContext.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/FeatureContext.html new file mode 100644 index 0000000000..149284686d --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/FeatureContext.html @@ -0,0 +1,128 @@ + + + + +FeatureContext (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Module jakarta.ws.rs
+
Package jakarta.ws.rs.core
+

Interface FeatureContext

+
+
+
+
All Superinterfaces:
+
Configurable<FeatureContext>
+
+
+
public interface FeatureContext +extends Configurable<FeatureContext>
+
A configurable context passed to Feature and DynamicFeature instances by JAX-RS + runtime during the phase of their configuration.
+
+
Author:
+
Marek Potociar (marek.potociar at oracle.com)
+
+
+
+ +
+ +
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/Form.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/Form.html new file mode 100644 index 0000000000..9fcb96c5c5 --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/Form.html @@ -0,0 +1,269 @@ + + + + +Form (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Module jakarta.ws.rs
+
Package jakarta.ws.rs.core
+

Class Form

+
+
java.lang.Object +
jakarta.ws.rs.core.Form
+
+
+
+
public class Form +extends Object
+
Represents the the HTML form data request entity encoded using the "application/x-www-form-urlencoded" + content type.
+
+
Since:
+
2.0
+
Author:
+
Marek Potociar
+
+
+
+ +
+
+
    + +
  • +
    +

    Constructor Details

    +
      +
    • +
      +

      Form

      +
      public Form()
      +
      Create a new form data instance. +

      + The underlying form parameter store is configured to preserve the insertion order of the parameters. I.e. parameters + can be iterated in the same order as they were inserted into the Form. +

      +
      +
      • +
    • +
      +

      Form

      +
      public Form(String parameterName, + String parameterValue)
      +
      Create a new form data instance with a single parameter entry. +

      + The underlying form parameter store is configured to preserve the insertion order of the parameters. I.e. parameters + can be iterated in the same order as they were inserted into the Form. +

      +
      +
      Parameters:
      +
      parameterName - form parameter name.
      +
      parameterValue - form parameter value.
      +
      +
      +
      • +
    • +
      +

      Form

      +
      public Form(MultivaluedMap<String,String> store)
      +
      Create a new form data instance and register a custom underlying parameter store. +

      + This method is useful in situations when a custom parameter store is needed in order to change the default parameter + iteration order, improve performance or facilitate other custom requirements placed on the parameter store. +

      +
      +
      Parameters:
      +
      store - form data store used by the created form instance.
      +
      +
      +
      • +
    +
    +
    • + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      param

      +
      public Form param(String name, + String value)
      +
      Adds a new value to the specified form parameter.
      +
      +
      Parameters:
      +
      name - name of the parameter.
      +
      value - new parameter value to be added.
      +
      Returns:
      +
      updated Form instance.
      +
      +
      +
      • +
    • +
      +

      asMap

      +
      public MultivaluedMap<String,String> asMap()
      +
      Returns multivalued map representation of the form.
      +
      +
      Returns:
      +
      form represented as multivalued map.
      +
      See Also:
      +
      + +
      +
      +
      +
      • +
    +
    +
    • +
+
+ +
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/GenericEntity.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/GenericEntity.html new file mode 100644 index 0000000000..e07095e5c7 --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/GenericEntity.html @@ -0,0 +1,354 @@ + + + + +GenericEntity (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Module jakarta.ws.rs
+
Package jakarta.ws.rs.core
+

Class GenericEntity<T>

+
+
java.lang.Object +
jakarta.ws.rs.core.GenericEntity<T>
+
+
+
+
Type Parameters:
+
T - response entity instance type
+
+
+
public class GenericEntity<T> +extends Object
+
Represents a message entity of a generic type T. +

+ Normally type erasure removes generic type information such that a Response instance that contains, e.g., an + entity of type List<String> appears to contain a raw List<?> at runtime. When the generic type is + required to select a suitable MessageBodyWriter, this class may be used to wrap the entity + and capture its generic type. +

+

+ There are two ways to create an instance: +

+
    +
  1. Create a (typically anonymous) subclass of this class which enables retrieval of the type information at runtime + despite type erasure. For example, the following code shows how to create a Response containing an entity of + type List<String> whose generic type will be available at runtime for selection of a suitable + MessageBodyWriter: + + 
    + List<String> list = new ArrayList<String>();
+ GenericEntity<List<String>> entity = new GenericEntity<List<String>>(list) {
+ };
+ Response response = Response.ok(entity).build();
+
    + +

    + where list is the instance of List<String> that will form the response body and entity is an instance + of an anonymous subclass of GenericEntity. +

    +
    2. +
  2. Create an instance directly by supplying the generic type information with the entity. For example the following + code shows how to create a response containing the result of a method invoked via reflection: + + 
    + Method method = ...;
+ GenericEntity<Object> entity = new GenericEntity<Object>(
+    method.invoke(...), method.getGenericReturnType());
+ Response response = Response.ok(entity).build();
+
    +

    + The above obtains the generic type from the return type of the method, the raw type is the class of entity. +

    +
    3. +
+
+
Since:
+
1.0
+
Author:
+
Paul Sandoz, Marc Hadley
+
See Also:
+
+ +
+
+
+
+
    + +
  • +
    +

    Constructor Summary

    +
    Constructors
    +
    +
    Modifier
    +
    Constructor
    +
    Description
    +
    protected
    +
    GenericEntity(T entity)
    +
    +
    Constructs a new generic entity.
    +
    +
     
    +
    GenericEntity(T entity, + Type genericType)
    +
    +
    Create a new instance of GenericEntity, supplying the generic type information.
    +
    +
    +
    +
    • + +
  • +
    +

    Method Summary

    +
    +
    +
    +
    +
    Modifier and Type
    +
    Method
    +
    Description
    +
    boolean
    +
    equals(Object obj)
    +
     
    +
    final T
    +
    getEntity()
    +
    +
    Get the enclosed entity.
    +
    +
    final Class<?>
    +
    getRawType()
    +
    +
    Gets the raw type of the enclosed entity.
    +
    +
    final Type
    +
    getType()
    +
    +
    Gets underlying Type instance.
    +
    +
    int
    +
    hashCode()
    +
     
    +
    String
    +
    toString()
    +
     
    +
    +
    +
    +
    +

    Methods inherited from class java.lang.Object

    +clone, finalize, getClass, notify, notifyAll, wait, wait, wait
    +
    +
    • +
+
+
+
    + +
  • +
    +

    Constructor Details

    +
      +
    • +
      +

      GenericEntity

      +
      protected GenericEntity(T entity)
      +
      Constructs a new generic entity. Derives represented class from type parameter. Note that this constructor is + protected, users should create a (usually anonymous) subclass as shown above.
      +
      +
      Parameters:
      +
      entity - the entity instance, must not be null.
      +
      Throws:
      +
      IllegalArgumentException - if entity is null.
      +
      +
      +
      • +
    • +
      +

      GenericEntity

      +
      public GenericEntity(T entity, + Type genericType)
      +
      Create a new instance of GenericEntity, supplying the generic type information. The entity must be assignable to a + variable of the supplied generic type, e.g. if entity is an instance of ArrayList<String> then + genericType could be the same or a superclass of ArrayList with the same generic type like + List<String>.
      +
      +
      Parameters:
      +
      entity - the entity instance, must not be null.
      +
      genericType - the generic type, must not be null.
      +
      Throws:
      +
      IllegalArgumentException - if the entity is not assignable to a variable of the supplied generic type or if + entity or genericType is null.
      +
      +
      +
      • +
    +
    +
    • + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      getRawType

      +
      public final Class<?> getRawType()
      +
      Gets the raw type of the enclosed entity. Note that this is the raw type of the instance, not the raw type of the + type parameter. I.e. in the example in the introduction, the raw type is ArrayList not List.
      +
      +
      Returns:
      +
      the raw type.
      +
      +
      +
      • +
    • +
      +

      getType

      +
      public final Type getType()
      +
      Gets underlying Type instance. Note that this is derived from the type parameter, not the enclosed instance. + I.e. in the example in the introduction, the type is List<String> not ArrayList<String>.
      +
      +
      Returns:
      +
      the type
      +
      +
      +
      • +
    • +
      +

      getEntity

      +
      public final T getEntity()
      +
      Get the enclosed entity.
      +
      +
      Returns:
      +
      the enclosed entity.
      +
      +
      +
      • +
    • +
      +

      equals

      +
      public boolean equals(Object obj)
      +
      +
      Overrides:
      +
      equals in class Object
      +
      +
      +
      • +
    • +
      +

      hashCode

      +
      public int hashCode()
      +
      +
      Overrides:
      +
      hashCode in class Object
      +
      +
      +
      • +
    • +
      +

      toString

      +
      public String toString()
      +
      +
      Overrides:
      +
      toString in class Object
      +
      +
      +
      • +
    +
    +
    • +
+
+ +
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/GenericType.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/GenericType.html new file mode 100644 index 0000000000..6b2acfc5e2 --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/GenericType.html @@ -0,0 +1,346 @@ + + + + +GenericType (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Module jakarta.ws.rs
+
Package jakarta.ws.rs.core
+

Class GenericType<T>

+
+
java.lang.Object +
jakarta.ws.rs.core.GenericType<T>
+
+
+
+
Type Parameters:
+
T - the generic type parameter.
+
+
+
public class GenericType<T> +extends Object
+
Represents a generic message entity type T. + + Supports in-line instantiation of objects that represent generic types with actual type parameters. An object that + represents any parameterized type may be obtained by sub-classing GenericType. Alternatively, an object + representing a concrete parameterized type can be created using a GenericType(java.lang.reflect.Type) and + manually specifying the actual (parameterized) type. +

+ For example: +

+ + 
+ GenericType<List<String>> stringListType = new GenericType<List<String>>() {
+ };
+
+

+ Or: +

+ + 
+  public class MyGenericType extends GenericType<List<String>> { ... }
+
+  ...
+
+  MyGenericType stringListType = new MyGenericType();
+
+

+ Note that due to the Java type erasure limitations the parameterized type information must be specified on a + subclass, not just during the instance creation. For example, the following case would throw an + IllegalArgumentException: +

+ + 
+  public class MyGenericType<T> extends GenericType<T> { ... }
+
+  ...
+
+  // The type is only specified on instance, not in a sub-class
+  MyGenericType<List<String>> stringListType =
+          new MyGenericType<List<String>>();
+
+
+
Since:
+
2.0
+
Author:
+
Marek Potociar, Paul Sandoz, Martin Matula
+
+
+
+
    + +
  • +
    +

    Constructor Summary

    +
    Constructors
    +
    +
    Modifier
    +
    Constructor
    +
    Description
    +
    protected
    +
    GenericType()
    +
    +
    Constructs a new generic type, deriving the generic type and class from type parameter.
    +
    +
     
    +
    GenericType(Type genericType)
    +
    +
    Constructs a new generic type, supplying the generic type information and deriving the class.
    +
    +
    +
    +
    • + +
  • +
    +

    Method Summary

    +
    +
    +
    +
    +
    Modifier and Type
    +
    Method
    +
    Description
    +
    boolean
    +
    equals(Object obj)
    +
     
    +
    static GenericType
    +
    forInstance(Object instance)
    +
    +
    Create a generic type from a Java instance.
    +
    +
    final Class<?>
    +
    getRawType()
    +
    +
    Returns the object representing the class or interface that declared the type represented by this generic type + instance.
    +
    +
    final Type
    +
    getType()
    +
    +
    Retrieve the type represented by the generic type instance.
    +
    +
    int
    +
    hashCode()
    +
     
    +
    String
    +
    toString()
    +
     
    +
    +
    +
    +
    +

    Methods inherited from class java.lang.Object

    +clone, finalize, getClass, notify, notifyAll, wait, wait, wait
    +
    +
    • +
+
+
+
    + +
  • +
    +

    Constructor Details

    +
      +
    • +
      +

      GenericType

      +
      protected GenericType()
      +
      Constructs a new generic type, deriving the generic type and class from type parameter. Note that this constructor is + protected, users should create a (usually anonymous) subclass as shown above.
      +
      +
      Throws:
      +
      IllegalArgumentException - in case the generic type parameter value is not provided by any of the subclasses.
      +
      +
      +
      • +
    • +
      +

      GenericType

      +
      public GenericType(Type genericType)
      +
      Constructs a new generic type, supplying the generic type information and deriving the class.
      +
      +
      Parameters:
      +
      genericType - the generic type.
      +
      Throws:
      +
      IllegalArgumentException - if genericType is null or not an instance of Class or + ParameterizedType whose raw type is an instance of Class.
      +
      +
      +
      • +
    +
    +
    • + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      forInstance

      +
      public static GenericType forInstance(Object instance)
      +
      Create a generic type from a Java instance. +

      + If the supplied instance is a GenericEntity, the generic type will be computed using the + GenericEntity.getType(). Otherwise instance.getClass() will be used. +

      +
      +
      Parameters:
      +
      instance - Java instance for which the GenericType description should be created.
      +
      Returns:
      +
      GenericType describing the Java instance.
      +
      Since:
      +
      2.1
      +
      +
      +
      • +
    • +
      +

      getType

      +
      public final Type getType()
      +
      Retrieve the type represented by the generic type instance.
      +
      +
      Returns:
      +
      the actual type represented by this generic type instance.
      +
      +
      +
      • +
    • +
      +

      getRawType

      +
      public final Class<?> getRawType()
      +
      Returns the object representing the class or interface that declared the type represented by this generic type + instance.
      +
      +
      Returns:
      +
      the class or interface that declared the type represented by this generic type instance.
      +
      +
      +
      • +
    • +
      +

      equals

      +
      public boolean equals(Object obj)
      +
      +
      Overrides:
      +
      equals in class Object
      +
      +
      +
      • +
    • +
      +

      hashCode

      +
      public int hashCode()
      +
      +
      Overrides:
      +
      hashCode in class Object
      +
      +
      +
      • +
    • +
      +

      toString

      +
      public String toString()
      +
      +
      Overrides:
      +
      toString in class Object
      +
      +
      +
      • +
    +
    +
    • +
+
+ +
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/HttpHeaders.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/HttpHeaders.html new file mode 100644 index 0000000000..95c561d710 --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/HttpHeaders.html @@ -0,0 +1,1132 @@ + + + + +HttpHeaders (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Module jakarta.ws.rs
+
Package jakarta.ws.rs.core
+

Interface HttpHeaders

+
+
+
+
public interface HttpHeaders
+
An injectable interface that provides access to HTTP header information. All methods throw + IllegalStateException if called outside the scope of a request (e.g. from a provider constructor).
+
+
Since:
+
1.0
+
Author:
+
Paul Sandoz, Marc Hadley
+
See Also:
+
+ +
+
+
+
+ +
+
+ +
+ +
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/Link.Builder.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/Link.Builder.html new file mode 100644 index 0000000000..ec836fe867 --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/Link.Builder.html @@ -0,0 +1,457 @@ + + + + +Link.Builder (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Module jakarta.ws.rs
+
Package jakarta.ws.rs.core
+

Interface Link.Builder

+
+
+
+
Enclosing class:
+
Link
+
+
+
public static interface Link.Builder
+
Builder class for hypermedia links.
+
+
Since:
+
2.0
+
See Also:
+
+ +
+
+
+
+
    + +
  • +
    +

    Method Summary

    +
    +
    +
    +
    +
    Modifier and Type
    +
    Method
    +
    Description
    +
    Link.Builder
    +
    baseUri(String uri)
    +
    +
    Set the base URI as a string for resolution of relative URIs.
    +
    +
    Link.Builder
    +
    baseUri(URI uri)
    +
    +
    Set the base URI for resolution of relative URIs.
    +
    +
    Link
    +
    build(Object... values)
    +
    +
    Finish building this link using the supplied values as URI parameters.
    +
    +
    Link
    +
    buildRelativized(URI uri, + Object... values)
    +
    +
    Finish building this link using the supplied values as URI parameters and relativize the result with respect to the + supplied URI.
    +
    +
    Link.Builder
    +
    link(Link link)
    +
    +
    Initialize builder using another link.
    +
    +
    Link.Builder
    +
    link(String link)
    +
    +
    Initialize builder using another link represented as a string.
    +
    +
    Link.Builder
    +
    param(String name, + String value)
    +
    +
    Set an arbitrary parameter on this link.
    +
    +
    Link.Builder
    +
    rel(String rel)
    +
    +
    Convenience method to set a link relation.
    +
    +
    Link.Builder
    +
    title(String title)
    +
    +
    Convenience method to set a title on this link.
    +
    +
    Link.Builder
    +
    type(String type)
    +
    +
    Convenience method to set a type on this link.
    +
    +
    Link.Builder
    +
    uri(String uri)
    +
    +
    Set underlying string representing URI template for the link being constructed.
    +
    +
    Link.Builder
    +
    uri(URI uri)
    +
    +
    Set underlying URI template for the link being constructed.
    +
    +
    Link.Builder
    +
    uriBuilder(UriBuilder uriBuilder)
    +
    +
    Set underlying URI builder representing the URI template for the link being constructed.
    +
    +
    +
    +
    +
    +
    • +
+
+
+
    + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      link

      +
      Link.Builder link(Link link)
      +
      Initialize builder using another link. Sets underlying URI and copies all parameters.
      +
      +
      Parameters:
      +
      link - other link from which to initialize.
      +
      Returns:
      +
      the updated builder.
      +
      +
      +
      • +
    • +
      +

      link

      +
      Link.Builder link(String link)
      +
      Initialize builder using another link represented as a string. Uses simple parser to convert string representation + into a link. + + 
      + link ::= '<' uri 'gt;' (';' link-param)*
+ link-param ::= name '=' quoted-string
+
      + + See RFC 5988 for more information.
      +
      +
      Parameters:
      +
      link - other link in string representation.
      +
      Returns:
      +
      the updated builder.
      +
      Throws:
      +
      IllegalArgumentException - if string representation of URI is invalid.
      +
      +
      +
      • +
    • +
      +

      uri

      +
      Link.Builder uri(URI uri)
      +
      Set underlying URI template for the link being constructed.
      +
      +
      Parameters:
      +
      uri - underlying URI for link
      +
      Returns:
      +
      the updated builder.
      +
      +
      +
      • +
    • +
      +

      uri

      +
      Link.Builder uri(String uri)
      +
      Set underlying string representing URI template for the link being constructed.
      +
      +
      Parameters:
      +
      uri - underlying URI for link.
      +
      Returns:
      +
      the updated builder.
      +
      Throws:
      +
      IllegalArgumentException - if string representation of URI is invalid.
      +
      +
      +
      • +
    • +
      +

      baseUri

      +
      Link.Builder baseUri(URI uri)
      +
      Set the base URI for resolution of relative URIs. If the underlying URI is already absolute, the base URI is ignored.
      +
      +
      Parameters:
      +
      uri - base URI for relative links.
      +
      Returns:
      +
      the updated builder.
      +
      See Also:
      +
      + +
      +
      +
      +
      • +
    • +
      +

      baseUri

      +
      Link.Builder baseUri(String uri)
      +
      Set the base URI as a string for resolution of relative URIs. If the underlying URI is already absolute, the base URI + is ignored.
      +
      +
      Parameters:
      +
      uri - base URI for relative links.
      +
      Returns:
      +
      the updated builder.
      +
      Throws:
      +
      IllegalArgumentException - if string representation of URI is invalid.
      +
      See Also:
      +
      + +
      +
      +
      +
      • +
    • +
      +

      uriBuilder

      +
      Link.Builder uriBuilder(UriBuilder uriBuilder)
      +
      Set underlying URI builder representing the URI template for the link being constructed.
      +
      +
      Parameters:
      +
      uriBuilder - underlying URI builder.
      +
      Returns:
      +
      the updated builder.
      +
      +
      +
      • +
    • +
      +

      rel

      +
      Link.Builder rel(String rel)
      +
      Convenience method to set a link relation. More than one rel value can be specified by using one or more + whitespace characters as delimiters according to RFC 5988. The effect of calling this method is cumulative; relations + are appended using a single space character as separator.
      +
      +
      Parameters:
      +
      rel - relation name.
      +
      Returns:
      +
      the updated builder.
      +
      Throws:
      +
      IllegalArgumentException - if the name is null.
      +
      +
      +
      • +
    • +
      +

      title

      +
      Link.Builder title(String title)
      +
      Convenience method to set a title on this link.
      +
      +
      Parameters:
      +
      title - title parameter of this link.
      +
      Returns:
      +
      the updated builder.
      +
      Throws:
      +
      IllegalArgumentException - if the title is null.
      +
      +
      +
      • +
    • +
      +

      type

      +
      Link.Builder type(String type)
      +
      Convenience method to set a type on this link.
      +
      +
      Parameters:
      +
      type - type parameter of this link.
      +
      Returns:
      +
      the updated builder.
      +
      Throws:
      +
      IllegalArgumentException - if the type is null.
      +
      +
      +
      • +
    • +
      +

      param

      +
      Link.Builder param(String name, + String value)
      +
      Set an arbitrary parameter on this link. Note that link parameters are those defined in RFC 5988 and should not be + confused with URI parameters which can be specified when calling build(Object...).
      +
      +
      Parameters:
      +
      name - the name of the parameter.
      +
      value - the value set for the parameter.
      +
      Returns:
      +
      the updated builder.
      +
      Throws:
      +
      IllegalArgumentException - if either the name or value are null.
      +
      +
      +
      • +
    • +
      +

      build

      +
      Link build(Object... values)
      +
      Finish building this link using the supplied values as URI parameters. + + The state of the builder is unaffected; this method may be called multiple times on the same builder instance.
      +
      +
      Parameters:
      +
      values - parameters used to build underlying URI.
      +
      Returns:
      +
      newly built link.
      +
      Throws:
      +
      IllegalArgumentException - if there are any URI template parameters without a supplied value, or if a value is + null.
      +
      UriBuilderException - if a URI cannot be constructed based on the current state of the underlying URI builder.
      +
      +
      +
      • +
    • +
      +

      buildRelativized

      +
      Link buildRelativized(URI uri, + Object... values)
      +
      Finish building this link using the supplied values as URI parameters and relativize the result with respect to the + supplied URI. + + If the underlying link is already relative or if it is absolute but does not share a prefix with the supplied URI, + this method is equivalent to calling build(java.lang.Object[]). Note that a base URI can be set + on a relative link using baseUri(java.net.URI). The state of the builder is unaffected; this + method may be called multiple times on the same builder instance.
      +
      +
      Parameters:
      +
      uri - URI used for relativization.
      +
      values - parameters used to build underlying URI.
      +
      Returns:
      +
      newly built link.
      +
      Throws:
      +
      IllegalArgumentException - if there are any URI template parameters without a supplied value, or if a value is + null.
      +
      UriBuilderException - if a URI cannot be constructed based on the current state of the underlying URI builder.
      +
      See Also:
      +
      + +
      +
      +
      +
      • +
    +
    +
    • +
+
+ +
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/Link.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/Link.html new file mode 100644 index 0000000000..9dd0286c40 --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/Link.html @@ -0,0 +1,624 @@ + + + + +Link (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Module jakarta.ws.rs
+
Package jakarta.ws.rs.core
+

Class Link

+
+
java.lang.Object +
jakarta.ws.rs.core.Link
+
+
+
+
public abstract class Link +extends Object
+

+ Class representing hypermedia links. A hypermedia link may include additional parameters beyond its underlying URI. + Parameters such as rel or type provide additional meta-data. Links in responses can be + followed by creating an Invocation.Builder or a + WebTarget. +

+ +

+ The methods toString() and valueOf(java.lang.String) can be used to serialize and de-serialize a link into a link + header (RFC 5988). +

+
+
Since:
+
2.0
+
Author:
+
Marek Potociar, Santiago Pericas-Geertsen
+
See Also:
+
+ +
+
+
+
+
    + +
  • +
    +

    Nested Class Summary

    +
    Nested Classes
    +
    +
    Modifier and Type
    +
    Class
    +
    Description
    +
    static interface 
    +
    Link.Builder
    +
    +
    Builder class for hypermedia links.
    +
    +
    +
    +
    • + +
  • +
    +

    Field Summary

    +
    Fields
    +
    +
    Modifier and Type
    +
    Field
    +
    Description
    +
    static final String
    +
    REL
    +
    +
    Rel link param from RFC 5988.
    +
    +
    static final String
    +
    TITLE
    +
    +
    Title link param from RFC 5988.
    +
    +
    static final String
    +
    TYPE
    +
    +
    Type link param from RFC 5988.
    +
    +
    +
    +
    • + +
  • +
    +

    Constructor Summary

    +
    Constructors
    +
    +
    Constructor
    +
    Description
    +
    Link()
    +
     
    +
    +
    +
    • + +
  • +
    +

    Method Summary

    +
    +
    +
    +
    +
    Modifier and Type
    +
    Method
    +
    Description
    +
    static Link.Builder
    +
    fromLink(Link link)
    +
    +
    Create a new builder instance initialized from another link.
    +
    +
    static Link.Builder
    +
    fromMethod(Class<?> resource, + String method)
    +
    +
    Convenience method to build a link from a resource.
    +
    +
    static Link.Builder
    +
    fromPath(String path)
    +
    +
    Convenience method to build a link from a path.
    +
    +
    static Link.Builder
    +
    fromResource(Class<?> resource)
    +
    +
    Convenience method to build a link from a resource.
    +
    +
    static Link.Builder
    +
    fromUri(String uri)
    +
    +
    Create a new builder instance initialized from an existing URI represented as a string.
    +
    +
    static Link.Builder
    +
    fromUri(URI uri)
    +
    +
    Create a new builder instance initialized from an existing URI.
    +
    +
    static Link.Builder
    +
    fromUriBuilder(UriBuilder uriBuilder)
    +
    +
    Create a new builder instance initialized from a URI builder.
    +
    +
    abstract Map<String,String>
    +
    getParams()
    +
    +
    Returns an immutable map that includes all the link parameters defined on this link.
    +
    +
    abstract String
    +
    getRel()
    +
    +
    Returns the value associated with the link rel param, or null if this param is not specified.
    +
    +
    abstract List<String>
    +
    getRels()
    +
    +
    Returns the value associated with the link rel param as a list of strings or the empty list if rel is + not defined.
    +
    +
    abstract String
    +
    getTitle()
    +
    +
    Returns the value associated with the link title param, or null if this param is not specified.
    +
    +
    abstract String
    +
    getType()
    +
    +
    Returns the value associated with the link type param, or null if this param is not specified.
    +
    +
    abstract URI
    +
    getUri()
    +
    +
    Returns the underlying URI associated with this link.
    +
    +
    abstract UriBuilder
    +
    getUriBuilder()
    +
    +
    Convenience method that returns a UriBuilder initialized with this link's underlying URI.
    +
    +
    abstract String
    +
    toString()
    +
    +
    Returns a string representation as a link header (RFC 5988).
    +
    +
    static Link
    +
    valueOf(String value)
    +
    +
    Simple parser to convert link header string representations into a link.
    +
    +
    +
    +
    +
    +

    Methods inherited from class java.lang.Object

    +clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
    +
    +
    • +
+
+
+
    + +
  • +
    +

    Field Details

    + +
    +
    • + +
  • +
    +

    Constructor Details

    +
      +
    • +
      +

      Link

      +
      public Link()
      +
      +
      • +
    +
    +
    • + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      getUri

      +
      public abstract URI getUri()
      +
      Returns the underlying URI associated with this link.
      +
      +
      Returns:
      +
      underlying URI.
      +
      +
      +
      • +
    • +
      +

      getUriBuilder

      +
      public abstract UriBuilder getUriBuilder()
      +
      Convenience method that returns a UriBuilder initialized with this link's underlying URI.
      +
      +
      Returns:
      +
      UriBuilder initialized using underlying URI.
      +
      +
      +
      • +
    • +
      +

      getRel

      +
      public abstract String getRel()
      +
      Returns the value associated with the link rel param, or null if this param is not specified.
      +
      +
      Returns:
      +
      relation types as string or null.
      +
      +
      +
      • +
    • +
      +

      getRels

      +
      public abstract List<String> getRels()
      +
      Returns the value associated with the link rel param as a list of strings or the empty list if rel is + not defined.
      +
      +
      Returns:
      +
      relation types as list of strings or empty list.
      +
      +
      +
      • +
    • +
      +

      getTitle

      +
      public abstract String getTitle()
      +
      Returns the value associated with the link title param, or null if this param is not specified.
      +
      +
      Returns:
      +
      value of title parameter or null.
      +
      +
      +
      • +
    • +
      +

      getType

      +
      public abstract String getType()
      +
      Returns the value associated with the link type param, or null if this param is not specified.
      +
      +
      Returns:
      +
      value of type parameter or null.
      +
      +
      +
      • +
    • +
      +

      getParams

      +
      public abstract Map<String,String> getParams()
      +
      Returns an immutable map that includes all the link parameters defined on this link. If defined, this map will + include entries for rel, title and type.
      +
      +
      Returns:
      +
      immutable map of link parameters.
      +
      +
      +
      • +
    • +
      +

      toString

      +
      public abstract String toString()
      +
      Returns a string representation as a link header (RFC 5988). All link params are serialized as link-param="value" + where value is a quoted-string. For example, + + <http://foo.bar/employee/john>; title="employee"; rel="manager friend"
      +
      +
      Overrides:
      +
      toString in class Object
      +
      Returns:
      +
      string link header representation for this link.
      +
      +
      +
      • +
    • +
      +

      valueOf

      +
      public static Link valueOf(String value)
      +
      Simple parser to convert link header string representations into a link. + + 
      + link ::= '<' uri 'gt;' (';' link-param)*
+ link-param ::= name '=' quoted-string
+
      + + See RFC 5988 for more information.
      +
      +
      Parameters:
      +
      value - String representation.
      +
      Returns:
      +
      newly parsed link.
      +
      Throws:
      +
      IllegalArgumentException - if a syntax error is found.
      +
      See Also:
      +
      + +
      +
      +
      +
      • +
    • +
      +

      fromUri

      +
      public static Link.Builder fromUri(URI uri)
      +
      Create a new builder instance initialized from an existing URI.
      +
      +
      Parameters:
      +
      uri - a URI that will be used to initialize the builder.
      +
      Returns:
      +
      a new builder.
      +
      Throws:
      +
      IllegalArgumentException - if uri is null.
      +
      +
      +
      • +
    • +
      +

      fromUri

      +
      public static Link.Builder fromUri(String uri)
      +
      Create a new builder instance initialized from an existing URI represented as a string.
      +
      +
      Parameters:
      +
      uri - a URI that will be used to initialize the builder.
      +
      Returns:
      +
      a new builder.
      +
      Throws:
      +
      IllegalArgumentException - if uri is null.
      +
      +
      +
      • +
    • +
      +

      fromUriBuilder

      +
      public static Link.Builder fromUriBuilder(UriBuilder uriBuilder)
      +
      Create a new builder instance initialized from a URI builder.
      +
      +
      Parameters:
      +
      uriBuilder - instance of URI builder.
      +
      Returns:
      +
      a new builder.
      +
      +
      +
      • +
    • +
      +

      fromLink

      +
      public static Link.Builder fromLink(Link link)
      +
      Create a new builder instance initialized from another link.
      +
      +
      Parameters:
      +
      link - other link used for initialization.
      +
      Returns:
      +
      a new builder.
      +
      +
      +
      • +
    • +
      +

      fromPath

      +
      public static Link.Builder fromPath(String path)
      +
      Convenience method to build a link from a path. Equivalent to fromUriBuilder(UriBuilder.fromPath(path)).
      +
      +
      Parameters:
      +
      path - a URI path that will be used to initialize the Link, may contain URI template parameters.
      +
      Returns:
      +
      a new Link.Builder.
      +
      Throws:
      +
      IllegalArgumentException - if path is null.
      +
      +
      +
      • +
    • +
      +

      fromResource

      +
      public static Link.Builder fromResource(Class<?> resource)
      +
      Convenience method to build a link from a resource. Equivalent to + Link.fromUriBuilder({@link UriBuilder#fromResource UriBuilder.fromResource(resource)}). Note that the link + URI passed to the Link.Builder instance returned by this method is relative. Should the link be built as + absolute, a base URI has to be specified in the builder prior to building the new + link instance. For example, on a server side a UriInfo.getBaseUri() may be typically used to define the base + URI of a link created using this method.
      +
      +
      Parameters:
      +
      resource - a root resource whose Path value will be used to initialize the builder.
      +
      Returns:
      +
      a new link builder instance.
      +
      Throws:
      +
      IllegalArgumentException - if resource is not annotated with Path or resource is + null.
      +
      See Also:
      +
      + +
      +
      +
      +
      • +
    • +
      +

      fromMethod

      +
      public static Link.Builder fromMethod(Class<?> resource, + String method)
      +
      Convenience method to build a link from a resource. Equivalent to + Link.fromUriBuilder({@link UriBuilder#fromMethod(Class, String) UriBuilder.fromMethod(resource, method)}). + Note that the link URI passed to the Link.Builder instance returned by this method is relative. Should the + link be built as absolute, a base URI has to be specified in the builder prior to + building the new link instance. For example, on a server side a UriInfo.getBaseUri() may be typically used to + define the base URI of a link created using this method.
      +
      +
      Parameters:
      +
      resource - the resource containing the method.
      +
      method - the name of the method whose Path value will be used to obtain the path to append.
      +
      Returns:
      +
      the updated Link.Builder.
      +
      Throws:
      +
      IllegalArgumentException - if resource or method is null, or there is more than or less than one + variant of the method annotated with Path.
      +
      See Also:
      +
      + +
      +
      +
      +
      • +
    +
    +
    • +
+
+ +
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/MediaType.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/MediaType.html new file mode 100644 index 0000000000..625fd67154 --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/MediaType.html @@ -0,0 +1,1021 @@ + + + + +MediaType (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Module jakarta.ws.rs
+
Package jakarta.ws.rs.core
+

Class MediaType

+
+
java.lang.Object +
jakarta.ws.rs.core.MediaType
+
+
+
+
public class MediaType +extends Object
+
An abstraction for a media type. Instances are immutable.
+
+
Since:
+
1.0
+
Author:
+
Paul Sandoz, Marc Hadley
+
See Also:
+
+ +
+
+
+
+ +
+
+
    + +
  • +
    +

    Field Details

    +
      +
    • +
      +

      CHARSET_PARAMETER

      +
      public static final String CHARSET_PARAMETER
      +
      The media type charset parameter name.
      +
      +
      See Also:
      +
      + +
      +
      +
      +
      • +
    • +
      +

      MEDIA_TYPE_WILDCARD

      +
      public static final String MEDIA_TYPE_WILDCARD
      +
      The value of a type or subtype wildcard "*".
      +
      +
      See Also:
      +
      + +
      +
      +
      +
      • +
    • +
      +

      WILDCARD

      +
      public static final String WILDCARD
      +
      A String constant representing wildcard "*/*" media type .
      +
      +
      See Also:
      +
      + +
      +
      +
      +
      • +
    • +
      +

      WILDCARD_TYPE

      +
      public static final MediaType WILDCARD_TYPE
      +
      A MediaType constant representing wildcard "*/*" media type.
      +
      +
      • +
    • +
      +

      APPLICATION_XML

      +
      public static final String APPLICATION_XML
      +
      A String constant representing "application/xml" media type.
      +
      +
      See Also:
      +
      + +
      +
      +
      +
      • +
    • +
      +

      APPLICATION_XML_TYPE

      +
      public static final MediaType APPLICATION_XML_TYPE
      +
      A MediaType constant representing "application/xml" media type.
      +
      +
      • +
    • +
      +

      APPLICATION_ATOM_XML

      +
      public static final String APPLICATION_ATOM_XML
      +
      A String constant representing "application/atom+xml" media type.
      +
      +
      See Also:
      +
      + +
      +
      +
      +
      • +
    • +
      +

      APPLICATION_ATOM_XML_TYPE

      +
      public static final MediaType APPLICATION_ATOM_XML_TYPE
      +
      A MediaType constant representing "application/atom+xml" media type.
      +
      +
      • +
    • +
      +

      APPLICATION_XHTML_XML

      +
      public static final String APPLICATION_XHTML_XML
      +
      A String constant representing "application/xhtml+xml" media type.
      +
      +
      See Also:
      +
      + +
      +
      +
      +
      • +
    • +
      +

      APPLICATION_XHTML_XML_TYPE

      +
      public static final MediaType APPLICATION_XHTML_XML_TYPE
      +
      A MediaType constant representing "application/xhtml+xml" media type.
      +
      +
      • +
    • +
      +

      APPLICATION_SVG_XML

      +
      @Deprecated(forRemoval=true) +public static final String APPLICATION_SVG_XML
      +
      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.
      +
      +
      A String constant representing "application/svg+xml" media type.
      +
      +
      See Also:
      +
      + +
      +
      +
      +
      • +
    • +
      +

      APPLICATION_SVG_XML_TYPE

      +
      @Deprecated(forRemoval=true) +public static final MediaType APPLICATION_SVG_XML_TYPE
      +
      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.
      +
      +
      A MediaType constant representing "application/svg+xml" media type.
      +
      +
      • +
    • +
      +

      APPLICATION_JSON

      +
      public static final String APPLICATION_JSON
      +
      A String constant representing "application/json" media type.
      +
      +
      See Also:
      +
      + +
      +
      +
      +
      • +
    • +
      +

      APPLICATION_JSON_TYPE

      +
      public static final MediaType APPLICATION_JSON_TYPE
      +
      A MediaType constant representing "application/json" media type.
      +
      +
      • +
    • +
      +

      APPLICATION_FORM_URLENCODED

      +
      public static final String APPLICATION_FORM_URLENCODED
      +
      A String constant representing "application/x-www-form-urlencoded" media type.
      +
      +
      See Also:
      +
      + +
      +
      +
      +
      • +
    • +
      +

      APPLICATION_FORM_URLENCODED_TYPE

      +
      public static final MediaType APPLICATION_FORM_URLENCODED_TYPE
      +
      A MediaType constant representing "application/x-www-form-urlencoded" media type.
      +
      +
      • +
    • +
      +

      MULTIPART_FORM_DATA

      +
      public static final String MULTIPART_FORM_DATA
      +
      A String constant representing "multipart/form-data" media type.
      +
      +
      See Also:
      +
      + +
      +
      +
      +
      • +
    • +
      +

      MULTIPART_FORM_DATA_TYPE

      +
      public static final MediaType MULTIPART_FORM_DATA_TYPE
      +
      A MediaType constant representing "multipart/form-data" media type.
      +
      +
      • +
    • +
      +

      APPLICATION_OCTET_STREAM

      +
      public static final String APPLICATION_OCTET_STREAM
      +
      A String constant representing "application/octet-stream" media type.
      +
      +
      See Also:
      +
      + +
      +
      +
      +
      • +
    • +
      +

      APPLICATION_OCTET_STREAM_TYPE

      +
      public static final MediaType APPLICATION_OCTET_STREAM_TYPE
      +
      A MediaType constant representing "application/octet-stream" media type.
      +
      +
      • +
    • +
      +

      TEXT_PLAIN

      +
      public static final String TEXT_PLAIN
      +
      A String constant representing "text/plain" media type.
      +
      +
      See Also:
      +
      + +
      +
      +
      +
      • +
    • +
      +

      TEXT_PLAIN_TYPE

      +
      public static final MediaType TEXT_PLAIN_TYPE
      +
      A MediaType constant representing "text/plain" media type.
      +
      +
      • +
    • +
      +

      TEXT_XML

      +
      public static final String TEXT_XML
      +
      A String constant representing "text/xml" media type.
      +
      +
      See Also:
      +
      + +
      +
      +
      +
      • +
    • +
      +

      TEXT_XML_TYPE

      +
      public static final MediaType TEXT_XML_TYPE
      +
      A MediaType constant representing "text/xml" media type.
      +
      +
      • +
    • +
      +

      TEXT_HTML

      +
      public static final String TEXT_HTML
      +
      A String constant representing "text/html" media type.
      +
      +
      See Also:
      +
      + +
      +
      +
      +
      • +
    • +
      +

      TEXT_HTML_TYPE

      +
      public static final MediaType TEXT_HTML_TYPE
      +
      A MediaType constant representing "text/html" media type.
      +
      +
      • +
    • +
      +

      SERVER_SENT_EVENTS

      +
      public static final String SERVER_SENT_EVENTS
      +
      String representation of Server sent events media type. (""text/event-stream"").
      +
      +
      See Also:
      +
      + +
      +
      +
      +
      • +
    • +
      +

      SERVER_SENT_EVENTS_TYPE

      +
      public static final MediaType SERVER_SENT_EVENTS_TYPE
      +
      Server sent events media type.
      +
      +
      • +
    • +
      +

      APPLICATION_JSON_PATCH_JSON

      +
      public static final String APPLICATION_JSON_PATCH_JSON
      +
      String representation of "application/json-patch+json" media type..
      +
      +
      See Also:
      +
      + +
      +
      +
      +
      • +
    • +
      +

      APPLICATION_JSON_PATCH_JSON_TYPE

      +
      public static final MediaType APPLICATION_JSON_PATCH_JSON_TYPE
      +
      A MediaType constant representing "application/json-patch+json" media type.
      +
      +
      • +
    • +
      +

      APPLICATION_MERGE_PATCH_JSON

      +
      public static final String APPLICATION_MERGE_PATCH_JSON
      +
      String representation of "application/merge-patch+json" media type..
      +
      +
      See Also:
      +
      + +
      +
      +
      +
      • +
    • +
      +

      APPLICATION_MERGE_PATCH_JSON_TYPE

      +
      public static final MediaType APPLICATION_MERGE_PATCH_JSON_TYPE
      +
      A MediaType constant representing "application/merge-patch+json" media type.
      +
      +
      • +
    +
    +
    • + +
  • +
    +

    Constructor Details

    +
      +
    • +
      +

      MediaType

      +
      public MediaType(String type, + String subtype, + Map<String,String> parameters)
      +
      Creates a new instance of MediaType with the supplied type, subtype and parameters.
      +
      +
      Parameters:
      +
      type - the primary type, null is equivalent to MEDIA_TYPE_WILDCARD.
      +
      subtype - the subtype, null is equivalent to MEDIA_TYPE_WILDCARD.
      +
      parameters - a map of media type parameters, null is the same as an empty map.
      +
      +
      +
      • +
    • +
      +

      MediaType

      +
      public MediaType(String type, + String subtype)
      +
      Creates a new instance of MediaType with the supplied type and subtype.
      +
      +
      Parameters:
      +
      type - the primary type, null is equivalent to MEDIA_TYPE_WILDCARD
      +
      subtype - the subtype, null is equivalent to MEDIA_TYPE_WILDCARD
      +
      +
      +
      • +
    • +
      +

      MediaType

      +
      public MediaType(String type, + String subtype, + String charset)
      +
      Creates a new instance of MediaType with the supplied type, subtype and "charset" + parameter.
      +
      +
      Parameters:
      +
      type - the primary type, null is equivalent to MEDIA_TYPE_WILDCARD
      +
      subtype - the subtype, null is equivalent to MEDIA_TYPE_WILDCARD
      +
      charset - the "charset" parameter value. If null or empty the + "charset" parameter will not be set.
      +
      +
      +
      • +
    • +
      +

      MediaType

      +
      public MediaType()
      +
      Creates a new instance of MediaType, both type and subtype are wildcards. Consider using the constant + WILDCARD_TYPE instead.
      +
      +
      • +
    +
    +
    • + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      valueOf

      +
      public static MediaType valueOf(String type)
      +
      Creates a new instance of MediaType by parsing the supplied string.
      +
      +
      Parameters:
      +
      type - the media type string.
      +
      Returns:
      +
      the newly created MediaType.
      +
      Throws:
      +
      IllegalArgumentException - if the supplied string cannot be parsed or is null.
      +
      +
      +
      • +
    • +
      +

      getType

      +
      public String getType()
      +
      Getter for primary type.
      +
      +
      Returns:
      +
      value of primary type.
      +
      +
      +
      • +
    • +
      +

      isWildcardType

      +
      public boolean isWildcardType()
      +
      Checks if the primary type is a wildcard.
      +
      +
      Returns:
      +
      true if the primary type is a wildcard.
      +
      +
      +
      • +
    • +
      +

      getSubtype

      +
      public String getSubtype()
      +
      Getter for subtype.
      +
      +
      Returns:
      +
      value of subtype.
      +
      +
      +
      • +
    • +
      +

      isWildcardSubtype

      +
      public boolean isWildcardSubtype()
      +
      Checks if the subtype is a wildcard.
      +
      +
      Returns:
      +
      true if the subtype is a wildcard.
      +
      +
      +
      • +
    • +
      +

      getParameters

      +
      public Map<String,String> getParameters()
      +
      Getter for a read-only parameter map. Keys are case-insensitive.
      +
      +
      Returns:
      +
      an immutable map of parameters.
      +
      +
      +
      • +
    • +
      +

      withCharset

      +
      public MediaType withCharset(String charset)
      +
      Create a new MediaType instance with the same type, subtype and parameters copied from the original instance + and the supplied "charset" parameter.
      +
      +
      Parameters:
      +
      charset - the "charset" parameter value. If null or empty the + "charset" parameter will not be set or updated.
      +
      Returns:
      +
      copy of the current MediaType instance with the "charset" parameter set to the + supplied value.
      +
      Since:
      +
      2.0
      +
      +
      +
      • +
    • +
      +

      isCompatible

      +
      public boolean isCompatible(MediaType other)
      +
      Check if this media type is compatible with another media type. + Two media types are considered to be compatible if and only if their types are equal, + or one of them has a wildcard type, and their subtypes are equal or one of them has a wildcard subtype. + + Media type parameters are ignored. The function is commutative.
      +
      +
      Parameters:
      +
      other - the media type to compare with.
      +
      Returns:
      +
      true if the types are compatible, false otherwise.
      +
      +
      +
      • +
    • +
      +

      equals

      +
      public boolean equals(Object obj)
      +

      + Compares obj to this media type to see if they are the same by comparing type, subtype and parameters. Note + that the case-sensitivity of parameter values is dependent on the semantics of the parameter name, see + HTTP/1.1. This method assumes that values + are case-sensitive. +

      + Note that the equals(...) implementation does not perform a class equality check + (this.getClass() == obj.getClass()). Therefore any class that extends from MediaType class and needs + to override one of the equals(...) and hashCode() methods must always override both methods to + ensure the contract between Object.equals(java.lang.Object) and Object.hashCode() does not break.
      +
      +
      Overrides:
      +
      equals in class Object
      +
      Parameters:
      +
      obj - the object to compare to.
      +
      Returns:
      +
      true if the two media types are the same, false otherwise.
      +
      +
      +
      • +
    • +
      +

      hashCode

      +
      public int hashCode()
      +

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

      + Note that the equals(java.lang.Object) implementation does not perform a class equality check + (this.getClass() == obj.getClass()). Therefore any class that extends from MediaType class and needs + to override one of the equals(Object) and hashCode() methods must always override both methods to + ensure the contract between Object.equals(java.lang.Object) and Object.hashCode() does not break.
      +
      +
      Overrides:
      +
      hashCode in class Object
      +
      Returns:
      +
      a generated hash code.
      +
      +
      +
      • +
    • +
      +

      toString

      +
      public String toString()
      +
      Convert the media type to a string suitable for use as the value of a corresponding HTTP header.
      +
      +
      Overrides:
      +
      toString in class Object
      +
      Returns:
      +
      a string version of the media type.
      +
      +
      +
      • +
    +
    +
    • +
+
+ +
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/MultivaluedHashMap.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/MultivaluedHashMap.html new file mode 100644 index 0000000000..31578b3977 --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/MultivaluedHashMap.html @@ -0,0 +1,335 @@ + + + + +MultivaluedHashMap (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Module jakarta.ws.rs
+
Package jakarta.ws.rs.core
+

Class MultivaluedHashMap<K,V>

+
+
java.lang.Object +
jakarta.ws.rs.core.AbstractMultivaluedMap<K,V> +
jakarta.ws.rs.core.MultivaluedHashMap<K,V>
+
+
+
+
+
Type Parameters:
+
K - the type of keys maintained by this map.
+
V - the type of mapped values.
+
+
+
All Implemented Interfaces:
+
MultivaluedMap<K,V>, Serializable, Map<K,List<V>>
+
+
+
public class MultivaluedHashMap<K,V> +extends AbstractMultivaluedMap<K,V> +implements Serializable
+
A hash table based implementation of MultivaluedMap interface. + +

+ This implementation provides all of the optional map operations. This class makes no guarantees as to the order of + the map; in particular, it does not guarantee that the order will remain constant over time. The implementation + permits null key. By default the implementation does also permit null values, but ignores them. This + behavior can be customized by overriding the protected addNull(...) and + addFirstNull(...) methods. +

+

+ This implementation provides constant-time performance for the basic operations (get and put), + assuming the hash function disperses the elements properly among the buckets. Iteration over collection views + requires time proportional to the "capacity" of the map instance (the number of buckets) plus its size (the number of + key-value mappings). Thus, it's very important not to set the initial capacity too high (or the load factor too low) + if iteration performance is important. +

+

+ An instance of MultivaluedHashMap has two parameters that affect its performance: initial capacity + and load factor. The capacity is the number of buckets in the hash table, and the initial capacity is + simply the capacity at the time the hash table is created. The load factor is a measure of how full the hash + table is allowed to get before its capacity is automatically increased. When the number of entries in the hash table + exceeds the product of the load factor and the current capacity, the hash table is rehashed (that is, internal + data structures are rebuilt) so that the hash table has approximately twice the number of buckets. +

+

+ As a general rule, the default load factor (.75) offers a good tradeoff between time and space costs. Higher values + decrease the space overhead but increase the lookup cost (reflected in most of the operations of the HashMap + class, including get and put). The expected number of entries in the map and its load factor should + be taken into account when setting its initial capacity, so as to minimize the number of rehash operations. If the + initial capacity is greater than the maximum number of entries divided by the load factor, no rehash operations will + ever occur. +

+

+ If many mappings are to be stored in a MultivaluedHashMap instance, creating it with a sufficiently large + capacity will allow the mappings to be stored more efficiently than letting it perform automatic rehashing as needed + to grow the table. +

+

+ Note that this implementation is not guaranteed to be synchronized. If multiple threads access a + hash map concurrently, and at least one of the threads modifies the map structurally, it must be synchronized + externally. (A structural modification is any operation that adds or deletes one or more mappings; merely changing + the value associated with a key that an instance already contains is not a structural modification.) This is + typically accomplished by synchronizing on some object that naturally encapsulates the map. +

+

+ The iterators returned by all of this class's "collection view methods" are fail-fast: if the map is + structurally modified at any time after the iterator is created, in any way except through the iterator's own + remove method, the iterator will throw a ConcurrentModificationException. Thus, in the face of + concurrent modification, the iterator fails quickly and cleanly, rather than risking arbitrary, non-deterministic + behavior at an undetermined time in the future. +

+ Note that the fail-fast behavior of an iterator cannot be guaranteed as it is, generally speaking, impossible to make + any hard guarantees in the presence of unsynchronized concurrent modification. Fail-fast iterators throw + ConcurrentModificationException on a best-effort basis. Therefore, it would be wrong to write a program that + depended on this exception for its correctness: the fail-fast behavior of iterators should be used only to detect + bugs.
+
+
Since:
+
2.0
+
Author:
+
Paul Sandoz, Marek Potociar
+
See Also:
+
+ +
+
+
+
+ +
+
+
    + +
  • +
    +

    Constructor Details

    +
      +
    • +
      +

      MultivaluedHashMap

      +
      public MultivaluedHashMap()
      +
      Constructs an empty multivalued hash map with the default initial capacity (16) and the default load factor + (0.75).
      +
      +
      • +
    • +
      +

      MultivaluedHashMap

      +
      public MultivaluedHashMap(int initialCapacity)
      +
      Constructs an empty multivalued hash map with the specified initial capacity and the default load factor + (0.75).
      +
      +
      Parameters:
      +
      initialCapacity - the initial capacity.
      +
      Throws:
      +
      IllegalArgumentException - if the initial capacity is negative.
      +
      +
      +
      • +
    • +
      +

      MultivaluedHashMap

      +
      public MultivaluedHashMap(int initialCapacity, + float loadFactor)
      +
      Constructs an empty multivalued hash map with the specified initial capacity and load factor.
      +
      +
      Parameters:
      +
      initialCapacity - the initial capacity
      +
      loadFactor - the load factor
      +
      Throws:
      +
      IllegalArgumentException - if the initial capacity is negative or the load factor is nonpositive
      +
      +
      +
      • +
    • +
      +

      MultivaluedHashMap

      +
      public MultivaluedHashMap(MultivaluedMap<? extends K,? extends V> map)
      +
      Constructs a new multivalued hash map with the same mappings as the specified MultivaluedMap. The + List instances holding the values of each key are created anew instead of being reused.
      +
      +
      Parameters:
      +
      map - the multivalued map whose mappings are to be placed in this multivalued map.
      +
      Throws:
      +
      NullPointerException - if the specified map is null
      +
      +
      +
      • +
    • +
      +

      MultivaluedHashMap

      +
      public MultivaluedHashMap(Map<? extends K,? extends V> map)
      +
      Constructs a new multivalued hash map with the same mappings as the specified single-valued Map.
      +
      +
      Parameters:
      +
      map - the single-valued map whose mappings are to be placed in this multivalued map.
      +
      Throws:
      +
      NullPointerException - if the specified map is null
      +
      +
      +
      • +
    +
    +
    • +
+
+ +
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/MultivaluedMap.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/MultivaluedMap.html new file mode 100644 index 0000000000..10cd901e88 --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/MultivaluedMap.html @@ -0,0 +1,317 @@ + + + + +MultivaluedMap (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Module jakarta.ws.rs
+
Package jakarta.ws.rs.core
+

Interface MultivaluedMap<K,V>

+
+
+
+
Type Parameters:
+
K - the type of keys maintained by this map
+
V - the type of mapped values
+
+
+
All Superinterfaces:
+
Map<K,List<V>>
+
+
+
All Known Implementing Classes:
+
AbstractMultivaluedMap, MultivaluedHashMap
+
+
+
public interface MultivaluedMap<K,V> +extends Map<K,List<V>>
+
A map of key-values pairs. Each key can have zero or more values.
+
+
Since:
+
1.0
+
Author:
+
Paul Sandoz, Marc Hadley, Marek Potociar
+
+
+
+ +
+
+
    + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      putSingle

      +
      void putSingle(K key, + V value)
      +
      Set the key's value to be a one item list consisting of the supplied value. Any existing values will be replaced.
      +
      +
      Parameters:
      +
      key - the key
      +
      value - the single value of the key
      +
      +
      +
      • +
    • +
      +

      add

      +
      void add(K key, + V value)
      +
      Add a value to the current list of values for the supplied key.
      +
      +
      Parameters:
      +
      key - the key
      +
      value - the value to be added.
      +
      +
      +
      • +
    • +
      +

      getFirst

      +
      V getFirst(K key)
      +
      A shortcut to get the first value of the supplied key.
      +
      +
      Parameters:
      +
      key - the key
      +
      Returns:
      +
      the first value for the specified key or null if the key is not in the map.
      +
      +
      +
      • +
    • +
      +

      addAll

      +
      void addAll(K key, + V... newValues)
      +
      Add multiple values to the current list of values for the supplied key. If the supplied array of new values is empty, + method returns immediately. Method throws a NullPointerException if the supplied array of values is + null.
      +
      +
      Parameters:
      +
      key - the key.
      +
      newValues - the values to be added.
      +
      Throws:
      +
      NullPointerException - if the supplied array of new values is null.
      +
      Since:
      +
      2.0
      +
      +
      +
      • +
    • +
      +

      addAll

      +
      void addAll(K key, + List<V> valueList)
      +
      Add all the values from the supplied value list to the current list of values for the supplied key. If the supplied + value list is empty, method returns immediately. Method throws a NullPointerException if the supplied array + of values is null.
      +
      +
      Parameters:
      +
      key - the key.
      +
      valueList - the list of values to be added.
      +
      Throws:
      +
      NullPointerException - if the supplied value list is null.
      +
      Since:
      +
      2.0
      +
      +
      +
      • +
    • +
      +

      addFirst

      +
      void addFirst(K key, + V value)
      +
      Add a value to the first position in the current list of values for the supplied key.
      +
      +
      Parameters:
      +
      key - the key
      +
      value - the value to be added.
      +
      Since:
      +
      2.0
      +
      +
      +
      • +
    • +
      +

      equalsIgnoreValueOrder

      +
      boolean equalsIgnoreValueOrder(MultivaluedMap<K,V> otherMap)
      +
      Compare the specified map with this map for equality modulo the order of values for each key. Specifically, the + values associated with each key are compared as if they were ordered lists.
      +
      +
      Parameters:
      +
      otherMap - map to be compared to this one.
      +
      Returns:
      +
      true if the maps are equal modulo value ordering.
      +
      Since:
      +
      2.0
      +
      +
      +
      • +
    +
    +
    • +
+
+ +
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/NewCookie.AbstractNewCookieBuilder.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/NewCookie.AbstractNewCookieBuilder.html new file mode 100644 index 0000000000..58c92dab06 --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/NewCookie.AbstractNewCookieBuilder.html @@ -0,0 +1,364 @@ + + + + +NewCookie.AbstractNewCookieBuilder (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Module jakarta.ws.rs
+
Package jakarta.ws.rs.core
+

Class NewCookie.AbstractNewCookieBuilder<T extends NewCookie.AbstractNewCookieBuilder<T>>

+
+
java.lang.Object +
jakarta.ws.rs.core.Cookie.AbstractCookieBuilder<NewCookie.AbstractNewCookieBuilder<T>> +
jakarta.ws.rs.core.NewCookie.AbstractNewCookieBuilder<T>
+
+
+
+
+
Type Parameters:
+
T - the current AbstractNewCookieBuilder type.
+
+
+
Direct Known Subclasses:
+
NewCookie.Builder
+
+
+
Enclosing class:
+
NewCookie
+
+
+
public abstract static class NewCookie.AbstractNewCookieBuilder<T extends NewCookie.AbstractNewCookieBuilder<T>> +extends Cookie.AbstractCookieBuilder<NewCookie.AbstractNewCookieBuilder<T>>
+
JAX-RS abstract NewCookie builder class.
+
+
Since:
+
3.1
+
+
+
+ +
+
+
    + +
  • +
    +

    Constructor Details

    +
      +
    • +
      +

      AbstractNewCookieBuilder

      +
      public AbstractNewCookieBuilder(String name)
      +
      Create a new instance.
      +
      +
      Parameters:
      +
      name - the name of the cookie.
      +
      +
      +
      • +
    • +
      +

      AbstractNewCookieBuilder

      +
      public AbstractNewCookieBuilder(Cookie cookie)
      +
      Create a new instance supplementing the information in the supplied cookie.
      +
      +
      Parameters:
      +
      cookie - the cookie to clone.
      +
      +
      +
      • +
    +
    +
    • + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      comment

      +
      public T comment(String comment)
      +
      Set the comment associated with the cookie.
      +
      +
      Parameters:
      +
      comment - the comment.
      +
      Returns:
      +
      the updated builder instance.
      +
      +
      +
      • +
    • +
      +

      maxAge

      +
      public T maxAge(int maxAge)
      +
      Set the maximum age of the the cookie in seconds. Cookies older than the maximum age are discarded. A cookie can be + unset by sending a new cookie with maximum age of 0 since it will overwrite any existing cookie and then be + immediately discarded. The default value of -1 indicates that the cookie will be discarded at the end of the + browser/application session.
      +
      +
      Parameters:
      +
      maxAge - the maximum age in seconds.
      +
      Returns:
      +
      the updated builder instance.
      +
      See Also:
      +
      + +
      +
      +
      +
      • +
    • +
      +

      expiry

      +
      public T expiry(Date expiry)
      +
      Set the cookie expiry date. Cookies whose expiry date has passed are discarded. A cookie can be unset by setting a + new cookie with an expiry date in the past, typically the lowest possible date that can be set. +

      + Note that it is recommended to use Max-Age to control cookie expiration, however some browsers + do not understand Max-Age, in which case setting Expires parameter may be necessary. +

      +
      +
      Parameters:
      +
      expiry - the cookie expiry date
      +
      Returns:
      +
      the updated builder instance.
      +
      See Also:
      +
      + +
      +
      +
      +
      • +
    • +
      +

      secure

      +
      public T secure(boolean secure)
      +
      Whether the cookie will only be sent over a secure connection. Defaults to false.
      +
      +
      Parameters:
      +
      secure - specifies whether the cookie will only be sent over a secure connection.
      +
      Returns:
      +
      the updated builder instance.
      +
      +
      +
      • +
    • +
      +

      httpOnly

      +
      public T httpOnly(boolean httpOnly)
      +
      Whether the cookie will only be visible as part of an HTTP request. Defaults to false.
      +
      +
      Parameters:
      +
      httpOnly - if true make the cookie HTTP only, i.e. only visible as part of an HTTP request.
      +
      Returns:
      +
      the updated builder instance.
      +
      +
      +
      • +
    • +
      +

      sameSite

      +
      public T sameSite(NewCookie.SameSite sameSite)
      +
      Set the attribute that controls whether the cookie is sent with cross-origin requests, providing protection against + cross-site request forgery.
      +
      +
      Parameters:
      +
      sameSite - specifies the value of the SameSite cookie attribute.
      +
      Returns:
      +
      the updated builder instance.
      +
      +
      +
      • +
    • +
      +

      build

      +
      public abstract NewCookie build()
      +
      Build a new NewCookie instance using all the configuration previously specified in this builder.
      +
      +
      Specified by:
      +
      build in class Cookie.AbstractCookieBuilder<NewCookie.AbstractNewCookieBuilder<T extends NewCookie.AbstractNewCookieBuilder<T>>>
      +
      Returns:
      +
      a new NewCookie instance.
      +
      Throws:
      +
      IllegalArgumentException - if name is null.
      +
      +
      +
      • +
    +
    +
    • +
+
+ +
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/NewCookie.Builder.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/NewCookie.Builder.html new file mode 100644 index 0000000000..6a6324f51f --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/NewCookie.Builder.html @@ -0,0 +1,243 @@ + + + + +NewCookie.Builder (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Module jakarta.ws.rs
+
Package jakarta.ws.rs.core
+

Class NewCookie.Builder

+
+
java.lang.Object +
jakarta.ws.rs.core.Cookie.AbstractCookieBuilder<NewCookie.AbstractNewCookieBuilder<NewCookie.Builder>> +
jakarta.ws.rs.core.NewCookie.AbstractNewCookieBuilder<NewCookie.Builder> +
jakarta.ws.rs.core.NewCookie.Builder
+
+
+
+
+
+
Enclosing class:
+
NewCookie
+
+
+
public static class NewCookie.Builder +extends NewCookie.AbstractNewCookieBuilder<NewCookie.Builder>
+
JAX-RS NewCookie builder class. +

+ New Cookie builder provides methods that let you conveniently configure and subsequently build a new + NewCookie instance. +

+ For example: + + 
+ NewCookie cookie = new NewCookie.Builder("name")
+         .path("/")
+         .domain("domain.com")
+         .sameSite(SameSite.LAX)
+         .build();
+
+
+
Since:
+
3.1
+
+
+
+ +
+
+
    + +
  • +
    +

    Constructor Details

    +
      +
    • +
      +

      Builder

      +
      public Builder(String name)
      +
      Create a new instance.
      +
      +
      Parameters:
      +
      name - the name of the cookie.
      +
      +
      +
      • +
    • +
      +

      Builder

      +
      public Builder(Cookie cookie)
      +
      Create a new instance supplementing the information in the supplied cookie.
      +
      +
      Parameters:
      +
      cookie - the cookie to clone.
      +
      +
      +
      • +
    +
    +
    • + +
  • +
    +

    Method Details

    + +
    +
    • +
+
+ +
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/NewCookie.SameSite.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/NewCookie.SameSite.html new file mode 100644 index 0000000000..28f07b4a16 --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/NewCookie.SameSite.html @@ -0,0 +1,264 @@ + + + + +NewCookie.SameSite (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Module jakarta.ws.rs
+
Package jakarta.ws.rs.core
+

Enum Class NewCookie.SameSite

+
+
java.lang.Object +
java.lang.Enum<NewCookie.SameSite> +
jakarta.ws.rs.core.NewCookie.SameSite
+
+
+
+
+
All Implemented Interfaces:
+
Serializable, Comparable<NewCookie.SameSite>, Constable
+
+
+
Enclosing class:
+
NewCookie
+
+
+
public static enum NewCookie.SameSite +extends Enum<NewCookie.SameSite>
+
The available values for the SameSite cookie attribute.
+
+
Since:
+
3.1
+
+
+
+ +
+
+
    + +
  • +
    +

    Enum Constant Details

    +
      +
    • +
      +

      NONE

      +
      public static final NewCookie.SameSite NONE
      +
      The None mode disables protection provided by the SameSite cookie attribute.
      +
      +
      • +
    • +
      +

      LAX

      +
      public static final NewCookie.SameSite LAX
      +
      The Lax mode only allows to send cookies for cross-site top level navigation requests.
      +
      +
      • +
    • +
      +

      STRICT

      +
      public static final NewCookie.SameSite STRICT
      +
      The Strict mode prevents clients from sending cookies with any cross-site request.
      +
      +
      • +
    +
    +
    • + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      values

      +
      public static NewCookie.SameSite[] values()
      +
      Returns an array containing the constants of this enum class, in +the order they are declared.
      +
      +
      Returns:
      +
      an array containing the constants of this enum class, in the order they are declared
      +
      +
      +
      • +
    • +
      +

      valueOf

      +
      public static NewCookie.SameSite valueOf(String name)
      +
      Returns the enum constant of this class with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this class. (Extraneous whitespace characters are +not permitted.)
      +
      +
      Parameters:
      +
      name - the name of the enum constant to be returned.
      +
      Returns:
      +
      the enum constant with the specified name
      +
      Throws:
      +
      IllegalArgumentException - if this enum class has no constant with the specified name
      +
      NullPointerException - if the argument is null
      +
      +
      +
      • +
    +
    +
    • +
+
+ +
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/NewCookie.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/NewCookie.html new file mode 100644 index 0000000000..b8a340ef29 --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/NewCookie.html @@ -0,0 +1,926 @@ + + + + +NewCookie (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Module jakarta.ws.rs
+
Package jakarta.ws.rs.core
+

Class NewCookie

+
+
java.lang.Object +
jakarta.ws.rs.core.Cookie +
jakarta.ws.rs.core.NewCookie
+
+
+
+
+
public class NewCookie +extends Cookie
+
Used to create a new HTTP cookie, transferred in a response.
+
+
Since:
+
1.0
+
Author:
+
Paul Sandoz, Marc Hadley
+
See Also:
+
+ +
+
+
+
+ +
+
+
    + +
  • +
    +

    Field Details

    +
      +
    • +
      +

      DEFAULT_MAX_AGE

      +
      public static final int DEFAULT_MAX_AGE
      +
      Specifies that the cookie expires with the current application/browser session.
      +
      +
      See Also:
      +
      + +
      +
      +
      +
      • +
    +
    +
    • + +
  • +
    +

    Constructor Details

    +
      +
    • +
      +

      NewCookie

      +
      @Deprecated +public NewCookie(String name, + String value)
      +
      Deprecated. +
      This constructor will be removed in a future version. Please use NewCookie.Builder instead.
      +
      +
      Create a new instance.
      +
      +
      Parameters:
      +
      name - the name of the cookie.
      +
      value - the value of the cookie.
      +
      Throws:
      +
      IllegalArgumentException - if name is null.
      +
      +
      +
      • +
    • +
      +

      NewCookie

      +
      @Deprecated +public NewCookie(String name, + String value, + String path, + String domain, + String comment, + int maxAge, + boolean secure)
      +
      Deprecated. +
      This constructor will be removed in a future version. Please use NewCookie.Builder instead.
      +
      +
      Create a new instance.
      +
      +
      Parameters:
      +
      name - the name of the cookie.
      +
      value - the value of the cookie.
      +
      path - the URI path for which the cookie is valid.
      +
      domain - the host domain for which the cookie is valid.
      +
      comment - the comment.
      +
      maxAge - the maximum age of the cookie in seconds.
      +
      secure - specifies whether the cookie will only be sent over a secure connection.
      +
      Throws:
      +
      IllegalArgumentException - if name is null.
      +
      +
      +
      • +
    • +
      +

      NewCookie

      +
      @Deprecated +public NewCookie(String name, + String value, + String path, + String domain, + String comment, + int maxAge, + boolean secure, + boolean httpOnly)
      +
      Deprecated. +
      This constructor will be removed in a future version. Please use NewCookie.Builder instead.
      +
      +
      Create a new instance.
      +
      +
      Parameters:
      +
      name - the name of the cookie.
      +
      value - the value of the cookie.
      +
      path - the URI path for which the cookie is valid.
      +
      domain - the host domain for which the cookie is valid.
      +
      comment - the comment.
      +
      maxAge - the maximum age of the cookie in seconds.
      +
      secure - specifies whether the cookie will only be sent over a secure connection.
      +
      httpOnly - if true make the cookie HTTP only, i.e. only visible as part of an HTTP request.
      +
      Throws:
      +
      IllegalArgumentException - if name is null.
      +
      Since:
      +
      2.0
      +
      +
      +
      • +
    • +
      +

      NewCookie

      +
      @Deprecated +public NewCookie(String name, + String value, + String path, + String domain, + int version, + String comment, + int maxAge, + boolean secure)
      +
      Deprecated. +
      This constructor will be removed in a future version. Please use NewCookie.Builder instead.
      +
      +
      Create a new instance.
      +
      +
      Parameters:
      +
      name - the name of the cookie
      +
      value - the value of the cookie
      +
      path - the URI path for which the cookie is valid
      +
      domain - the host domain for which the cookie is valid
      +
      version - the version of the specification to which the cookie complies
      +
      comment - the comment
      +
      maxAge - the maximum age of the cookie in seconds
      +
      secure - specifies whether the cookie will only be sent over a secure connection
      +
      Throws:
      +
      IllegalArgumentException - if name is null.
      +
      +
      +
      • +
    • +
      +

      NewCookie

      +
      @Deprecated +public NewCookie(String name, + String value, + String path, + String domain, + int version, + String comment, + int maxAge, + Date expiry, + boolean secure, + boolean httpOnly)
      +
      Deprecated. +
      This constructor will be removed in a future version. Please use NewCookie.Builder instead.
      +
      +
      Create a new instance.
      +
      +
      Parameters:
      +
      name - the name of the cookie
      +
      value - the value of the cookie
      +
      path - the URI path for which the cookie is valid
      +
      domain - the host domain for which the cookie is valid
      +
      version - the version of the specification to which the cookie complies
      +
      comment - the comment
      +
      maxAge - the maximum age of the cookie in seconds
      +
      expiry - the cookie expiry date.
      +
      secure - specifies whether the cookie will only be sent over a secure connection
      +
      httpOnly - if true make the cookie HTTP only, i.e. only visible as part of an HTTP request.
      +
      Throws:
      +
      IllegalArgumentException - if name is null.
      +
      Since:
      +
      2.0
      +
      +
      +
      • +
    • +
      +

      NewCookie

      +
      @Deprecated +public NewCookie(String name, + String value, + String path, + String domain, + int version, + String comment, + int maxAge, + Date expiry, + boolean secure, + boolean httpOnly, + NewCookie.SameSite sameSite)
      +
      Deprecated. +
      This constructor will be removed in a future version. Please use NewCookie.Builder instead.
      +
      +
      Create a new instance.
      +
      +
      Parameters:
      +
      name - the name of the cookie
      +
      value - the value of the cookie
      +
      path - the URI path for which the cookie is valid
      +
      domain - the host domain for which the cookie is valid
      +
      version - the version of the specification to which the cookie complies
      +
      comment - the comment
      +
      maxAge - the maximum age of the cookie in seconds
      +
      expiry - the cookie expiry date.
      +
      secure - specifies whether the cookie will only be sent over a secure connection
      +
      httpOnly - if true make the cookie HTTP only, i.e. only visible as part of an HTTP request.
      +
      sameSite - specifies the value of the SameSite cookie attribute
      +
      Throws:
      +
      IllegalArgumentException - if name is null.
      +
      Since:
      +
      3.1
      +
      +
      +
      • +
    • +
      +

      NewCookie

      +
      @Deprecated +public NewCookie(Cookie cookie)
      +
      Deprecated. +
      This constructor will be removed in a future version. Please use NewCookie.Builder instead.
      +
      +
      Create a new instance copying the information in the supplied cookie.
      +
      +
      Parameters:
      +
      cookie - the cookie to clone.
      +
      Throws:
      +
      IllegalArgumentException - if cookie is null.
      +
      +
      +
      • +
    • +
      +

      NewCookie

      +
      @Deprecated +public NewCookie(Cookie cookie, + String comment, + int maxAge, + boolean secure)
      +
      Deprecated. +
      This constructor will be removed in a future version. Please use NewCookie.Builder instead.
      +
      +
      Create a new instance supplementing the information in the supplied cookie.
      +
      +
      Parameters:
      +
      cookie - the cookie to clone.
      +
      comment - the comment.
      +
      maxAge - the maximum age of the cookie in seconds.
      +
      secure - specifies whether the cookie will only be sent over a secure connection.
      +
      Throws:
      +
      IllegalArgumentException - if cookie is null.
      +
      +
      +
      • +
    • +
      +

      NewCookie

      +
      @Deprecated +public NewCookie(Cookie cookie, + String comment, + int maxAge, + Date expiry, + boolean secure, + boolean httpOnly)
      +
      Deprecated. +
      This constructor will be removed in a future version. Please use NewCookie.Builder instead.
      +
      +
      Create a new instance supplementing the information in the supplied cookie.
      +
      +
      Parameters:
      +
      cookie - the cookie to clone.
      +
      comment - the comment.
      +
      maxAge - the maximum age of the cookie in seconds.
      +
      expiry - the cookie expiry date.
      +
      secure - specifies whether the cookie will only be sent over a secure connection.
      +
      httpOnly - if true make the cookie HTTP only, i.e. only visible as part of an HTTP request.
      +
      Throws:
      +
      IllegalArgumentException - if cookie is null.
      +
      Since:
      +
      2.0
      +
      +
      +
      • +
    • +
      +

      NewCookie

      +
      @Deprecated +public NewCookie(Cookie cookie, + String comment, + int maxAge, + Date expiry, + boolean secure, + boolean httpOnly, + NewCookie.SameSite sameSite)
      +
      Deprecated. +
      This constructor will be removed in a future version. Please use NewCookie.Builder instead.
      +
      +
      Create a new instance supplementing the information in the supplied cookie.
      +
      +
      Parameters:
      +
      cookie - the cookie to clone.
      +
      comment - the comment.
      +
      maxAge - the maximum age of the cookie in seconds.
      +
      expiry - the cookie expiry date.
      +
      secure - specifies whether the cookie will only be sent over a secure connection.
      +
      httpOnly - if true make the cookie HTTP only, i.e. only visible as part of an HTTP request.
      +
      sameSite - specifies the value of the SameSite cookie attribute
      +
      Throws:
      +
      IllegalArgumentException - if cookie is null.
      +
      Since:
      +
      3.1
      +
      +
      +
      • +
    • +
      +

      NewCookie

      +
      protected NewCookie(NewCookie.AbstractNewCookieBuilder<?> builder)
      +
      Create a new instance from the supplied NewCookie.AbstractNewCookieBuilder instance.
      +
      +
      Parameters:
      +
      builder - the builder.
      +
      Throws:
      +
      IllegalArgumentException - if builder.name is null.
      +
      Since:
      +
      3.1
      +
      +
      +
      • +
    +
    +
    • + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      valueOf

      +
      @Deprecated +public static NewCookie valueOf(String value)
      +
      Deprecated. +
      This method will be removed in a future version. Please use + RuntimeDelegate.getInstance().createHeaderDelegate(NewCookie.class).fromString(value) instead.
      +
      +
      Creates a new instance of NewCookie by parsing the supplied string.
      +
      +
      Parameters:
      +
      value - the cookie string.
      +
      Returns:
      +
      the newly created NewCookie.
      +
      Throws:
      +
      IllegalArgumentException - if the supplied string cannot be parsed or is null.
      +
      +
      +
      • +
    • +
      +

      getComment

      +
      public String getComment()
      +
      Get the comment associated with the cookie.
      +
      +
      Returns:
      +
      the comment or null if none set
      +
      +
      +
      • +
    • +
      +

      getMaxAge

      +
      public int getMaxAge()
      +
      Get the maximum age of the the cookie in seconds. Cookies older than the maximum age are discarded. A cookie can be + unset by sending a new cookie with maximum age of 0 since it will overwrite any existing cookie and then be + immediately discarded. The default value of -1 indicates that the cookie will be discarded at the end of the + browser/application session. +

      + Note that it is recommended to use Max-Age to control cookie expiration, however some browsers do not + understand Max-Age, in which case setting getExpiry() Expires} parameter may be necessary. +

      +
      +
      Returns:
      +
      the maximum age in seconds.
      +
      See Also:
      +
      + +
      +
      +
      +
      • +
    • +
      +

      getExpiry

      +
      public Date getExpiry()
      +
      Get the cookie expiry date. Cookies whose expiry date has passed are discarded. A cookie can be unset by setting a + new cookie with an expiry date in the past, typically the lowest possible date that can be set. +

      + Note that it is recommended to use Max-Age to control cookie expiration, however some browsers + do not understand Max-Age, in which case setting Expires parameter may be necessary. +

      +
      +
      Returns:
      +
      cookie expiry date or null if no expiry date was set.
      +
      Since:
      +
      2.0
      +
      See Also:
      +
      + +
      +
      +
      +
      • +
    • +
      +

      isSecure

      +
      public boolean isSecure()
      +
      Whether the cookie will only be sent over a secure connection. Defaults to false.
      +
      +
      Returns:
      +
      true if the cookie will only be sent over a secure connection, false otherwise.
      +
      +
      +
      • +
    • +
      +

      isHttpOnly

      +
      public boolean isHttpOnly()
      +
      Returns true if this cookie contains the HttpOnly attribute. This means that the cookie should not be + accessible to scripting engines, like javascript.
      +
      +
      Returns:
      +
      true if this cookie should be considered http only, false otherwise.
      +
      Since:
      +
      2.0
      +
      +
      +
      • +
    • +
      +

      getSameSite

      +
      public NewCookie.SameSite getSameSite()
      +
      Returns the value of the SameSite attribute for this cookie or null if the attribute is not set. + This attributes controls whether the cookie is sent with cross-origin requests, providing protection against + cross-site request forgery.
      +
      +
      Returns:
      +
      the value of the SameSite cookie attribute or null.
      +
      Since:
      +
      3.1
      +
      +
      +
      • +
    • +
      +

      toCookie

      +
      public Cookie toCookie()
      +
      Obtain a new instance of a Cookie with the same name, value, path, domain and version as this + NewCookie. This method can be used to obtain an object that can be compared for equality with another + Cookie; since a Cookie will never compare equal to a NewCookie.
      +
      +
      Returns:
      +
      a Cookie
      +
      +
      +
      • +
    • +
      +

      toString

      +
      @Deprecated +public String toString()
      +
      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.
      +
      +
      Convert the cookie to a string suitable for use as the value of the corresponding HTTP header.
      +
      +
      Overrides:
      +
      toString in class Cookie
      +
      Returns:
      +
      a stringified cookie.
      +
      +
      +
      • +
    • +
      +

      hashCode

      +
      public int hashCode()
      +
      Generate a hash code by hashing all of the properties.
      +
      +
      Overrides:
      +
      hashCode in class Cookie
      +
      Returns:
      +
      the hash code.
      +
      +
      +
      • +
    • +
      +

      equals

      +
      public boolean equals(Object obj)
      +
      Compare for equality. Use toCookie() to compare a NewCookie to a Cookie considering only the + common properties.
      +
      +
      Overrides:
      +
      equals in class Cookie
      +
      Parameters:
      +
      obj - the object to compare to
      +
      Returns:
      +
      true if the object is a NewCookie with the same value for all properties, false otherwise.
      +
      +
      +
      • +
    +
    +
    • +
+
+ +
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/NoContentException.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/NoContentException.html new file mode 100644 index 0000000000..d5a641216f --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/NoContentException.html @@ -0,0 +1,225 @@ + + + + +NoContentException (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Module jakarta.ws.rs
+
Package jakarta.ws.rs.core
+

Class NoContentException

+
+
java.lang.Object +
java.lang.Throwable +
java.lang.Exception +
java.io.IOException +
jakarta.ws.rs.core.NoContentException
+
+
+
+
+
+
+
All Implemented Interfaces:
+
Serializable
+
+
+
public class NoContentException +extends IOException
+
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. +

+ This exception, when thrown while reading a server request entity, is automatically translated by JAX-RS server + runtime into a BadRequestException wrapping the original NoContentException and rethrown + for a standard processing by the registered exception mappers. +

+
+
Since:
+
2.0
+
Author:
+
Marek Potociar (marek.potociar at oracle.com)
+
See Also:
+
+ +
+
+
+
+ +
+
+
    + +
  • +
    +

    Constructor Details

    +
      +
    • +
      +

      NoContentException

      +
      public NoContentException(String message)
      +
      Construct a new NoContentException instance.
      +
      +
      Parameters:
      +
      message - the detail message (which is saved for later retrieval by the Throwable.getMessage() method).
      +
      +
      +
      • +
    • +
      +

      NoContentException

      +
      public NoContentException(String message, + Throwable cause)
      +
      Construct a new NoContentException instance.
      +
      +
      Parameters:
      +
      message - the detail message (which is saved for later retrieval by the Throwable.getMessage() method).
      +
      cause - the underlying cause of the exception.
      +
      +
      +
      • +
    • +
      +

      NoContentException

      +
      public NoContentException(Throwable cause)
      +
      Construct a new NoContentException instance.
      +
      +
      Parameters:
      +
      cause - the underlying cause of the exception.
      +
      +
      +
      • +
    +
    +
    • +
+
+ +
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/PathSegment.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/PathSegment.html new file mode 100644 index 0000000000..54b26860f2 --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/PathSegment.html @@ -0,0 +1,192 @@ + + + + +PathSegment (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Module jakarta.ws.rs
+
Package jakarta.ws.rs.core
+

Interface PathSegment

+
+
+
+
public interface PathSegment
+
Represents a URI path segment and any associated matrix parameters. When an instance of this type is injected with + PathParam, the value of the annotation identifies which path segment is selected and the presence + of an Encoded annotation will result in an instance that supplies the path and matrix parameter + values in URI encoded form.
+
+
Since:
+
1.0
+
Author:
+
Paul Sandoz, Marc Hadley
+
See Also:
+
+ +
+
+
+
+
    + +
  • +
    +

    Method Summary

    +
    +
    +
    +
    +
    Modifier and Type
    +
    Method
    +
    Description
    +
    MultivaluedMap<String,String>
    +
    getMatrixParameters()
    +
    +
    Get a map of the matrix parameters associated with the path segment.
    +
    +
    String
    +
    getPath()
    +
    +
    Get the path segment.
    +
    +
    +
    +
    +
    +
    • +
+
+
+
    + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      getPath

      +
      String getPath()
      +
      Get the path segment.
      +
      +
      Returns:
      +
      the path segment
      +
      +
      +
      • +
    • +
      +

      getMatrixParameters

      +
      MultivaluedMap<String,String> getMatrixParameters()
      +
      Get a map of the matrix parameters associated with the path segment. The map keys are the names of the matrix + parameters with any percent-escaped octets decoded.
      +
      +
      Returns:
      +
      the map of matrix parameters
      +
      See Also:
      +
      + +
      +
      +
      +
      • +
    +
    +
    • +
+
+ +
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/Request.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/Request.html new file mode 100644 index 0000000000..1b681112c7 --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/Request.html @@ -0,0 +1,311 @@ + + + + +Request (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Module jakarta.ws.rs
+
Package jakarta.ws.rs.core
+

Interface Request

+
+
+
+
public interface Request
+
An injectable helper for request processing, all methods throw an IllegalStateException if called outside the + scope of a request (e.g. from a provider constructor). + + Precondition processing (see the evaluatePreconditions methods) can result in either a null return + value to indicate that preconditions have been met and that the request should continue, or a non-null return + value to indicate that preconditions were not met. In the event that preconditions were not met, the returned + ResponseBuilder instance will have an appropriate status and will also include a Vary header if the + selectVariant(List) method was called prior to to calling evaluatePreconditions. It is the + responsibility of the caller to check the status and add additional metadata if required. E.g., see + HTTP/1.1, section 10.3.5 for details + of the headers that are expected to accompany a 304 Not Modified response.
+
+
Since:
+
1.0
+
Author:
+
Paul Sandoz, Marc Hadley, Marek Potociar
+
+
+
+ +
+
+
    + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      getMethod

      +
      String getMethod()
      +
      Get the request method, e.g. GET, POST, etc.
      +
      +
      Returns:
      +
      the request method.
      +
      See Also:
      +
      + +
      +
      +
      +
      • +
    • +
      +

      selectVariant

      +
      Variant selectVariant(List<Variant> variants)
      +
      Select the representation variant that best matches the request. Returns null in case there is no matching + variant in the list. +

      + More explicit variants are chosen ahead of less explicit ones. A vary header is computed from the supplied list and + automatically added to the response. +

      +
      +
      Parameters:
      +
      variants - a list of Variant that describe all of the available representation variants.
      +
      Returns:
      +
      the variant that best matches the request or null if there's no match.
      +
      Throws:
      +
      IllegalArgumentException - if variants is empty or null.
      +
      IllegalStateException - if called outside the scope of a request.
      +
      See Also:
      +
      + +
      +
      +
      +
      • +
    • +
      +

      evaluatePreconditions

      +
      Response.ResponseBuilder evaluatePreconditions(EntityTag eTag)
      +
      Evaluate request preconditions based on the passed in value.
      +
      +
      Parameters:
      +
      eTag - an ETag for the current state of the resource
      +
      Returns:
      +
      null if the preconditions are met or a ResponseBuilder set with the appropriate status if the + preconditions are not met. A returned ResponseBuilder will include an ETag header set with the value of eTag, + provided none of the precondition evaluation has failed, in which case the ETag header would not be included and the + status code of the returned ResponseBuilder would be set to Response.Status.PRECONDITION_FAILED.
      +
      Throws:
      +
      IllegalArgumentException - if eTag is null.
      +
      IllegalStateException - if called outside the scope of a request.
      +
      +
      +
      • +
    • +
      +

      evaluatePreconditions

      +
      Response.ResponseBuilder evaluatePreconditions(Date lastModified)
      +
      Evaluate request preconditions based on the passed in value.
      +
      +
      Parameters:
      +
      lastModified - a date that specifies the modification date of the resource
      +
      Returns:
      +
      null if the preconditions are met or a ResponseBuilder set with the appropriate status if the + preconditions are not met.
      +
      Throws:
      +
      IllegalArgumentException - if lastModified is null.
      +
      IllegalStateException - if called outside the scope of a request.
      +
      +
      +
      • +
    • +
      +

      evaluatePreconditions

      +
      Response.ResponseBuilder evaluatePreconditions(Date lastModified, + EntityTag eTag)
      +
      Evaluate request preconditions based on the passed in value.
      +
      +
      Parameters:
      +
      lastModified - a date that specifies the modification date of the resource
      +
      eTag - an ETag for the current state of the resource
      +
      Returns:
      +
      null if the preconditions are met or a ResponseBuilder set with the appropriate status if the + preconditions are not met. A returned ResponseBuilder will include an ETag header set with the value of eTag, + provided none of the precondition evaluation has failed, in which case the ETag header would not be included and the + status code of the returned ResponseBuilder would be set to Response.Status.PRECONDITION_FAILED.
      +
      Throws:
      +
      IllegalArgumentException - if lastModified or eTag is null.
      +
      IllegalStateException - if called outside the scope of a request.
      +
      +
      +
      • +
    • +
      +

      evaluatePreconditions

      +
      Response.ResponseBuilder evaluatePreconditions()
      +
      Evaluate request preconditions for a resource that does not currently exist. The primary use of this method is to + support the If-Match: * and + If-None-Match: * preconditions. + +

      + Note that precondition If-None-Match: something will never be + considered to have been met, and it is the application's responsibility to enforce any additional method-specific + semantics. E.g. a PUT on a resource that does not exist might succeed whereas a GET on a resource + that does not exist would likely result in a 404 response. It would be the responsibility of the application to + generate the 404 response. +

      +
      +
      Returns:
      +
      null if the preconditions are met or a ResponseBuilder set with the appropriate status if the + preconditions are not met.
      +
      Throws:
      +
      IllegalStateException - if called outside the scope of a request.
      +
      Since:
      +
      1.1
      +
      +
      +
      • +
    +
    +
    • +
+
+ +
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/Response.ResponseBuilder.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/Response.ResponseBuilder.html new file mode 100644 index 0000000000..e690c6b357 --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/Response.ResponseBuilder.html @@ -0,0 +1,890 @@ + + + + +Response.ResponseBuilder (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Module jakarta.ws.rs
+
Package jakarta.ws.rs.core
+

Class Response.ResponseBuilder

+
+
java.lang.Object +
jakarta.ws.rs.core.Response.ResponseBuilder
+
+
+
+
Enclosing class:
+
Response
+
+
+
public abstract static class Response.ResponseBuilder +extends Object
+
A class used to build Response instances that contain metadata instead of or in addition to an entity. An initial + instance may be obtained via static methods of the Response class, instance methods provide the ability to set + metadata. E.g. to create a response that indicates the creation of a new resource: + + 
+ @POST
+ Response addWidget(...) {
+   Widget w = ...
+   URI widgetId = UriBuilder.fromResource(Widget.class)...
+   return Response.created(widgetId).build();
+ }
+
+ +

+ Several methods have parameters of type URI, UriBuilder provides convenient methods to create such values as + does URI.create(). +

+ +

+ Where multiple variants of the same method are provided, the type of the supplied parameter is retained in the + metadata of the built Response. +

+
+
+ +
+
+
    + +
  • +
    +

    Constructor Details

    +
      +
    • +
      +

      ResponseBuilder

      +
      protected ResponseBuilder()
      +
      Protected constructor, use one of the static methods of Response to obtain an instance.
      +
      +
      • +
    +
    +
    • + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      newInstance

      +
      protected static Response.ResponseBuilder newInstance()
      +
      Create a new builder instance.
      +
      +
      Returns:
      +
      a new response builder.
      +
      +
      +
      • +
    • +
      +

      build

      +
      public abstract Response build()
      +
      Create a Response instance from the current ResponseBuilder. The builder is reset to a blank state equivalent to + calling the ok method.
      +
      +
      Returns:
      +
      a Response instance.
      +
      +
      +
      • +
    • +
      +

      clone

      +
      public abstract Response.ResponseBuilder clone()
      +
      +

      + Create a copy of the ResponseBuilder preserving its state. +

      +
      +
      Overrides:
      +
      clone in class Object
      +
      Returns:
      +
      a copy of the ResponseBuilder.
      +
      +
      +
      • +
    • +
      +

      status

      +
      public abstract Response.ResponseBuilder status(int status)
      +
      Set the status on the ResponseBuilder.
      +
      +
      Parameters:
      +
      status - the response status.
      +
      Returns:
      +
      the updated response builder.
      +
      Throws:
      +
      IllegalArgumentException - if status is less than 100 or greater than 599.
      +
      +
      +
      • +
    • +
      +

      status

      +
      public abstract Response.ResponseBuilder status(int status, + String reasonPhrase)
      +
      Set the status on the ResponseBuilder.
      +
      +
      Parameters:
      +
      status - the response status.
      +
      reasonPhrase - the reason phrase.
      +
      Returns:
      +
      the updated response builder.
      +
      Throws:
      +
      IllegalArgumentException - if status is less than 100 or greater than 599.
      +
      Since:
      +
      2.1
      +
      +
      +
      • +
    • +
      +

      status

      +
      public Response.ResponseBuilder status(Response.StatusType status)
      +
      Set the status on the ResponseBuilder.
      +
      +
      Parameters:
      +
      status - the response status.
      +
      Returns:
      +
      the updated response builder.
      +
      Throws:
      +
      IllegalArgumentException - if status is null.
      +
      Since:
      +
      1.1
      +
      +
      +
      • +
    • +
      +

      status

      +
      public Response.ResponseBuilder status(Response.Status status)
      +
      Set the status on the ResponseBuilder.
      +
      +
      Parameters:
      +
      status - the response status.
      +
      Returns:
      +
      the updated response builder.
      +
      Throws:
      +
      IllegalArgumentException - if status is null.
      +
      +
      +
      • +
    • +
      +

      entity

      +
      public abstract Response.ResponseBuilder entity(Object entity)
      +

      + Set the response entity in the builder. +

      +

      + Any Java type instance for a response entity, that is supported by the runtime can be passed. It is the callers + responsibility to wrap the actual entity with GenericEntity if preservation of its generic type is required. + Note that the entity can be also set as an input stream. +

      + A specific entity media type can be set using one of the type(...) methods.
      +
      +
      Parameters:
      +
      entity - the request entity.
      +
      Returns:
      +
      updated response builder instance.
      +
      See Also:
      +
      + +
      +
      +
      +
      • +
    • +
      +

      entity

      +
      public abstract Response.ResponseBuilder entity(Object entity, + Annotation[] annotations)
      +

      + Set the response entity in the builder. +

      +

      + Any Java type instance for a response entity, that is supported by the runtime can be passed. It is the callers + responsibility to wrap the actual entity with GenericEntity if preservation of its generic type is required. + Note that the entity can be also set as an input stream. +

      + A specific entity media type can be set using one of the type(...) methods.
      +
      +
      Parameters:
      +
      entity - the request entity.
      +
      annotations - annotations that will be passed to the MessageBodyWriter, (in addition to any annotations + declared directly on a resource method that returns the built response).
      +
      Returns:
      +
      updated response builder instance.
      +
      Since:
      +
      2.0
      +
      See Also:
      +
      + +
      +
      +
      +
      • +
    • +
      +

      allow

      +
      public abstract Response.ResponseBuilder allow(String... methods)
      +
      Set the list of allowed methods for the resource. Any duplicate method names will be truncated to a single entry.
      +
      +
      Parameters:
      +
      methods - the methods to be listed as allowed for the resource, if null any existing allowed method list + will be removed.
      +
      Returns:
      +
      the updated response builder.
      +
      Since:
      +
      2.0
      +
      +
      +
      • +
    • +
      +

      allow

      +
      public abstract Response.ResponseBuilder allow(Set<String> methods)
      +
      Set the list of allowed methods for the resource.
      +
      +
      Parameters:
      +
      methods - the methods to be listed as allowed for the resource, if null any existing allowed method list + will be removed.
      +
      Returns:
      +
      the updated response builder.
      +
      Since:
      +
      2.0
      +
      +
      +
      • +
    • +
      +

      cacheControl

      +
      public abstract Response.ResponseBuilder cacheControl(CacheControl cacheControl)
      +
      Set the cache control data of the message.
      +
      +
      Parameters:
      +
      cacheControl - the cache control directives, if null any existing cache control directives will be + removed.
      +
      Returns:
      +
      the updated response builder.
      +
      +
      +
      • +
    • +
      +

      encoding

      +
      public abstract Response.ResponseBuilder encoding(String encoding)
      +
      Set the message entity content encoding.
      +
      +
      Parameters:
      +
      encoding - the content encoding of the message entity, if null any existing value for content encoding + will be removed.
      +
      Returns:
      +
      the updated response builder.
      +
      Since:
      +
      2.0
      +
      +
      +
      • +
    • +
      +

      header

      +
      public abstract Response.ResponseBuilder header(String name, + Object value)
      +
      Add an arbitrary header.
      +
      +
      Parameters:
      +
      name - the name of the header
      +
      value - the value of the header, the header will be serialized using a + RuntimeDelegate.HeaderDelegate if one is available via + RuntimeDelegate.createHeaderDelegate(java.lang.Class) for the class of value or using + its toString method if a header delegate is not available. If value is null then all current + headers of the same name will be removed.
      +
      Returns:
      +
      the updated response builder.
      +
      +
      +
      • +
    • +
      +

      replaceAll

      +
      public abstract Response.ResponseBuilder replaceAll(MultivaluedMap<String,Object> headers)
      +
      Replaces all existing headers with the newly supplied headers.
      +
      +
      Parameters:
      +
      headers - new headers to be set, if null all existing headers will be removed.
      +
      Returns:
      +
      the updated response builder.
      +
      Since:
      +
      2.0
      +
      +
      +
      • +
    • +
      +

      language

      +
      public abstract Response.ResponseBuilder language(String language)
      +
      Set the message entity language.
      +
      +
      Parameters:
      +
      language - the language of the message entity, if null any existing value for language will be removed.
      +
      Returns:
      +
      the updated response builder.
      +
      +
      +
      • +
    • +
      +

      language

      +
      public abstract Response.ResponseBuilder language(Locale language)
      +
      Set the message entity language.
      +
      +
      Parameters:
      +
      language - the language of the message entity, if null any existing value for type will be removed.
      +
      Returns:
      +
      the updated response builder.
      +
      +
      +
      • +
    • +
      +

      type

      +
      public abstract Response.ResponseBuilder type(MediaType type)
      +
      Set the message entity media type.
      +
      +
      Parameters:
      +
      type - the media type of the message entity. If null, any existing value for type will be removed.
      +
      Returns:
      +
      the updated response builder.
      +
      +
      +
      • +
    • +
      +

      type

      +
      public abstract Response.ResponseBuilder type(String type)
      +
      Set the message entity media type.
      +
      +
      Parameters:
      +
      type - the media type of the message entity. If null, any existing value for type will be removed.
      +
      Returns:
      +
      the updated response builder.
      +
      +
      +
      • +
    • +
      +

      variant

      +
      public abstract Response.ResponseBuilder variant(Variant variant)
      +

      + Set message entity representation metadata. +

      + Equivalent to setting the values of content type, content language, and content encoding separately using the values + of the variant properties.
      +
      +
      Parameters:
      +
      variant - metadata of the message entity, a null value is equivalent to a variant with all null + properties.
      +
      Returns:
      +
      the updated response builder.
      +
      Since:
      +
      2.0
      +
      See Also:
      +
      + +
      +
      +
      +
      • +
    • +
      +

      contentLocation

      +
      public abstract Response.ResponseBuilder contentLocation(URI location)
      +
      Set the content location.
      +
      +
      Parameters:
      +
      location - the content location. Relative or absolute URIs may be used for the value of content location. If + null any existing value for content location will be removed.
      +
      Returns:
      +
      the updated response builder.
      +
      +
      +
      • +
    • +
      +

      cookie

      +
      public abstract Response.ResponseBuilder cookie(NewCookie... cookies)
      +
      Add cookies to the response message.
      +
      +
      Parameters:
      +
      cookies - new cookies that will accompany the response. A null value will remove all cookies, including + those added via the header(java.lang.String, java.lang.Object) method.
      +
      Returns:
      +
      the updated response builder.
      +
      +
      +
      • +
    • +
      +

      expires

      +
      public abstract Response.ResponseBuilder expires(Date expires)
      +
      Set the response expiration date.
      +
      +
      Parameters:
      +
      expires - the expiration date, if null removes any existing expires value.
      +
      Returns:
      +
      the updated response builder.
      +
      +
      +
      • +
    • +
      +

      lastModified

      +
      public abstract Response.ResponseBuilder lastModified(Date lastModified)
      +
      Set the response entity last modification date.
      +
      +
      Parameters:
      +
      lastModified - the last modified date, if null any existing last modified value will be removed.
      +
      Returns:
      +
      the updated response builder.
      +
      +
      +
      • +
    • +
      +

      location

      +
      public abstract Response.ResponseBuilder location(URI location)
      +
      Set the location.
      +
      +
      Parameters:
      +
      location - the location. If a relative URI is supplied it will be converted into an absolute URI by resolving it + relative to the base URI of the application (see UriInfo.getBaseUri()). If null any existing value for + location will be removed.
      +
      Returns:
      +
      the updated response builder.
      +
      +
      +
      • +
    • +
      +

      tag

      +
      public abstract Response.ResponseBuilder tag(EntityTag tag)
      +
      Set a response entity tag.
      +
      +
      Parameters:
      +
      tag - the entity tag, if null any existing entity tag value will be removed.
      +
      Returns:
      +
      the updated response builder.
      +
      +
      +
      • +
    • +
      +

      tag

      +
      public abstract Response.ResponseBuilder tag(String tag)
      +

      + Set a strong response entity tag. +

      + This is a shortcut for tag(new EntityTag(value)).
      +
      +
      Parameters:
      +
      tag - the string content of a strong entity tag. The JAX-RS runtime will quote the supplied value when creating + the header. If null any existing entity tag value will be removed.
      +
      Returns:
      +
      the updated response builder.
      +
      +
      +
      • +
    • +
      +

      variants

      +
      public abstract Response.ResponseBuilder variants(Variant... variants)
      +
      Add a Vary header that lists the available variants.
      +
      +
      Parameters:
      +
      variants - a list of available representation variants, a null value will remove an existing value for + Vary header.
      +
      Returns:
      +
      the updated response builder.
      +
      Since:
      +
      2.0
      +
      +
      +
      • +
    • +
      +

      variants

      +
      public abstract Response.ResponseBuilder variants(List<Variant> variants)
      +
      Add a Vary header that lists the available variants.
      +
      +
      Parameters:
      +
      variants - a list of available representation variants, a null value will remove an existing value for + Vary header.
      +
      Returns:
      +
      the updated response builder.
      +
      +
      +
      • +
    • +
      +

      links

      +
      public abstract Response.ResponseBuilder links(Link... links)
      +
      Add one or more link headers.
      +
      +
      Parameters:
      +
      links - links to be added to the message as headers, a null value will remove any existing Link headers.
      +
      Returns:
      +
      the updated response builder.
      +
      Since:
      +
      2.0
      +
      +
      +
      • +
    • +
      +

      link

      +
      public abstract Response.ResponseBuilder link(URI uri, + String rel)
      +
      Add a link header.
      +
      +
      Parameters:
      +
      uri - underlying URI for link header.
      +
      rel - value of "rel" parameter.
      +
      Returns:
      +
      the updated response builder.
      +
      Since:
      +
      2.0
      +
      +
      +
      • +
    • +
      +

      link

      +
      public abstract Response.ResponseBuilder link(String uri, + String rel)
      +
      Add a link header.
      +
      +
      Parameters:
      +
      uri - underlying URI for link header.
      +
      rel - value of "rel" parameter.
      +
      Returns:
      +
      the updated response builder.
      +
      Since:
      +
      2.0
      +
      +
      +
      • +
    +
    +
    • +
+
+ +
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/Response.Status.Family.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/Response.Status.Family.html new file mode 100644 index 0000000000..cf223361b9 --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/Response.Status.Family.html @@ -0,0 +1,311 @@ + + + + +Response.Status.Family (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Module jakarta.ws.rs
+
Package jakarta.ws.rs.core
+

Enum Class Response.Status.Family

+
+
java.lang.Object +
java.lang.Enum<Response.Status.Family> +
jakarta.ws.rs.core.Response.Status.Family
+
+
+
+
+
All Implemented Interfaces:
+
Serializable, Comparable<Response.Status.Family>, Constable
+
+
+
Enclosing class:
+
Response.Status
+
+
+
public static enum Response.Status.Family +extends Enum<Response.Status.Family>
+
An enumeration representing the class of status code. Family is used here since class is overloaded in Java.
+
+
+ +
+
+
    + +
  • +
    +

    Enum Constant Details

    + +
    +
    • + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      values

      +
      public static Response.Status.Family[] values()
      +
      Returns an array containing the constants of this enum class, in +the order they are declared.
      +
      +
      Returns:
      +
      an array containing the constants of this enum class, in the order they are declared
      +
      +
      +
      • +
    • +
      +

      valueOf

      +
      public static Response.Status.Family valueOf(String name)
      +
      Returns the enum constant of this class with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this class. (Extraneous whitespace characters are +not permitted.)
      +
      +
      Parameters:
      +
      name - the name of the enum constant to be returned.
      +
      Returns:
      +
      the enum constant with the specified name
      +
      Throws:
      +
      IllegalArgumentException - if this enum class has no constant with the specified name
      +
      NullPointerException - if the argument is null
      +
      +
      +
      • +
    • +
      +

      familyOf

      +
      public static Response.Status.Family familyOf(int statusCode)
      +
      Get the response status family for the status code.
      +
      +
      Parameters:
      +
      statusCode - response status code to get the family for.
      +
      Returns:
      +
      family of the response status code.
      +
      +
      +
      • +
    +
    +
    • +
+
+ +
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/Response.Status.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/Response.Status.html new file mode 100644 index 0000000000..57dc80e853 --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/Response.Status.html @@ -0,0 +1,983 @@ + + + + +Response.Status (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Module jakarta.ws.rs
+
Package jakarta.ws.rs.core
+

Enum Class Response.Status

+
+
java.lang.Object +
java.lang.Enum<Response.Status> +
jakarta.ws.rs.core.Response.Status
+
+
+
+
+
All Implemented Interfaces:
+
Response.StatusType, Serializable, Comparable<Response.Status>, Constable
+
+
+
Enclosing class:
+
Response
+
+
+
public static enum Response.Status +extends Enum<Response.Status> +implements Response.StatusType
+
Commonly used status codes defined by HTTP, see + HTTP/1.1 documentation for the complete + list. Additional status codes can be added by applications by creating an implementation of Response.StatusType.
+
+
+ +
+
+ +
+ +
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/Response.StatusType.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/Response.StatusType.html new file mode 100644 index 0000000000..d1f39866c0 --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/Response.StatusType.html @@ -0,0 +1,218 @@ + + + + +Response.StatusType (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Module jakarta.ws.rs
+
Package jakarta.ws.rs.core
+

Interface Response.StatusType

+
+
+
+
All Known Implementing Classes:
+
Response.Status
+
+
+
Enclosing class:
+
Response
+
+
+
public static interface Response.StatusType
+
Base interface for statuses used in responses.
+
+
Since:
+
1.1
+
+
+
+ +
+
+
    + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      getStatusCode

      +
      int getStatusCode()
      +
      Get the associated status code.
      +
      +
      Returns:
      +
      the status code.
      +
      +
      +
      • +
    • +
      +

      getFamily

      +
      Response.Status.Family getFamily()
      +
      Get the class of status code.
      +
      +
      Returns:
      +
      the class of status code.
      +
      +
      +
      • +
    • +
      +

      getReasonPhrase

      +
      String getReasonPhrase()
      +
      Get the reason phrase.
      +
      +
      Returns:
      +
      the reason phrase.
      +
      +
      +
      • +
    • +
      +

      toEnum

      +
      default Response.Status toEnum()
      +
      Get the this Status Type as a Response.Status. +

      + Please note that returned status contains only a status code, the reason phrase is set to default one (corresponding + to the status code).

      +
      +
      Returns:
      +
      Response.Status representing this status type.
      +
      Since:
      +
      2.1
      +
      +
      +
      • +
    +
    +
    • +
+
+ +
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/Response.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/Response.html new file mode 100644 index 0000000000..a9ec376632 --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/Response.html @@ -0,0 +1,1410 @@ + + + + +Response (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Module jakarta.ws.rs
+
Package jakarta.ws.rs.core
+

Class Response

+
+
java.lang.Object +
jakarta.ws.rs.core.Response
+
+
+
+
All Implemented Interfaces:
+
AutoCloseable
+
+
+
public abstract class Response +extends Object +implements AutoCloseable
+
Defines the contract between a returned instance and the runtime when an application needs to provide meta-data to + the runtime. +

+ An application class should not extend this class directly. Response class is reserved for an extension by a + JAX-RS implementation providers. An application should use one of the static methods to create a Response + instance using a ResponseBuilder. +

+

+ Several methods have parameters of type URI, UriBuilder provides convenient methods to create such values as + does URI.create(java.lang.String). +

+
+
Since:
+
1.0
+
Author:
+
Paul Sandoz, Marc Hadley, Marek Potociar
+
See Also:
+
+ +
+
+
+
+ +
+
+
    + +
  • +
    +

    Constructor Details

    +
      +
    • +
      +

      Response

      +
      protected Response()
      +
      Protected constructor, use one of the static methods to obtain a Response.ResponseBuilder instance and obtain a + Response from that.
      +
      +
      • +
    +
    +
    • + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      getStatus

      +
      public abstract int getStatus()
      +
      Get the status code associated with the response.
      +
      +
      Returns:
      +
      the response status code.
      +
      +
      +
      • +
    • +
      +

      getStatusInfo

      +
      public abstract Response.StatusType getStatusInfo()
      +
      Get the complete status information associated with the response.
      +
      +
      Returns:
      +
      the response status information. The returned value is never null.
      +
      Since:
      +
      2.0
      +
      +
      +
      • +
    • +
      +

      getEntity

      +
      public abstract Object getEntity()
      +
      Get the message entity Java instance. Returns null if the message does not contain an entity body. +

      + If the entity is represented by an un-consumed input stream the method will return the input + stream. +

      +
      +
      Returns:
      +
      the message entity or null if message does not contain an entity body (i.e. when hasEntity() + returns false).
      +
      Throws:
      +
      IllegalStateException - if the entity was previously fully consumed as an input stream, or + if the response has been closed.
      +
      +
      +
      • +
    • +
      +

      readEntity

      +
      public abstract <T> T readEntity(Class<T> entityType)
      +
      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. +

      + Method throws an ProcessingException if the content of the message cannot be mapped to an entity of the + requested type and IllegalStateException in case the entity is not backed by an input stream or if the + original entity input stream has already been consumed without buffering the entity data + prior consuming. +

      +

      + A message instance returned from this method will be cached for subsequent retrievals via getEntity(). + Unless the supplied entity type is an input stream, this method automatically + closes the an unconsumed original response entity data stream if open. In case the entity data has + been buffered, the buffer will be reset prior consuming the buffered data to enable subsequent invocations of + readEntity(...) methods on this response. +

      +
      +
      Type Parameters:
      +
      T - entity instance Java type.
      +
      Parameters:
      +
      entityType - the type of entity.
      +
      Returns:
      +
      the message entity; for a zero-length response entities returns a corresponding Java object that represents + zero-length data. In case no zero-length representation is defined for the Java type, a ProcessingException + wrapping the underlying NoContentException is thrown.
      +
      Throws:
      +
      ProcessingException - if the content of the message cannot be mapped to an entity of the requested type.
      +
      IllegalStateException - if the entity is not backed by an input stream, the response has been closed already, or if the entity input stream has been fully consumed already and has not been buffered prior + consuming.
      +
      Since:
      +
      2.0
      +
      See Also:
      +
      + +
      +
      +
      +
      • +
    • +
      +

      readEntity

      +
      public abstract <T> T readEntity(GenericType<T> entityType)
      +
      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. +

      + Method throws an ProcessingException if the content of the message cannot be mapped to an entity of the + requested type and IllegalStateException in case the entity is not backed by an input stream or if the + original entity input stream has already been consumed without buffering the entity data + prior consuming. +

      +

      + A message instance returned from this method will be cached for subsequent retrievals via getEntity(). + Unless the supplied entity type is an input stream, this method automatically + closes the an unconsumed original response entity data stream if open. In case the entity data has + been buffered, the buffer will be reset prior consuming the buffered data to enable subsequent invocations of + readEntity(...) methods on this response. +

      +
      +
      Type Parameters:
      +
      T - entity instance Java type.
      +
      Parameters:
      +
      entityType - the type of entity; may be generic.
      +
      Returns:
      +
      the message entity; for a zero-length response entities returns a corresponding Java object that represents + zero-length data. In case no zero-length representation is defined for the Java type, a ProcessingException + wrapping the underlying NoContentException is thrown.
      +
      Throws:
      +
      ProcessingException - if the content of the message cannot be mapped to an entity of the requested type.
      +
      IllegalStateException - if the entity is not backed by an input stream, the response has been closed already, or if the entity input stream has been fully consumed already and has not been buffered prior + consuming.
      +
      Since:
      +
      2.0
      +
      See Also:
      +
      + +
      +
      +
      +
      • +
    • +
      +

      readEntity

      +
      public abstract <T> T readEntity(Class<T> entityType, + Annotation[] annotations)
      +
      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. +

      + Method throws an ProcessingException if the content of the message cannot be mapped to an entity of the + requested type and IllegalStateException in case the entity is not backed by an input stream or if the + original entity input stream has already been consumed without buffering the entity data + prior consuming. +

      +

      + A message instance returned from this method will be cached for subsequent retrievals via getEntity(). + Unless the supplied entity type is an input stream, this method automatically + closes the an unconsumed original response entity data stream if open. In case the entity data has + been buffered, the buffer will be reset prior consuming the buffered data to enable subsequent invocations of + readEntity(...) methods on this response. +

      +
      +
      Type Parameters:
      +
      T - entity instance Java type.
      +
      Parameters:
      +
      entityType - the type of entity.
      +
      annotations - annotations that will be passed to the MessageBodyReader.
      +
      Returns:
      +
      the message entity; for a zero-length response entities returns a corresponding Java object that represents + zero-length data. In case no zero-length representation is defined for the Java type, a ProcessingException + wrapping the underlying NoContentException is thrown.
      +
      Throws:
      +
      ProcessingException - if the content of the message cannot be mapped to an entity of the requested type.
      +
      IllegalStateException - if the entity is not backed by an input stream, the response has been closed already, or if the entity input stream has been fully consumed already and has not been buffered prior + consuming.
      +
      Since:
      +
      2.0
      +
      See Also:
      +
      + +
      +
      +
      +
      • +
    • +
      +

      readEntity

      +
      public abstract <T> T readEntity(GenericType<T> entityType, + Annotation[] annotations)
      +
      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. +

      + Method throws an ProcessingException if the content of the message cannot be mapped to an entity of the + requested type and IllegalStateException in case the entity is not backed by an input stream or if the + original entity input stream has already been consumed without buffering the entity data + prior consuming. +

      +

      + A message instance returned from this method will be cached for subsequent retrievals via getEntity(). + Unless the supplied entity type is an input stream, this method automatically + closes the an unconsumed original response entity data stream if open. In case the entity data has + been buffered, the buffer will be reset prior consuming the buffered data to enable subsequent invocations of + readEntity(...) methods on this response. +

      +
      +
      Type Parameters:
      +
      T - entity instance Java type.
      +
      Parameters:
      +
      entityType - the type of entity; may be generic.
      +
      annotations - annotations that will be passed to the MessageBodyReader.
      +
      Returns:
      +
      the message entity; for a zero-length response entities returns a corresponding Java object that represents + zero-length data. In case no zero-length representation is defined for the Java type, a ProcessingException + wrapping the underlying NoContentException is thrown.
      +
      Throws:
      +
      ProcessingException - if the content of the message cannot be mapped to an entity of the requested type.
      +
      IllegalStateException - if the entity is not backed by an input stream, the response has been closed already, or if the entity input stream has been fully consumed already and has not been buffered prior + consuming.
      +
      Since:
      +
      2.0
      +
      See Also:
      +
      + +
      +
      +
      +
      • +
    • +
      +

      hasEntity

      +
      public abstract boolean hasEntity()
      +
      Check if there is an entity available in the response. The method returns true if the entity is present, + returns false otherwise. +

      + Note that the method may return true also for response messages with a zero-length content, in case the + "Content-Length" and + "Content-Type" headers are specified in the message. In such case, an + attempt to read the entity using one of the readEntity(...) methods will return a corresponding instance + representing a zero-length entity for a given Java type or produce a ProcessingException in case no such + instance is available for the Java type. +

      +
      +
      Returns:
      +
      true if there is an entity present in the message, false otherwise.
      +
      Throws:
      +
      IllegalStateException - in case the response has been closed.
      +
      Since:
      +
      2.0
      +
      +
      +
      • +
    • +
      +

      bufferEntity

      +
      public abstract boolean bufferEntity()
      +
      Buffer the message entity data. +

      + In case the message entity is backed by an unconsumed entity input stream, all the bytes of the original entity input + stream are read and stored in a local buffer. The original entity input stream is consumed and automatically closed + as part of the operation and the method returns true. +

      +

      + In case the response entity instance is not backed by an unconsumed input stream an invocation of + bufferEntity method is ignored and the method returns false. +

      +

      + This operation is idempotent, i.e. it can be invoked multiple times with the same effect which also means that + calling the bufferEntity() method on an already buffered (and thus closed) message instance is legal and has + no further effect. Also, the result returned by the bufferEntity() method is consistent across all + invocations of the method on the same Response instance. +

      +

      + Buffering the message entity data allows for multiple invocations of readEntity(...) methods on the response + instance. Note however, that once the response instance itself is closed, the implementations are + expected to release the buffered message entity data too. Therefore any subsequent attempts to read a message entity + stream on such closed response will result in an IllegalStateException being thrown. +

      +
      +
      Returns:
      +
      true if the message entity input stream was available and was buffered successfully, returns + false if the entity stream was not available.
      +
      Throws:
      +
      ProcessingException - if there was an error while buffering the entity input stream.
      +
      IllegalStateException - in case the response has been closed.
      +
      Since:
      +
      2.0
      +
      +
      +
      • +
    • +
      +

      close

      +
      public abstract void close()
      +
      Close the underlying message entity input stream (if available and open) as well as releases any other resources + associated with the response (e.g. buffered message entity data). +

      + This operation is idempotent, i.e. it can be invoked multiple times with the same effect which also means that + calling the close() method on an already closed message instance is legal and has no further effect. +

      +

      + The close() method should be invoked on all instances that contain an un-consumed entity input stream to + ensure the resources associated with the instance are properly cleaned-up and prevent potential memory leaks. This is + typical for client-side scenarios where application layer code processes only the response headers and ignores the + response entity. +

      +

      + Any attempts to manipulate (read, get, buffer) a message entity on a closed response will result in an + IllegalStateException being thrown. +

      +
      +
      Specified by:
      +
      close in interface AutoCloseable
      +
      Throws:
      +
      ProcessingException - if there is an error closing the response.
      +
      Since:
      +
      2.0
      +
      +
      +
      • +
    • +
      +

      getMediaType

      +
      public abstract MediaType getMediaType()
      +
      Get the media type of the message entity.
      +
      +
      Returns:
      +
      the media type or null if there is no response entity.
      +
      Since:
      +
      2.0
      +
      +
      +
      • +
    • +
      +

      getLanguage

      +
      public abstract Locale getLanguage()
      +
      Get the language of the message entity.
      +
      +
      Returns:
      +
      the language of the entity or null if not specified.
      +
      Since:
      +
      2.0
      +
      +
      +
      • +
    • +
      +

      getLength

      +
      public abstract int getLength()
      +
      Get Content-Length value.
      +
      +
      Returns:
      +
      Content-Length as integer if present and valid number. In other cases returns -1.
      +
      Since:
      +
      2.0
      +
      +
      +
      • +
    • +
      +

      getAllowedMethods

      +
      public abstract Set<String> getAllowedMethods()
      +
      Get the allowed HTTP methods from the Allow HTTP header.
      +
      +
      Returns:
      +
      the allowed HTTP methods, all methods will returned as upper case strings.
      +
      Since:
      +
      2.0
      +
      +
      +
      • +
    • +
      +

      getCookies

      +
      public abstract Map<String,NewCookie> getCookies()
      +
      Get any new cookies set on the response message.
      +
      +
      Returns:
      +
      a read-only map of cookie name (String) to Cookie.
      +
      Since:
      +
      2.0
      +
      +
      +
      • +
    • +
      +

      getEntityTag

      +
      public abstract EntityTag getEntityTag()
      +
      Get the entity tag.
      +
      +
      Returns:
      +
      the entity tag, otherwise null if not present.
      +
      Since:
      +
      2.0
      +
      +
      +
      • +
    • +
      +

      getDate

      +
      public abstract Date getDate()
      +
      Get message date.
      +
      +
      Returns:
      +
      the message date, otherwise null if not present.
      +
      Since:
      +
      2.0
      +
      +
      +
      • +
    • +
      +

      getLastModified

      +
      public abstract Date getLastModified()
      +
      Get the last modified date.
      +
      +
      Returns:
      +
      the last modified date, otherwise null if not present.
      +
      Since:
      +
      2.0
      +
      +
      +
      • +
    • +
      +

      getLocation

      +
      public abstract URI getLocation()
      +
      Get the location.
      +
      +
      Returns:
      +
      the location URI, otherwise null if not present.
      +
      Since:
      +
      2.0
      +
      +
      +
      • +
    • +
      +

      getLinks

      +
      public abstract Set<Link> getLinks()
      +
      Get the links attached to the message as headers. Any links in the message that are relative must be resolved with + respect to the actual request URI that produced this response. Note that request URIs may be updated by filters, so + the actual request URI may differ from that in the original invocation.
      +
      +
      Returns:
      +
      links, may return empty Set if no links are present. Does not return null.
      +
      Since:
      +
      2.0
      +
      +
      +
      • +
    • +
      +

      hasLink

      +
      public abstract boolean hasLink(String relation)
      +
      Check if link for relation exists.
      +
      +
      Parameters:
      +
      relation - link relation.
      +
      Returns:
      +
      true if the link for the relation is present in the message headers, + false otherwise.
      +
      Since:
      +
      2.0
      +
      +
      +
      • +
    • +
      +

      getLink

      +
      public abstract Link getLink(String relation)
      +
      Get the link for the relation. A relative link is resolved with respect to the actual request URI that produced this + response. Note that request URIs may be updated by filters, so the actual request URI may differ from that in the + original invocation.
      +
      +
      Parameters:
      +
      relation - link relation.
      +
      Returns:
      +
      the link for the relation, otherwise null if not present.
      +
      Since:
      +
      2.0
      +
      +
      +
      • +
    • +
      +

      getLinkBuilder

      +
      public abstract Link.Builder getLinkBuilder(String relation)
      +
      Convenience method that returns a Link.Builder for the relation. See getLink(java.lang.String) for more information.
      +
      +
      Parameters:
      +
      relation - link relation.
      +
      Returns:
      +
      the link builder for the relation, otherwise null if not present.
      +
      Since:
      +
      2.0
      +
      +
      +
      • +
    • +
      +

      getMetadata

      +
      public abstract MultivaluedMap<String,Object> getMetadata()
      +
      See getHeaders(). + + This method is considered deprecated. Users are encouraged to switch their code to use the getHeaders() + method instead. The method may be annotated as @Deprecated in a future release of JAX-RS API.
      +
      +
      Returns:
      +
      response headers as a multivalued map.
      +
      +
      +
      • +
    • +
      +

      getHeaders

      +
      public MultivaluedMap<String,Object> getHeaders()
      +
      Get view of the response headers and their object values. + + The underlying header data may be subsequently modified by the JAX-RS runtime on the server side. Changes in the + underlying header data are reflected in this view. +

      + On the server-side, when the message is sent, the non-string values will be serialized using a + RuntimeDelegate.HeaderDelegate if one is available via + RuntimeDelegate.createHeaderDelegate(java.lang.Class) for the class of the value or using the + values toString method if a header delegate is not available. +

      +

      + On the client side, the returned map is identical to the one returned by getStringHeaders(). +

      +
      +
      Returns:
      +
      response headers as an object view of header values.
      +
      Since:
      +
      2.0
      +
      See Also:
      +
      + +
      +
      +
      +
      • +
    • +
      +

      getStringHeaders

      +
      public abstract MultivaluedMap<String,String> getStringHeaders()
      +
      Get view of the response headers and their string values. + + The underlying header data may be subsequently modified by the JAX-RS runtime on the server side. Changes in the + underlying header data are reflected in this view.
      +
      +
      Returns:
      +
      response headers as a string view of header values.
      +
      Since:
      +
      2.0
      +
      See Also:
      +
      + +
      +
      +
      +
      • +
    • +
      +

      getHeaderString

      +
      public abstract String getHeaderString(String name)
      +
      Get a message header as a single string value. + + Each single header value is converted to String using a RuntimeDelegate.HeaderDelegate if one + is available via RuntimeDelegate.createHeaderDelegate(java.lang.Class) for the header value + class or using its toString method if a header delegate is not available.
      +
      +
      Parameters:
      +
      name - the message header.
      +
      Returns:
      +
      the message header value. If the message header is not present then null is returned. If the message + header is present but has no value then the empty string is returned. If the message header is present more than once + then the values of joined together and separated by a ',' character.
      +
      Since:
      +
      2.0
      +
      See Also:
      +
      + +
      +
      +
      +
      • +
    • +
      +

      isClosed

      +
      public boolean isClosed()
      +
      Check if the response is closed. The method returns true if the response is closed, + returns false otherwise.
      +
      +
      Returns:
      +
      true if the response has been closed, false otherwise.
      +
      Since:
      +
      3.1
      +
      +
      +
      • +
    • +
      +

      fromResponse

      +
      public static Response.ResponseBuilder fromResponse(Response response)
      +
      Create a new ResponseBuilder by performing a shallow copy of an existing Response. +

      + The returned builder has its own response headers but the header values are shared with the + original Response instance. The original response entity instance reference is set in the new response + builder. +

      +

      + Note that if the entity is backed by an un-consumed input stream, the reference to the stream is copied. In such case + make sure to buffer the entity stream of the original response instance before passing it to + this method. +

      +
      +
      Parameters:
      +
      response - a Response from which the status code, entity and response headers will be + copied.
      +
      Returns:
      +
      a new response builder.
      +
      Since:
      +
      2.0
      +
      +
      +
      • +
    • +
      +

      status

      +
      public static Response.ResponseBuilder status(Response.StatusType status)
      +
      Create a new ResponseBuilder with the supplied status.
      +
      +
      Parameters:
      +
      status - the response status.
      +
      Returns:
      +
      a new response builder.
      +
      Throws:
      +
      IllegalArgumentException - if status is null.
      +
      +
      +
      • +
    • +
      +

      status

      +
      public static Response.ResponseBuilder status(Response.Status status)
      +
      Create a new ResponseBuilder with the supplied status.
      +
      +
      Parameters:
      +
      status - the response status.
      +
      Returns:
      +
      a new response builder.
      +
      Throws:
      +
      IllegalArgumentException - if status is null.
      +
      +
      +
      • +
    • +
      +

      status

      +
      public static Response.ResponseBuilder status(int status)
      +
      Create a new ResponseBuilder with the supplied status.
      +
      +
      Parameters:
      +
      status - the response status.
      +
      Returns:
      +
      a new response builder.
      +
      Throws:
      +
      IllegalArgumentException - if status is less than 100 or greater than 599.
      +
      +
      +
      • +
    • +
      +

      status

      +
      public static Response.ResponseBuilder status(int status, + String reasonPhrase)
      +
      Create a new ResponseBuilder with the supplied status and reason phrase.
      +
      +
      Parameters:
      +
      status - the response status.
      +
      reasonPhrase - the reason phrase.
      +
      Returns:
      +
      the updated response builder.
      +
      Throws:
      +
      IllegalArgumentException - if status is less than 100 or greater than 599.
      +
      Since:
      +
      2.1
      +
      +
      +
      • +
    • +
      +

      ok

      +
      public static Response.ResponseBuilder ok()
      +
      Create a new ResponseBuilder with an OK status.
      +
      +
      Returns:
      +
      a new response builder.
      +
      +
      +
      • +
    • +
      +

      ok

      +
      public static Response.ResponseBuilder ok(Object entity)
      +
      Create a new ResponseBuilder that contains a representation. It is the callers responsibility to wrap the actual + entity with GenericEntity if preservation of its generic type is required.
      +
      +
      Parameters:
      +
      entity - the representation entity data.
      +
      Returns:
      +
      a new response builder.
      +
      +
      +
      • +
    • +
      +

      ok

      +
      public static Response.ResponseBuilder ok(Object entity, + MediaType type)
      +
      Create a new ResponseBuilder that contains a representation. It is the callers responsibility to wrap the actual + entity with GenericEntity if preservation of its generic type is required.
      +
      +
      Parameters:
      +
      entity - the representation entity data.
      +
      type - the media type of the entity.
      +
      Returns:
      +
      a new response builder.
      +
      +
      +
      • +
    • +
      +

      ok

      +
      public static Response.ResponseBuilder ok(Object entity, + String type)
      +
      Create a new ResponseBuilder that contains a representation. It is the callers responsibility to wrap the actual + entity with GenericEntity if preservation of its generic type is required.
      +
      +
      Parameters:
      +
      entity - the representation entity data.
      +
      type - the media type of the entity.
      +
      Returns:
      +
      a new response builder.
      +
      +
      +
      • +
    • +
      +

      ok

      +
      public static Response.ResponseBuilder ok(Object entity, + Variant variant)
      +
      Create a new ResponseBuilder that contains a representation. It is the callers responsibility to wrap the actual + entity with GenericEntity if preservation of its generic type is required.
      +
      +
      Parameters:
      +
      entity - the representation entity data.
      +
      variant - representation metadata.
      +
      Returns:
      +
      a new response builder.
      +
      +
      +
      • +
    • +
      +

      serverError

      +
      public static Response.ResponseBuilder serverError()
      +
      Create a new ResponseBuilder with an server error status.
      +
      +
      Returns:
      +
      a new response builder.
      +
      +
      +
      • +
    • +
      +

      created

      +
      public static Response.ResponseBuilder created(URI location)
      +
      Create a new ResponseBuilder for a created resource, set the location header using the supplied value.
      +
      +
      Parameters:
      +
      location - the URI of the new resource. If a relative URI is supplied it will be converted into an absolute URI + by resolving it relative to the base URI (see UriInfo.getRequestUri()).
      +
      Returns:
      +
      a new response builder.
      +
      Throws:
      +
      IllegalArgumentException - if location is null.
      +
      +
      +
      • +
    • +
      +

      accepted

      +
      public static Response.ResponseBuilder accepted()
      +
      Create a new ResponseBuilder with an ACCEPTED status.
      +
      +
      Returns:
      +
      a new response builder.
      +
      Since:
      +
      2.0
      +
      +
      +
      • +
    • +
      +

      accepted

      +
      public static Response.ResponseBuilder accepted(Object entity)
      +
      Create a new ResponseBuilder with an ACCEPTED status that contains a representation. It is the callers responsibility + to wrap the actual entity with GenericEntity if preservation of its generic type is required.
      +
      +
      Parameters:
      +
      entity - the representation entity data.
      +
      Returns:
      +
      a new response builder.
      +
      Since:
      +
      2.0
      +
      +
      +
      • +
    • +
      +

      noContent

      +
      public static Response.ResponseBuilder noContent()
      +
      Create a new ResponseBuilder for an empty response.
      +
      +
      Returns:
      +
      a new response builder.
      +
      +
      +
      • +
    • +
      +

      notModified

      +
      public static Response.ResponseBuilder notModified()
      +
      Create a new ResponseBuilder with a not-modified status.
      +
      +
      Returns:
      +
      a new response builder.
      +
      +
      +
      • +
    • +
      +

      notModified

      +
      public static Response.ResponseBuilder notModified(EntityTag tag)
      +
      Create a new ResponseBuilder with a not-modified status.
      +
      +
      Parameters:
      +
      tag - a tag for the unmodified entity.
      +
      Returns:
      +
      a new response builder.
      +
      Throws:
      +
      IllegalArgumentException - if tag is null.
      +
      +
      +
      • +
    • +
      +

      notModified

      +
      public static Response.ResponseBuilder notModified(String tag)
      +
      Create a new ResponseBuilder with a not-modified status and a strong entity tag. This is a shortcut for + notModified(new EntityTag(value)).
      +
      +
      Parameters:
      +
      tag - the string content of a strong entity tag. The JAX-RS runtime will quote the supplied value when creating + the header.
      +
      Returns:
      +
      a new response builder.
      +
      Throws:
      +
      IllegalArgumentException - if tag is null.
      +
      +
      +
      • +
    • +
      +

      seeOther

      +
      public static Response.ResponseBuilder seeOther(URI location)
      +
      Create a new ResponseBuilder for a redirection. Used in the redirect-after-POST (aka POST/redirect/GET) pattern.
      +
      +
      Parameters:
      +
      location - the redirection URI. If a relative URI is supplied it will be converted into an absolute URI by + resolving it relative to the base URI of the application (see UriInfo.getBaseUri()).
      +
      Returns:
      +
      a new response builder.
      +
      Throws:
      +
      IllegalArgumentException - if location is null.
      +
      +
      +
      • +
    • +
      +

      temporaryRedirect

      +
      public static Response.ResponseBuilder temporaryRedirect(URI location)
      +
      Create a new ResponseBuilder for a temporary redirection.
      +
      +
      Parameters:
      +
      location - the redirection URI. If a relative URI is supplied it will be converted into an absolute URI by + resolving it relative to the base URI of the application (see UriInfo.getBaseUri()).
      +
      Returns:
      +
      a new response builder.
      +
      Throws:
      +
      IllegalArgumentException - if location is null.
      +
      +
      +
      • +
    • +
      +

      notAcceptable

      +
      public static Response.ResponseBuilder notAcceptable(List<Variant> variants)
      +
      Create a new ResponseBuilder for a not acceptable response.
      +
      +
      Parameters:
      +
      variants - list of variants that were available, a null value is equivalent to an empty list.
      +
      Returns:
      +
      a new response builder.
      +
      +
      +
      • +
    +
    +
    • +
+
+ +
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/SecurityContext.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/SecurityContext.html new file mode 100644 index 0000000000..4944b78954 --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/SecurityContext.html @@ -0,0 +1,331 @@ + + + + +SecurityContext (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Module jakarta.ws.rs
+
Package jakarta.ws.rs.core
+

Interface SecurityContext

+
+
+
+
public interface SecurityContext
+
An injectable interface that provides access to security related information.
+
+
Since:
+
1.0
+
Author:
+
Paul Sandoz, Marc Hadley
+
See Also:
+
+ +
+
+
+
+
    + +
  • +
    +

    Field Summary

    +
    Fields
    +
    +
    Modifier and Type
    +
    Field
    +
    Description
    +
    static final String
    +
    BASIC_AUTH
    +
    +
    String identifier for Basic authentication.
    +
    +
    static final String
    +
    CLIENT_CERT_AUTH
    +
    +
    String identifier for Client Certificate authentication.
    +
    +
    static final String
    +
    DIGEST_AUTH
    +
    +
    String identifier for Digest authentication.
    +
    +
    static final String
    +
    FORM_AUTH
    +
    +
    String identifier for Form authentication.
    +
    +
    +
    +
    • + +
  • +
    +

    Method Summary

    +
    +
    +
    +
    +
    Modifier and Type
    +
    Method
    +
    Description
    +
    String
    +
    getAuthenticationScheme()
    +
    +
    Returns the string value of the authentication scheme used to protect the resource.
    +
    +
    Principal
    +
    getUserPrincipal()
    +
    +
    Returns a java.security.Principal object containing the name of the current authenticated user.
    +
    +
    boolean
    +
    isSecure()
    +
    +
    Returns a boolean indicating whether this request was made using a secure channel, such as HTTPS.
    +
    +
    boolean
    +
    isUserInRole(String role)
    +
    +
    Returns a boolean indicating whether the authenticated user is included in the specified logical "role".
    +
    +
    +
    +
    +
    +
    • +
+
+
+
    + +
  • +
    +

    Field Details

    +
      +
    • +
      +

      BASIC_AUTH

      +
      static final String BASIC_AUTH
      +
      String identifier for Basic authentication. Value "BASIC"
      +
      +
      See Also:
      +
      + +
      +
      +
      +
      • +
    • +
      +

      CLIENT_CERT_AUTH

      +
      static final String CLIENT_CERT_AUTH
      +
      String identifier for Client Certificate authentication. Value "CLIENT_CERT"
      +
      +
      See Also:
      +
      + +
      +
      +
      +
      • +
    • +
      +

      DIGEST_AUTH

      +
      static final String DIGEST_AUTH
      +
      String identifier for Digest authentication. Value "DIGEST"
      +
      +
      See Also:
      +
      + +
      +
      +
      +
      • +
    • +
      +

      FORM_AUTH

      +
      static final String FORM_AUTH
      +
      String identifier for Form authentication. Value "FORM"
      +
      +
      See Also:
      +
      + +
      +
      +
      +
      • +
    +
    +
    • + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      getUserPrincipal

      +
      Principal getUserPrincipal()
      +
      Returns a java.security.Principal object containing the name of the current authenticated user. If the + user has not been authenticated, the method returns null.
      +
      +
      Returns:
      +
      a java.security.Principal containing the name of the user making this request; null if the user + has not been authenticated
      +
      Throws:
      +
      IllegalStateException - if called outside the scope of a request
      +
      +
      +
      • +
    • +
      +

      isUserInRole

      +
      boolean isUserInRole(String role)
      +
      Returns a boolean indicating whether the authenticated user is included in the specified logical "role". If the user + has not been authenticated, the method returns false.
      +
      +
      Parameters:
      +
      role - a String specifying the name of the role
      +
      Returns:
      +
      a boolean indicating whether the user making the request belongs to a given role; + false if the user has not been authenticated
      +
      Throws:
      +
      IllegalStateException - if called outside the scope of a request
      +
      +
      +
      • +
    • +
      +

      isSecure

      +
      boolean isSecure()
      +
      Returns a boolean indicating whether this request was made using a secure channel, such as HTTPS.
      +
      +
      Returns:
      +
      true if the request was made using a secure channel, false otherwise
      +
      Throws:
      +
      IllegalStateException - if called outside the scope of a request
      +
      +
      +
      • +
    • +
      +

      getAuthenticationScheme

      +
      String getAuthenticationScheme()
      +
      Returns the string value of the authentication scheme used to protect the resource. If the resource is not + authenticated, null is returned. + + Values are the same as the CGI variable AUTH_TYPE
      +
      +
      Returns:
      +
      one of the static members BASIC_AUTH, FORM_AUTH, CLIENT_CERT_AUTH, DIGEST_AUTH (suitable for == comparison) + or the container-specific string indicating the authentication scheme, or null if the request was not authenticated.
      +
      Throws:
      +
      IllegalStateException - if called outside the scope of a request
      +
      +
      +
      • +
    +
    +
    • +
+
+ +
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/StreamingOutput.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/StreamingOutput.html new file mode 100644 index 0000000000..b9642d3fdf --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/StreamingOutput.html @@ -0,0 +1,173 @@ + + + + +StreamingOutput (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Module jakarta.ws.rs
+
Package jakarta.ws.rs.core
+

Interface StreamingOutput

+
+
+
+
public interface StreamingOutput
+
A type that may be used as a resource method return value or as the entity in a Response when the application + wishes to stream the output. This is a lightweight alternative to a MessageBodyWriter.
+
+
Since:
+
1.0
+
Author:
+
Paul Sandoz, Marc Hadley
+
See Also:
+
+ +
+
+
+
+
    + +
  • +
    +

    Method Summary

    +
    +
    +
    +
    +
    Modifier and Type
    +
    Method
    +
    Description
    +
    void
    +
    write(OutputStream output)
    +
    +
    Called to write the message body.
    +
    +
    +
    +
    +
    +
    • +
+
+
+
    + +
  • +
    +

    Method Details

    + +
    +
    • +
+
+ +
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/UriBuilder.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/UriBuilder.html new file mode 100644 index 0000000000..bb929e11dd --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/UriBuilder.html @@ -0,0 +1,1302 @@ + + + + +UriBuilder (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Module jakarta.ws.rs
+
Package jakarta.ws.rs.core
+

Class UriBuilder

+
+
java.lang.Object +
jakarta.ws.rs.core.UriBuilder
+
+
+
+
public abstract class UriBuilder +extends Object
+
URI template-aware utility class for building URIs from their components. See Path.value() for an + explanation of URI templates. + +

+ Builder methods perform contextual encoding of characters not permitted in the corresponding URI component following + the rules of the + application/x-www-form-urlencoded media type + for query parameters and RFC 3986 for all other components. Note that + only characters not permitted in a particular component are subject to encoding so, e.g., a path supplied to one of + the path methods may contain matrix parameters or multiple path segments since the separators are legal + characters and will not be encoded. Percent encoded values are also recognized where allowed and will not be double + encoded. +

+ +

+ URI templates are allowed in most components of a URI but their value is restricted to a particular component. E.g. +

UriBuilder.fromPath("{arg1}").build("foo#bar");
would result in encoding of the + '#' such that the resulting URI is "foo%23bar". To create a URI "foo#bar" use +
UriBuilder.fromPath("{arg1}").fragment("{arg2}").build("foo", "bar")
instead. + URI template names and delimiters are never encoded but their values are encoded when a URI is built. Template + parameter regular expressions are ignored when building a URI, i.e. no validation is performed.
+
+
Since:
+
1.0
+
Author:
+
Paul Sandoz, Marc Hadley
+
See Also:
+
+ +
+
+
+
+ +
+
+
    + +
  • +
    +

    Constructor Details

    +
      +
    • +
      +

      UriBuilder

      +
      protected UriBuilder()
      +
      Protected constructor, use one of the static fromXxx(...) methods to obtain an instance.
      +
      +
      • +
    +
    +
    • + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      newInstance

      +
      public static UriBuilder newInstance()
      +
      Creates a new instance of UriBuilder.
      +
      +
      Returns:
      +
      a new instance of UriBuilder.
      +
      Since:
      +
      3.0
      +
      +
      +
      • +
    • +
      +

      fromUri

      +
      public static UriBuilder fromUri(URI uri)
      +
      Create a new instance initialized from an existing URI.
      +
      +
      Parameters:
      +
      uri - a URI that will be used to initialize the UriBuilder.
      +
      Returns:
      +
      a new UriBuilder.
      +
      Throws:
      +
      IllegalArgumentException - if uri is null.
      +
      +
      +
      • +
    • +
      +

      fromUri

      +
      public static UriBuilder fromUri(String uriTemplate)
      +
      Create a new instance initialized from an existing URI.
      +
      +
      Parameters:
      +
      uriTemplate - a URI template that will be used to initialize the UriBuilder, may contain URI parameters.
      +
      Returns:
      +
      a new UriBuilder.
      +
      Throws:
      +
      IllegalArgumentException - if uriTemplate is not a valid URI template or is null.
      +
      +
      +
      • +
    • +
      +

      fromLink

      +
      public static UriBuilder fromLink(Link link)
      +
      Create a new instance initialized from a Link.
      +
      +
      Parameters:
      +
      link - a Link that will be used to initialize the UriBuilder, only its URI is used.
      +
      Returns:
      +
      a new UriBuilder
      +
      Throws:
      +
      IllegalArgumentException - if link is null
      +
      Since:
      +
      2.0
      +
      +
      +
      • +
    • +
      +

      fromPath

      +
      public static UriBuilder fromPath(String path) + throws IllegalArgumentException
      +
      Create a new instance representing a relative URI initialized from a URI path.
      +
      +
      Parameters:
      +
      path - a URI path that will be used to initialize the UriBuilder, may contain URI template parameters.
      +
      Returns:
      +
      a new UriBuilder.
      +
      Throws:
      +
      IllegalArgumentException - if path is null.
      +
      +
      +
      • +
    • +
      +

      fromResource

      +
      public static UriBuilder fromResource(Class<?> resource)
      +
      Create a new instance representing a relative URI initialized from a root resource class.
      +
      +
      Parameters:
      +
      resource - a root resource whose Path value will be used to initialize the UriBuilder.
      +
      Returns:
      +
      a new UriBuilder.
      +
      Throws:
      +
      IllegalArgumentException - if resource is not annotated with Path or resource is + null.
      +
      +
      +
      • +
    • +
      +

      fromMethod

      +
      public static UriBuilder fromMethod(Class<?> resource, + String method)
      +
      Create a new instance representing a relative URI initialized from a Path-annotated method. + + This method can only be used in cases where there is a single method with the specified name that is annotated with + Path.
      +
      +
      Parameters:
      +
      resource - the resource containing the method.
      +
      method - the name of the method whose Path value will be used to obtain the path to append.
      +
      Returns:
      +
      the updated UriBuilder.
      +
      Throws:
      +
      IllegalArgumentException - if resource or method is null, or there is more than or less than one + variant of the method annotated with Path.
      +
      Since:
      +
      2.0
      +
      +
      +
      • +
    • +
      +

      clone

      +
      public abstract UriBuilder clone()
      +
      Create a copy of the UriBuilder preserving its state. This is a more efficient means of creating a copy than + constructing a new UriBuilder from a URI returned by the build(Object...) method.
      +
      +
      Overrides:
      +
      clone in class Object
      +
      Returns:
      +
      a copy of the UriBuilder.
      +
      +
      +
      • +
    • +
      +

      uri

      +
      public abstract UriBuilder uri(URI uri)
      +
      Copies the non-null components of the supplied URI to the UriBuilder replacing any existing values for those + components.
      +
      +
      Parameters:
      +
      uri - the URI to copy components from.
      +
      Returns:
      +
      the updated UriBuilder.
      +
      Throws:
      +
      IllegalArgumentException - if the uri parameter is null.
      +
      +
      +
      • +
    • +
      +

      uri

      +
      public abstract UriBuilder uri(String uriTemplate)
      +
      Parses the uriTemplate string and copies the parsed components of the supplied URI to the UriBuilder + replacing any existing values for those components.
      +
      +
      Parameters:
      +
      uriTemplate - a URI template that will be used to initialize the UriBuilder, may contain URI parameters.
      +
      Returns:
      +
      the updated UriBuilder.
      +
      Throws:
      +
      IllegalArgumentException - if uriTemplate is not a valid URI template or is null.
      +
      Since:
      +
      2.0
      +
      +
      +
      • +
    • +
      +

      scheme

      +
      public abstract UriBuilder scheme(String scheme)
      +
      Set the URI scheme.
      +
      +
      Parameters:
      +
      scheme - the URI scheme, may contain URI template parameters. A null value will unset the URI scheme, + but will not unset the any scheme-specific-part components.
      +
      Returns:
      +
      the updated UriBuilder.
      +
      Throws:
      +
      IllegalArgumentException - if scheme is invalid.
      +
      +
      +
      • +
    • +
      +

      schemeSpecificPart

      +
      public abstract UriBuilder schemeSpecificPart(String ssp)
      +
      Set the URI scheme-specific-part (see URI). This method will overwrite any existing values for + authority, user-info, host, port and path.
      +
      +
      Parameters:
      +
      ssp - the URI scheme-specific-part, may contain URI template parameters.
      +
      Returns:
      +
      the updated UriBuilder.
      +
      Throws:
      +
      IllegalArgumentException - if ssp cannot be parsed or is null.
      +
      +
      +
      • +
    • +
      +

      userInfo

      +
      public abstract UriBuilder userInfo(String ui)
      +
      Set the URI user-info.
      +
      +
      Parameters:
      +
      ui - the URI user-info, may contain URI template parameters. A null value will unset userInfo component + of the URI.
      +
      Returns:
      +
      the updated UriBuilder.
      +
      +
      +
      • +
    • +
      +

      host

      +
      public abstract UriBuilder host(String host)
      +
      Set the URI host.
      +
      +
      Parameters:
      +
      host - the URI host, may contain URI template parameters. A null value will unset the host component of + the URI, but will not unset other authority component parts (user info or port).
      +
      Returns:
      +
      the updated UriBuilder.
      +
      Throws:
      +
      IllegalArgumentException - if host is invalid.
      +
      +
      +
      • +
    • +
      +

      port

      +
      public abstract UriBuilder port(int port)
      +
      Set the URI port.
      +
      +
      Parameters:
      +
      port - the URI port, a value of -1 will unset an explicit port.
      +
      Returns:
      +
      the updated UriBuilder.
      +
      Throws:
      +
      IllegalArgumentException - if port is invalid.
      +
      +
      +
      • +
    • +
      +

      replacePath

      +
      public abstract UriBuilder replacePath(String path)
      +
      Set the URI path. This method will overwrite any existing path and associated matrix parameters. Existing '/' + characters are preserved thus a single value can represent multiple URI path segments.
      +
      +
      Parameters:
      +
      path - the path, may contain URI template parameters. A null value will unset the path component of the + URI.
      +
      Returns:
      +
      the updated UriBuilder.
      +
      +
      +
      • +
    • +
      +

      path

      +
      public abstract UriBuilder path(String path)
      +
      Append path to the existing path. When constructing the final path, a '/' separator will be inserted between the + existing path and the supplied path if necessary. Existing '/' characters are preserved thus a single value can + represent multiple URI path segments.
      +
      +
      Parameters:
      +
      path - the path, may contain URI template parameters.
      +
      Returns:
      +
      the updated UriBuilder.
      +
      Throws:
      +
      IllegalArgumentException - if path is null.
      +
      +
      +
      • +
    • +
      +

      path

      +
      public abstract UriBuilder path(Class resource)
      +
      Append the path from a Path-annotated class to the existing path. When constructing the final path, a '/' separator + will be inserted between the existing path and the supplied path if necessary.
      +
      +
      Parameters:
      +
      resource - a resource whose Path value will be used to obtain the path to append.
      +
      Returns:
      +
      the updated UriBuilder.
      +
      Throws:
      +
      IllegalArgumentException - if resource is null, or if resource is not annotated with + Path.
      +
      +
      +
      • +
    • +
      +

      path

      +
      public abstract UriBuilder path(Class resource, + String method)
      +
      Append the path from a Path-annotated method to the existing path. When constructing the final path, a '/' separator + will be inserted between the existing path and the supplied path if necessary. This method is a convenience shortcut + to path(Method), it can only be used in cases where there is a single method with the specified name that is + annotated with Path.
      +
      +
      Parameters:
      +
      resource - the resource containing the method.
      +
      method - the name of the method whose Path value will be used to obtain the path to append.
      +
      Returns:
      +
      the updated UriBuilder.
      +
      Throws:
      +
      IllegalArgumentException - if resource or method is null, or there is more than or less than one + variant of the method annotated with Path.
      +
      +
      +
      • +
    • +
      +

      path

      +
      public abstract UriBuilder path(Method method)
      +
      Append the path from a Path-annotated method to the existing path. When constructing the final + path, a '/' separator will be inserted between the existing path and the supplied path if necessary.
      +
      +
      Parameters:
      +
      method - a method whose Path value will be used to obtain the path to append to the existing + path.
      +
      Returns:
      +
      the updated UriBuilder.
      +
      Throws:
      +
      IllegalArgumentException - if method is null or is not annotated with a Path.
      +
      +
      +
      • +
    • +
      +

      segment

      +
      public abstract UriBuilder segment(String... segments)
      +
      Append path segments to the existing path. When constructing the final path, a '/' separator will be inserted between + the existing path and the first path segment if necessary and each supplied segment will also be separated by '/'. + Existing '/' characters are encoded thus a single value can only represent a single URI path segment.
      +
      +
      Parameters:
      +
      segments - the path segment values, each may contain URI template parameters.
      +
      Returns:
      +
      the updated UriBuilder.
      +
      Throws:
      +
      IllegalArgumentException - if segments or any element of segments is null.
      +
      +
      +
      • +
    • +
      +

      replaceMatrix

      +
      public abstract UriBuilder replaceMatrix(String matrix)
      +
      Set the matrix parameters of the current final segment of the current URI path. This method will overwrite any + existing matrix parameters on the current final segment of the current URI path. Note that the matrix parameters are + tied to a particular path segment; subsequent addition of path segments will not affect their position in the URI + path.
      +
      +
      Parameters:
      +
      matrix - the matrix parameters, may contain URI template parameters. A null value will remove all matrix + parameters of the current final segment of the current URI path.
      +
      Returns:
      +
      the updated UriBuilder.
      +
      Throws:
      +
      IllegalArgumentException - if matrix cannot be parsed.
      +
      See Also:
      +
      + +
      +
      +
      +
      • +
    • +
      +

      matrixParam

      +
      public abstract UriBuilder matrixParam(String name, + Object... values)
      +
      Append a matrix parameter to the existing set of matrix parameters of the current final segment of the URI path. If + multiple values are supplied the parameter will be added once per value. Note that the matrix parameters are tied to + a particular path segment; subsequent addition of path segments will not affect their position in the URI path.
      +
      +
      Parameters:
      +
      name - the matrix parameter name, may contain URI template parameters.
      +
      values - the matrix parameter value(s), each object will be converted. to a String using its + toString() method. Stringified values may contain URI template parameters.
      +
      Returns:
      +
      the updated UriBuilder.
      +
      Throws:
      +
      IllegalArgumentException - if name or values is null.
      +
      See Also:
      +
      + +
      +
      +
      +
      • +
    • +
      +

      replaceMatrixParam

      +
      public abstract UriBuilder replaceMatrixParam(String name, + Object... values)
      +
      Replace the existing value(s) of a matrix parameter on the current final segment of the URI path. If multiple values + are supplied the parameter will be added once per value. Note that the matrix parameters are tied to a particular + path segment; subsequent addition of path segments will not affect their position in the URI path.
      +
      +
      Parameters:
      +
      name - the matrix parameter name, may contain URI template parameters.
      +
      values - the matrix parameter value(s), each object will be converted. to a String using its + toString() method. Stringified values may contain URI template parameters. If values is empty or + null then all current values of the parameter are removed.
      +
      Returns:
      +
      the updated UriBuilder.
      +
      Throws:
      +
      IllegalArgumentException - if name is null.
      +
      See Also:
      +
      + +
      +
      +
      +
      • +
    • +
      +

      replaceQuery

      +
      public abstract UriBuilder replaceQuery(String query)
      +
      Set the URI query string. This method will overwrite any existing query parameters.
      +
      +
      Parameters:
      +
      query - the URI query string, may contain URI template parameters. A null value will remove all query + parameters.
      +
      Returns:
      +
      the updated UriBuilder.
      +
      Throws:
      +
      IllegalArgumentException - if query cannot be parsed.
      +
      +
      +
      • +
    • +
      +

      queryParam

      +
      public abstract UriBuilder queryParam(String name, + Object... values)
      +
      Append a query parameter to the existing set of query parameters. If multiple values are supplied the parameter will + be added once per value.
      +
      +
      Parameters:
      +
      name - the query parameter name, may contain URI template parameters.
      +
      values - the query parameter value(s), each object will be converted to a String using its + toString() method. Stringified values may contain URI template parameters.
      +
      Returns:
      +
      the updated UriBuilder.
      +
      Throws:
      +
      IllegalArgumentException - if name or values is null.
      +
      +
      +
      • +
    • +
      +

      replaceQueryParam

      +
      public abstract UriBuilder replaceQueryParam(String name, + Object... values)
      +
      Replace the existing value(s) of a query parameter. If multiple values are supplied the parameter will be added once + per value.
      +
      +
      Parameters:
      +
      name - the query parameter name, may contain URI template parameters.
      +
      values - the query parameter value(s), each object will be converted to a String using its + toString() method. Stringified values may contain URI template parameters. If values is empty or + null then all current values of the parameter are removed.
      +
      Returns:
      +
      the updated UriBuilder.
      +
      Throws:
      +
      IllegalArgumentException - if name is null.
      +
      +
      +
      • +
    • +
      +

      fragment

      +
      public abstract UriBuilder fragment(String fragment)
      +
      Set the URI fragment.
      +
      +
      Parameters:
      +
      fragment - the URI fragment, may contain URI template parameters. A null value will remove any existing + fragment.
      +
      Returns:
      +
      the updated UriBuilder.
      +
      +
      +
      • +
    • +
      +

      resolveTemplate

      +
      public abstract UriBuilder resolveTemplate(String name, + Object value)
      +
      Resolve a URI template with a given name in this UriBuilder instance using a supplied value. + + In case a null template name or value is entered a IllegalArgumentException is thrown.
      +
      +
      Parameters:
      +
      name - name of the URI template.
      +
      value - value to be used to resolve the template.
      +
      Returns:
      +
      the updated UriBuilder.
      +
      Throws:
      +
      IllegalArgumentException - if the resolved template name or value is null.
      +
      Since:
      +
      2.0
      +
      +
      +
      • +
    • +
      +

      resolveTemplate

      +
      public abstract UriBuilder resolveTemplate(String name, + Object value, + boolean encodeSlashInPath)
      +
      Resolve a URI template with a given name in this UriBuilder instance using a supplied value. + + In case a null template name or value is entered a IllegalArgumentException is thrown.
      +
      +
      Parameters:
      +
      name - name of the URI template.
      +
      value - value to be used to resolve the template.
      +
      encodeSlashInPath - if true, the slash ('/') characters in template values will be encoded if + the template is placed in the URI path component, otherwise the slash characters will not be encoded in path + templates.
      +
      Returns:
      +
      the updated UriBuilder.
      +
      Throws:
      +
      IllegalArgumentException - if the resolved template name or value is null.
      +
      Since:
      +
      2.0
      +
      +
      +
      • +
    • +
      +

      resolveTemplateFromEncoded

      +
      public abstract UriBuilder resolveTemplateFromEncoded(String name, + Object value)
      +
      Resolve a URI template with a given name in this UriBuilder instance using a supplied encoded value. + + A template with a matching name will be replaced by the supplied value. Value is converted to String using + its toString() method and is then encoded to match the rules of the URI component to which they pertain. All + % characters in the stringified values that are not followed by two hexadecimal numbers will be encoded. + + In case a null template name or encoded value is entered a IllegalArgumentException is thrown.
      +
      +
      Parameters:
      +
      name - name of the URI template.
      +
      value - encoded value to be used to resolve the template.
      +
      Returns:
      +
      the updated UriBuilder.
      +
      Throws:
      +
      IllegalArgumentException - if the resolved template name or encoded value is null.
      +
      Since:
      +
      2.0
      +
      +
      +
      • +
    • +
      +

      resolveTemplates

      +
      public abstract UriBuilder resolveTemplates(Map<String,Object> templateValues)
      +
      Resolve one or more URI templates in this UriBuilder instance using supplied name-value pairs. + + A call to the method with an empty parameter map is ignored.
      +
      +
      Parameters:
      +
      templateValues - a map of URI template names and their values.
      +
      Returns:
      +
      the updated UriBuilder.
      +
      Throws:
      +
      IllegalArgumentException - if the name-value map or any of the names or values in the map is null.
      +
      Since:
      +
      2.0
      +
      +
      +
      • +
    • +
      +

      resolveTemplates

      +
      public abstract UriBuilder resolveTemplates(Map<String,Object> templateValues, + boolean encodeSlashInPath) + throws IllegalArgumentException
      +
      Resolve one or more URI templates in this UriBuilder instance using supplied name-value pairs. + + A call to the method with an empty parameter map is ignored.
      +
      +
      Parameters:
      +
      templateValues - a map of URI template names and their values.
      +
      encodeSlashInPath - if true, the slash ('/') characters in template values will be encoded if + the template is placed in the URI path component, otherwise the slash characters will not be encoded in path + templates.
      +
      Returns:
      +
      the updated UriBuilder.
      +
      Throws:
      +
      IllegalArgumentException - if the name-value map or any of the names or values in the map is null.
      +
      Since:
      +
      2.0
      +
      +
      +
      • +
    • +
      +

      resolveTemplatesFromEncoded

      +
      public abstract UriBuilder resolveTemplatesFromEncoded(Map<String,Object> templateValues)
      +
      Resolve one or more URI templates in this UriBuilder instance using supplied name-value pairs. + + All templates with their name matching one of the keys in the supplied map will be replaced by the value in the + supplied map. Values are converted to String using their toString() method and are then encoded to + match the rules of the URI component to which they pertain. All % characters in the stringified values that are not + followed by two hexadecimal numbers will be encoded. + + A call to the method with an empty parameter map is ignored.
      +
      +
      Parameters:
      +
      templateValues - a map of URI template names and their values.
      +
      Returns:
      +
      the updated UriBuilder.
      +
      Throws:
      +
      IllegalArgumentException - if the name-value map or any of the names or values in the map is null.
      +
      Since:
      +
      2.0
      +
      +
      +
      • +
    • +
      +

      buildFromMap

      +
      public abstract URI buildFromMap(Map<String,?> values)
      +
      Build a URI. + + Any URI template parameters will be replaced by the value in the supplied map. Values are converted to String + using their toString() method and are then encoded to match the rules of the URI component to which they + pertain. All '%' characters in the stringified values will be encoded. The state of the builder is + unaffected; this method may be called multiple times on the same builder instance. +

      + NOTE: By default all '/' characters in the stringified values will be encoded in path templates, i.e. the + result is identical to invoking buildFromMap(valueMap, true). To + override this behavior use buildFromMap(valueMap, false) instead. +

      +
      +
      Parameters:
      +
      values - a map of URI template parameter names and values.
      +
      Returns:
      +
      the URI built from the UriBuilder.
      +
      Throws:
      +
      IllegalArgumentException - if there are any URI template parameters without a supplied value, or if a template + parameter value is null.
      +
      UriBuilderException - if a URI cannot be constructed based on the current state of the builder.
      +
      See Also:
      +
      + +
      +
      +
      +
      • +
    • +
      +

      buildFromMap

      +
      public abstract URI buildFromMap(Map<String,?> values, + boolean encodeSlashInPath) + throws IllegalArgumentException, +UriBuilderException
      +
      Build a URI. + + Any URI template parameters will be replaced by the value in the supplied map. Values are converted to String + using their toString() method and are then encoded to match the rules of the URI component to which they + pertain. All '%' characters in the stringified values will be encoded. The state of the builder is + unaffected; this method may be called multiple times on the same builder instance. +

      + The encodeSlashInPath parameter may be used to override the default encoding of '/' characters in the + stringified template values in cases when the template is part of the URI path component when using the + buildFromMap(java.util.Map) method. If the encodeSlashInPath parameter is set to true + (default), the slash ('/') characters in parameter values will be encoded if the template is placed in the + URI path component. If set to false the default encoding behavior is overridden an slash characters in + template values will not be encoded when used to substitute path templates. +

      +
      +
      Parameters:
      +
      values - a map of URI template parameter names and values.
      +
      encodeSlashInPath - if true, the slash ('/') characters in parameter values will be encoded if + the template is placed in the URI path component, otherwise the slash characters will not be encoded in path + templates.
      +
      Returns:
      +
      the URI built from the UriBuilder.
      +
      Throws:
      +
      IllegalArgumentException - if there are any URI template parameters without a supplied value, or if a template + parameter value is null.
      +
      UriBuilderException - if a URI cannot be constructed based on the current state of the builder.
      +
      See Also:
      +
      + +
      +
      +
      +
      • +
    • +
      +

      buildFromEncodedMap

      +
      public abstract URI buildFromEncodedMap(Map<String,?> values) + throws IllegalArgumentException, +UriBuilderException
      +
      Build a URI. + + Any URI template parameters will be replaced by the value in the supplied map. Values are converted to String + using their toString() method and are then encoded to match the rules of the URI component to which they + pertain. All % characters in the stringified values that are not followed by two hexadecimal numbers will be encoded. + The state of the builder is unaffected; this method may be called multiple times on the same builder instance.
      +
      +
      Parameters:
      +
      values - a map of URI template parameter names and values.
      +
      Returns:
      +
      the URI built from the UriBuilder.
      +
      Throws:
      +
      IllegalArgumentException - if there are any URI template parameters without a supplied value, or if a template + parameter value is null.
      +
      UriBuilderException - if a URI cannot be constructed based on the current state of the builder.
      +
      Since:
      +
      2.0
      +
      See Also:
      +
      + +
      +
      +
      +
      • +
    • +
      +

      build

      +
      public abstract URI build(Object... values) + throws IllegalArgumentException, +UriBuilderException
      +
      Build a URI, using the supplied values in order to replace any URI template parameters. Values are converted to + String using their toString() method and are then encoded to match the rules of the URI component to + which they pertain. All '%' characters in the stringified values will be encoded. The state of the builder is + unaffected; this method may be called multiple times on the same builder instance. +

      + All instances of the same template parameter will be replaced by the same value that corresponds to the position of + the first instance of the template parameter. e.g. the template "{a}/{b}/{a}" with values {"x", "y", "z"} will result + in the the URI "x/y/x", not "x/y/z". +

      +

      + NOTE: By default all '/' characters in the stringified values will be encoded in path templates, i.e. the + result is identical to invoking build(Object[], boolean) build(values, true)}. To override this behavior use + build(values, false) instead. +

      +
      +
      Parameters:
      +
      values - a list of URI template parameter values.
      +
      Returns:
      +
      the URI built from the UriBuilder.
      +
      Throws:
      +
      IllegalArgumentException - if there are any URI template parameters without a supplied value, or if a value is + null.
      +
      UriBuilderException - if a URI cannot be constructed based on the current state of the builder.
      +
      See Also:
      +
      + +
      +
      +
      +
      • +
    • +
      +

      build

      +
      public abstract URI build(Object[] values, + boolean encodeSlashInPath) + throws IllegalArgumentException, +UriBuilderException
      +
      Build a URI, using the supplied values in order to replace any URI template parameters. Values are converted to + String using their toString() method and are then encoded to match the rules of the URI component to + which they pertain. All '%' characters in the stringified values will be encoded. The state of the builder is + unaffected; this method may be called multiple times on the same builder instance. +

      + All instances of the same template parameter will be replaced by the same value that corresponds to the position of + the first instance of the template parameter. e.g. the template "{a}/{b}/{a}" with values {"x", "y", "z"} will result + in the the URI "x/y/x", not "x/y/z". +

      +

      + The encodeSlashInPath parameter may be used to override the default encoding of '/' characters in the + stringified template values in cases when the template is part of the URI path component when using the + build(Object[]) method. If the encodeSlashInPath parameter is set to true (default), the + slash ('/') characters in parameter values will be encoded if the template is placed in the URI path + component. If set to false the default encoding behavior is overridden an slash characters in template values + will not be encoded when used to substitute path templates. +

      +
      +
      Parameters:
      +
      values - a list of URI template parameter values.
      +
      encodeSlashInPath - if true, the slash ('/') characters in parameter values will be encoded if + the template is placed in the URI path component, otherwise the slash characters will not be encoded in path + templates.
      +
      Returns:
      +
      the URI built from the UriBuilder.
      +
      Throws:
      +
      IllegalArgumentException - if there are any URI template parameters without a supplied value, or if a value is + null.
      +
      UriBuilderException - if a URI cannot be constructed based on the current state of the builder.
      +
      Since:
      +
      2.0
      +
      See Also:
      +
      + +
      +
      +
      +
      • +
    • +
      +

      buildFromEncoded

      +
      public abstract URI buildFromEncoded(Object... values) + throws IllegalArgumentException, +UriBuilderException
      +
      Build a URI. Any URI templates parameters will be replaced with the supplied values in order. Values are converted to + String using their toString() method and are then encoded to match the rules of the URI component to + which they pertain. All % characters in the stringified values that are not followed by two hexadecimal numbers will + be encoded. The state of the builder is unaffected; this method may be called multiple times on the same builder + instance. +

      + All instances of the same template parameter will be replaced by the same value that corresponds to the position of + the first instance of the template parameter. e.g. the template "{a}/{b}/{a}" with values {"x", "y", "z"} will result + in the the URI "x/y/x", not "x/y/z".

      +
      +
      Parameters:
      +
      values - a list of URI template parameter values.
      +
      Returns:
      +
      the URI built from the UriBuilder.
      +
      Throws:
      +
      IllegalArgumentException - if there are any URI template parameters without a supplied value, or if a value is + null.
      +
      UriBuilderException - if a URI cannot be constructed based on the current state of the builder.
      +
      See Also:
      +
      + +
      +
      +
      +
      • +
    • +
      +

      toTemplate

      +
      public abstract String toTemplate()
      +
      Get the URI template string represented by this URI builder.
      +
      +
      Returns:
      +
      the URI template string for this URI builder.
      +
      Since:
      +
      2.0
      +
      +
      +
      • +
    +
    +
    • +
+
+ +
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/UriBuilderException.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/UriBuilderException.html new file mode 100644 index 0000000000..50ef46fb22 --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/UriBuilderException.html @@ -0,0 +1,238 @@ + + + + +UriBuilderException (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Module jakarta.ws.rs
+
Package jakarta.ws.rs.core
+

Class UriBuilderException

+
+
java.lang.Object +
java.lang.Throwable +
java.lang.Exception +
java.lang.RuntimeException +
jakarta.ws.rs.core.UriBuilderException
+
+
+
+
+
+
+
All Implemented Interfaces:
+
Serializable
+
+
+
public class UriBuilderException +extends RuntimeException
+
A runtime exception thrown by UriBuilder.build(Object...) methods when a URI cannot be + constructed based on the current state of the builder.
+
+
Since:
+
1.0
+
Author:
+
Paul Sandoz, Marc Hadley
+
See Also:
+
+ +
+
+
+
+ +
+
+
    + +
  • +
    +

    Constructor Details

    +
      +
    • +
      +

      UriBuilderException

      +
      public UriBuilderException()
      +
      Creates a new instance of UriBuilderException without detail message.
      +
      +
      • +
    • +
      +

      UriBuilderException

      +
      public UriBuilderException(String msg)
      +
      Constructs an instance of UriBuilderException with the specified detail message.
      +
      +
      Parameters:
      +
      msg - the detail message (which is saved for later retrieval by the Throwable.getMessage() method).
      +
      +
      +
      • +
    • +
      +

      UriBuilderException

      +
      public UriBuilderException(String msg, + Throwable cause)
      +
      Constructs an instance of UriBuilderException with the specified detail message and cause. +

      + Note that the detail message associated with cause is not automatically incorporated in this exception's detail + message.

      +
      +
      Parameters:
      +
      msg - the detail message (which is saved for later retrieval by the Throwable.getMessage() method).
      +
      cause - the cause (which is saved for later retrieval by the Throwable.getCause() method). (A null value is + permitted, and indicates that the cause is nonexistent or unknown.)
      +
      +
      +
      • +
    • +
      +

      UriBuilderException

      +
      public UriBuilderException(Throwable cause)
      +
      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). This constructor is useful for exceptions that are little more than wrappers for other throwables.
      +
      +
      Parameters:
      +
      cause - the original exception
      +
      +
      +
      • +
    +
    +
    • +
+
+ +
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/UriInfo.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/UriInfo.html new file mode 100644 index 0000000000..0a53aeea10 --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/UriInfo.html @@ -0,0 +1,755 @@ + + + + +UriInfo (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Module jakarta.ws.rs
+
Package jakarta.ws.rs.core
+

Interface UriInfo

+
+
+
+
public interface UriInfo
+
An injectable interface that provides access to application and request URI information. Relative URIs are relative + to the base URI of the application, see getBaseUri(). + +

+ All methods throw java.lang.IllegalStateException if called outside the scope of a request (e.g. from a + provider constructor). +

+
+
Since:
+
1.0
+
Author:
+
Paul Sandoz, Marc Hadley
+
See Also:
+
+ +
+
+
+
+ +
+
+
    + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      getPath

      +
      String getPath()
      +
      Get the path of the current request relative to the base URI as a string. All sequences of escaped octets are + decoded, equivalent to getPath(true).
      +
      +
      Returns:
      +
      the relative URI path.
      +
      Throws:
      +
      IllegalStateException - if called outside the scope of a request.
      +
      +
      +
      • +
    • +
      +

      getPath

      +
      String getPath(boolean decode)
      +
      Get the path of the current request relative to the base URI as a string.
      +
      +
      Parameters:
      +
      decode - controls whether sequences of escaped octets are decoded (true) or not (false).
      +
      Returns:
      +
      the relative URI path
      +
      Throws:
      +
      IllegalStateException - if called outside the scope of a request.
      +
      +
      +
      • +
    • +
      +

      getPathSegments

      +
      List<PathSegment> getPathSegments()
      +
      Get the path of the current request relative to the base URI as a list of PathSegment. This method is useful + when the path needs to be parsed, particularly when matrix parameters may be present in the path. All sequences of + escaped octets in path segments and matrix parameter values are decoded, equivalent to getPathSegments(true).
      +
      +
      Returns:
      +
      an unmodifiable list of PathSegment. The matrix parameter map of each path segment is also + unmodifiable.
      +
      Throws:
      +
      IllegalStateException - if called outside the scope of a request
      +
      See Also:
      +
      + +
      +
      +
      +
      • +
    • +
      +

      getPathSegments

      +
      List<PathSegment> getPathSegments(boolean decode)
      +
      Get the path of the current request relative to the base URI as a list of PathSegment. This method is useful + when the path needs to be parsed, particularly when matrix parameters may be present in the path.
      +
      +
      Parameters:
      +
      decode - controls whether sequences of escaped octets in path segments and matrix parameter values are decoded + (true) or not (false).
      +
      Returns:
      +
      an unmodifiable list of PathSegment. The matrix parameter map of each path segment is also + unmodifiable.
      +
      Throws:
      +
      IllegalStateException - if called outside the scope of a request
      +
      See Also:
      +
      + +
      +
      +
      +
      • +
    • +
      +

      getRequestUri

      +
      URI getRequestUri()
      +
      Get the absolute request URI including any query parameters.
      +
      +
      Returns:
      +
      the absolute request URI
      +
      Throws:
      +
      IllegalStateException - if called outside the scope of a request
      +
      +
      +
      • +
    • +
      +

      getRequestUriBuilder

      +
      UriBuilder getRequestUriBuilder()
      +
      Get the absolute request URI in the form of a UriBuilder.
      +
      +
      Returns:
      +
      a UriBuilder initialized with the absolute request URI.
      +
      Throws:
      +
      IllegalStateException - if called outside the scope of a request.
      +
      +
      +
      • +
    • +
      +

      getAbsolutePath

      +
      URI getAbsolutePath()
      +
      Get the absolute path of the request. This includes everything preceding the path (host, port etc) but excludes query + parameters. This is a shortcut for uriInfo.getBaseUri().resolve(uriInfo.getPath(false)).
      +
      +
      Returns:
      +
      the absolute path of the request.
      +
      Throws:
      +
      IllegalStateException - if called outside the scope of a request.
      +
      +
      +
      • +
    • +
      +

      getAbsolutePathBuilder

      +
      UriBuilder getAbsolutePathBuilder()
      +
      Get the absolute path of the request in the form of a UriBuilder. This includes everything preceding the path (host, + port etc) but excludes query parameters.
      +
      +
      Returns:
      +
      a UriBuilder initialized with the absolute path of the request.
      +
      Throws:
      +
      IllegalStateException - if called outside the scope of a request.
      +
      +
      +
      • +
    • +
      +

      getBaseUri

      +
      URI getBaseUri()
      +
      Get the base URI of the application. URIs of root resource classes are all relative to this base URI.
      +
      +
      Returns:
      +
      the base URI of the application.
      +
      +
      +
      • +
    • +
      +

      getBaseUriBuilder

      +
      UriBuilder getBaseUriBuilder()
      +
      Get the base URI of the application in the form of a UriBuilder.
      +
      +
      Returns:
      +
      a UriBuilder initialized with the base URI of the application.
      +
      +
      +
      • +
    • +
      +

      getPathParameters

      +
      MultivaluedMap<String,String> getPathParameters()
      +
      Get the values of any embedded URI template parameters. All sequences of escaped octets are decoded, equivalent to + getPathParameters(true).
      +
      +
      Returns:
      +
      an unmodifiable map of parameter names and values.
      +
      Throws:
      +
      IllegalStateException - if called outside the scope of a request.
      +
      See Also:
      +
      + +
      +
      +
      +
      • +
    • +
      +

      getPathParameters

      +
      MultivaluedMap<String,String> getPathParameters(boolean decode)
      +
      Get the values of any embedded URI template parameters.
      +
      +
      Parameters:
      +
      decode - controls whether sequences of escaped octets are decoded (true) or not (false).
      +
      Returns:
      +
      an unmodifiable map of parameter names and values
      +
      Throws:
      +
      IllegalStateException - if called outside the scope of a request.
      +
      See Also:
      +
      + +
      +
      +
      +
      • +
    • +
      +

      getQueryParameters

      +
      MultivaluedMap<String,String> getQueryParameters()
      +
      Get the URI query parameters of the current request. The map keys are the names of the query parameters with any + escaped characters decoded. All sequences of escaped octets in parameter names and values are decoded, equivalent to + getQueryParameters(true).
      +
      +
      Returns:
      +
      an unmodifiable map of query parameter names and values.
      +
      Throws:
      +
      IllegalStateException - if called outside the scope of a request.
      +
      +
      +
      • +
    • +
      +

      getQueryParameters

      +
      MultivaluedMap<String,String> getQueryParameters(boolean decode)
      +
      Get the URI query parameters of the current request. The map keys are the names of the query parameters with any + escaped characters decoded.
      +
      +
      Parameters:
      +
      decode - controls whether sequences of escaped octets in parameter names and values are decoded (true) + or not (false).
      +
      Returns:
      +
      an unmodifiable map of query parameter names and values.
      +
      Throws:
      +
      IllegalStateException - if called outside the scope of a request.
      +
      +
      +
      • +
    • +
      +

      getMatchedURIs

      +
      List<String> getMatchedURIs()
      +
      Get a read-only list of URIs for matched resources. + + Each entry is a relative URI that matched a resource class, a sub-resource method or a sub-resource locator. All + sequences of escaped octets are decoded, equivalent to getMatchedURIs(true). Entries do not include query + parameters but do include matrix parameters if present in the request URI. Entries are ordered in reverse request URI + matching order, with the current resource URI first. E.g. given the following resource classes: + + 
      + @Path("foo")
+ public class FooResource {
+  @GET
+  public String getFoo() {...}
+
+  @Path("bar")
+  public BarResource getBarResource() {...}
+ }
+
+ public class BarResource {
+  @GET
+  public String getBar() {...}
+ }
+
      + +

      + The values returned by this method based on request uri and where the method is called from are: +

      + + + + + + + + + + + + + + + + + + + + + + + +
      Matched URIs from requests
      RequestCalled fromValue(s)
      GET /fooFooResource.getFoofoo
      GET /foo/barFooResource.getBarResourcefoo/bar, foo
      GET /foo/barBarResource.getBarfoo/bar, foo
      + + In case the method is invoked prior to the request matching (e.g. from a pre-matching filter), the method returns an + empty list.
      +
      +
      Returns:
      +
      a read-only list of URI paths for matched resources.
      +
      +
      +
      • +
    • +
      +

      getMatchedResourceTemplate

      +
      String getMatchedResourceTemplate()
      +

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

      +

      + Each Path value used to match a resource class, a sub-resource method or a sub-resource locator is concatenated + into a single String value. The template does not include query parameters but does include matrix parameters + if present in the request URI. The concatenation is ordered in the request URI matching order, with the + ApplicationPath value first and current resource URI last. E.g. given the following resource classes: +

      + + 
      + @Path("foo")
+ public class FooResource {
+  @GET
+  @Path("{foo:[f-z][a-z]*}")
+  public String getFoo() {...}
+
+  @Path("{bar:[b-e][a-z]*}")
+  public BarResource getBarResource() {...}
+ }
+
+ public class BarResource {
+  @GET
+  @Path("{id}{id:[0-9]}")
+  public String getBar() {...}
+ }
+
      + +

      + The values returned by this method based on request uri and where the method is called from are: +

      + + + + + + + + + + + + + + + + + + + + + + + +
      Matched URIs from requests
      RequestCalled fromValue(s)
      GET /fooFooResource.getFoo/foo/{foo:[f-z][a-z]*}
      GET /foo/barFooResource.getBarResource/foo/{bar:[b-e][a-z]*}
      GET /foo/bar/id0BarResource.getBar/foo/{bar:[b-e][a-z]*}/{id}{id:[0-9]}
      + + In case the method is invoked prior to the request matching (e.g. from a pre-matching filter), the method returns an + empty string.
      +
      +
      Returns:
      +
      A concatenated string of Path templates.
      +
      +
      +
      • +
    • +
      +

      getMatchedURIs

      +
      List<String> getMatchedURIs(boolean decode)
      +
      Get a read-only list of URIs for matched resources. + + Each entry is a relative URI that matched a resource class, a sub-resource method or a sub-resource locator. Entries + do not include query parameters but do include matrix parameters if present in the request URI. Entries are ordered + in reverse request URI matching order, with the current resource URI first. See getMatchedURIs() for an + example. + + In case the method is invoked prior to the request matching (e.g. from a pre-matching filter), the method returns an + empty list.
      +
      +
      Parameters:
      +
      decode - controls whether sequences of escaped octets are decoded (true) or not (false).
      +
      Returns:
      +
      a read-only list of URI paths for matched resources.
      +
      +
      +
      • +
    • +
      +

      getMatchedResources

      +
      List<Object> getMatchedResources()
      +
      Get a read-only list of the currently matched resource class instances. + + Each entry is a resource class instance that matched the request URI either directly or via a sub-resource method or + a sub-resource locator. Entries are ordered according to reverse request URI matching order, with the current + resource first. E.g. given the following resource classes: + + 
      + @Path("foo")
+ public class FooResource {
+  @GET
+  public String getFoo() {...}
+
+  @Path("bar")
+  public BarResource getBarResource() {...}
+ }
+
+ public class BarResource {
+  @GET
+  public String getBar() {...}
+ }
+
      + +

      + The values returned by this method based on request uri and where the method is called from are: +

      + + + + + + + + + + + + + + + + + + + + + + + +
      Matched resources from requests
      RequestCalled fromValue(s)
      GET /fooFooResource.getFooFooResource
      GET /foo/barFooResource.getBarResourceFooResource
      GET /foo/barBarResource.getBarBarResource, FooResource
      + + In case the method is invoked prior to the request matching (e.g. from a pre-matching filter), the method returns an + empty list.
      +
      +
      Returns:
      +
      a read-only list of matched resource class instances.
      +
      +
      +
      • +
    • +
      +

      resolve

      +
      URI resolve(URI uri)
      +
      Resolve a relative URI with respect to the base URI of the application. The resolved URI returned by this method is + normalized. If the supplied URI is already resolved, it is just returned.
      +
      +
      Parameters:
      +
      uri - URI to resolve against the base URI of the application.
      +
      Returns:
      +
      newly resolved URI or supplied URI if already resolved.
      +
      Since:
      +
      2.0
      +
      +
      +
      • +
    • +
      +

      relativize

      +
      URI relativize(URI uri)
      +
      Relativize a URI with respect to the current request URI. Relativization works as follows: +
        +
      1. If the URI to relativize is already relative, it is first resolved using resolve(java.net.URI).
        2. +
      2. The resulting URI is relativized with respect to the current request URI. If the two URIs do not share a prefix, + the URI computed in step 1 is returned.
        3. +
      + +

      + Examples (for base URI http://example.com:8080/app/root/):
      +
      + Request URI: http://example.com:8080/app/root/a/b/c/resource.html
      + Supplied URI: a/b/c/d/file.txt
      + Returned URI: d/file.txt
      +
      + Request URI: http://example.com:8080/app/root/a/b/c/resource.html
      + Supplied URI: http://example2.com:9090/app2/root2/a/d/file.txt
      + Returned URI: http://example2.com:9090/app2/root2/a/d/file.txt +

      + +

      + In the second example, the supplied URI is returned given that it is absolute and there is no common prefix between + it and the request URI. +

      +
      +
      Parameters:
      +
      uri - URI to relativize against the request URI.
      +
      Returns:
      +
      newly relativized URI.
      +
      Throws:
      +
      IllegalStateException - if called outside the scope of a request.
      +
      Since:
      +
      2.0
      +
      +
      +
      • +
    +
    +
    • +
+
+ +
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/Variant.VariantListBuilder.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/Variant.VariantListBuilder.html new file mode 100644 index 0000000000..c2a63ab65b --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/Variant.VariantListBuilder.html @@ -0,0 +1,313 @@ + + + + +Variant.VariantListBuilder (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Module jakarta.ws.rs
+
Package jakarta.ws.rs.core
+

Class Variant.VariantListBuilder

+
+
java.lang.Object +
jakarta.ws.rs.core.Variant.VariantListBuilder
+
+
+
+
Enclosing class:
+
Variant
+
+
+
public abstract static class Variant.VariantListBuilder +extends Object
+
A builder for a list of representation variants.
+
+
+ +
+
+
    + +
  • +
    +

    Constructor Details

    +
      +
    • +
      +

      VariantListBuilder

      +
      protected VariantListBuilder()
      +
      Protected constructor, use the static newInstance method to obtain an instance.
      +
      +
      • +
    +
    +
    • + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      newInstance

      +
      public static Variant.VariantListBuilder newInstance()
      +
      Create a new builder instance.
      +
      +
      Returns:
      +
      a new builder instance.
      +
      +
      +
      • +
    • +
      +

      build

      +
      public abstract List<Variant> build()
      +
      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. After this + method is called the builder is reset to an empty state.
      +
      +
      Returns:
      +
      a list of representation variants.
      +
      +
      +
      • +
    • +
      +

      add

      +
      public abstract Variant.VariantListBuilder add()
      +
      Add the current combination of metadata to the list of supported variants, after this method is called the current + combination of metadata is emptied. +

      + If more than one value is supplied for one or more of the variant properties then a variant will be generated for + each possible combination. E.g. in the following list would have five (4 + 1) members: +

      + + 
      + List<Variant> list = VariantListBuilder.newInstance()
+         .languages(Locale.ENGLISH, Locale.FRENCH).encodings("zip", "identity").add()
+         .languages(Locale.GERMAN).mediaTypes(MediaType.TEXT_PLAIN_TYPE).add()
+         .build()
+
      +

      + Note that it is not necessary to call the add() method immediately before the build method is called. E.g. + the resulting list produced in the example above would be identical to the list produced by the following code: +

      + + 
      + List<Variant> list = VariantListBuilder.newInstance()
+         .languages(Locale.ENGLISH, Locale.FRENCH).encodings("zip", "identity").add()
+         .languages(Locale.GERMAN).mediaTypes(MediaType.TEXT_PLAIN_TYPE)
+         .build()
+
      +
      +
      Returns:
      +
      the updated builder.
      +
      Throws:
      +
      IllegalStateException - if there is not at least one mediaType, language or encoding set for the current + variant.
      +
      +
      +
      • +
    • +
      +

      languages

      +
      public abstract Variant.VariantListBuilder languages(Locale... languages)
      +
      Set the language(s) for this variant.
      +
      +
      Parameters:
      +
      languages - the available languages.
      +
      Returns:
      +
      the updated builder.
      +
      +
      +
      • +
    • +
      +

      encodings

      +
      public abstract Variant.VariantListBuilder encodings(String... encodings)
      +
      Set the encoding(s) for this variant.
      +
      +
      Parameters:
      +
      encodings - the available encodings.
      +
      Returns:
      +
      the updated builder.
      +
      +
      +
      • +
    • +
      +

      mediaTypes

      +
      public abstract Variant.VariantListBuilder mediaTypes(MediaType... mediaTypes)
      +
      Set the media type(s) for this variant.
      +
      +
      Parameters:
      +
      mediaTypes - the available mediaTypes. If specific charsets are supported they should be included as parameters + of the respective media type.
      +
      Returns:
      +
      the updated builder.
      +
      +
      +
      • +
    +
    +
    • +
+
+ +
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/Variant.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/Variant.html new file mode 100644 index 0000000000..785f8f9c74 --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/Variant.html @@ -0,0 +1,476 @@ + + + + +Variant (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Module jakarta.ws.rs
+
Package jakarta.ws.rs.core
+

Class Variant

+
+
java.lang.Object +
jakarta.ws.rs.core.Variant
+
+
+
+
public class Variant +extends Object
+
Abstraction for a resource representation variant. + + Contains information about media type, language and encoding of the resource representation.
+
+
Since:
+
1.0
+
Author:
+
Paul Sandoz, Marc Hadley
+
+
+
+ +
+
+
    + +
  • +
    +

    Constructor Details

    +
      +
    • +
      +

      Variant

      +
      public Variant(MediaType mediaType, + String language, + String encoding)
      +
      Create a new instance of Variant.
      +
      +
      Parameters:
      +
      mediaType - the media type of the variant - may be null.
      +
      language - the language of the variant (two-letter ISO-639 code); may be null.
      +
      encoding - the content encoding of the variant - may be null.
      +
      Throws:
      +
      IllegalArgumentException - if all the parameters are null.
      +
      Since:
      +
      2.0
      +
      +
      +
      • +
    • +
      +

      Variant

      +
      public Variant(MediaType mediaType, + String language, + String country, + String encoding)
      +
      Create a new instance of Variant.
      +
      +
      Parameters:
      +
      mediaType - the media type of the variant - may be null.
      +
      language - the language of the variant (two-letter ISO-639 code); may be null.
      +
      country - uppercase two-letter ISO-3166 language code of the variant; may be null provided + language is null too.
      +
      encoding - the content encoding of the variant - may be null.
      +
      Throws:
      +
      IllegalArgumentException - if all the parameters are null.
      +
      Since:
      +
      2.0
      +
      +
      +
      • +
    • +
      +

      Variant

      +
      public Variant(MediaType mediaType, + String language, + String country, + String languageVariant, + String encoding)
      +
      Create a new instance of Variant.
      +
      +
      Parameters:
      +
      mediaType - the media type of the variant - may be null.
      +
      language - the language of the variant (two-letter ISO-639 code); may be null.
      +
      country - uppercase two-letter ISO-3166 language code of the variant; may be null provided + language is null too.
      +
      languageVariant - vendor and browser specific language code of the variant (see also Locale class + description); may be null provided language and country are null too.
      +
      encoding - the content encoding of the variant - may be null.
      +
      Throws:
      +
      IllegalArgumentException - if all the parameters are null.
      +
      Since:
      +
      2.0
      +
      +
      +
      • +
    • +
      +

      Variant

      +
      public Variant(MediaType mediaType, + Locale language, + String encoding)
      +
      Create a new instance of Variant.
      +
      +
      Parameters:
      +
      mediaType - the media type of the variant - may be null.
      +
      language - the language of the variant - may be null.
      +
      encoding - the content encoding of the variant - may be null.
      +
      Throws:
      +
      IllegalArgumentException - if all the parameters are null.
      +
      +
      +
      • +
    +
    +
    • + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      getLanguage

      +
      public Locale getLanguage()
      +
      Get the language of the variant.
      +
      +
      Returns:
      +
      the language or null if none set.
      +
      +
      +
      • +
    • +
      +

      getLanguageString

      +
      public String getLanguageString()
      +
      Get the string representation of the variant language, or null if no language has been set.
      +
      +
      Returns:
      +
      the string representing variant language or null if none set.
      +
      Since:
      +
      2.0
      +
      +
      +
      • +
    • +
      +

      getMediaType

      +
      public MediaType getMediaType()
      +
      Get the media type of the variant.
      +
      +
      Returns:
      +
      the media type or null if none set.
      +
      +
      +
      • +
    • +
      +

      getEncoding

      +
      public String getEncoding()
      +
      Get the encoding of the variant.
      +
      +
      Returns:
      +
      the encoding or null if none set.
      +
      +
      +
      • +
    • +
      +

      mediaTypes

      +
      public static Variant.VariantListBuilder mediaTypes(MediaType... mediaTypes)
      +
      Create a Variant.VariantListBuilder initialized with a set of supported media types.
      +
      +
      Parameters:
      +
      mediaTypes - the available mediaTypes. If specific char-sets are supported they should be included as parameters + of the respective media type.
      +
      Returns:
      +
      the initialized builder.
      +
      Throws:
      +
      IllegalArgumentException - if mediaTypes is null or contains no elements.
      +
      +
      +
      • +
    • +
      +

      languages

      +
      public static Variant.VariantListBuilder languages(Locale... languages)
      +
      Create a Variant.VariantListBuilder initialized with a set of supported languages.
      +
      +
      Parameters:
      +
      languages - the available languages.
      +
      Returns:
      +
      the initialized builder.
      +
      Throws:
      +
      IllegalArgumentException - if languages is null or contains no elements.
      +
      +
      +
      • +
    • +
      +

      encodings

      +
      public static Variant.VariantListBuilder encodings(String... encodings)
      +
      Create a Variant.VariantListBuilder initialized with a set of supported encodings.
      +
      +
      Parameters:
      +
      encodings - the available encodings.
      +
      Returns:
      +
      the initialized builder.
      +
      Throws:
      +
      IllegalArgumentException - if encodings is null or contains no elements.
      +
      +
      +
      • +
    • +
      +

      hashCode

      +
      public int hashCode()
      +
      Generate hash code from variant properties.
      +
      +
      Overrides:
      +
      hashCode in class Object
      +
      Returns:
      +
      the hash code.
      +
      +
      +
      • +
    • +
      +

      equals

      +
      public boolean equals(Object obj)
      +
      Compares obj to this variant to see if they are the same considering all property values.
      +
      +
      Overrides:
      +
      equals in class Object
      +
      Parameters:
      +
      obj - the object to compare to.
      +
      Returns:
      +
      true if the two variants are the same, false otherwise.
      +
      +
      +
      • +
    • +
      +

      toString

      +
      public String toString()
      +
      +
      Overrides:
      +
      toString in class Object
      +
      +
      +
      • +
    +
    +
    • +
+
+ +
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/class-use/AbstractMultivaluedMap.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/class-use/AbstractMultivaluedMap.html new file mode 100644 index 0000000000..b14d6a404f --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/class-use/AbstractMultivaluedMap.html @@ -0,0 +1,92 @@ + + + + +Uses of Class jakarta.ws.rs.core.AbstractMultivaluedMap (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
jakarta.ws.rs.core.AbstractMultivaluedMap

+
+
Packages that use AbstractMultivaluedMap
+
+
Package
+
Description
+
jakarta.ws.rs.core
+
+
Low-level interfaces and annotations used to create RESTful service resources.
+
+
+
+ +
+
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/class-use/Application.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/class-use/Application.html new file mode 100644 index 0000000000..98d3854872 --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/class-use/Application.html @@ -0,0 +1,154 @@ + + + + +Uses of Class jakarta.ws.rs.core.Application (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
jakarta.ws.rs.core.Application

+
+
Packages that use Application
+
+
Package
+
Description
+
jakarta.ws.rs
+
+
High-level interfaces and annotations used to create RESTful service resources.
+
+
jakarta.ws.rs.ext
+
+
APIs that provide extensions to the types supported by the JAX-RS API.
+
+
+
+ +
+
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/class-use/CacheControl.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/class-use/CacheControl.html new file mode 100644 index 0000000000..6b8b2f539d --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/class-use/CacheControl.html @@ -0,0 +1,125 @@ + + + + +Uses of Class jakarta.ws.rs.core.CacheControl (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
jakarta.ws.rs.core.CacheControl

+
+
Packages that use CacheControl
+
+
Package
+
Description
+
jakarta.ws.rs.client
+
+
The JAX-RS client API
+
+
jakarta.ws.rs.core
+
+
Low-level interfaces and annotations used to create RESTful service resources.
+
+
+
+ +
+
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/class-use/Configurable.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/class-use/Configurable.html new file mode 100644 index 0000000000..d7d8dd6119 --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/class-use/Configurable.html @@ -0,0 +1,142 @@ + + + + +Uses of Interface jakarta.ws.rs.core.Configurable (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
jakarta.ws.rs.core.Configurable

+
+
Packages that use Configurable
+
+
Package
+
Description
+
jakarta.ws.rs.client
+
+
The JAX-RS client API
+
+
jakarta.ws.rs.core
+
+
Low-level interfaces and annotations used to create RESTful service resources.
+
+
+
+ +
+
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/class-use/Configuration.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/class-use/Configuration.html new file mode 100644 index 0000000000..148e54baf5 --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/class-use/Configuration.html @@ -0,0 +1,129 @@ + + + + +Uses of Interface jakarta.ws.rs.core.Configuration (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
jakarta.ws.rs.core.Configuration

+
+
Packages that use Configuration
+
+
Package
+
Description
+
jakarta.ws.rs.client
+
+
The JAX-RS client API
+
+
jakarta.ws.rs.core
+
+
Low-level interfaces and annotations used to create RESTful service resources.
+
+
+
+ +
+
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/class-use/Context.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/class-use/Context.html new file mode 100644 index 0000000000..8b7d4cfc64 --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/class-use/Context.html @@ -0,0 +1,63 @@ + + + + +Uses of Annotation Interface jakarta.ws.rs.core.Context (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Annotation Interface
jakarta.ws.rs.core.Context

+
+No usage of jakarta.ws.rs.core.Context
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/class-use/Cookie.AbstractCookieBuilder.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/class-use/Cookie.AbstractCookieBuilder.html new file mode 100644 index 0000000000..0093ed6382 --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/class-use/Cookie.AbstractCookieBuilder.html @@ -0,0 +1,124 @@ + + + + +Uses of Class jakarta.ws.rs.core.Cookie.AbstractCookieBuilder (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
jakarta.ws.rs.core.Cookie.AbstractCookieBuilder

+
+
Packages that use Cookie.AbstractCookieBuilder
+
+
Package
+
Description
+
jakarta.ws.rs.core
+
+
Low-level interfaces and annotations used to create RESTful service resources.
+
+
+
+ +
+
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/class-use/Cookie.Builder.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/class-use/Cookie.Builder.html new file mode 100644 index 0000000000..9d4ca9699f --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/class-use/Cookie.Builder.html @@ -0,0 +1,63 @@ + + + + +Uses of Class jakarta.ws.rs.core.Cookie.Builder (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
jakarta.ws.rs.core.Cookie.Builder

+
+No usage of jakarta.ws.rs.core.Cookie.Builder
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/class-use/Cookie.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/class-use/Cookie.html new file mode 100644 index 0000000000..ea806340e4 --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/class-use/Cookie.html @@ -0,0 +1,239 @@ + + + + +Uses of Class jakarta.ws.rs.core.Cookie (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
jakarta.ws.rs.core.Cookie

+
+
Packages that use Cookie
+
+
Package
+
Description
+
jakarta.ws.rs.client
+
+
The JAX-RS client API
+
+
jakarta.ws.rs.container
+
+
Container-specific JAX-RS API.
+
+
jakarta.ws.rs.core
+
+
Low-level interfaces and annotations used to create RESTful service resources.
+
+
+
+ +
+
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/class-use/EntityPart.Builder.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/class-use/EntityPart.Builder.html new file mode 100644 index 0000000000..b8b331c8ae --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/class-use/EntityPart.Builder.html @@ -0,0 +1,175 @@ + + + + +Uses of Interface jakarta.ws.rs.core.EntityPart.Builder (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
jakarta.ws.rs.core.EntityPart.Builder

+
+
Packages that use EntityPart.Builder
+
+
Package
+
Description
+
jakarta.ws.rs.core
+
+
Low-level interfaces and annotations used to create RESTful service resources.
+
+
jakarta.ws.rs.ext
+
+
APIs that provide extensions to the types supported by the JAX-RS API.
+
+
+
+ +
+
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/class-use/EntityPart.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/class-use/EntityPart.html new file mode 100644 index 0000000000..7ffdc60006 --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/class-use/EntityPart.html @@ -0,0 +1,92 @@ + + + + +Uses of Interface jakarta.ws.rs.core.EntityPart (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
jakarta.ws.rs.core.EntityPart

+
+
Packages that use EntityPart
+
+
Package
+
Description
+
jakarta.ws.rs.core
+
+
Low-level interfaces and annotations used to create RESTful service resources.
+
+
+
+ +
+
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/class-use/EntityTag.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/class-use/EntityTag.html new file mode 100644 index 0000000000..2afc2b413d --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/class-use/EntityTag.html @@ -0,0 +1,166 @@ + + + + +Uses of Class jakarta.ws.rs.core.EntityTag (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
jakarta.ws.rs.core.EntityTag

+
+
Packages that use EntityTag
+
+
Package
+
Description
+
jakarta.ws.rs.client
+
+
The JAX-RS client API
+
+
jakarta.ws.rs.container
+
+
Container-specific JAX-RS API.
+
+
jakarta.ws.rs.core
+
+
Low-level interfaces and annotations used to create RESTful service resources.
+
+
+
+ +
+
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/class-use/Feature.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/class-use/Feature.html new file mode 100644 index 0000000000..dddc2c9d6e --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/class-use/Feature.html @@ -0,0 +1,105 @@ + + + + +Uses of Interface jakarta.ws.rs.core.Feature (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
jakarta.ws.rs.core.Feature

+
+
Packages that use Feature
+
+
Package
+
Description
+
jakarta.ws.rs.core
+
+
Low-level interfaces and annotations used to create RESTful service resources.
+
+
+
+
    +
  • +
    +

    Uses of Feature in jakarta.ws.rs.core

    +
    Methods in jakarta.ws.rs.core with parameters of type Feature
    +
    +
    Modifier and Type
    +
    Method
    +
    Description
    +
    boolean
    +
    Configuration.isEnabled(Feature feature)
    +
    +
    Check if a particular feature instance has been previously enabled in the runtime configuration + context.
    +
    +
    +
    Method parameters in jakarta.ws.rs.core with type arguments of type Feature
    +
    +
    Modifier and Type
    +
    Method
    +
    Description
    +
    boolean
    +
    Configuration.isEnabled(Class<? extends Feature> featureClass)
    +
    +
    Check if a feature instance of featureClass class has been previously enabled in the runtime + configuration context.
    +
    +
    +
    +
    • +
+
+
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/class-use/FeatureContext.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/class-use/FeatureContext.html new file mode 100644 index 0000000000..acf7822de7 --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/class-use/FeatureContext.html @@ -0,0 +1,115 @@ + + + + +Uses of Interface jakarta.ws.rs.core.FeatureContext (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
jakarta.ws.rs.core.FeatureContext

+
+
Packages that use FeatureContext
+
+
Package
+
Description
+
jakarta.ws.rs.container
+
+
Container-specific JAX-RS API.
+
+
jakarta.ws.rs.core
+
+
Low-level interfaces and annotations used to create RESTful service resources.
+
+
+
+ +
+
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/class-use/Form.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/class-use/Form.html new file mode 100644 index 0000000000..040c9a2b11 --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/class-use/Form.html @@ -0,0 +1,129 @@ + + + + +Uses of Class jakarta.ws.rs.core.Form (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
jakarta.ws.rs.core.Form

+
+
Packages that use Form
+
+
Package
+
Description
+
jakarta.ws.rs.client
+
+
The JAX-RS client API
+
+
jakarta.ws.rs.core
+
+
Low-level interfaces and annotations used to create RESTful service resources.
+
+
+
+ +
+
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/class-use/GenericEntity.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/class-use/GenericEntity.html new file mode 100644 index 0000000000..e1fa7c19ab --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/class-use/GenericEntity.html @@ -0,0 +1,63 @@ + + + + +Uses of Class jakarta.ws.rs.core.GenericEntity (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
jakarta.ws.rs.core.GenericEntity

+
+No usage of jakarta.ws.rs.core.GenericEntity
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/class-use/GenericType.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/class-use/GenericType.html new file mode 100644 index 0000000000..e6c3d5c30c --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/class-use/GenericType.html @@ -0,0 +1,344 @@ + + + + +Uses of Class jakarta.ws.rs.core.GenericType (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
jakarta.ws.rs.core.GenericType

+
+
Packages that use GenericType
+
+
Package
+
Description
+
jakarta.ws.rs.client
+
+
The JAX-RS client API
+
+
jakarta.ws.rs.core
+
+
Low-level interfaces and annotations used to create RESTful service resources.
+
+
jakarta.ws.rs.sse
+
+
Server-Sent Events related API.
+
+
+
+ +
+
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/class-use/HttpHeaders.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/class-use/HttpHeaders.html new file mode 100644 index 0000000000..712faa7049 --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/class-use/HttpHeaders.html @@ -0,0 +1,63 @@ + + + + +Uses of Interface jakarta.ws.rs.core.HttpHeaders (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
jakarta.ws.rs.core.HttpHeaders

+
+No usage of jakarta.ws.rs.core.HttpHeaders
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/class-use/Link.Builder.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/class-use/Link.Builder.html new file mode 100644 index 0000000000..b587d35595 --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/class-use/Link.Builder.html @@ -0,0 +1,244 @@ + + + + +Uses of Interface jakarta.ws.rs.core.Link.Builder (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
jakarta.ws.rs.core.Link.Builder

+
+
Packages that use Link.Builder
+
+
Package
+
Description
+
jakarta.ws.rs.client
+
+
The JAX-RS client API
+
+
jakarta.ws.rs.container
+
+
Container-specific JAX-RS API.
+
+
jakarta.ws.rs.core
+
+
Low-level interfaces and annotations used to create RESTful service resources.
+
+
jakarta.ws.rs.ext
+
+
APIs that provide extensions to the types supported by the JAX-RS API.
+
+
+
+ +
+
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/class-use/Link.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/class-use/Link.html new file mode 100644 index 0000000000..d35a6f06d5 --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/class-use/Link.html @@ -0,0 +1,225 @@ + + + + +Uses of Class jakarta.ws.rs.core.Link (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
jakarta.ws.rs.core.Link

+
+
Packages that use Link
+
+
Package
+
Description
+
jakarta.ws.rs.client
+
+
The JAX-RS client API
+
+
jakarta.ws.rs.container
+
+
Container-specific JAX-RS API.
+
+
jakarta.ws.rs.core
+
+
Low-level interfaces and annotations used to create RESTful service resources.
+
+
+
+ +
+
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/class-use/MediaType.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/class-use/MediaType.html new file mode 100644 index 0000000000..c8ae87000c --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/class-use/MediaType.html @@ -0,0 +1,557 @@ + + + + +Uses of Class jakarta.ws.rs.core.MediaType (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
jakarta.ws.rs.core.MediaType

+
+
Packages that use MediaType
+
+
Package
+
Description
+
jakarta.ws.rs.client
+
+
The JAX-RS client API
+
+
jakarta.ws.rs.container
+
+
Container-specific JAX-RS API.
+
+
jakarta.ws.rs.core
+
+
Low-level interfaces and annotations used to create RESTful service resources.
+
+
jakarta.ws.rs.ext
+
+
APIs that provide extensions to the types supported by the JAX-RS API.
+
+
jakarta.ws.rs.sse
+
+
Server-Sent Events related API.
+
+
+
+ +
+
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/class-use/MultivaluedHashMap.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/class-use/MultivaluedHashMap.html new file mode 100644 index 0000000000..6f7d640d36 --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/class-use/MultivaluedHashMap.html @@ -0,0 +1,63 @@ + + + + +Uses of Class jakarta.ws.rs.core.MultivaluedHashMap (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
jakarta.ws.rs.core.MultivaluedHashMap

+
+No usage of jakarta.ws.rs.core.MultivaluedHashMap
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/class-use/MultivaluedMap.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/class-use/MultivaluedMap.html new file mode 100644 index 0000000000..449a627142 --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/class-use/MultivaluedMap.html @@ -0,0 +1,327 @@ + + + + +Uses of Interface jakarta.ws.rs.core.MultivaluedMap (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
jakarta.ws.rs.core.MultivaluedMap

+
+
Packages that use MultivaluedMap
+
+
Package
+
Description
+
jakarta.ws.rs.client
+
+
The JAX-RS client API
+
+
jakarta.ws.rs.container
+
+
Container-specific JAX-RS API.
+
+
jakarta.ws.rs.core
+
+
Low-level interfaces and annotations used to create RESTful service resources.
+
+
jakarta.ws.rs.ext
+
+
APIs that provide extensions to the types supported by the JAX-RS API.
+
+
+
+ +
+
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/class-use/NewCookie.AbstractNewCookieBuilder.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/class-use/NewCookie.AbstractNewCookieBuilder.html new file mode 100644 index 0000000000..cae81599a4 --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/class-use/NewCookie.AbstractNewCookieBuilder.html @@ -0,0 +1,114 @@ + + + + +Uses of Class jakarta.ws.rs.core.NewCookie.AbstractNewCookieBuilder (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
jakarta.ws.rs.core.NewCookie.AbstractNewCookieBuilder

+
+
Packages that use NewCookie.AbstractNewCookieBuilder
+
+
Package
+
Description
+
jakarta.ws.rs.core
+
+
Low-level interfaces and annotations used to create RESTful service resources.
+
+
+
+ +
+
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/class-use/NewCookie.Builder.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/class-use/NewCookie.Builder.html new file mode 100644 index 0000000000..4586e776c5 --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/class-use/NewCookie.Builder.html @@ -0,0 +1,63 @@ + + + + +Uses of Class jakarta.ws.rs.core.NewCookie.Builder (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
jakarta.ws.rs.core.NewCookie.Builder

+
+No usage of jakarta.ws.rs.core.NewCookie.Builder
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/class-use/NewCookie.SameSite.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/class-use/NewCookie.SameSite.html new file mode 100644 index 0000000000..2784ae5c82 --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/class-use/NewCookie.SameSite.html @@ -0,0 +1,151 @@ + + + + +Uses of Enum Class jakarta.ws.rs.core.NewCookie.SameSite (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Enum Class
jakarta.ws.rs.core.NewCookie.SameSite

+
+
Packages that use NewCookie.SameSite
+
+
Package
+
Description
+
jakarta.ws.rs.core
+
+
Low-level interfaces and annotations used to create RESTful service resources.
+
+
+
+ +
+
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/class-use/NewCookie.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/class-use/NewCookie.html new file mode 100644 index 0000000000..733ff96c23 --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/class-use/NewCookie.html @@ -0,0 +1,164 @@ + + + + +Uses of Class jakarta.ws.rs.core.NewCookie (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
jakarta.ws.rs.core.NewCookie

+
+
Packages that use NewCookie
+
+
Package
+
Description
+
jakarta.ws.rs.client
+
+
The JAX-RS client API
+
+
jakarta.ws.rs.container
+
+
Container-specific JAX-RS API.
+
+
jakarta.ws.rs.core
+
+
Low-level interfaces and annotations used to create RESTful service resources.
+
+
+
+ +
+
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/class-use/NoContentException.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/class-use/NoContentException.html new file mode 100644 index 0000000000..81ff018767 --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/class-use/NoContentException.html @@ -0,0 +1,63 @@ + + + + +Uses of Class jakarta.ws.rs.core.NoContentException (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
jakarta.ws.rs.core.NoContentException

+
+No usage of jakarta.ws.rs.core.NoContentException
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/class-use/PathSegment.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/class-use/PathSegment.html new file mode 100644 index 0000000000..86109b06ae --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/class-use/PathSegment.html @@ -0,0 +1,97 @@ + + + + +Uses of Interface jakarta.ws.rs.core.PathSegment (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
jakarta.ws.rs.core.PathSegment

+
+
Packages that use PathSegment
+
+
Package
+
Description
+
jakarta.ws.rs.core
+
+
Low-level interfaces and annotations used to create RESTful service resources.
+
+
+
+ +
+
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/class-use/Request.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/class-use/Request.html new file mode 100644 index 0000000000..23e720fa66 --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/class-use/Request.html @@ -0,0 +1,92 @@ + + + + +Uses of Interface jakarta.ws.rs.core.Request (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
jakarta.ws.rs.core.Request

+
+
Packages that use Request
+
+
Package
+
Description
+
jakarta.ws.rs.container
+
+
Container-specific JAX-RS API.
+
+
+
+ +
+
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/class-use/Response.ResponseBuilder.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/class-use/Response.ResponseBuilder.html new file mode 100644 index 0000000000..ceacb863c8 --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/class-use/Response.ResponseBuilder.html @@ -0,0 +1,399 @@ + + + + +Uses of Class jakarta.ws.rs.core.Response.ResponseBuilder (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
jakarta.ws.rs.core.Response.ResponseBuilder

+
+
Packages that use Response.ResponseBuilder
+
+
Package
+
Description
+
jakarta.ws.rs.core
+
+
Low-level interfaces and annotations used to create RESTful service resources.
+
+
jakarta.ws.rs.ext
+
+
APIs that provide extensions to the types supported by the JAX-RS API.
+
+
+
+ +
+
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/class-use/Response.Status.Family.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/class-use/Response.Status.Family.html new file mode 100644 index 0000000000..cad9985c70 --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/class-use/Response.Status.Family.html @@ -0,0 +1,113 @@ + + + + +Uses of Enum Class jakarta.ws.rs.core.Response.Status.Family (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Enum Class
jakarta.ws.rs.core.Response.Status.Family

+
+
Packages that use Response.Status.Family
+
+
Package
+
Description
+
jakarta.ws.rs.core
+
+
Low-level interfaces and annotations used to create RESTful service resources.
+
+
+
+ +
+
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/class-use/Response.Status.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/class-use/Response.Status.html new file mode 100644 index 0000000000..2b18185bac --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/class-use/Response.Status.html @@ -0,0 +1,226 @@ + + + + +Uses of Enum Class jakarta.ws.rs.core.Response.Status (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Enum Class
jakarta.ws.rs.core.Response.Status

+
+
Packages that use Response.Status
+
+
Package
+
Description
+
jakarta.ws.rs
+
+
High-level interfaces and annotations used to create RESTful service resources.
+
+
jakarta.ws.rs.core
+
+
Low-level interfaces and annotations used to create RESTful service resources.
+
+
+
+ +
+
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/class-use/Response.StatusType.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/class-use/Response.StatusType.html new file mode 100644 index 0000000000..99c0582e79 --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/class-use/Response.StatusType.html @@ -0,0 +1,183 @@ + + + + +Uses of Interface jakarta.ws.rs.core.Response.StatusType (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
jakarta.ws.rs.core.Response.StatusType

+
+
Packages that use Response.StatusType
+
+
Package
+
Description
+
jakarta.ws.rs.client
+
+
The JAX-RS client API
+
+
jakarta.ws.rs.container
+
+
Container-specific JAX-RS API.
+
+
jakarta.ws.rs.core
+
+
Low-level interfaces and annotations used to create RESTful service resources.
+
+
+
+ +
+
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/class-use/Response.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/class-use/Response.html new file mode 100644 index 0000000000..cf839e2b8a --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/class-use/Response.html @@ -0,0 +1,681 @@ + + + + +Uses of Class jakarta.ws.rs.core.Response (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
jakarta.ws.rs.core.Response

+
+
Packages that use Response
+
+
Package
+
Description
+
jakarta.ws.rs
+
+
High-level interfaces and annotations used to create RESTful service resources.
+
+
jakarta.ws.rs.client
+
+
The JAX-RS client API
+
+
jakarta.ws.rs.container
+
+
Container-specific JAX-RS API.
+
+
jakarta.ws.rs.core
+
+
Low-level interfaces and annotations used to create RESTful service resources.
+
+
jakarta.ws.rs.ext
+
+
APIs that provide extensions to the types supported by the JAX-RS API.
+
+
+
+ +
+
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/class-use/SecurityContext.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/class-use/SecurityContext.html new file mode 100644 index 0000000000..c2c3576655 --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/class-use/SecurityContext.html @@ -0,0 +1,103 @@ + + + + +Uses of Interface jakarta.ws.rs.core.SecurityContext (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
jakarta.ws.rs.core.SecurityContext

+
+
Packages that use SecurityContext
+
+
Package
+
Description
+
jakarta.ws.rs.container
+
+
Container-specific JAX-RS API.
+
+
+
+ +
+
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/class-use/StreamingOutput.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/class-use/StreamingOutput.html new file mode 100644 index 0000000000..851adb9b20 --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/class-use/StreamingOutput.html @@ -0,0 +1,63 @@ + + + + +Uses of Interface jakarta.ws.rs.core.StreamingOutput (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
jakarta.ws.rs.core.StreamingOutput

+
+No usage of jakarta.ws.rs.core.StreamingOutput
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/class-use/UriBuilder.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/class-use/UriBuilder.html new file mode 100644 index 0000000000..36cbb420e9 --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/class-use/UriBuilder.html @@ -0,0 +1,377 @@ + + + + +Uses of Class jakarta.ws.rs.core.UriBuilder (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
jakarta.ws.rs.core.UriBuilder

+
+
Packages that use UriBuilder
+
+
Package
+
Description
+
jakarta.ws.rs
+
+
High-level interfaces and annotations used to create RESTful service resources.
+
+
jakarta.ws.rs.client
+
+
The JAX-RS client API
+
+
jakarta.ws.rs.core
+
+
Low-level interfaces and annotations used to create RESTful service resources.
+
+
jakarta.ws.rs.ext
+
+
APIs that provide extensions to the types supported by the JAX-RS API.
+
+
+
+ +
+
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/class-use/UriBuilderException.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/class-use/UriBuilderException.html new file mode 100644 index 0000000000..daf97f48fd --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/class-use/UriBuilderException.html @@ -0,0 +1,114 @@ + + + + +Uses of Class jakarta.ws.rs.core.UriBuilderException (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
jakarta.ws.rs.core.UriBuilderException

+
+
Packages that use UriBuilderException
+
+
Package
+
Description
+
jakarta.ws.rs.core
+
+
Low-level interfaces and annotations used to create RESTful service resources.
+
+
+
+ +
+
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/class-use/UriInfo.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/class-use/UriInfo.html new file mode 100644 index 0000000000..208468e51f --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/class-use/UriInfo.html @@ -0,0 +1,92 @@ + + + + +Uses of Interface jakarta.ws.rs.core.UriInfo (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
jakarta.ws.rs.core.UriInfo

+
+
Packages that use UriInfo
+
+
Package
+
Description
+
jakarta.ws.rs.container
+
+
Container-specific JAX-RS API.
+
+
+
+ +
+
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/class-use/Variant.VariantListBuilder.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/class-use/Variant.VariantListBuilder.html new file mode 100644 index 0000000000..98d20cb2f9 --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/class-use/Variant.VariantListBuilder.html @@ -0,0 +1,148 @@ + + + + +Uses of Class jakarta.ws.rs.core.Variant.VariantListBuilder (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
jakarta.ws.rs.core.Variant.VariantListBuilder

+
+
Packages that use Variant.VariantListBuilder
+
+
Package
+
Description
+
jakarta.ws.rs.core
+
+
Low-level interfaces and annotations used to create RESTful service resources.
+
+
jakarta.ws.rs.ext
+
+
APIs that provide extensions to the types supported by the JAX-RS API.
+
+
+
+ +
+
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/class-use/Variant.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/class-use/Variant.html new file mode 100644 index 0000000000..5dac495876 --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/class-use/Variant.html @@ -0,0 +1,187 @@ + + + + +Uses of Class jakarta.ws.rs.core.Variant (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
jakarta.ws.rs.core.Variant

+
+
Packages that use Variant
+
+
Package
+
Description
+
jakarta.ws.rs.client
+
+
The JAX-RS client API
+
+
jakarta.ws.rs.core
+
+
Low-level interfaces and annotations used to create RESTful service resources.
+
+
+
+ +
+
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/package-summary.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/package-summary.html new file mode 100644 index 0000000000..f5f3ccbf8d --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/package-summary.html @@ -0,0 +1,310 @@ + + + + +jakarta.ws.rs.core (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+
Module jakarta.ws.rs
+

Package jakarta.ws.rs.core

+
+
+
package jakarta.ws.rs.core
+
+
Low-level interfaces and annotations used to create RESTful service resources.
+
+
+ +
+
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/package-tree.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/package-tree.html new file mode 100644 index 0000000000..b9b49d1ed8 --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/package-tree.html @@ -0,0 +1,176 @@ + + + + +jakarta.ws.rs.core Class Hierarchy (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Hierarchy For Package jakarta.ws.rs.core

+
+Package Hierarchies: + +
+

Class Hierarchy

+ +
+
+

Interface Hierarchy

+ +
+
+

Annotation Interface Hierarchy

+ +
+
+

Enum Class Hierarchy

+ +
+
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/package-use.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/package-use.html new file mode 100644 index 0000000000..a7af8fcfc2 --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/core/package-use.html @@ -0,0 +1,465 @@ + + + + +Uses of Package jakarta.ws.rs.core (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Package
jakarta.ws.rs.core

+
+
Packages that use jakarta.ws.rs.core
+
+
Package
+
Description
+
jakarta.ws.rs
+
+
High-level interfaces and annotations used to create RESTful service resources.
+
+
jakarta.ws.rs.client
+
+
The JAX-RS client API
+
+
jakarta.ws.rs.container
+
+
Container-specific JAX-RS API.
+
+
jakarta.ws.rs.core
+
+
Low-level interfaces and annotations used to create RESTful service resources.
+
+
jakarta.ws.rs.ext
+
+
APIs that provide extensions to the types supported by the JAX-RS API.
+
+
jakarta.ws.rs.sse
+
+
Server-Sent Events related API.
+
+
+
+
    +
  • +
    +
    Classes in jakarta.ws.rs.core used by jakarta.ws.rs
    +
    +
    Class
    +
    Description
    +
    Application
    +
    +
    Defines the components of a JAX-RS application and supplies additional meta-data.
    +
    +
    Response
    +
    +
    Defines the contract between a returned instance and the runtime when an application needs to provide meta-data to + the runtime.
    +
    +
    Response.Status
    +
    +
    Commonly used status codes defined by HTTP, see + HTTP/1.1 documentation for the complete + list.
    +
    +
    UriBuilder
    +
    +
    URI template-aware utility class for building URIs from their components.
    +
    +
    +
    +
    • +
  • +
    +
    Classes in jakarta.ws.rs.core used by jakarta.ws.rs.client
    +
    +
    Class
    +
    Description
    +
    CacheControl
    +
    +
    An abstraction for the value of a HTTP Cache-Control response header.
    +
    +
    Configurable
    +
    +
    Represents a client or server-side configurable context in JAX-RS.
    +
    +
    Configuration
    +
    +
    A configuration state associated with a configurable JAX-RS context.
    +
    +
    Cookie
    +
    +
    Represents the value of a HTTP cookie, transferred in a request.
    +
    +
    EntityTag
    +
    +
    An abstraction for the value of a HTTP Entity Tag, used as the value of an ETag response header.
    +
    +
    Form
    +
    +
    Represents the the HTML form data request entity encoded using the "application/x-www-form-urlencoded" + content type.
    +
    +
    GenericType
    +
    +
    Represents a generic message entity type T.
    +
    +
    Link
    +
    +
    + Class representing hypermedia links.
    +
    +
    Link.Builder
    +
    +
    Builder class for hypermedia links.
    +
    +
    MediaType
    +
    +
    An abstraction for a media type.
    +
    +
    MultivaluedMap
    +
    +
    A map of key-values pairs.
    +
    +
    NewCookie
    +
    +
    Used to create a new HTTP cookie, transferred in a response.
    +
    +
    Response
    +
    +
    Defines the contract between a returned instance and the runtime when an application needs to provide meta-data to + the runtime.
    +
    +
    Response.StatusType
    +
    +
    Base interface for statuses used in responses.
    +
    +
    UriBuilder
    +
    +
    URI template-aware utility class for building URIs from their components.
    +
    +
    Variant
    +
    +
    Abstraction for a resource representation variant.
    +
    +
    +
    +
    • +
  • +
    +
    Classes in jakarta.ws.rs.core used by jakarta.ws.rs.container
    +
    +
    Class
    +
    Description
    +
    Cookie
    +
    +
    Represents the value of a HTTP cookie, transferred in a request.
    +
    +
    EntityTag
    +
    +
    An abstraction for the value of a HTTP Entity Tag, used as the value of an ETag response header.
    +
    +
    FeatureContext
    +
    +
    A configurable context passed to Feature and DynamicFeature instances by JAX-RS + runtime during the phase of their configuration.
    +
    +
    Link
    +
    +
    + Class representing hypermedia links.
    +
    +
    Link.Builder
    +
    +
    Builder class for hypermedia links.
    +
    +
    MediaType
    +
    +
    An abstraction for a media type.
    +
    +
    MultivaluedMap
    +
    +
    A map of key-values pairs.
    +
    +
    NewCookie
    +
    +
    Used to create a new HTTP cookie, transferred in a response.
    +
    +
    Request
    +
    +
    An injectable helper for request processing, all methods throw an IllegalStateException if called outside the + scope of a request (e.g.
    +
    +
    Response
    +
    +
    Defines the contract between a returned instance and the runtime when an application needs to provide meta-data to + the runtime.
    +
    +
    Response.StatusType
    +
    +
    Base interface for statuses used in responses.
    +
    +
    SecurityContext
    +
    +
    An injectable interface that provides access to security related information.
    +
    +
    UriInfo
    +
    +
    An injectable interface that provides access to application and request URI information.
    +
    +
    +
    +
    • +
  • +
    +
    Classes in jakarta.ws.rs.core used by jakarta.ws.rs.core
    +
    +
    Class
    +
    Description
    +
    AbstractMultivaluedMap
    +
    +
    Abstract skeleton implementation of a MultivaluedMap that is backed by a [key, multi-value] store represented + as a Map<K, List<V>>.
    +
    +
    CacheControl
    +
    +
    An abstraction for the value of a HTTP Cache-Control response header.
    +
    +
    Configurable
    +
    +
    Represents a client or server-side configurable context in JAX-RS.
    +
    +
    Configuration
    +
    +
    A configuration state associated with a configurable JAX-RS context.
    +
    +
    Cookie
    +
    +
    Represents the value of a HTTP cookie, transferred in a request.
    +
    +
    Cookie.AbstractCookieBuilder
    +
    +
    JAX-RS abstract Cookie builder class.
    +
    +
    EntityPart
    +
    +
    A EntityPart is one part of a multipart entity.
    +
    +
    EntityPart.Builder
    +
    +
    Builder for EntityPart instances.
    +
    +
    EntityTag
    +
    +
    An abstraction for the value of a HTTP Entity Tag, used as the value of an ETag response header.
    +
    +
    Feature
    +
    +
    A feature extension contract.
    +
    +
    FeatureContext
    +
    +
    A configurable context passed to Feature and DynamicFeature instances by JAX-RS + runtime during the phase of their configuration.
    +
    +
    Form
    +
    +
    Represents the the HTML form data request entity encoded using the "application/x-www-form-urlencoded" + content type.
    +
    +
    GenericType
    +
    +
    Represents a generic message entity type T.
    +
    +
    Link
    +
    +
    + Class representing hypermedia links.
    +
    +
    Link.Builder
    +
    +
    Builder class for hypermedia links.
    +
    +
    MediaType
    +
    +
    An abstraction for a media type.
    +
    +
    MultivaluedMap
    +
    +
    A map of key-values pairs.
    +
    +
    NewCookie
    +
    +
    Used to create a new HTTP cookie, transferred in a response.
    +
    +
    NewCookie.AbstractNewCookieBuilder
    +
    +
    JAX-RS abstract NewCookie builder class.
    +
    +
    NewCookie.SameSite
    +
    +
    The available values for the SameSite cookie attribute.
    +
    +
    PathSegment
    +
    +
    Represents a URI path segment and any associated matrix parameters.
    +
    +
    Response
    +
    +
    Defines the contract between a returned instance and the runtime when an application needs to provide meta-data to + the runtime.
    +
    +
    Response.ResponseBuilder
    +
    +
    A class used to build Response instances that contain metadata instead of or in addition to an entity.
    +
    +
    Response.Status
    +
    +
    Commonly used status codes defined by HTTP, see + HTTP/1.1 documentation for the complete + list.
    +
    +
    Response.Status.Family
    +
    +
    An enumeration representing the class of status code.
    +
    +
    Response.StatusType
    +
    +
    Base interface for statuses used in responses.
    +
    +
    UriBuilder
    +
    +
    URI template-aware utility class for building URIs from their components.
    +
    +
    UriBuilderException
    +
    +
    A runtime exception thrown by UriBuilder.build(Object...) methods when a URI cannot be + constructed based on the current state of the builder.
    +
    +
    Variant
    +
    +
    Abstraction for a resource representation variant.
    +
    +
    Variant.VariantListBuilder
    +
    +
    A builder for a list of representation variants.
    +
    +
    +
    +
    • +
  • +
    +
    Classes in jakarta.ws.rs.core used by jakarta.ws.rs.ext
    +
    +
    Class
    +
    Description
    +
    Application
    +
    +
    Defines the components of a JAX-RS application and supplies additional meta-data.
    +
    +
    EntityPart.Builder
    +
    +
    Builder for EntityPart instances.
    +
    +
    Link.Builder
    +
    +
    Builder class for hypermedia links.
    +
    +
    MediaType
    +
    +
    An abstraction for a media type.
    +
    +
    MultivaluedMap
    +
    +
    A map of key-values pairs.
    +
    +
    Response
    +
    +
    Defines the contract between a returned instance and the runtime when an application needs to provide meta-data to + the runtime.
    +
    +
    Response.ResponseBuilder
    +
    +
    A class used to build Response instances that contain metadata instead of or in addition to an entity.
    +
    +
    UriBuilder
    +
    +
    URI template-aware utility class for building URIs from their components.
    +
    +
    Variant.VariantListBuilder
    +
    +
    A builder for a list of representation variants.
    +
    +
    +
    +
    • +
  • +
    +
    Classes in jakarta.ws.rs.core used by jakarta.ws.rs.sse
    +
    +
    Class
    +
    Description
    +
    GenericType
    +
    +
    Represents a generic message entity type T.
    +
    +
    MediaType
    +
    +
    An abstraction for a media type.
    +
    +
    +
    +
    • +
+
+
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/ext/ContextResolver.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/ext/ContextResolver.html new file mode 100644 index 0000000000..876d2dffd0 --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/ext/ContextResolver.html @@ -0,0 +1,183 @@ + + + + +ContextResolver (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Module jakarta.ws.rs
+
Package jakarta.ws.rs.ext
+

Interface ContextResolver<T>

+
+
+
+
Type Parameters:
+
T - type of the context
+
+
+
public interface ContextResolver<T>
+
Contract for a provider that supplies context information to resource classes and other providers. + + A ContextResolver implementation may be annotated with Produces to restrict the media + types for which it will be considered suitable. +

+ Providers implementing ContextResolver contract must be either programmatically registered in a JAX-RS + runtime or must be annotated with @Provider annotation to be automatically + discovered by the JAX-RS runtime during a provider scanning phase. +

+
+
Since:
+
1.0
+
Author:
+
Paul Sandoz, Marc Hadley
+
See Also:
+
+ +
+
+
+
+
    + +
  • +
    +

    Method Summary

    +
    +
    +
    +
    +
    Modifier and Type
    +
    Method
    +
    Description
    +
    T
    +
    getContext(Class<?> type)
    +
    +
    Get a context of type T that is applicable to the supplied type.
    +
    +
    +
    +
    +
    +
    • +
+
+
+
    + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      getContext

      +
      T getContext(Class<?> type)
      +
      Get a context of type T that is applicable to the supplied type.
      +
      +
      Parameters:
      +
      type - the class of object for which a context is desired
      +
      Returns:
      +
      a context for the supplied type or null if a context for the supplied type is not available from this + provider.
      +
      +
      +
      • +
    +
    +
    • +
+
+ +
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/ext/ExceptionMapper.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/ext/ExceptionMapper.html new file mode 100644 index 0000000000..33ac0220ea --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/ext/ExceptionMapper.html @@ -0,0 +1,178 @@ + + + + +ExceptionMapper (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Module jakarta.ws.rs
+
Package jakarta.ws.rs.ext
+

Interface ExceptionMapper<E extends Throwable>

+
+
+
+
Type Parameters:
+
E - exception type supported by the provider.
+
+
+
public interface ExceptionMapper<E extends Throwable>
+
Contract for a provider that maps Java exceptions to Response. +

+ Providers implementing ExceptionMapper contract must be either programmatically registered in a JAX-RS + runtime or must be annotated with @Provider annotation to be automatically + discovered by the JAX-RS runtime during a provider scanning phase.

+
+
Since:
+
1.0
+
Author:
+
Paul Sandoz, Marc Hadley
+
See Also:
+
+ +
+
+
+
+
    + +
  • +
    +

    Method Summary

    +
    +
    +
    +
    +
    Modifier and Type
    +
    Method
    +
    Description
    +
    Response
    +
    toResponse(E exception)
    +
    +
    Map an exception to a Response.
    +
    +
    +
    +
    +
    +
    • +
+
+
+
    + +
  • +
    +

    Method Details

    + +
    +
    • +
+
+ +
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/ext/InterceptorContext.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/ext/InterceptorContext.html new file mode 100644 index 0000000000..ed2ca4bd5d --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/ext/InterceptorContext.html @@ -0,0 +1,460 @@ + + + + +InterceptorContext (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Module jakarta.ws.rs
+
Package jakarta.ws.rs.ext
+

Interface InterceptorContext

+
+
+
+
All Known Subinterfaces:
+
ReaderInterceptorContext, WriterInterceptorContext
+
+
+
public interface InterceptorContext
+
Context shared by message body interceptors that can be used to wrap calls to + MessageBodyReader.readFrom(java.lang.Class<T>, java.lang.reflect.Type, java.lang.annotation.Annotation[], jakarta.ws.rs.core.MediaType, jakarta.ws.rs.core.MultivaluedMap<java.lang.String, java.lang.String>, java.io.InputStream) and MessageBodyWriter.writeTo(T, java.lang.Class<?>, java.lang.reflect.Type, java.lang.annotation.Annotation[], jakarta.ws.rs.core.MediaType, jakarta.ws.rs.core.MultivaluedMap<java.lang.String, java.lang.Object>, java.io.OutputStream). The getters + and setters in this context class correspond to the parameters in the aforementioned methods.
+
+
Since:
+
2.0
+
Author:
+
Santiago Pericas-Geertsen, Bill Burke
+
See Also:
+
+ +
+
+
+
+
    + +
  • +
    +

    Method Summary

    +
    +
    +
    +
    +
    Modifier and Type
    +
    Method
    +
    Description
    +
    Annotation[]
    +
    getAnnotations()
    +
    +
    Get an array of the annotations formally declared on the artifact that initiated the intercepted entity provider + invocation.
    +
    +
    Type
    +
    getGenericType()
    +
    +
    Get the type of the object to be produced or written.
    +
    +
    MediaType
    +
    getMediaType()
    +
    +
    Get media type of HTTP entity.
    +
    +
    Object
    +
    getProperty(String name)
    +
    +
    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.
    +
    +
    Collection<String>
    +
    getPropertyNames()
    +
    +
    Returns an immutable collection containing the property names available within the + context of the current request/response exchange context.
    +
    +
    Class<?>
    +
    getType()
    +
    +
    Get Java type supported by corresponding message body provider.
    +
    +
    default boolean
    +
    hasProperty(String name)
    +
    +
    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.
    +
    +
    void
    +
    removeProperty(String name)
    +
    +
    Removes a property with the given name from the current request/response exchange context.
    +
    +
    void
    +
    setAnnotations(Annotation[] annotations)
    +
    +
    Update annotations on the formal declaration of the artifact that initiated the intercepted entity provider + invocation.
    +
    +
    void
    +
    setGenericType(Type genericType)
    +
    +
    Update type of the object to be produced or written.
    +
    +
    void
    +
    setMediaType(MediaType mediaType)
    +
    +
    Update media type of HTTP entity.
    +
    +
    void
    +
    setProperty(String name, + Object object)
    +
    +
    Binds an object to a given property name in the current request/response exchange context.
    +
    +
    void
    +
    setType(Class<?> type)
    +
    +
    Update Java type before calling message body provider.
    +
    +
    +
    +
    +
    +
    • +
+
+
+
    + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      getProperty

      +
      Object getProperty(String name)
      +
      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. +

      + A property allows a JAX-RS filters and interceptors to exchange additional custom information not already provided by + this interface. +

      +

      + A list of supported properties can be retrieved using getPropertyNames(). Custom property names should + follow the same convention as package names. +

      +

      + In a Servlet container, on the server side, the properties are backed by the ServletRequest and contain all + the attributes available in the ServletRequest. +

      +
      +
      Parameters:
      +
      name - a String specifying the name of the property.
      +
      Returns:
      +
      an Object containing the value of the property, or null if no property exists matching the + given name.
      +
      See Also:
      +
      + +
      +
      +
      +
      • +
    • +
      +

      hasProperty

      +
      default boolean hasProperty(String name)
      +
      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. +

      + Use the getProperty(java.lang.String) method with a property name to get the value of a property. +

      +
      +
      Parameters:
      +
      name - a String specifying the name of the property.
      +
      Returns:
      +
      true if this property is registered in the context, or false if no property exists matching + the given name.
      +
      See Also:
      +
      + +
      +
      +
      +
      • +
    • +
      +

      getPropertyNames

      +
      Collection<String> getPropertyNames()
      +
      Returns an immutable collection containing the property names available within the + context of the current request/response exchange context. +

      + Use the getProperty(java.lang.String) method with a property name to get the value of a property. +

      +

      + In a Servlet container, the properties are synchronized with the ServletRequest and expose all the attributes + available in the ServletRequest. Any modifications of the properties are also reflected in the set of + properties of the associated ServletRequest. +

      +
      +
      Returns:
      +
      an immutable collection of property names.
      +
      See Also:
      +
      + +
      +
      +
      +
      • +
    • +
      +

      setProperty

      +
      void setProperty(String name, + Object object)
      +
      Binds an object to a given property name in the current request/response exchange context. If the name specified is + already used for a property, this method will replace the value of the property with the new value. +

      + A property allows a JAX-RS filters and interceptors to exchange additional custom information not already provided by + this interface. +

      +

      + A list of supported properties can be retrieved using getPropertyNames(). Custom property names should + follow the same convention as package names. +

      +

      + If a null value is passed, the effect is the same as calling the removeProperty(String) method. +

      +

      + In a Servlet container, on the server side, the properties are backed by the ServletRequest and contain all + the attributes available in the ServletRequest. +

      +
      +
      Parameters:
      +
      name - a String specifying the name of the property.
      +
      object - an Object representing the property to be bound.
      +
      +
      +
      • +
    • +
      +

      removeProperty

      +
      void removeProperty(String name)
      +
      Removes a property with the given name from the current request/response exchange context. After removal, subsequent + calls to getProperty(java.lang.String) to retrieve the property value will return null. +

      + In a Servlet container, on the server side, the properties are backed by the ServletRequest and contain all + the attributes available in the ServletRequest. +

      +
      +
      Parameters:
      +
      name - a String specifying the name of the property to be removed.
      +
      +
      +
      • +
    • +
      +

      getAnnotations

      +
      Annotation[] getAnnotations()
      +
      Get an array of the annotations formally declared on the artifact that initiated the intercepted entity provider + invocation. + + E.g. if the message body is to be converted into a method parameter, this will be the annotations on that parameter + returned by Method.getParameterAnnotations(); if the + server-side response entity instance is to be converted into an output stream, this will be the annotations on the + matched resource method returned by Method.getAnnotations(). + + This method may return an empty array in case the interceptor is not invoked in a context of any particular resource + method (e.g. as part of the client API), but will never return null.
      +
      +
      Returns:
      +
      annotations declared on the artifact that initiated the intercepted entity provider invocation.
      +
      +
      +
      • +
    • +
      +

      setAnnotations

      +
      void setAnnotations(Annotation[] annotations)
      +
      Update annotations on the formal declaration of the artifact that initiated the intercepted entity provider + invocation. + + Calling this method has no effect in the client API.
      +
      +
      Parameters:
      +
      annotations - updated annotations declarataion of the artifact that initiated the intercepted entity provider + invocation. Must not be null.
      +
      Throws:
      +
      NullPointerException - in case the input parameter is null.
      +
      +
      +
      • +
    • +
      +

      getType

      +
      Class<?> getType()
      +
      Get Java type supported by corresponding message body provider.
      +
      +
      Returns:
      +
      java type supported by provider
      +
      +
      +
      • +
    • +
      +

      setType

      +
      void setType(Class<?> type)
      +
      Update Java type before calling message body provider.
      +
      +
      Parameters:
      +
      type - java type for provider
      +
      +
      +
      • +
    • +
      +

      getGenericType

      +
      Type getGenericType()
      +
      Get the type of the object to be produced or written.
      +
      +
      Returns:
      +
      type of object produced or written
      +
      +
      +
      • +
    • +
      +

      setGenericType

      +
      void setGenericType(Type genericType)
      +
      Update type of the object to be produced or written.
      +
      +
      Parameters:
      +
      genericType - new type for object
      +
      +
      +
      • +
    • +
      +

      getMediaType

      +
      MediaType getMediaType()
      +
      Get media type of HTTP entity.
      +
      +
      Returns:
      +
      media type of HTTP entity
      +
      +
      +
      • +
    • +
      +

      setMediaType

      +
      void setMediaType(MediaType mediaType)
      +
      Update media type of HTTP entity.
      +
      +
      Parameters:
      +
      mediaType - new type for HTTP entity
      +
      +
      +
      • +
    +
    +
    • +
+
+ +
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/ext/MessageBodyReader.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/ext/MessageBodyReader.html new file mode 100644 index 0000000000..245f9baacd --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/ext/MessageBodyReader.html @@ -0,0 +1,254 @@ + + + + +MessageBodyReader (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Module jakarta.ws.rs
+
Package jakarta.ws.rs.ext
+

Interface MessageBodyReader<T>

+
+
+
+
Type Parameters:
+
T - Java type supported by the provider
+
+
+
public interface MessageBodyReader<T>
+
Contract for a provider that supports the conversion of a stream to a Java type. + + A MessageBodyReader implementation may be annotated with Consumes to restrict the media + types for which it will be considered suitable. The MessageBodyReader pipeline is executed if the matching + resource method declares an entity parameter or uses at least one FormParam. +

+ Providers implementing MessageBodyReader contract must be either programmatically registered in a JAX-RS + runtime or must be annotated with @Provider annotation to be automatically + discovered by the JAX-RS runtime during a provider scanning phase. +

+
+
Since:
+
1.0
+
Author:
+
Paul Sandoz, Marc Hadley
+
See Also:
+
+ +
+
+
+
+ +
+
+
    + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      isReadable

      +
      boolean isReadable(Class<?> type, + Type genericType, + Annotation[] annotations, + MediaType mediaType)
      +
      Ascertain if the MessageBodyReader can produce an instance of a particular type. The type parameter gives the + class of the instance that should be produced, the genericType parameter gives the + java.lang.reflect.Type of the instance that should be produced. E.g. if the instance + to be produced is List<String>, the type parameter will be java.util.List and the + genericType parameter will be java.lang.reflect.ParameterizedType.
      +
      +
      Parameters:
      +
      type - the class of instance to be produced.
      +
      genericType - the type of instance to be produced. E.g. if the message body is to be converted into a method + parameter, this will be the formal type of the method parameter as returned by + Method.getGenericParameterTypes.
      +
      annotations - an array of the annotations on the declaration of the artifact that will be initialized with the + produced instance. E.g. if the message body is to be converted into a method parameter, this will be the annotations + on that parameter returned by Method.getParameterAnnotations.
      +
      mediaType - the media type of the HTTP entity, if one is not specified in the request then + application/octet-stream is used.
      +
      Returns:
      +
      true if the type is supported, otherwise false.
      +
      +
      +
      • +
    • +
      +

      readFrom

      +
      T readFrom(Class<T> type, + Type genericType, + Annotation[] annotations, + MediaType mediaType, + MultivaluedMap<String,String> httpHeaders, + InputStream entityStream) + throws IOException, +WebApplicationException
      +
      Read a type from the InputStream. +

      + In case the entity input stream is empty, the reader is expected to either return a Java representation of a + zero-length entity or throw a NoContentException in case no zero-length entity + representation is defined for the supported Java type. A NoContentException, if thrown by a message body + reader while reading a server request entity, is automatically translated by JAX-RS server runtime into a + BadRequestException wrapping the original NoContentException and rethrown for a standard + processing by the registered exception mappers. +

      +
      +
      Parameters:
      +
      type - the type that is to be read from the entity stream.
      +
      genericType - the type of instance to be produced. E.g. if the message body is to be converted into a method + parameter, this will be the formal type of the method parameter as returned by + Method.getGenericParameterTypes.
      +
      annotations - an array of the annotations on the declaration of the artifact that will be initialized with the + produced instance. E.g. if the message body is to be converted into a method parameter, this will be the annotations + on that parameter returned by Method.getParameterAnnotations.
      +
      mediaType - the media type of the HTTP entity.
      +
      httpHeaders - the read-only HTTP headers associated with HTTP entity.
      +
      entityStream - the InputStream of the HTTP entity. The caller is responsible for ensuring that the input + stream ends when the entity has been consumed. The implementation should not close the input stream.
      +
      Returns:
      +
      the type that was read from the stream. In case the entity input stream is empty, the reader is expected to + either return an instance representing a zero-length entity or throw a NoContentException in + case no zero-length entity representation is defined for the supported Java type.
      +
      Throws:
      +
      IOException - if an IO error arises. In case the entity input stream is empty and the reader is not + able to produce a Java representation for a zero-length entity, NoContentException is expected to be thrown.
      +
      WebApplicationException - if a specific HTTP error response needs to be produced. Only effective if + thrown prior to the response being committed.
      +
      +
      +
      • +
    +
    +
    • +
+
+ +
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/ext/MessageBodyWriter.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/ext/MessageBodyWriter.html new file mode 100644 index 0000000000..b81e6d145c --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/ext/MessageBodyWriter.html @@ -0,0 +1,273 @@ + + + + +MessageBodyWriter (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Module jakarta.ws.rs
+
Package jakarta.ws.rs.ext
+

Interface MessageBodyWriter<T>

+
+
+
+
Type Parameters:
+
T - the type that can be written.
+
+
+
public interface MessageBodyWriter<T>
+
Contract for a provider that supports the conversion of a Java type to a stream. + + A MessageBodyWriter implementation may be annotated with Produces to restrict the media + types for which it will be considered suitable. The MessageBodyWriter pipeline is only invoked if there is + a non-null response entity. +

+ Providers implementing MessageBodyWriter contract must be either programmatically registered in a JAX-RS + runtime or must be annotated with @Provider annotation to be automatically + discovered by the JAX-RS runtime during a provider scanning phase. +

+
+
Since:
+
1.0
+
Author:
+
Paul Sandoz, Marc Hadley
+
See Also:
+
+ +
+
+
+
+
    + +
  • +
    +

    Method Summary

    +
    +
    +
    +
    +
    Modifier and Type
    +
    Method
    +
    Description
    +
    default long
    +
    getSize(T t, + Class<?> type, + Type genericType, + Annotation[] annotations, + MediaType mediaType)
    +
    +
    Originally, the method has been called before writeTo to ascertain the length in bytes of the serialized form + of t.
    +
    +
    boolean
    +
    isWriteable(Class<?> type, + Type genericType, + Annotation[] annotations, + MediaType mediaType)
    +
    +
    Ascertain if the MessageBodyWriter supports a particular type.
    +
    +
    void
    +
    writeTo(T t, + Class<?> type, + Type genericType, + Annotation[] annotations, + MediaType mediaType, + MultivaluedMap<String,Object> httpHeaders, + OutputStream entityStream)
    +
    +
    Write a type to an HTTP message.
    +
    +
    +
    +
    +
    +
    • +
+
+
+
    + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      isWriteable

      +
      boolean isWriteable(Class<?> type, + Type genericType, + Annotation[] annotations, + MediaType mediaType)
      +
      Ascertain if the MessageBodyWriter supports a particular type.
      +
      +
      Parameters:
      +
      type - the class of instance that is to be written.
      +
      genericType - the type of instance to be written, obtained either by reflection of a resource method return type + or via inspection of the returned instance. GenericEntity provides a way to specify this + information at runtime.
      +
      annotations - an array of the annotations attached to the message entity instance.
      +
      mediaType - the media type of the HTTP entity.
      +
      Returns:
      +
      true if the type is supported, otherwise false.
      +
      +
      +
      • +
    • +
      +

      getSize

      +
      default long getSize(T t, + Class<?> type, + Type genericType, + Annotation[] annotations, + MediaType mediaType)
      +
      Originally, the method has been called before writeTo to ascertain the length in bytes of the serialized form + of t. A non-negative return value has been used in a HTTP Content-Length header. +

      + As of JAX-RS 2.0, the method has been deprecated and the value returned by the method is ignored by a JAX-RS runtime. + All MessageBodyWriter implementations are advised to return -1 from the method. Responsibility to + compute the actual Content-Length header value has been delegated to JAX-RS runtime. +

      +
      +
      Parameters:
      +
      t - the instance to write
      +
      type - the class of instance that is to be written.
      +
      genericType - the type of instance to be written. GenericEntity provides a way to + specify this information at runtime.
      +
      annotations - an array of the annotations attached to the message entity instance.
      +
      mediaType - the media type of the HTTP entity.
      +
      Returns:
      +
      length in bytes or -1 if the length cannot be determined in advance.
      +
      +
      +
      • +
    • +
      +

      writeTo

      +
      void writeTo(T t, + Class<?> type, + Type genericType, + Annotation[] annotations, + MediaType mediaType, + MultivaluedMap<String,Object> httpHeaders, + OutputStream entityStream) + throws IOException, +WebApplicationException
      +
      Write a type to an HTTP message. The message header map is mutable but any changes must be made before writing to the + output stream since the headers will be flushed prior to writing the message body.
      +
      +
      Parameters:
      +
      t - the instance to write.
      +
      type - the class of instance that is to be written.
      +
      genericType - the type of instance to be written. GenericEntity provides a way to + specify this information at runtime.
      +
      annotations - an array of the annotations attached to the message entity instance.
      +
      mediaType - the media type of the HTTP entity.
      +
      httpHeaders - a mutable map of the HTTP message headers.
      +
      entityStream - the OutputStream for the HTTP entity. The implementation must not close the output + stream.
      +
      Throws:
      +
      IOException - if an IO error arises.
      +
      WebApplicationException - if a specific HTTP error response needs to be produced. Only effective if + thrown prior to the message being committed.
      +
      +
      +
      • +
    +
    +
    • +
+
+ +
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/ext/ParamConverter.Lazy.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/ext/ParamConverter.Lazy.html new file mode 100644 index 0000000000..bada55ea7f --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/ext/ParamConverter.Lazy.html @@ -0,0 +1,115 @@ + + + + +ParamConverter.Lazy (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Module jakarta.ws.rs
+
Package jakarta.ws.rs.ext
+

Annotation Interface ParamConverter.Lazy

+
+
+
+
Enclosing interface:
+
ParamConverter<T>
+
+
+
@Target(TYPE) +@Retention(RUNTIME) +@Documented +public static @interface ParamConverter.Lazy
+
Mandates that a conversion of any default value delegated to a parameter + converter annotated with @Lazy annotation SHOULD occur only once the value is actually required (e.g. to be + injected for the first time).
+
+
Since:
+
2.0
+
+
+
+ +
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/ext/ParamConverter.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/ext/ParamConverter.html new file mode 100644 index 0000000000..dc5ca552ad --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/ext/ParamConverter.html @@ -0,0 +1,232 @@ + + + + +ParamConverter (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Module jakarta.ws.rs
+
Package jakarta.ws.rs.ext
+

Interface ParamConverter<T>

+
+
+
+
Type Parameters:
+
T - the supported Java type convertible to/from a String format.
+
+
+
public interface ParamConverter<T>
+
Defines a contract for a delegate responsible for converting between a String form of a message parameter + value and the corresponding custom Java type T. + + Conversion of message parameter values injected via @PathParam, + @QueryParam, @MatrixParam, + @FormParam, @CookieParam and + @HeaderParam is supported. + JAX-RS implementations MUST support the ParamConverter mechanism for all Java types. If a + ParamConverter is available for a type, it MUST be preferred over all other conversion strategies mentioned + in section 3.2 (i.e. single String argument constructor, static valueOf or fromString + methods, etc.). +

+ By default, when used for injection of parameter values, a selected ParamConverter instance MUST be used + eagerly by a JAX-RS runtime to convert any default value in the resource or provider model, that + is during the application deployment, before any value – default or otherwise – is actually required. + This conversion strategy ensures that any errors in the default values are reported as early as possible. This + default behavior may be overridden by annotating the ParamConverter implementation class with a @Lazy annotation. In such case any default value conversion delegated to the @Lazy-annotated converter + will be deferred to a latest possible moment (i.e. until the injection of such default value is required). +

+

+ NOTE: A service implementing this contract is not recognized as a registrable JAX-RS extension provider. Instead, a + ParamConverterProvider instance responsible for providing ParamConverter instances has to be + registered as one of the JAX-RS extension providers. +

+
+
Since:
+
2.0
+
Author:
+
Marek Potociar
+
+
+
+
    + +
  • +
    +

    Nested Class Summary

    +
    Nested Classes
    +
    +
    Modifier and Type
    +
    Interface
    +
    Description
    +
    static @interface 
    +
    ParamConverter.Lazy
    +
    +
    Mandates that a conversion of any default value delegated to a parameter + converter annotated with @Lazy annotation SHOULD occur only once the value is actually required (e.g.
    +
    +
    +
    +
    • + +
  • +
    +

    Method Summary

    +
    +
    +
    +
    +
    Modifier and Type
    +
    Method
    +
    Description
    +
    T
    +
    fromString(String value)
    +
    +
    Parse the supplied value and create an instance of T.
    +
    +
    String
    +
    toString(T value)
    +
    +
    Convert the supplied value to a String.
    +
    +
    +
    +
    +
    +
    • +
+
+
+
    + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      fromString

      +
      T fromString(String value)
      +
      Parse the supplied value and create an instance of T.
      +
      +
      Parameters:
      +
      value - the string value.
      +
      Returns:
      +
      the newly created instance of T.
      +
      Throws:
      +
      IllegalArgumentException - if the supplied string cannot be parsed or is null.
      +
      +
      +
      • +
    • +
      +

      toString

      +
      String toString(T value)
      +
      Convert the supplied value to a String. +

      + This method is reserved for future use. Proprietary JAX-RS extensions may leverage the method. Users should be aware + that any such support for the method comes at the expense of producing non-portable code. +

      +
      +
      Parameters:
      +
      value - the value of type T.
      +
      Returns:
      +
      a String representation of the value.
      +
      Throws:
      +
      IllegalArgumentException - if the supplied object cannot be serialized or is null.
      +
      +
      +
      • +
    +
    +
    • +
+
+ +
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/ext/ParamConverterProvider.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/ext/ParamConverterProvider.html new file mode 100644 index 0000000000..4c1b9b3885 --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/ext/ParamConverterProvider.html @@ -0,0 +1,178 @@ + + + + +ParamConverterProvider (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Module jakarta.ws.rs
+
Package jakarta.ws.rs.ext
+

Interface ParamConverterProvider

+
+
+
+
public interface ParamConverterProvider
+
Contract for a provider of ParamConverter instances. +

+ Providers implementing ParamConverterProvider contract must be either programmatically registered in a JAX-RS + runtime or must be annotated with @Provider annotation to be automatically + discovered by the JAX-RS runtime during a provider scanning phase. +

+
+
Since:
+
2.0
+
Author:
+
Marek Potociar
+
+
+
+
    + +
  • +
    +

    Method Summary

    +
    +
    +
    +
    +
    Modifier and Type
    +
    Method
    +
    Description
    +
    <T> ParamConverter<T>
    +
    getConverter(Class<T> rawType, + Type genericType, + Annotation[] annotations)
    +
    +
    Obtain a ParamConverter that can provide from/to string conversion for an instance of a particular Java type.
    +
    +
    +
    +
    +
    +
    • +
+
+
+
    + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      getConverter

      +
      <T> ParamConverter<T> getConverter(Class<T> rawType, + Type genericType, + Annotation[] annotations)
      +
      Obtain a ParamConverter that can provide from/to string conversion for an instance of a particular Java type.
      +
      +
      Type Parameters:
      +
      T - the supported Java type convertible to/from a String format.
      +
      Parameters:
      +
      rawType - the raw type of the object to be converted.
      +
      genericType - the type of object to be converted. E.g. if an String value representing the injected request + parameter is to be converted into a method parameter, this will be the formal type of the method parameter as + returned by Class.getGenericParameterTypes.
      +
      annotations - an array of the annotations associated with the convertible parameter instance. E.g. if a string + value is to be converted into a method parameter, this would be the annotations on that parameter as returned by + Method.getParameterAnnotations().
      +
      Returns:
      +
      the string converter, otherwise null.
      +
      +
      +
      • +
    +
    +
    • +
+
+ +
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/ext/Provider.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/ext/Provider.html new file mode 100644 index 0000000000..0ad85b86aa --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/ext/Provider.html @@ -0,0 +1,112 @@ + + + + +Provider (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Module jakarta.ws.rs
+
Package jakarta.ws.rs.ext
+

Annotation Interface Provider

+
+
+
+
@Target(TYPE) +@Retention(RUNTIME) +@Documented +public @interface Provider
+
Marks an implementation of an extension interface that should be discoverable by JAX-RS runtime during a provider + scanning phase.
+
+
Since:
+
1.0
+
Author:
+
Paul Sandoz, Marc Hadley
+
+
+
+ +
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/ext/Providers.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/ext/Providers.html new file mode 100644 index 0000000000..46b5f99cea --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/ext/Providers.html @@ -0,0 +1,281 @@ + + + + +Providers (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Module jakarta.ws.rs
+
Package jakarta.ws.rs.ext
+

Interface Providers

+
+
+
+
public interface Providers
+
An injectable interface providing runtime lookup of provider instances.
+
+
Since:
+
1.0
+
Author:
+
Paul Sandoz, Marc Hadley
+
See Also:
+
+ +
+
+
+
+ +
+
+
    + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      getMessageBodyReader

      +
      <T> MessageBodyReader<T> getMessageBodyReader(Class<T> type, + Type genericType, + Annotation[] annotations, + MediaType mediaType)
      +
      Get a message body reader that matches a set of criteria. The set of readers is first filtered by comparing the + supplied value of mediaType with the value of each reader's Consumes, ensuring the + supplied value of type is assignable to the generic type of the reader, and eliminating those that do not + match. The list of matching readers is then ordered with those with the best matching values of + Consumes (x/y > x/* > */*) sorted first. Finally, the + MessageBodyReader.isReadable(Class, Type, Annotation[], MediaType) method is called on each reader in order + using the supplied criteria and the first reader that returns true is selected and returned.
      +
      +
      Type Parameters:
      +
      T - type of the the object that is to be read.
      +
      Parameters:
      +
      type - the class of the object that is to be read.
      +
      genericType - the type of object to be produced. E.g. if the message body is to be converted into a method + parameter, this will be the formal type of the method parameter as returned by + Class.getGenericParameterTypes.
      +
      annotations - an array of the annotations on the declaration of the artifact that will be initialized with the + produced instance. E.g. if the message body is to be converted into a method parameter, this will be the annotations + on that parameter returned by Class.getParameterAnnotations.
      +
      mediaType - the media type of the data that will be read.
      +
      Returns:
      +
      a MessageBodyReader that matches the supplied criteria or null if none is found.
      +
      +
      +
      • +
    • +
      +

      getMessageBodyWriter

      +
      <T> MessageBodyWriter<T> getMessageBodyWriter(Class<T> type, + Type genericType, + Annotation[] annotations, + MediaType mediaType)
      +
      Get a message body writer that matches a set of criteria. The set of writers is first filtered by comparing the + supplied value of mediaType with the value of each writer's Produces, ensuring the + supplied value of type is assignable to the generic type of the reader, and eliminating those that do not + match. The list of matching writers is then ordered with those with the best matching values of + Produces (x/y > x/* > */*) sorted first. Finally, the + MessageBodyWriter.isWriteable(Class, Type, Annotation[], MediaType) method is called on each writer in order + using the supplied criteria and the first writer that returns true is selected and returned.
      +
      +
      Type Parameters:
      +
      T - type of the object that is to be written.
      +
      Parameters:
      +
      type - the class of the object that is to be written.
      +
      genericType - the type of object to be written. E.g. if the message body is to be produced from a field, this + will be the declared type of the field as returned by Field.getGenericType.
      +
      annotations - an array of the annotations on the declaration of the artifact that will be written. E.g. if the + message body is to be produced from a field, this will be the annotations on that field returned by + Field.getDeclaredAnnotations.
      +
      mediaType - the media type of the data that will be written.
      +
      Returns:
      +
      a MessageBodyReader that matches the supplied criteria or null if none is found.
      +
      +
      +
      • +
    • +
      +

      getExceptionMapper

      +
      <T extends Throwable> ExceptionMapper<T> getExceptionMapper(Class<T> type)
      +
      Get an exception mapping provider for a particular class of exception. Returns the provider whose generic type is the + nearest superclass of type.
      +
      +
      Type Parameters:
      +
      T - type of the exception handled by the exception mapping provider.
      +
      Parameters:
      +
      type - the class of exception.
      +
      Returns:
      +
      an ExceptionMapper for the supplied type or null if none is found.
      +
      +
      +
      • +
    • +
      +

      getContextResolver

      +
      <T> ContextResolver<T> getContextResolver(Class<T> contextType, + MediaType mediaType)
      +
      Get a context resolver for a particular type of context and media type. The set of resolvers is first filtered by + comparing the supplied value of mediaType with the value of each resolver's Produces, + ensuring the generic type of the context resolver is assignable to the supplied value of contextType, and + eliminating those that do not match. If only one resolver matches the criteria then it is returned. If more than one + resolver matches then the list of matching resolvers is ordered with those with the best matching values of + Produces (x/y > x/* > */*) sorted first. A proxy is returned that delegates calls + to ContextResolver.getContext(java.lang.Class) to each matching context resolver in order and returns the + first non-null value it obtains or null if all matching context resolvers return null.
      +
      +
      Type Parameters:
      +
      T - type of the context.
      +
      Parameters:
      +
      contextType - the class of context desired.
      +
      mediaType - the media type of data for which a context is required.
      +
      Returns:
      +
      a matching context resolver instance or null if no matching context providers are found.
      +
      +
      +
      • +
    +
    +
    • +
+
+ +
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/ext/ReaderInterceptor.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/ext/ReaderInterceptor.html new file mode 100644 index 0000000000..8ddf6abf6d --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/ext/ReaderInterceptor.html @@ -0,0 +1,184 @@ + + + + +ReaderInterceptor (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Module jakarta.ws.rs
+
Package jakarta.ws.rs.ext
+

Interface ReaderInterceptor

+
+
+
+
public interface ReaderInterceptor
+
Interface for message body reader interceptors that wrap around calls to + MessageBodyReader.readFrom(java.lang.Class<T>, java.lang.reflect.Type, java.lang.annotation.Annotation[], jakarta.ws.rs.core.MediaType, jakarta.ws.rs.core.MultivaluedMap<java.lang.String, java.lang.String>, java.io.InputStream). +

+ Providers implementing ReaderInterceptor contract must be either programmatically registered in a JAX-RS + runtime or must be annotated with @Provider annotation to be automatically + discovered by the JAX-RS runtime during a provider scanning phase. Message body interceptor instances may also be + discovered and bound dynamically to particular resource methods. +

+
+
Since:
+
2.0
+
Author:
+
Santiago Pericas-Geertsen, Bill Burke, Marek Potociar
+
See Also:
+
+ +
+
+
+
+ +
+
+ +
+ +
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/ext/ReaderInterceptorContext.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/ext/ReaderInterceptorContext.html new file mode 100644 index 0000000000..98702b8e3b --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/ext/ReaderInterceptorContext.html @@ -0,0 +1,237 @@ + + + + +ReaderInterceptorContext (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Module jakarta.ws.rs
+
Package jakarta.ws.rs.ext
+

Interface ReaderInterceptorContext

+
+
+
+
All Superinterfaces:
+
InterceptorContext
+
+
+
public interface ReaderInterceptorContext +extends InterceptorContext
+
Context class used by ReaderInterceptor to intercept calls to (@link + jakarta.ws.rs.ext.MessageBodyReader#readFrom}. The getters and setters in this context class correspond to the + parameters of the intercepted method.
+
+
Since:
+
2.0
+
Author:
+
Santiago Pericas-Geertsen, Bill Burke
+
See Also:
+
+ +
+
+
+
+ +
+
+ +
+ +
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/ext/RuntimeDelegate.HeaderDelegate.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/ext/RuntimeDelegate.HeaderDelegate.html new file mode 100644 index 0000000000..049363017f --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/ext/RuntimeDelegate.HeaderDelegate.html @@ -0,0 +1,186 @@ + + + + +RuntimeDelegate.HeaderDelegate (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Module jakarta.ws.rs
+
Package jakarta.ws.rs.ext
+

Interface RuntimeDelegate.HeaderDelegate<T>

+
+
+
+
Type Parameters:
+
T - a JAX-RS type that corresponds to the value of a HTTP header.
+
+
+
Enclosing class:
+
RuntimeDelegate
+
+
+
public static interface RuntimeDelegate.HeaderDelegate<T>
+
Defines the contract for a delegate that is responsible for converting between the String form of a HTTP header and + the corresponding JAX-RS type T.
+
+
+
    + +
  • +
    +

    Method Summary

    +
    +
    +
    +
    +
    Modifier and Type
    +
    Method
    +
    Description
    +
    T
    +
    fromString(String value)
    +
    +
    Parse the supplied value and create an instance of T.
    +
    +
    String
    +
    toString(T value)
    +
    +
    Convert the supplied value to a String.
    +
    +
    +
    +
    +
    +
    • +
+
+
+
    + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      fromString

      +
      T fromString(String value)
      +
      Parse the supplied value and create an instance of T.
      +
      +
      Parameters:
      +
      value - the string value.
      +
      Returns:
      +
      the newly created instance of T.
      +
      Throws:
      +
      IllegalArgumentException - if the supplied string cannot be parsed or is null.
      +
      +
      +
      • +
    • +
      +

      toString

      +
      String toString(T value)
      +
      Convert the supplied value to a String.
      +
      +
      Parameters:
      +
      value - the value of type T.
      +
      Returns:
      +
      a String representation of the value.
      +
      Throws:
      +
      IllegalArgumentException - if the supplied object cannot be serialized or is null.
      +
      +
      +
      • +
    +
    +
    • +
+
+ +
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/ext/RuntimeDelegate.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/ext/RuntimeDelegate.html new file mode 100644 index 0000000000..157ee30251 --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/ext/RuntimeDelegate.html @@ -0,0 +1,547 @@ + + + + +RuntimeDelegate (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Module jakarta.ws.rs
+
Package jakarta.ws.rs.ext
+

Class RuntimeDelegate

+
+
java.lang.Object +
jakarta.ws.rs.ext.RuntimeDelegate
+
+
+
+
public abstract class RuntimeDelegate +extends Object
+
Implementations of JAX-RS provide a concrete subclass of RuntimeDelegate and various JAX-RS API methods defer to + methods of RuntimeDelegate for their functionality. Regular users of JAX-RS are not expected to use this class + directly and overriding an implementation of this class with a user supplied subclass may cause unexpected behavior.
+
+
Since:
+
1.0
+
Author:
+
Paul Sandoz, Marc Hadley
+
+
+
+ +
+
+
    + +
  • +
    +

    Field Details

    + +
    +
    • + +
  • +
    +

    Constructor Details

    +
      +
    • +
      +

      RuntimeDelegate

      +
      protected RuntimeDelegate()
      +
      Allows custom implementations to extend the RuntimeDelegate class.
      +
      +
      • +
    +
    +
    • + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      getInstance

      +
      public static RuntimeDelegate getInstance()
      +
      Obtain a RuntimeDelegate instance. If an instance had not already been created and set via + setInstance(RuntimeDelegate), the first invocation will create an instance which will then be cached for + future use. + +

      + The algorithm used to locate the RuntimeDelegate subclass to use consists of the following steps: +

      +
        +
      • If a resource with the name of META-INF/services/jakarta.ws.rs.ext.RuntimeDelegate exists, then its first + line, if present, is used as the UTF-8 encoded name of the implementation class.
        • +
      • If the $java.home/lib/jaxrs.properties file exists and it is readable by the + java.util.Properties.load(InputStream) method and it contains an entry whose key is + jakarta.ws.rs.ext.RuntimeDelegate, then the value of that entry is used as the name of the implementation + class.
        • +
      • If a system property with the name jakarta.ws.rs.ext.RuntimeDelegate is defined, then its value is used as + the name of the implementation class.
        • +
      • Finally, a default implementation class name is used.
        • +
      +
      +
      Returns:
      +
      an instance of RuntimeDelegate.
      +
      +
      +
      • +
    • +
      +

      setInstance

      +
      public static void setInstance(RuntimeDelegate rd)
      +
      Set the runtime delegate that will be used by JAX-RS classes. If this method is not called prior to + getInstance() then an implementation will be sought as described in getInstance().
      +
      +
      Parameters:
      +
      rd - the runtime delegate instance
      +
      Throws:
      +
      SecurityException - if there is a security manager and the permission ReflectPermission("suppressAccessChecks") + has not been granted.
      +
      +
      +
      • +
    • +
      +

      createUriBuilder

      +
      public abstract UriBuilder createUriBuilder()
      +
      Create a new instance of a UriBuilder.
      +
      +
      Returns:
      +
      new UriBuilder instance.
      +
      See Also:
      +
      + +
      +
      +
      +
      • +
    • +
      +

      createResponseBuilder

      +
      public abstract Response.ResponseBuilder createResponseBuilder()
      +
      Create a new instance of a Response.ResponseBuilder.
      +
      +
      Returns:
      +
      new ResponseBuilder instance.
      +
      See Also:
      +
      + +
      +
      +
      +
      • +
    • +
      +

      createVariantListBuilder

      +
      public abstract Variant.VariantListBuilder createVariantListBuilder()
      +
      Create a new instance of a Variant.VariantListBuilder.
      +
      +
      Returns:
      +
      new VariantListBuilder instance.
      +
      See Also:
      +
      + +
      +
      +
      +
      • +
    • +
      +

      createEndpoint

      +
      public abstract <T> T createEndpoint(Application application, + Class<T> endpointType) + throws IllegalArgumentException, +UnsupportedOperationException
      +
      Create a configured instance of the supplied endpoint type. How the returned endpoint instance is published is + dependent on the type of endpoint.
      +
      +
      Type Parameters:
      +
      T - endpoint type.
      +
      Parameters:
      +
      application - the application configuration.
      +
      endpointType - the type of endpoint instance to be created.
      +
      Returns:
      +
      a configured instance of the requested type.
      +
      Throws:
      +
      IllegalArgumentException - if application is null or the requested endpoint type is not supported.
      +
      UnsupportedOperationException - if the implementation supports no endpoint types.
      +
      +
      +
      • +
    • +
      +

      createHeaderDelegate

      +
      public abstract <T> +RuntimeDelegate.HeaderDelegate<T> createHeaderDelegate(Class<T> type) + throws IllegalArgumentException
      +
      Obtain an instance of a RuntimeDelegate.HeaderDelegate for the supplied class. An implementation is required to support the + following values for type: CacheControl, Cookie, + EntityTag, Link, NewCookie, + MediaType and java.util.Date.
      +
      +
      Type Parameters:
      +
      T - header type.
      +
      Parameters:
      +
      type - the class of the header.
      +
      Returns:
      +
      an instance of HeaderDelegate for the supplied type.
      +
      Throws:
      +
      IllegalArgumentException - if type is null.
      +
      See Also:
      +
      + +
      +
      +
      +
      • +
    • +
      +

      createLinkBuilder

      +
      public abstract Link.Builder createLinkBuilder()
      +
      Create a new instance of a Link.Builder.
      +
      +
      Returns:
      +
      new Link.Builder instance.
      +
      See Also:
      +
      + +
      +
      +
      +
      • +
    • +
      +

      createConfigurationBuilder

      +
      public abstract SeBootstrap.Configuration.Builder createConfigurationBuilder()
      +
      Create a new instance of a SeBootstrap.Configuration.Builder. +

      + This method is not intended to be invoked by applications. Call SeBootstrap.Configuration.builder() + instead. +

      +
      +
      Returns:
      +
      new SeBootstrap.Configuration.Builder instance.
      +
      See Also:
      +
      + +
      +
      +
      +
      • +
    • +
      +

      bootstrap

      +
      public abstract CompletionStage<SeBootstrap.Instance> bootstrap(Application application, + SeBootstrap.Configuration configuration)
      +
      Perform startup of the application in Java SE environments. +

      + This method is not intended to be invoked by applications. Call SeBootstrap.start(Application, SeBootstrap.Configuration) instead. +

      +
      +
      Parameters:
      +
      application - The application to start up.
      +
      configuration - The bootstrap configuration.
      +
      Returns:
      +
      CompletionStage asynchronously producing handle of the running application instance.
      +
      +
      +
      • +
    • +
      +

      bootstrap

      +
      public abstract CompletionStage<SeBootstrap.Instance> bootstrap(Class<? extends Application> clazz, + SeBootstrap.Configuration configuration)
      +
      Perform startup of the application in Java SE environments. +

      + This method is not intended to be invoked by applications. Call SeBootstrap.start(Class, SeBootstrap.Configuration) instead. +

      +
      +
      Parameters:
      +
      clazz - The application class to instantiate and start.
      +
      configuration - The bootstrap configuration.
      +
      Returns:
      +
      CompletionStage asynchronously producing handle of the running application instance.
      +
      +
      +
      • +
    • +
      +

      createEntityPartBuilder

      +
      public abstract EntityPart.Builder createEntityPartBuilder(String partName) + throws IllegalArgumentException
      +
      Create a new instance of a EntityPart.Builder. +

      + This method is not intended to be invoked by applications. Call EntityPart.withName(String) instead. +

      +
      +
      Parameters:
      +
      partName - name for this part within the multipart body.
      +
      Returns:
      +
      new EntityPart.Builder instance with specified part name
      +
      Throws:
      +
      IllegalArgumentException - if partName is null.
      +
      Since:
      +
      3.1
      +
      +
      +
      • +
    +
    +
    • +
+
+ +
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/ext/WriterInterceptor.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/ext/WriterInterceptor.html new file mode 100644 index 0000000000..58b6b9e1f6 --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/ext/WriterInterceptor.html @@ -0,0 +1,182 @@ + + + + +WriterInterceptor (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Module jakarta.ws.rs
+
Package jakarta.ws.rs.ext
+

Interface WriterInterceptor

+
+
+
+
public interface WriterInterceptor
+
Interface for message body writer interceptors that wrap around calls to + MessageBodyWriter.writeTo(T, java.lang.Class<?>, java.lang.reflect.Type, java.lang.annotation.Annotation[], jakarta.ws.rs.core.MediaType, jakarta.ws.rs.core.MultivaluedMap<java.lang.String, java.lang.Object>, java.io.OutputStream). + +

+ Providers implementing WriterInterceptor contract must be either programmatically registered in a JAX-RS + runtime or must be annotated with @Provider annotation to be automatically + discovered by the JAX-RS runtime during a provider scanning phase. Message body interceptor instances may also be + discovered and bound dynamically to particular resource methods. +

+
+
Since:
+
2.0
+
Author:
+
Santiago Pericas-Geertsen, Bill Burke, Marek Potociar
+
See Also:
+
+ +
+
+
+
+ +
+
+ +
+ +
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/ext/WriterInterceptorContext.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/ext/WriterInterceptorContext.html new file mode 100644 index 0000000000..5c19395d8a --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/ext/WriterInterceptorContext.html @@ -0,0 +1,264 @@ + + + + +WriterInterceptorContext (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Module jakarta.ws.rs
+
Package jakarta.ws.rs.ext
+

Interface WriterInterceptorContext

+
+
+
+
All Superinterfaces:
+
InterceptorContext
+
+
+
public interface WriterInterceptorContext +extends InterceptorContext
+
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). The getters and setters in this context class correspond to the + parameters of the intercepted method.
+
+
Since:
+
2.0
+
Author:
+
Santiago Pericas-Geertsen, Bill Burke
+
See Also:
+
+ +
+
+
+
+ +
+
+ +
+ +
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/ext/class-use/ContextResolver.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/ext/class-use/ContextResolver.html new file mode 100644 index 0000000000..0360444fef --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/ext/class-use/ContextResolver.html @@ -0,0 +1,93 @@ + + + + +Uses of Interface jakarta.ws.rs.ext.ContextResolver (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
jakarta.ws.rs.ext.ContextResolver

+
+
Packages that use ContextResolver
+
+
Package
+
Description
+
jakarta.ws.rs.ext
+
+
APIs that provide extensions to the types supported by the JAX-RS API.
+
+
+
+ +
+
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/ext/class-use/ExceptionMapper.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/ext/class-use/ExceptionMapper.html new file mode 100644 index 0000000000..c743ca113d --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/ext/class-use/ExceptionMapper.html @@ -0,0 +1,92 @@ + + + + +Uses of Interface jakarta.ws.rs.ext.ExceptionMapper (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
jakarta.ws.rs.ext.ExceptionMapper

+
+
Packages that use ExceptionMapper
+
+
Package
+
Description
+
jakarta.ws.rs.ext
+
+
APIs that provide extensions to the types supported by the JAX-RS API.
+
+
+
+ +
+
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/ext/class-use/InterceptorContext.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/ext/class-use/InterceptorContext.html new file mode 100644 index 0000000000..d7090249f0 --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/ext/class-use/InterceptorContext.html @@ -0,0 +1,99 @@ + + + + +Uses of Interface jakarta.ws.rs.ext.InterceptorContext (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
jakarta.ws.rs.ext.InterceptorContext

+
+
Packages that use InterceptorContext
+
+
Package
+
Description
+
jakarta.ws.rs.ext
+
+
APIs that provide extensions to the types supported by the JAX-RS API.
+
+
+
+ +
+
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/ext/class-use/MessageBodyReader.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/ext/class-use/MessageBodyReader.html new file mode 100644 index 0000000000..a0e44addb6 --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/ext/class-use/MessageBodyReader.html @@ -0,0 +1,95 @@ + + + + +Uses of Interface jakarta.ws.rs.ext.MessageBodyReader (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
jakarta.ws.rs.ext.MessageBodyReader

+
+
Packages that use MessageBodyReader
+
+
Package
+
Description
+
jakarta.ws.rs.ext
+
+
APIs that provide extensions to the types supported by the JAX-RS API.
+
+
+
+ +
+
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/ext/class-use/MessageBodyWriter.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/ext/class-use/MessageBodyWriter.html new file mode 100644 index 0000000000..aa1311915e --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/ext/class-use/MessageBodyWriter.html @@ -0,0 +1,95 @@ + + + + +Uses of Interface jakarta.ws.rs.ext.MessageBodyWriter (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
jakarta.ws.rs.ext.MessageBodyWriter

+
+
Packages that use MessageBodyWriter
+
+
Package
+
Description
+
jakarta.ws.rs.ext
+
+
APIs that provide extensions to the types supported by the JAX-RS API.
+
+
+
+ +
+
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/ext/class-use/ParamConverter.Lazy.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/ext/class-use/ParamConverter.Lazy.html new file mode 100644 index 0000000000..a9d96ac393 --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/ext/class-use/ParamConverter.Lazy.html @@ -0,0 +1,63 @@ + + + + +Uses of Annotation Interface jakarta.ws.rs.ext.ParamConverter.Lazy (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Annotation Interface
jakarta.ws.rs.ext.ParamConverter.Lazy

+
+No usage of jakarta.ws.rs.ext.ParamConverter.Lazy
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/ext/class-use/ParamConverter.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/ext/class-use/ParamConverter.html new file mode 100644 index 0000000000..1f2db2af7a --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/ext/class-use/ParamConverter.html @@ -0,0 +1,94 @@ + + + + +Uses of Interface jakarta.ws.rs.ext.ParamConverter (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
jakarta.ws.rs.ext.ParamConverter

+
+
Packages that use ParamConverter
+
+
Package
+
Description
+
jakarta.ws.rs.ext
+
+
APIs that provide extensions to the types supported by the JAX-RS API.
+
+
+
+ +
+
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/ext/class-use/ParamConverterProvider.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/ext/class-use/ParamConverterProvider.html new file mode 100644 index 0000000000..6c75bbab9b --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/ext/class-use/ParamConverterProvider.html @@ -0,0 +1,63 @@ + + + + +Uses of Interface jakarta.ws.rs.ext.ParamConverterProvider (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
jakarta.ws.rs.ext.ParamConverterProvider

+
+No usage of jakarta.ws.rs.ext.ParamConverterProvider
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/ext/class-use/Provider.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/ext/class-use/Provider.html new file mode 100644 index 0000000000..7f37f96885 --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/ext/class-use/Provider.html @@ -0,0 +1,63 @@ + + + + +Uses of Annotation Interface jakarta.ws.rs.ext.Provider (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Annotation Interface
jakarta.ws.rs.ext.Provider

+
+No usage of jakarta.ws.rs.ext.Provider
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/ext/class-use/Providers.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/ext/class-use/Providers.html new file mode 100644 index 0000000000..13bb553db7 --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/ext/class-use/Providers.html @@ -0,0 +1,63 @@ + + + + +Uses of Interface jakarta.ws.rs.ext.Providers (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
jakarta.ws.rs.ext.Providers

+
+No usage of jakarta.ws.rs.ext.Providers
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/ext/class-use/ReaderInterceptor.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/ext/class-use/ReaderInterceptor.html new file mode 100644 index 0000000000..2617061128 --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/ext/class-use/ReaderInterceptor.html @@ -0,0 +1,63 @@ + + + + +Uses of Interface jakarta.ws.rs.ext.ReaderInterceptor (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
jakarta.ws.rs.ext.ReaderInterceptor

+
+No usage of jakarta.ws.rs.ext.ReaderInterceptor
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/ext/class-use/ReaderInterceptorContext.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/ext/class-use/ReaderInterceptorContext.html new file mode 100644 index 0000000000..9eeb618838 --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/ext/class-use/ReaderInterceptorContext.html @@ -0,0 +1,92 @@ + + + + +Uses of Interface jakarta.ws.rs.ext.ReaderInterceptorContext (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
jakarta.ws.rs.ext.ReaderInterceptorContext

+
+
Packages that use ReaderInterceptorContext
+
+
Package
+
Description
+
jakarta.ws.rs.ext
+
+
APIs that provide extensions to the types supported by the JAX-RS API.
+
+
+
+ +
+
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/ext/class-use/RuntimeDelegate.HeaderDelegate.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/ext/class-use/RuntimeDelegate.HeaderDelegate.html new file mode 100644 index 0000000000..a157249b6b --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/ext/class-use/RuntimeDelegate.HeaderDelegate.html @@ -0,0 +1,92 @@ + + + + +Uses of Interface jakarta.ws.rs.ext.RuntimeDelegate.HeaderDelegate (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
jakarta.ws.rs.ext.RuntimeDelegate.HeaderDelegate

+
+
Packages that use RuntimeDelegate.HeaderDelegate
+
+
Package
+
Description
+
jakarta.ws.rs.ext
+
+
APIs that provide extensions to the types supported by the JAX-RS API.
+
+
+
+ +
+
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/ext/class-use/RuntimeDelegate.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/ext/class-use/RuntimeDelegate.html new file mode 100644 index 0000000000..a0ad50b87c --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/ext/class-use/RuntimeDelegate.html @@ -0,0 +1,103 @@ + + + + +Uses of Class jakarta.ws.rs.ext.RuntimeDelegate (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
jakarta.ws.rs.ext.RuntimeDelegate

+
+
Packages that use RuntimeDelegate
+
+
Package
+
Description
+
jakarta.ws.rs.ext
+
+
APIs that provide extensions to the types supported by the JAX-RS API.
+
+
+
+ +
+
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/ext/class-use/WriterInterceptor.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/ext/class-use/WriterInterceptor.html new file mode 100644 index 0000000000..5617f3f784 --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/ext/class-use/WriterInterceptor.html @@ -0,0 +1,63 @@ + + + + +Uses of Interface jakarta.ws.rs.ext.WriterInterceptor (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
jakarta.ws.rs.ext.WriterInterceptor

+
+No usage of jakarta.ws.rs.ext.WriterInterceptor
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/ext/class-use/WriterInterceptorContext.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/ext/class-use/WriterInterceptorContext.html new file mode 100644 index 0000000000..6988834870 --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/ext/class-use/WriterInterceptorContext.html @@ -0,0 +1,92 @@ + + + + +Uses of Interface jakarta.ws.rs.ext.WriterInterceptorContext (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
jakarta.ws.rs.ext.WriterInterceptorContext

+
+
Packages that use WriterInterceptorContext
+
+
Package
+
Description
+
jakarta.ws.rs.ext
+
+
APIs that provide extensions to the types supported by the JAX-RS API.
+
+
+
+ +
+
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/ext/package-summary.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/ext/package-summary.html new file mode 100644 index 0000000000..7d4e30053b --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/ext/package-summary.html @@ -0,0 +1,204 @@ + + + + +jakarta.ws.rs.ext (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+
Module jakarta.ws.rs
+

Package jakarta.ws.rs.ext

+
+
+
package jakarta.ws.rs.ext
+
+
APIs that provide extensions to the types supported by the JAX-RS API.
+
+
+ +
+
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/ext/package-tree.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/ext/package-tree.html new file mode 100644 index 0000000000..0dde9e30e2 --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/ext/package-tree.html @@ -0,0 +1,105 @@ + + + + +jakarta.ws.rs.ext Class Hierarchy (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Hierarchy For Package jakarta.ws.rs.ext

+
+Package Hierarchies: + +
+

Class Hierarchy

+ +
+
+

Interface Hierarchy

+ +
+
+

Annotation Interface Hierarchy

+ +
+
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/ext/package-use.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/ext/package-use.html new file mode 100644 index 0000000000..32f43927ea --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/ext/package-use.html @@ -0,0 +1,131 @@ + + + + +Uses of Package jakarta.ws.rs.ext (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Package
jakarta.ws.rs.ext

+
+
Packages that use jakarta.ws.rs.ext
+
+
Package
+
Description
+
jakarta.ws.rs.ext
+
+
APIs that provide extensions to the types supported by the JAX-RS API.
+
+
+
+ +
+
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/package-summary.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/package-summary.html new file mode 100644 index 0000000000..edb1cc9d7a --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/package-summary.html @@ -0,0 +1,351 @@ + + + + +jakarta.ws.rs (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+
Module jakarta.ws.rs
+

Package jakarta.ws.rs

+
+
+
package jakarta.ws.rs
+
+
High-level interfaces and annotations used to create RESTful service resources. For example: + + 
+ @Path("widgets/{widgetid}")
+ @Consumes("application/widgets+xml")
+ @Produces("application/widgets+xml")
+ public class WidgetResource {
+
+     @GET
+     public String getWidget(@PathParam("widgetid") String id) {
+         return getWidgetAsXml(id);
+     }
+
+     @PUT
+     public void updateWidget(@PathParam("widgetid") String id,
+                              Source update) {
+         updateWidgetFromXml(id, update);
+     }
+
+     ...
+ }
+
+
+
+
    +
  • + +
    • +
  • +
    +
    +
    +
    +
    Class
    +
    Description
    +
    ApplicationPath
    +
    +
    Identifies the application path that serves as the base URI for all resource URIs provided by + Path.
    +
    +
    BadRequestException
    +
    +
    A runtime exception indicating a bad client request.
    +
    +
    BeanParam
    +
    +
    The annotation that may be used to inject custom JAX-RS "parameter aggregator" value object into a resource class + field, property or resource method parameter.
    +
    +
    ClientErrorException
    +
    +
    A base runtime application exception indicating a client request error (HTTP 4xx status codes).
    +
    +
    ConstrainedTo
    +
    +
    Indicates the run-time context in which an annotated JAX-RS provider is applicable.
    +
    +
    Consumes
    +
    +
    Defines the media types that the methods of a resource class or MessageBodyReader can accept.
    +
    +
    CookieParam
    +
    +
    Binds the value of a HTTP cookie to a resource method parameter, resource class field, or resource class bean + property.
    +
    +
    DefaultValue
    +
    +
    Defines the default value of request meta-data that is bound using one of the following annotations: + PathParam, QueryParam, MatrixParam, + CookieParam, FormParam, or HeaderParam.
    +
    +
    DELETE
    +
    +
    Indicates that the annotated method responds to HTTP DELETE requests.
    +
    +
    Encoded
    +
    +
    Disables automatic decoding of parameter values bound using QueryParam, PathParam, FormParam + or MatrixParam.
    +
    +
    ForbiddenException
    +
    +
    A runtime exception indicating that an access to a resource requested by a client has been + forbidden by the server.
    +
    +
    FormParam
    +
    +
    Binds the value(s) of a form parameter contained within a request entity body to a resource method parameter.
    +
    +
    GET
    +
    +
    Indicates that the annotated method responds to HTTP GET requests.
    +
    +
    HEAD
    +
    +
    Indicates that the annotated method responds to HTTP HEAD requests.
    +
    +
    HeaderParam
    +
    +
    Binds the value(s) of a HTTP header to a resource method parameter, resource class field, or resource class bean + property.
    +
    +
    HttpMethod
    +
    +
    Associates the name of a HTTP method with an annotation.
    +
    +
    InternalServerErrorException
    +
    +
    A runtime exception indicating an internal server + error.
    +
    +
    MatrixParam
    +
    +
    Binds the value(s) of a URI matrix parameter to a resource method parameter, resource class field, or resource class + bean property.
    +
    +
    NameBinding
    +
    +
    Meta-annotation used to create name binding annotations for filters and interceptors.
    +
    +
    NotAcceptableException
    +
    +
    A runtime exception indicating that a client request is not + acceptable by the server.
    +
    +
    NotAllowedException
    +
    +
    A runtime exception indicating a client requesting a resource method that is + not allowed.
    +
    +
    NotAuthorizedException
    +
    +
    A runtime exception indicating request authorization failure caused by one of the following scenarios: + + a client did not send the required authorization credentials to access the requested resource, i.e.
    +
    +
    NotFoundException
    +
    +
    A runtime exception indicating a resource requested by a client was not found on the server.
    +
    +
    NotSupportedException
    +
    +
    A runtime exception indicating that the client request entity media type is + not supported.
    +
    +
    OPTIONS
    +
    +
    Indicates that the annotated method responds to HTTP OPTIONS requests.
    +
    +
    PATCH
    +
    +
    Indicates that the annotated method responds to HTTP PATCH requests.
    +
    +
    Path
    +
    +
    Identifies the URI path that a resource class or class method will serve requests for.
    +
    +
    PathParam
    +
    +
    Binds the value of a URI template parameter or a path segment containing the template parameter to a resource method + parameter, resource class field, or resource class bean property.
    +
    +
    POST
    +
    +
    Indicates that the annotated method responds to HTTP POST requests.
    +
    +
    Priorities
    +
    +
    A collection of built-in priority constants for the JAX-RS components that are supposed to be ordered based on their + jakarta.annotation.Priority class-level annotation value when used or applied by JAX-RS runtime.
    +
    +
    ProcessingException
    +
    +
    A base JAX-RS runtime processing exception.
    +
    +
    Produces
    +
    +
    Defines the media type(s) that the methods of a resource class or MessageBodyWriter can + produce.
    +
    +
    PUT
    +
    +
    Indicates that the annotated method responds to HTTP PUT requests.
    +
    +
    QueryParam
    +
    +
    Binds the value(s) of a HTTP query parameter to a resource method parameter, resource class field, or resource class + bean property.
    +
    +
    RedirectionException
    +
    +
    A runtime application exception indicating a request redirection (HTTP 3xx status codes).
    +
    +
    RuntimeType
    +
    +
    Enumeration of JAX-RS runtime types.
    +
    +
    SeBootstrap
    +
    +
    Bootstrap class used to startup a JAX-RS application in Java SE environments.
    +
    +
    SeBootstrap.Configuration
    +
    +
    Provides information needed by the JAX-RS implementation for bootstrapping an application.
    +
    +
    SeBootstrap.Configuration.Builder
    +
    +
    Builder for bootstrap SeBootstrap.Configuration.
    +
    +
    SeBootstrap.Configuration.SSLClientAuthentication
    +
    +
    Secure socket client authentication policy
    +
    +
    SeBootstrap.Instance
    +
    +
    Handle of the running application instance.
    +
    +
    SeBootstrap.Instance.StopResult
    +
    +
    Result of stopping the application instance.
    +
    +
    ServerErrorException
    +
    +
    A base runtime application exception indicating a server error (HTTP 5xx status codes).
    +
    +
    ServiceUnavailableException
    +
    +
    A runtime exception indicating that the requested resource + cannot be served.
    +
    +
    WebApplicationException
    +
    +
    Runtime exception for applications.
    +
    +
    +
    +
    +
    • +
+
+
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/package-tree.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/package-tree.html new file mode 100644 index 0000000000..8213d76048 --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/package-tree.html @@ -0,0 +1,165 @@ + + + + +jakarta.ws.rs Class Hierarchy (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Hierarchy For Package jakarta.ws.rs

+
+Package Hierarchies: + +
+

Class Hierarchy

+ +
+
+

Interface Hierarchy

+ +
+
+

Annotation Interface Hierarchy

+ +
+
+

Enum Class Hierarchy

+ +
+
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/package-use.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/package-use.html new file mode 100644 index 0000000000..8cefdf3b98 --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/package-use.html @@ -0,0 +1,192 @@ + + + + +Uses of Package jakarta.ws.rs (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Package
jakarta.ws.rs

+
+
Packages that use jakarta.ws.rs
+
+
Package
+
Description
+
jakarta.ws.rs
+
+
High-level interfaces and annotations used to create RESTful service resources.
+
+
jakarta.ws.rs.client
+
+
The JAX-RS client API
+
+
jakarta.ws.rs.core
+
+
Low-level interfaces and annotations used to create RESTful service resources.
+
+
jakarta.ws.rs.ext
+
+
APIs that provide extensions to the types supported by the JAX-RS API.
+
+
+
+ +
+
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/sse/InboundSseEvent.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/sse/InboundSseEvent.html new file mode 100644 index 0000000000..2e1dfb28ca --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/sse/InboundSseEvent.html @@ -0,0 +1,295 @@ + + + + +InboundSseEvent (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Module jakarta.ws.rs
+
Package jakarta.ws.rs.sse
+

Interface InboundSseEvent

+
+
+
+
All Superinterfaces:
+
SseEvent
+
+
+
public interface InboundSseEvent +extends SseEvent
+
Inbound Server-sent event. +

+ Used on the client side, when accepting incoming Server-sent events.

+
+
Since:
+
2.1
+
Author:
+
Marek Potociar
+
+
+
+ +
+
+
    + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      isEmpty

      +
      boolean isEmpty()
      +
      Check if the event is empty (i.e. does not contain any data).
      +
      +
      Returns:
      +
      true if current instance does not contain any data, false otherwise.
      +
      +
      +
      • +
    • +
      +

      readData

      +
      String readData()
      +
      Get the original event data as String.
      +
      +
      Returns:
      +
      event data de-serialized into a string.
      +
      Throws:
      +
      ProcessingException - when provided type can't be read. The thrown exception wraps the original + cause.
      +
      +
      +
      • +
    • +
      +

      readData

      +
      <T> T readData(Class<T> type)
      +
      Read event data as a given Java type.
      +
      +
      Type Parameters:
      +
      T - generic event data type
      +
      Parameters:
      +
      type - Java type to be used for event data de-serialization.
      +
      Returns:
      +
      event data de-serialized as an instance of a given type.
      +
      Throws:
      +
      ProcessingException - when provided type can't be read. The thrown exception wraps the original + cause.
      +
      +
      +
      • +
    • +
      +

      readData

      +
      <T> T readData(GenericType<T> type)
      +
      Read event data as a given generic type.
      +
      +
      Type Parameters:
      +
      T - generic event data type
      +
      Parameters:
      +
      type - generic type to be used for event data de-serialization.
      +
      Returns:
      +
      event data de-serialized as an instance of a given type.
      +
      Throws:
      +
      ProcessingException - when provided type can't be read. The thrown exception wraps the original + cause.
      +
      +
      +
      • +
    • +
      +

      readData

      +
      <T> T readData(Class<T> messageType, + MediaType mediaType)
      +
      Read event data as a given Java type.
      +
      +
      Type Parameters:
      +
      T - generic event data type
      +
      Parameters:
      +
      messageType - Java type to be used for event data de-serialization.
      +
      mediaType - media type to be used for event data de-serialization.
      +
      Returns:
      +
      event data de-serialized as an instance of a given type.
      +
      Throws:
      +
      ProcessingException - when provided type can't be read. The thrown exception wraps the original + cause.
      +
      +
      +
      • +
    • +
      +

      readData

      +
      <T> T readData(GenericType<T> type, + MediaType mediaType)
      +
      Read event data as a given generic type.
      +
      +
      Type Parameters:
      +
      T - generic event data type
      +
      Parameters:
      +
      type - generic type to be used for event data de-serialization.
      +
      mediaType - media type to be used for event data de-serialization.
      +
      Returns:
      +
      event data de-serialized as an instance of a given type.
      +
      Throws:
      +
      ProcessingException - when provided type can't be read. The thrown exception wraps the original + cause.
      +
      +
      +
      • +
    +
    +
    • +
+
+ +
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/sse/OutboundSseEvent.Builder.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/sse/OutboundSseEvent.Builder.html new file mode 100644 index 0000000000..66413b2824 --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/sse/OutboundSseEvent.Builder.html @@ -0,0 +1,358 @@ + + + + +OutboundSseEvent.Builder (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Module jakarta.ws.rs
+
Package jakarta.ws.rs.sse
+

Interface OutboundSseEvent.Builder

+
+
+
+
Enclosing interface:
+
OutboundSseEvent
+
+
+
public static interface OutboundSseEvent.Builder
+
A builder class used for creating OutboundSseEvent instances.
+
+
+ +
+
+
    + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      id

      +
      OutboundSseEvent.Builder id(String id)
      +
      Set the event id. +

      + Will be send as a value of the SSE "id" field. This field is optional.

      +
      +
      Parameters:
      +
      id - event id.
      +
      Returns:
      +
      updated builder instance.
      +
      +
      +
      • +
    • +
      +

      name

      +
      OutboundSseEvent.Builder name(String name)
      +
      Set event name. +

      + Will be send as a value of the SSE "event" field. This field is optional.

      +
      +
      Parameters:
      +
      name - event name.
      +
      Returns:
      +
      updated builder instance.
      +
      +
      +
      • +
    • +
      +

      reconnectDelay

      +
      OutboundSseEvent.Builder reconnectDelay(long milliseconds)
      +
      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. +

      + Will be send as a value of the SSE "retry" field. This field is optional. +

      + Absence of a value of this field in an OutboundSseEvent instance is indicated by + SseEvent.RECONNECT_NOT_SET value returned from SseEvent.getReconnectDelay().

      +
      +
      Parameters:
      +
      milliseconds - reconnection delay in milliseconds. Negative values un-set the reconnection delay.
      +
      Returns:
      +
      updated builder instance.
      +
      +
      +
      • +
    • +
      +

      mediaType

      +
      OutboundSseEvent.Builder mediaType(MediaType mediaType)
      +
      Set the media type of the event data. +

      + This information is mandatory. The default value is MediaType.TEXT_PLAIN.

      +
      +
      Parameters:
      +
      mediaType - MediaType of event data. Must not be null.
      +
      Returns:
      +
      updated builder instance.
      +
      Throws:
      +
      NullPointerException - in case the mediaType parameter is null.
      +
      +
      +
      • +
    • +
      +

      comment

      +
      OutboundSseEvent.Builder comment(String comment)
      +
      Set comment string associated with the event. +

      + The comment will be serialized with the event, before event data are serialized. If the event does not contain any + data, a separate "event" that contains only the comment will be sent. This information is optional, provided the + event data are set. +

      + Note that multiple invocations of this method result in a previous comment being replaced with a new one. To achieve + multi-line comments, a multi-line comment string has to be used.

      +
      +
      Parameters:
      +
      comment - comment string.
      +
      Returns:
      +
      updated builder instance.
      +
      +
      +
      • +
    • +
      +

      data

      +
      OutboundSseEvent.Builder data(Class type, + Object data)
      +
      Set event data and java type of event data. +

      + Type information will be used for MessageBodyWriter lookup. +

      + Note that multiple invocations of this method result in previous even data being replaced with new one.

      +
      +
      Parameters:
      +
      type - java type of supplied data. Must not be null.
      +
      data - event data. Must not be null.
      +
      Returns:
      +
      updated builder instance.
      +
      Throws:
      +
      NullPointerException - in case either type or data parameter is null.
      +
      +
      +
      • +
    • +
      +

      data

      +
      OutboundSseEvent.Builder data(GenericType type, + Object data)
      +
      Set event data and a generic java type of event data. +

      + Type information will be used for MessageBodyWriter lookup. +

      + Note that multiple invocations of this method result in previous even data being replaced with new one.

      +
      +
      Parameters:
      +
      type - generic type of supplied data. Must not be null.
      +
      data - event data. Must not be null.
      +
      Returns:
      +
      updated builder instance.
      +
      Throws:
      +
      NullPointerException - in case either type or data parameter is null.
      +
      +
      +
      • +
    • +
      +

      data

      +
      OutboundSseEvent.Builder data(Object data)
      +
      Set event data and java type of event data. +

      + This is a convenience method that derives the event data type information from the runtime type of the event data. + The supplied event data may be represented as GenericEntity. +

      + Note that multiple invocations of this method result in previous even data being replaced with new one.

      +
      +
      Parameters:
      +
      data - event data. Must not be null.
      +
      Returns:
      +
      updated builder instance.
      +
      Throws:
      +
      NullPointerException - in case the data parameter is null.
      +
      +
      +
      • +
    • +
      +

      build

      +
      OutboundSseEvent build()
      +
      Build OutboundSseEvent. +

      + There are two valid configurations: +

        +
      • if a comment is set, all other parameters are optional. If event + data and media type is set, event data will + be serialized after the comment.
        • +
      • if a comment is not set, at least the event data must be set. All other parameters are optional.
        • +
      +
      +
      Returns:
      +
      new OutboundSseEvent instance.
      +
      Throws:
      +
      IllegalStateException - when called with invalid configuration (neither a comment nor event data are set).
      +
      +
      +
      • +
    +
    +
    • +
+
+ +
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/sse/OutboundSseEvent.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/sse/OutboundSseEvent.html new file mode 100644 index 0000000000..338f3520e3 --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/sse/OutboundSseEvent.html @@ -0,0 +1,257 @@ + + + + +OutboundSseEvent (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Module jakarta.ws.rs
+
Package jakarta.ws.rs.sse
+

Interface OutboundSseEvent

+
+
+
+
All Superinterfaces:
+
SseEvent
+
+
+
public interface OutboundSseEvent +extends SseEvent
+
Representation of a single outbound Server-sent event. +

+ Used on the server side, when creating and sending an event to a client or when broadcasting.

+
+
Since:
+
2.1
+
Author:
+
Marek Potociar
+
+
+
+ +
+
+
    + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      getType

      +
      Class<?> getType()
      +
      Get data type. +

      + This information is used to select a proper MessageBodyWriter to be used for serializing the + event data.

      +
      +
      Returns:
      +
      data type. May return null, if the event does not contain any data.
      +
      +
      +
      • +
    • +
      +

      getGenericType

      +
      Type getGenericType()
      +
      Get generic data type. +

      + This information is used to select a proper MessageBodyWriter to be used for serializing the + event data.

      +
      +
      Returns:
      +
      generic data type. May return null, if the event does not contain any data.
      +
      +
      +
      • +
    • +
      +

      getMediaType

      +
      MediaType getMediaType()
      +
      Get media type of the event data. +

      + This information is used to a select proper MessageBodyWriter to be used for serializing the + event data.

      +
      +
      Returns:
      +
      data MediaType.
      +
      +
      +
      • +
    • +
      +

      getData

      +
      Object getData()
      +
      Get event data. +

      + The event data, if specified, are serialized and sent as one or more SSE event "data" fields (depending on + the line breaks in the actual serialized data content). The data are serialized using an available + MessageBodyWriter that is selected based on the event type, + getGenericType() generic type} and getMediaType() media type}.

      +
      +
      Returns:
      +
      event data. May return null, if the event does not contain any data.
      +
      +
      +
      • +
    +
    +
    • +
+
+ +
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/sse/Sse.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/sse/Sse.html new file mode 100644 index 0000000000..38e12235cb --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/sse/Sse.html @@ -0,0 +1,224 @@ + + + + +Sse (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Module jakarta.ws.rs
+
Package jakarta.ws.rs.sse
+

Interface Sse

+
+
+
+
public interface Sse
+
Server-side entry point for creating OutboundSseEvent and SseBroadcaster. +

+ Instance of this interface can be injected into a field or as a parameter of a method or a constructor. Also, the + instance is thread safe, meaning that it can be shared and its method invoked from different threads without causing + inconsistent internal state.

+
+
Since:
+
2.1
+
Author:
+
Marek Potociar (marek.potociar at oracle.com)
+
+
+
+ +
+
+
    + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      newEventBuilder

      +
      OutboundSseEvent.Builder newEventBuilder()
      +
      Get a new outbound event builder.
      +
      +
      Returns:
      +
      SSE outbound event builder.
      +
      +
      +
      • +
    • +
      +

      newEvent

      +
      default OutboundSseEvent newEvent(String data)
      +
      Create new OutboundSseEvent from provided data. +

      + The data can be string only and must not be null.

      +
      +
      Parameters:
      +
      data - event data.
      +
      Returns:
      +
      created OutboundSseEvent.
      +
      Throws:
      +
      IllegalArgumentException - when data is null.
      +
      +
      +
      • +
    • +
      +

      newEvent

      +
      default OutboundSseEvent newEvent(String name, + String data)
      +
      Create new OutboundSseEvent from provided data and name.
      +
      +
      Parameters:
      +
      name - event name. (see SseEvent.getName()).
      +
      data - event data.
      +
      Returns:
      +
      created OutboundSseEvent.
      +
      Throws:
      +
      IllegalArgumentException - when name or data is null.
      +
      +
      +
      • +
    • +
      +

      newBroadcaster

      +
      SseBroadcaster newBroadcaster()
      +
      Get a new Server-sent event broadcaster.
      +
      +
      Returns:
      +
      new Server-sent event broadcaster instance.
      +
      +
      +
      • +
    +
    +
    • +
+
+ +
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/sse/SseBroadcaster.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/sse/SseBroadcaster.html new file mode 100644 index 0000000000..b761e399e8 --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/sse/SseBroadcaster.html @@ -0,0 +1,276 @@ + + + + +SseBroadcaster (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Module jakarta.ws.rs
+
Package jakarta.ws.rs.sse
+

Interface SseBroadcaster

+
+
+
+
All Superinterfaces:
+
AutoCloseable
+
+
+
public interface SseBroadcaster +extends AutoCloseable
+
Server-Sent events broadcasting facility. +

+ Server broadcaster can be used to manage multiple server sinks. It enables sending events to all + registered event outputs and provides facility to effectively handle exceptions and closures of individual registered + event outputs. +

+ Instance of this interface is thread safe, meaning that it can be shared and its method invoked from different + threads without causing inconsistent internal state.

+
+
Since:
+
2.1
+
Author:
+
Marek Potociar
+
+
+
+ +
+
+
    + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      onError

      +
      void onError(BiConsumer<SseEventSink,Throwable> onError)
      +
      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. +

      + This operation is potentially slow, especially if large number of listeners get registered in the broadcaster. The + SseBroadcaster implementation is optimized to efficiently handle small amounts of concurrent listener + registrations and removals and large amounts of registered listener notifications.

      +
      +
      Parameters:
      +
      onError - bi-consumer, taking two parameters: SseEventSink, which is the source of the error and the + actual Throwable instance.
      +
      +
      +
      • +
    • +
      +

      onClose

      +
      void onClose(Consumer<SseEventSink> onClose)
      +
      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. +

      + This operation is potentially slow, especially if large number of listeners get registered in the broadcaster. The + SseBroadcaster implementation is optimized to efficiently handle small amounts of concurrent listener + registrations and removals and large amounts of registered listener notifications.

      +
      +
      Parameters:
      +
      onClose - consumer taking single parameter, a SseEventSink, which was closed.
      +
      +
      +
      • +
    • +
      +

      register

      +
      void register(SseEventSink sseEventSink)
      +
      Register provided SseEventSink instance to this SseBroadcaster.
      +
      +
      Parameters:
      +
      sseEventSink - to be registered.
      +
      +
      +
      • +
    • +
      +

      broadcast

      +
      CompletionStage<?> broadcast(OutboundSseEvent event)
      +
      Publish an SSE event to all registered SseEventSink instances.
      +
      +
      Parameters:
      +
      event - SSE event to be published.
      +
      Returns:
      +
      completion stage that completes when the event has been broadcast to all registered event sinks.
      +
      +
      +
      • +
    • +
      +

      close

      +
      void close()
      +
      Close the broadcaster and all registered SseEventSink instances. Any other resources associated with the + SseBroadcaster should be released. This method is equivalent to calling close(true). +

      + Subsequent calls have no effect and are ignored. Once the SseBroadcaster is closed, invoking any other method + on the broadcaster instance would result in an IllegalStateException being thrown.

      +
      +
      Specified by:
      +
      close in interface AutoCloseable
      +
      +
      +
      • +
    • +
      +

      close

      +
      void close(boolean cascading)
      +
      Close the broadcaster and release any resources associated with it. The closing of registered SseEventSink is + controlled by the cascading parameter. +

      + Subsequent calls have no effect and are ignored. Once the SseBroadcaster is closed, invoking any other method + on the broadcaster instance would result in an IllegalStateException being thrown.

      +
      +
      Parameters:
      +
      cascading - Boolean value that controls closing of registered SseEventSink instances.
      +
      +
      +
      • +
    +
    +
    • +
+
+ +
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/sse/SseEvent.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/sse/SseEvent.html new file mode 100644 index 0000000000..2bd028385b --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/sse/SseEvent.html @@ -0,0 +1,287 @@ + + + + +SseEvent (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Module jakarta.ws.rs
+
Package jakarta.ws.rs.sse
+

Interface SseEvent

+
+
+
+
All Known Subinterfaces:
+
InboundSseEvent, OutboundSseEvent
+
+
+
public interface SseEvent
+
Base Server Sent Event definition. +

+ This interface provides basic properties of the Server Sent Event, namely ID, Name, and Comment. It also provides + access to the Reconnect delay property. +

+ SseEvent is extended by another two interfaces, InboundSseEvent and OutboundSseEvent. The + main difference is in how are instances created and how the stored data can be accessed (or provided).

+
+
Since:
+
2.1
+
Author:
+
Marek Potociar
+
+
+
+
    + +
  • +
    +

    Field Summary

    +
    Fields
    +
    +
    Modifier and Type
    +
    Field
    +
    Description
    +
    static final long
    +
    RECONNECT_NOT_SET
    +
    +
    A "reconnection not set" value for the SSE reconnect delay set via SSE event retry field.
    +
    +
    +
    +
    • + +
  • +
    +

    Method Summary

    +
    +
    +
    +
    +
    Modifier and Type
    +
    Method
    +
    Description
    +
    String
    +
    getComment()
    +
    +
    Get a comment string that accompanies the event.
    +
    +
    String
    +
    getId()
    +
    +
    Get event identifier.
    +
    +
    String
    +
    getName()
    +
    +
    Get event name.
    +
    +
    long
    +
    getReconnectDelay()
    +
    +
    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.
    +
    +
    boolean
    +
    isReconnectDelaySet()
    +
    +
    Check if the connection retry time has been set in the event.
    +
    +
    +
    +
    +
    +
    • +
+
+
+
    + +
  • +
    +

    Field Details

    +
      +
    • +
      +

      RECONNECT_NOT_SET

      +
      static final long RECONNECT_NOT_SET
      +
      A "reconnection not set" value for the SSE reconnect delay set via SSE event retry field.
      +
      +
      See Also:
      +
      + +
      +
      +
      +
      • +
    +
    +
    • + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      getId

      +
      String getId()
      +
      Get event identifier. +

      + Contains value of SSE "id" field. This field is optional. Method may return null, if the event + identifier is not specified.

      +
      +
      Returns:
      +
      event id.
      +
      +
      +
      • +
    • +
      +

      getName

      +
      String getName()
      +
      Get event name. +

      + Contains value of SSE "event" field. This field is optional. Method may return null, if the event + name is not specified.

      +
      +
      Returns:
      +
      event name, or null if not set.
      +
      +
      +
      • +
    • +
      +

      getComment

      +
      String getComment()
      +
      Get a comment string that accompanies the event. +

      + Contains value of the comment associated with SSE event. This field is optional. Method may return null, if + the event comment is not specified.

      +
      +
      Returns:
      +
      comment associated with the event.
      +
      +
      +
      • +
    • +
      +

      getReconnectDelay

      +
      long getReconnectDelay()
      +
      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. +

      + Contains value of SSE "retry" field. This field is optional. Method returns RECONNECT_NOT_SET if no + value has been set.

      +
      +
      Returns:
      +
      reconnection delay in milliseconds or RECONNECT_NOT_SET if no value has been set.
      +
      +
      +
      • +
    • +
      +

      isReconnectDelaySet

      +
      boolean isReconnectDelaySet()
      +
      Check if the connection retry time has been set in the event.
      +
      +
      Returns:
      +
      true if new reconnection delay has been set in the event, false otherwise.
      +
      +
      +
      • +
    +
    +
    • +
+
+ +
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/sse/SseEventSink.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/sse/SseEventSink.html new file mode 100644 index 0000000000..3f00d5687a --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/sse/SseEventSink.html @@ -0,0 +1,229 @@ + + + + +SseEventSink (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Module jakarta.ws.rs
+
Package jakarta.ws.rs.sse
+

Interface SseEventSink

+
+
+
+
All Superinterfaces:
+
AutoCloseable
+
+
+
public interface SseEventSink +extends AutoCloseable
+
Outbound Server-Sent Events stream. +

+ The instance of SseEventSink can be only acquired by injection of a resource method parameter: + + 

+ @GET
+ @Path("eventStream")
+ @Produces(MediaType.SERVER_SENT_EVENTS)
+ public void eventStream(@Context SseEventSink eventSink) {
+     // ...
+ }
+
+ + The injected instance is then considered as a return type, so the resource method doesn't return anything, similarly + as in server-side async processing. +

+ The underlying client connection is kept open and the application code is able to send events. A server-side instance + implementing the interface corresponds exactly to a single client HTTP connection. +

+ The injected instance is thread safe.

+
+
Since:
+
2.1
+
Author:
+
Marek Potociar (marek.potociar at oracle.com)
+
+
+
+
    + +
  • +
    +

    Method Summary

    +
    +
    +
    +
    +
    Modifier and Type
    +
    Method
    +
    Description
    +
    void
    +
    close()
    +
    +
    Close the SseEventSink instance and release all associated resources.
    +
    +
    boolean
    +
    isClosed()
    +
    +
    Check if the stream has been closed already.
    +
    +
    CompletionStage<?>
    +
    send(OutboundSseEvent event)
    +
    +
    Send an outbound Server-sent event to this sink.
    +
    +
    +
    +
    +
    +
    • +
+
+
+
    + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      isClosed

      +
      boolean isClosed()
      +
      Check if the stream has been closed already. +

      + Please note that the client connection represented by this SseServerSink can be closed by the client side + when a client decides to close connection and disconnect from the server.

      +
      +
      Returns:
      +
      true when closed, false otherwise.
      +
      +
      +
      • +
    • +
      +

      send

      +
      CompletionStage<?> send(OutboundSseEvent event)
      +
      Send an outbound Server-sent event to this sink. +

      + Event will be serialized and sent to the client.

      +
      +
      Parameters:
      +
      event - event to be written.
      +
      Returns:
      +
      completion stage that completes when the event has been sent. If there is a problem during sending of an + event, completion stage will be completed exceptionally.
      +
      +
      +
      • +
    • +
      +

      close

      +
      void close() + throws IOException
      +
      Close the SseEventSink instance and release all associated resources. +

      + Subsequent calls have no effect and are ignored. Once the SseEventSink is closed, invoking any method other + than this one and isClosed() would result in an IllegalStateException being thrown.

      +
      +
      Specified by:
      +
      close in interface AutoCloseable
      +
      Throws:
      +
      IOException - if an I/O error occurs.
      +
      +
      +
      • +
    +
    +
    • +
+
+ +
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/sse/SseEventSource.Builder.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/sse/SseEventSource.Builder.html new file mode 100644 index 0000000000..fdb2436325 --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/sse/SseEventSource.Builder.html @@ -0,0 +1,311 @@ + + + + +SseEventSource.Builder (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Module jakarta.ws.rs
+
Package jakarta.ws.rs.sse
+

Class SseEventSource.Builder

+
+
java.lang.Object +
jakarta.ws.rs.sse.SseEventSource.Builder
+
+
+
+
Enclosing interface:
+
SseEventSource
+
+
+
public abstract static class SseEventSource.Builder +extends Object
+
JAX-RS SseEventSource builder class. +

+ Event source builder provides methods that let you conveniently configure and subsequently build a new + SseEventSource instance. You can obtain a new event source builder instance using a static + SseEventSource.target(endpoint) factory method. +

+ For example: + + 

+ SseEventSource es = SseEventSource.target(endpoint)
+         .reconnectingEvery(5, SECONDS)
+         .build();
+ es.register(System.out::println);
+ es.open();
+
+
+
+ +
+
+
    + +
  • +
    +

    Field Details

    +
      +
    • +
      +

      JAXRS_DEFAULT_SSE_BUILDER_PROPERTY

      +
      public static final String JAXRS_DEFAULT_SSE_BUILDER_PROPERTY
      +
      Name of the property identifying the SseEventSource.Builder implementation to be returned from + newBuilder().
      +
      +
      See Also:
      +
      + +
      +
      +
      +
      • +
    +
    +
    • + +
  • +
    +

    Constructor Details

    +
      +
    • +
      +

      Builder

      +
      protected Builder()
      +
      Allows custom implementations to extend the SSE event source builder class.
      +
      +
      • +
    +
    +
    • + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      target

      +
      protected abstract SseEventSource.Builder target(WebTarget endpoint)
      +
      Set the SSE streaming endpoint.
      +
      +
      Parameters:
      +
      endpoint - SSE streaming endpoint. Must not be null.
      +
      Returns:
      +
      updated event source builder instance.
      +
      Throws:
      +
      NullPointerException - in case the supplied web target is null.
      +
      +
      +
      • +
    • +
      +

      reconnectingEvery

      +
      public abstract SseEventSource.Builder reconnectingEvery(long delay, + TimeUnit unit)
      +
      Set the initial reconnect delay to be used by the event source. +

      + Note that this value may be later overridden by the SSE endpoint using either a retry SSE event field or + HTTP 503 + "Retry-After" mechanism as described in the + SseEventSource javadoc.

      +
      +
      Parameters:
      +
      delay - the default time to wait before attempting to recover from a connection loss.
      +
      unit - time unit of the reconnect delay parameter.
      +
      Returns:
      +
      updated event source builder instance.
      +
      +
      +
      • +
    • +
      +

      build

      +
      public abstract SseEventSource build()
      +
      Build new SSE event source pointing at a SSE streaming web target. +

      + The returned event source is ready, but not connected to the SSE endpoint. It is + expected that you will manually invoke its SseEventSource.open() method once you are ready to start receiving SSE events. + In case you want to build an event source instance that is already connected to the SSE endpoint, use the event + source builder SseEventSource.open() method instead. +

      + Once the event source is open, the incoming events are processed by the event source in an asynchronous task that + runs in an internal single-threaded scheduled executor service.

      +
      +
      Returns:
      +
      new event source instance, ready to be connected to the SSE endpoint.
      +
      See Also:
      +
      + +
      +
      +
      +
      • +
    +
    +
    • +
+
+ +
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/sse/SseEventSource.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/sse/SseEventSource.html new file mode 100644 index 0000000000..7476fd8ff9 --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/sse/SseEventSource.html @@ -0,0 +1,392 @@ + + + + +SseEventSource (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Module jakarta.ws.rs
+
Package jakarta.ws.rs.sse
+

Interface SseEventSource

+
+
+
+
All Superinterfaces:
+
AutoCloseable
+
+
+
public interface SseEventSource +extends AutoCloseable
+
Client for reading and processing incoming Server-Sent Events. +

+ SSE event source instances of this class are thread safe. To build a new instance, you can use the + SseEventSource.target(endpoint) factory method to get a new event + source builder that can be further customised and eventually used to create a new SSE event source. +

+ Once a SseEventSource is created, it can be used to open a connection to the associated + web target. After establishing the connection, the event source starts processing any incoming + inbound events. Whenever a new event is received, an Consumer<InboundSseEvent>#accept(InboundSseEvent) method is invoked on any registered event consumers. +

Reconnect support

+

+ The SseEventSource supports automated recuperation from a connection loss, including + negotiation of delivery of any missed events based on the last received SSE event id field value, provided + this field is set by the server and the negotiation facility is supported by the server. In case of a connection loss, + the last received SSE event id field value is sent in the + "Last-Event-ID" HTTP + request header as part of a new connection request sent to the SSE endpoint. Upon a receipt of such reconnect request, the SSE + endpoint that supports this negotiation facility is expected to replay all missed events. Note however, that this is a + best-effort mechanism which does not provide any guaranty that all events would be delivered without a loss. You should + therefore not rely on receiving every single event and design your client application code accordingly. +

+ By default, when a connection to the SSE endpoint is lost, the event source will wait 500 ms + before attempting to reconnect to the SSE endpoint. The SSE endpoint can however control the client-side retry delay + by including a special retry field value in any sent event. JAX-RS SseEventSource tracks any + received SSE event retry field values set by the endpoint and adjusts the reconnect delay accordingly, + using the last received retry field value as the reconnect delay. +

+ In addition to handling the standard connection loss failures, JAX-RS SseEventSource behaves differently to various + HTTP response status codes and headers: +

    +
  • 200 - with "Content-Type" header of "text/event-stream": This is normal + operation. onEvent is invoked for each event. onComplete is invoked when there are no more + events. onError is invoked only if an unrecoverable error occurs during processing.
    • +
  • 200 - with unsupported or missing "Content-Type" header: This is an + error condition. onError is invoked.
    • +
  • 204 - This indicates that server has no events to send. Only onComplete is invoked.
    • +
  • 503 - with "Retry-After" header set to a valid value: This indicates + that the server is unavailable, but that the client should reconnect later. No consumers are invoked unless the client + event source is closed, prior to reconnecting (resulting in onComplete invocation). After the specified + delay, the client should automatically attempt to reconnect which will result in a new response.
    • +
  • 503 - with invalid or missing "Retry-After" header: This is an error + condition. onError is invoked.
    • +
  • Any other status code: This is an error condition. onError is invoked.
    • +
+

+ In the case of an error condition response, the Throwable passed to the onError consumer + should be a WebApplicationException containing the invalid Response object. +

+ Note that if, for any of the registered event consumers, an invocation of Consumer<InboundSseEvent>#accept(InboundSseEvent) method throws an exception, this is not an error condition. + Thus onError is not invoked and event processing is not stopped. + Users are encouraged to handle exceptions on their own as part of the event processing logic.

+
+
Since:
+
2.1
+
Author:
+
Marek Potociar
+
+
+
+ +
+
+
    + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      register

      +
      void register(Consumer<InboundSseEvent> onEvent)
      +
      Register a InboundSseEvent consumer. +

      + Given consumer is invoked once per each received event.

      +
      +
      Parameters:
      +
      onEvent - event consumer.
      +
      Throws:
      +
      IllegalArgumentException - when the provided parameter is null.
      +
      +
      +
      • +
    • +
      +

      register

      +
      void register(Consumer<InboundSseEvent> onEvent, + Consumer<Throwable> onError)
      +
      Register InboundSseEvent and Throwable consumers. +

      + Event consumer is invoked once per each received event, Throwable consumer is invoked invoked upon a + unrecoverable error encountered by a SseEventSource.

      +
      +
      Parameters:
      +
      onEvent - event consumer.
      +
      onError - error consumer.
      +
      Throws:
      +
      IllegalArgumentException - when the any of the provided parameters is null.
      +
      +
      +
      • +
    • +
      +

      register

      +
      void register(Consumer<InboundSseEvent> onEvent, + Consumer<Throwable> onError, + Runnable onComplete)
      +
      Register InboundSseEvent and Throwable consumers and onComplete callback. +

      + Event consumer is invoked once per each received event, Throwable consumer is invoked invoked upon a + unrecoverable error encountered by a SseEventSource, onComplete callback is invoked after a successful + connection and when there are no further events to be received. Note that the onComplete callback will not be + invoked if the onError callback has been invoked.

      +
      +
      Parameters:
      +
      onEvent - event consumer.
      +
      onError - error consumer.
      +
      onComplete - onComplete handler.
      +
      Throws:
      +
      IllegalArgumentException - when the any of the provided parameters is null.
      +
      +
      +
      • +
    • +
      +

      target

      +
      static SseEventSource.Builder target(WebTarget endpoint)
      +
      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.
      +
      +
      Parameters:
      +
      endpoint - SSE streaming endpoint. Must not be null.
      +
      Returns:
      +
      a builder of a new event source instance pointing at the specified SSE streaming endpoint.
      +
      Throws:
      +
      NullPointerException - in case the supplied web target is null.
      +
      +
      +
      • +
    • +
      +

      open

      +
      void open()
      +
      Open the connection to the supplied SSE underlying web target and start processing incoming + events.
      +
      +
      Throws:
      +
      IllegalStateException - in case the event source has already been opened earlier.
      +
      +
      +
      • +
    • +
      +

      isOpen

      +
      boolean isOpen()
      +
      Check if this event source instance has already been opened.
      +
      +
      Returns:
      +
      true if this event source is open, false otherwise.
      +
      +
      +
      • +
    • +
      +

      close

      +
      default void close()
      +
      Close this event source. +

      + The method will wait up to 5 seconds for the internal event processing tasks to complete.

      +
      +
      Specified by:
      +
      close in interface AutoCloseable
      +
      +
      +
      • +
    • +
      +

      close

      +
      boolean close(long timeout, + TimeUnit unit)
      +
      Close this event source and wait for the internal event processing task to complete for up to the specified amount of + wait time. +

      + The method blocks until the event processing task has completed execution after a shutdown request, or until the + timeout occurs, or the current thread is interrupted, whichever happens first. +

      + In case the waiting for the event processing task has been interrupted, this method restores the + interrupt flag on the thread before returning false.

      +
      +
      Parameters:
      +
      timeout - the maximum time to wait.
      +
      unit - the time unit of the timeout argument.
      +
      Returns:
      +
      true if this executor terminated and false if the timeout elapsed before termination or the + termination was interrupted.
      +
      +
      +
      • +
    +
    +
    • +
+
+ +
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/sse/class-use/InboundSseEvent.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/sse/class-use/InboundSseEvent.html new file mode 100644 index 0000000000..67febf94bd --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/sse/class-use/InboundSseEvent.html @@ -0,0 +1,105 @@ + + + + +Uses of Interface jakarta.ws.rs.sse.InboundSseEvent (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
jakarta.ws.rs.sse.InboundSseEvent

+
+
Packages that use InboundSseEvent
+
+
Package
+
Description
+
jakarta.ws.rs.sse
+
+
Server-Sent Events related API.
+
+
+
+ +
+
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/sse/class-use/OutboundSseEvent.Builder.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/sse/class-use/OutboundSseEvent.Builder.html new file mode 100644 index 0000000000..f9f12dea1e --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/sse/class-use/OutboundSseEvent.Builder.html @@ -0,0 +1,135 @@ + + + + +Uses of Interface jakarta.ws.rs.sse.OutboundSseEvent.Builder (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
jakarta.ws.rs.sse.OutboundSseEvent.Builder

+
+
Packages that use OutboundSseEvent.Builder
+
+
Package
+
Description
+
jakarta.ws.rs.sse
+
+
Server-Sent Events related API.
+
+
+
+ +
+
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/sse/class-use/OutboundSseEvent.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/sse/class-use/OutboundSseEvent.html new file mode 100644 index 0000000000..df7d1df682 --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/sse/class-use/OutboundSseEvent.html @@ -0,0 +1,119 @@ + + + + +Uses of Interface jakarta.ws.rs.sse.OutboundSseEvent (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
jakarta.ws.rs.sse.OutboundSseEvent

+
+
Packages that use OutboundSseEvent
+
+
Package
+
Description
+
jakarta.ws.rs.sse
+
+
Server-Sent Events related API.
+
+
+
+ +
+
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/sse/class-use/Sse.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/sse/class-use/Sse.html new file mode 100644 index 0000000000..9742cb429e --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/sse/class-use/Sse.html @@ -0,0 +1,63 @@ + + + + +Uses of Interface jakarta.ws.rs.sse.Sse (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
jakarta.ws.rs.sse.Sse

+
+No usage of jakarta.ws.rs.sse.Sse
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/sse/class-use/SseBroadcaster.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/sse/class-use/SseBroadcaster.html new file mode 100644 index 0000000000..f47cbbb3fc --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/sse/class-use/SseBroadcaster.html @@ -0,0 +1,92 @@ + + + + +Uses of Interface jakarta.ws.rs.sse.SseBroadcaster (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
jakarta.ws.rs.sse.SseBroadcaster

+
+
Packages that use SseBroadcaster
+
+
Package
+
Description
+
jakarta.ws.rs.sse
+
+
Server-Sent Events related API.
+
+
+
+ +
+
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/sse/class-use/SseEvent.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/sse/class-use/SseEvent.html new file mode 100644 index 0000000000..81e19c2b8d --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/sse/class-use/SseEvent.html @@ -0,0 +1,97 @@ + + + + +Uses of Interface jakarta.ws.rs.sse.SseEvent (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
jakarta.ws.rs.sse.SseEvent

+
+
Packages that use SseEvent
+
+
Package
+
Description
+
jakarta.ws.rs.sse
+
+
Server-Sent Events related API.
+
+
+
+ +
+
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/sse/class-use/SseEventSink.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/sse/class-use/SseEventSink.html new file mode 100644 index 0000000000..272b7e6405 --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/sse/class-use/SseEventSink.html @@ -0,0 +1,111 @@ + + + + +Uses of Interface jakarta.ws.rs.sse.SseEventSink (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
jakarta.ws.rs.sse.SseEventSink

+
+
Packages that use SseEventSink
+
+
Package
+
Description
+
jakarta.ws.rs.sse
+
+
Server-Sent Events related API.
+
+
+
+ +
+
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/sse/class-use/SseEventSource.Builder.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/sse/class-use/SseEventSource.Builder.html new file mode 100644 index 0000000000..b2c0f9451e --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/sse/class-use/SseEventSource.Builder.html @@ -0,0 +1,104 @@ + + + + +Uses of Class jakarta.ws.rs.sse.SseEventSource.Builder (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
jakarta.ws.rs.sse.SseEventSource.Builder

+
+
Packages that use SseEventSource.Builder
+
+
Package
+
Description
+
jakarta.ws.rs.sse
+
+
Server-Sent Events related API.
+
+
+
+ +
+
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/sse/class-use/SseEventSource.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/sse/class-use/SseEventSource.html new file mode 100644 index 0000000000..f59c082e9b --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/sse/class-use/SseEventSource.html @@ -0,0 +1,92 @@ + + + + +Uses of Interface jakarta.ws.rs.sse.SseEventSource (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
jakarta.ws.rs.sse.SseEventSource

+
+
Packages that use SseEventSource
+
+
Package
+
Description
+
jakarta.ws.rs.sse
+
+
Server-Sent Events related API.
+
+
+
+ +
+
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/sse/package-summary.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/sse/package-summary.html new file mode 100644 index 0000000000..babacd401a --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/sse/package-summary.html @@ -0,0 +1,169 @@ + + + + +jakarta.ws.rs.sse (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+
Module jakarta.ws.rs
+

Package jakarta.ws.rs.sse

+
+
+
package jakarta.ws.rs.sse
+
+
Server-Sent Events related API. + + This package provides support for providing event streams from the server and also for processing then on the client + side.
+
+
+ +
+
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/sse/package-tree.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/sse/package-tree.html new file mode 100644 index 0000000000..12f1d3f934 --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/sse/package-tree.html @@ -0,0 +1,97 @@ + + + + +jakarta.ws.rs.sse Class Hierarchy (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Hierarchy For Package jakarta.ws.rs.sse

+
+Package Hierarchies: + +
+

Class Hierarchy

+ +
+
+

Interface Hierarchy

+ +
+
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/sse/package-use.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/sse/package-use.html new file mode 100644 index 0000000000..bd6702c205 --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/jakarta/ws/rs/sse/package-use.html @@ -0,0 +1,117 @@ + + + + +Uses of Package jakarta.ws.rs.sse (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Package
jakarta.ws.rs.sse

+
+
Packages that use jakarta.ws.rs.sse
+
+
Package
+
Description
+
jakarta.ws.rs.sse
+
+
Server-Sent Events related API.
+
+
+
+ +
+
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/jakarta.ws.rs/module-summary.html b/restful-ws/4.0/apidocs/jakarta.ws.rs/module-summary.html new file mode 100644 index 0000000000..b3462be0ec --- /dev/null +++ b/restful-ws/4.0/apidocs/jakarta.ws.rs/module-summary.html @@ -0,0 +1,129 @@ + + + + +jakarta.ws.rs (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Module jakarta.ws.rs

+
+
+
module jakarta.ws.rs
+
+ +
Defines the Jakarta RESTful Web Services API
+
+
+ +
+
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/legal/ADDITIONAL_LICENSE_INFO b/restful-ws/4.0/apidocs/legal/ADDITIONAL_LICENSE_INFO new file mode 100644 index 0000000000..ff700cd09f --- /dev/null +++ b/restful-ws/4.0/apidocs/legal/ADDITIONAL_LICENSE_INFO @@ -0,0 +1,37 @@ + ADDITIONAL INFORMATION ABOUT LICENSING + +Certain files distributed by Oracle America, Inc. and/or its affiliates are +subject to the following clarification and special exception to the GPLv2, +based on the GNU Project exception for its Classpath libraries, known as the +GNU Classpath Exception. + +Note that Oracle includes multiple, independent programs in this software +package. Some of those programs are provided under licenses deemed +incompatible with the GPLv2 by the Free Software Foundation and others. +For example, the package includes programs licensed under the Apache +License, Version 2.0 and may include FreeType. Such programs are licensed +to you under their original licenses. + +Oracle facilitates your further distribution of this package by adding the +Classpath Exception to the necessary parts of its GPLv2 code, which permits +you to use that code in combination with other independent modules not +licensed under the GPLv2. However, note that this would not permit you to +commingle code under an incompatible license with Oracle's GPLv2 licensed +code by, for example, cutting and pasting such code into a file also +containing Oracle's GPLv2 licensed code and then distributing the result. + +Additionally, if you were to remove the Classpath Exception from any of the +files to which it applies and distribute the result, you would likely be +required to license some or all of the other code in that distribution under +the GPLv2 as well, and since the GPLv2 is incompatible with the license terms +of some items included in the distribution by Oracle, removing the Classpath +Exception could therefore effectively compromise your ability to further +distribute the package. + +Failing to distribute notices associated with some files may also create +unexpected legal consequences. + +Proceed with caution and we recommend that you obtain the advice of a lawyer +skilled in open source matters before removing the Classpath Exception or +making modifications to this package which may subsequently be redistributed +and/or involve the use of third party software. diff --git a/restful-ws/4.0/apidocs/legal/ASSEMBLY_EXCEPTION b/restful-ws/4.0/apidocs/legal/ASSEMBLY_EXCEPTION new file mode 100644 index 0000000000..429666664e --- /dev/null +++ b/restful-ws/4.0/apidocs/legal/ASSEMBLY_EXCEPTION @@ -0,0 +1,27 @@ + +OPENJDK ASSEMBLY EXCEPTION + +The OpenJDK source code made available by Oracle America, Inc. (Oracle) at +openjdk.org ("OpenJDK Code") is distributed under the terms of the GNU +General Public License version 2 +only ("GPL2"), with the following clarification and special exception. + + Linking this OpenJDK Code statically or dynamically with other code + is making a combined work based on this library. Thus, the terms + and conditions of GPL2 cover the whole combination. + + As a special exception, Oracle gives you permission to link this + OpenJDK Code with certain code licensed by Oracle as indicated at + https://openjdk.org/legal/exception-modules-2007-05-08.html + ("Designated Exception Modules") to produce an executable, + regardless of the license terms of the Designated Exception Modules, + and to copy and distribute the resulting executable under GPL2, + provided that the Designated Exception Modules continue to be + governed by the licenses under which they were offered by Oracle. + +As such, it allows licensees and sublicensees of Oracle's GPL2 OpenJDK Code +to build an executable that includes those portions of necessary code that +Oracle could not provide under GPL2 (or that Oracle has provided under GPL2 +with the Classpath exception). If you modify or add to the OpenJDK code, +that new GPL2 code may still be combined with Designated Exception Modules +if the new code is made subject to this exception by its copyright holder. diff --git a/restful-ws/4.0/apidocs/legal/LICENSE b/restful-ws/4.0/apidocs/legal/LICENSE new file mode 100644 index 0000000000..8b400c7ab8 --- /dev/null +++ b/restful-ws/4.0/apidocs/legal/LICENSE @@ -0,0 +1,347 @@ +The GNU General Public License (GPL) + +Version 2, June 1991 + +Copyright (C) 1989, 1991 Free Software Foundation, Inc. +51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + +Everyone is permitted to copy and distribute verbatim copies of this license +document, but changing it is not allowed. + +Preamble + +The licenses for most software are designed to take away your freedom to share +and change it. By contrast, the GNU General Public License is intended to +guarantee your freedom to share and change free software--to make sure the +software is free for all its users. This General Public License applies to +most of the Free Software Foundation's software and to any other program whose +authors commit to using it. (Some other Free Software Foundation software is +covered by the GNU Library General Public License instead.) You can apply it to +your programs, too. + +When we speak of free software, we are referring to freedom, not price. Our +General Public Licenses are designed to make sure that you have the freedom to +distribute copies of free software (and charge for this service if you wish), +that you receive source code or can get it if you want it, that you can change +the software or use pieces of it in new free programs; and that you know you +can do these things. + +To protect your rights, we need to make restrictions that forbid anyone to deny +you these rights or to ask you to surrender the rights. These restrictions +translate to certain responsibilities for you if you distribute copies of the +software, or if you modify it. + +For example, if you distribute copies of such a program, whether gratis or for +a fee, you must give the recipients all the rights that you have. You must +make sure that they, too, receive or can get the source code. And you must +show them these terms so they know their rights. + +We protect your rights with two steps: (1) copyright the software, and (2) +offer you this license which gives you legal permission to copy, distribute +and/or modify the software. + +Also, for each author's protection and ours, we want to make certain that +everyone understands that there is no warranty for this free software. If the +software is modified by someone else and passed on, we want its recipients to +know that what they have is not the original, so that any problems introduced +by others will not reflect on the original authors' reputations. + +Finally, any free program is threatened constantly by software patents. We +wish to avoid the danger that redistributors of a free program will +individually obtain patent licenses, in effect making the program proprietary. +To prevent this, we have made it clear that any patent must be licensed for +everyone's free use or not licensed at all. + +The precise terms and conditions for copying, distribution and modification +follow. + +TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION + +0. This License applies to any program or other work which contains a notice +placed by the copyright holder saying it may be distributed under the terms of +this General Public License. The "Program", below, refers to any such program +or work, and a "work based on the Program" means either the Program or any +derivative work under copyright law: that is to say, a work containing the +Program or a portion of it, either verbatim or with modifications and/or +translated into another language. (Hereinafter, translation is included +without limitation in the term "modification".) Each licensee is addressed as +"you". + +Activities other than copying, distribution and modification are not covered by +this License; they are outside its scope. The act of running the Program is +not restricted, and the output from the Program is covered only if its contents +constitute a work based on the Program (independent of having been made by +running the Program). Whether that is true depends on what the Program does. + +1. You may copy and distribute verbatim copies of the Program's source code as +you receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice and +disclaimer of warranty; keep intact all the notices that refer to this License +and to the absence of any warranty; and give any other recipients of the +Program a copy of this License along with the Program. + +You may charge a fee for the physical act of transferring a copy, and you may +at your option offer warranty protection in exchange for a fee. + +2. You may modify your copy or copies of the Program or any portion of it, thus +forming a work based on the Program, and copy and distribute such modifications +or work under the terms of Section 1 above, provided that you also meet all of +these conditions: + + a) You must cause the modified files to carry prominent notices stating + that you changed the files and the date of any change. + + b) You must cause any work that you distribute or publish, that in whole or + in part contains or is derived from the Program or any part thereof, to be + licensed as a whole at no charge to all third parties under the terms of + this License. + + c) If the modified program normally reads commands interactively when run, + you must cause it, when started running for such interactive use in the + most ordinary way, to print or display an announcement including an + appropriate copyright notice and a notice that there is no warranty (or + else, saying that you provide a warranty) and that users may redistribute + the program under these conditions, and telling the user how to view a copy + of this License. (Exception: if the Program itself is interactive but does + not normally print such an announcement, your work based on the Program is + not required to print an announcement.) + +These requirements apply to the modified work as a whole. If identifiable +sections of that work are not derived from the Program, and can be reasonably +considered independent and separate works in themselves, then this License, and +its terms, do not apply to those sections when you distribute them as separate +works. But when you distribute the same sections as part of a whole which is a +work based on the Program, the distribution of the whole must be on the terms +of this License, whose permissions for other licensees extend to the entire +whole, and thus to each and every part regardless of who wrote it. + +Thus, it is not the intent of this section to claim rights or contest your +rights to work written entirely by you; rather, the intent is to exercise the +right to control the distribution of derivative or collective works based on +the Program. + +In addition, mere aggregation of another work not based on the Program with the +Program (or with a work based on the Program) on a volume of a storage or +distribution medium does not bring the other work under the scope of this +License. + +3. You may copy and distribute the Program (or a work based on it, under +Section 2) in object code or executable form under the terms of Sections 1 and +2 above provided that you also do one of the following: + + a) Accompany it with the complete corresponding machine-readable source + code, which must be distributed under the terms of Sections 1 and 2 above + on a medium customarily used for software interchange; or, + + b) Accompany it with a written offer, valid for at least three years, to + give any third party, for a charge no more than your cost of physically + performing source distribution, a complete machine-readable copy of the + corresponding source code, to be distributed under the terms of Sections 1 + and 2 above on a medium customarily used for software interchange; or, + + c) Accompany it with the information you received as to the offer to + distribute corresponding source code. (This alternative is allowed only + for noncommercial distribution and only if you received the program in + object code or executable form with such an offer, in accord with + Subsection b above.) + +The source code for a work means the preferred form of the work for making +modifications to it. For an executable work, complete source code means all +the source code for all modules it contains, plus any associated interface +definition files, plus the scripts used to control compilation and installation +of the executable. However, as a special exception, the source code +distributed need not include anything that is normally distributed (in either +source or binary form) with the major components (compiler, kernel, and so on) +of the operating system on which the executable runs, unless that component +itself accompanies the executable. + +If distribution of executable or object code is made by offering access to copy +from a designated place, then offering equivalent access to copy the source +code from the same place counts as distribution of the source code, even though +third parties are not compelled to copy the source along with the object code. + +4. You may not copy, modify, sublicense, or distribute the Program except as +expressly provided under this License. Any attempt otherwise to copy, modify, +sublicense or distribute the Program is void, and will automatically terminate +your rights under this License. However, parties who have received copies, or +rights, from you under this License will not have their licenses terminated so +long as such parties remain in full compliance. + +5. You are not required to accept this License, since you have not signed it. +However, nothing else grants you permission to modify or distribute the Program +or its derivative works. These actions are prohibited by law if you do not +accept this License. Therefore, by modifying or distributing the Program (or +any work based on the Program), you indicate your acceptance of this License to +do so, and all its terms and conditions for copying, distributing or modifying +the Program or works based on it. + +6. Each time you redistribute the Program (or any work based on the Program), +the recipient automatically receives a license from the original licensor to +copy, distribute or modify the Program subject to these terms and conditions. +You may not impose any further restrictions on the recipients' exercise of the +rights granted herein. You are not responsible for enforcing compliance by +third parties to this License. + +7. If, as a consequence of a court judgment or allegation of patent +infringement or for any other reason (not limited to patent issues), conditions +are imposed on you (whether by court order, agreement or otherwise) that +contradict the conditions of this License, they do not excuse you from the +conditions of this License. If you cannot distribute so as to satisfy +simultaneously your obligations under this License and any other pertinent +obligations, then as a consequence you may not distribute the Program at all. +For example, if a patent license would not permit royalty-free redistribution +of the Program by all those who receive copies directly or indirectly through +you, then the only way you could satisfy both it and this License would be to +refrain entirely from distribution of the Program. + +If any portion of this section is held invalid or unenforceable under any +particular circumstance, the balance of the section is intended to apply and +the section as a whole is intended to apply in other circumstances. + +It is not the purpose of this section to induce you to infringe any patents or +other property right claims or to contest validity of any such claims; this +section has the sole purpose of protecting the integrity of the free software +distribution system, which is implemented by public license practices. Many +people have made generous contributions to the wide range of software +distributed through that system in reliance on consistent application of that +system; it is up to the author/donor to decide if he or she is willing to +distribute software through any other system and a licensee cannot impose that +choice. + +This section is intended to make thoroughly clear what is believed to be a +consequence of the rest of this License. + +8. If the distribution and/or use of the Program is restricted in certain +countries either by patents or by copyrighted interfaces, the original +copyright holder who places the Program under this License may add an explicit +geographical distribution limitation excluding those countries, so that +distribution is permitted only in or among countries not thus excluded. In +such case, this License incorporates the limitation as if written in the body +of this License. + +9. The Free Software Foundation may publish revised and/or new versions of the +General Public License from time to time. Such new versions will be similar in +spirit to the present version, but may differ in detail to address new problems +or concerns. + +Each version is given a distinguishing version number. If the Program +specifies a version number of this License which applies to it and "any later +version", you have the option of following the terms and conditions either of +that version or of any later version published by the Free Software Foundation. +If the Program does not specify a version number of this License, you may +choose any version ever published by the Free Software Foundation. + +10. If you wish to incorporate parts of the Program into other free programs +whose distribution conditions are different, write to the author to ask for +permission. For software which is copyrighted by the Free Software Foundation, +write to the Free Software Foundation; we sometimes make exceptions for this. +Our decision will be guided by the two goals of preserving the free status of +all derivatives of our free software and of promoting the sharing and reuse of +software generally. + +NO WARRANTY + +11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR +THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE +STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE +PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, +INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND +FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND +PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, +YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + +12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL +ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE +PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR +INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA +BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A +FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER +OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. + +END OF TERMS AND CONDITIONS + +How to Apply These Terms to Your New Programs + +If you develop a new program, and you want it to be of the greatest possible +use to the public, the best way to achieve this is to make it free software +which everyone can redistribute and change under these terms. + +To do so, attach the following notices to the program. It is safest to attach +them to the start of each source file to most effectively convey the exclusion +of warranty; and each file should have at least the "copyright" line and a +pointer to where the full notice is found. + + One line to give the program's name and a brief idea of what it does. + + Copyright (C) + + This program is free software; you can redistribute it and/or modify it + under the terms of the GNU General Public License as published by the Free + Software Foundation; either version 2 of the License, or (at your option) + any later version. + + This program is distributed in the hope that it will be useful, but WITHOUT + ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or + FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for + more details. + + You should have received a copy of the GNU General Public License along + with this program; if not, write to the Free Software Foundation, Inc., + 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. + +Also add information on how to contact you by electronic and paper mail. + +If the program is interactive, make it output a short notice like this when it +starts in an interactive mode: + + Gnomovision version 69, Copyright (C) year name of author Gnomovision comes + with ABSOLUTELY NO WARRANTY; for details type 'show w'. This is free + software, and you are welcome to redistribute it under certain conditions; + type 'show c' for details. + +The hypothetical commands 'show w' and 'show c' should show the appropriate +parts of the General Public License. Of course, the commands you use may be +called something other than 'show w' and 'show c'; they could even be +mouse-clicks or menu items--whatever suits your program. + +You should also get your employer (if you work as a programmer) or your school, +if any, to sign a "copyright disclaimer" for the program, if necessary. Here +is a sample; alter the names: + + Yoyodyne, Inc., hereby disclaims all copyright interest in the program + 'Gnomovision' (which makes passes at compilers) written by James Hacker. + + signature of Ty Coon, 1 April 1989 + + Ty Coon, President of Vice + +This General Public License does not permit incorporating your program into +proprietary programs. If your program is a subroutine library, you may +consider it more useful to permit linking proprietary applications with the +library. If this is what you want to do, use the GNU Library General Public +License instead of this License. + + +"CLASSPATH" EXCEPTION TO THE GPL + +Certain source files distributed by Oracle America and/or its affiliates are +subject to the following clarification and special exception to the GPL, but +only where Oracle has expressly included in the particular source file's header +the words "Oracle designates this particular file as subject to the "Classpath" +exception as provided by Oracle in the LICENSE file that accompanied this code." + + Linking this library statically or dynamically with other modules is making + a combined work based on this library. Thus, the terms and conditions of + the GNU General Public License cover the whole combination. + + As a special exception, the copyright holders of this library give you + permission to link this library with independent modules to produce an + executable, regardless of the license terms of these independent modules, + and to copy and distribute the resulting executable under terms of your + choice, provided that you also meet, for each linked independent module, + the terms and conditions of the license of that module. An independent + module is a module which is not derived from or based on this library. If + you modify this library, you may extend this exception to your version of + the library, but you are not obligated to do so. If you do not wish to do + so, delete this exception statement from your version. diff --git a/restful-ws/4.0/apidocs/legal/jquery.md b/restful-ws/4.0/apidocs/legal/jquery.md new file mode 100644 index 0000000000..d468b3183a --- /dev/null +++ b/restful-ws/4.0/apidocs/legal/jquery.md @@ -0,0 +1,72 @@ +## jQuery v3.6.1 + +### jQuery License +``` +jQuery v 3.6.1 +Copyright OpenJS Foundation and other contributors, https://openjsf.org/ + +Permission is hereby granted, free of charge, to any person obtaining +a copy of this software and associated documentation files (the +"Software"), to deal in the Software without restriction, including +without limitation the rights to use, copy, modify, merge, publish, +distribute, sublicense, and/or sell copies of the Software, and to +permit persons to whom the Software is furnished to do so, subject to +the following conditions: + +The above copyright notice and this permission notice shall be +included in all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, +EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF +MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND +NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE +LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION +OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION +WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. + +****************************************** + +The jQuery JavaScript Library v3.6.1 also includes Sizzle.js + +Sizzle.js includes the following license: + +Copyright JS Foundation and other contributors, https://js.foundation/ + +This software consists of voluntary contributions made by many +individuals. For exact contribution history, see the revision history +available at https://github.com/jquery/sizzle + +The following license applies to all parts of this software except as +documented below: + +==== + +Permission is hereby granted, free of charge, to any person obtaining +a copy of this software and associated documentation files (the +"Software"), to deal in the Software without restriction, including +without limitation the rights to use, copy, modify, merge, publish, +distribute, sublicense, and/or sell copies of the Software, and to +permit persons to whom the Software is furnished to do so, subject to +the following conditions: + +The above copyright notice and this permission notice shall be +included in all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, +EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF +MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND +NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE +LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION +OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION +WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. + +==== + +All files located in the node_modules and external directories are +externally maintained libraries used by this software which have their +own licenses; we recommend you read them, as their terms may differ from +the terms above. + +********************* + +``` diff --git a/restful-ws/4.0/apidocs/legal/jqueryUI.md b/restful-ws/4.0/apidocs/legal/jqueryUI.md new file mode 100644 index 0000000000..8bda9d7a85 --- /dev/null +++ b/restful-ws/4.0/apidocs/legal/jqueryUI.md @@ -0,0 +1,49 @@ +## jQuery UI v1.13.2 + +### jQuery UI License +``` +Copyright jQuery Foundation and other contributors, https://jquery.org/ + +This software consists of voluntary contributions made by many +individuals. For exact contribution history, see the revision history +available at https://github.com/jquery/jquery-ui + +The following license applies to all parts of this software except as +documented below: + +==== + +Permission is hereby granted, free of charge, to any person obtaining +a copy of this software and associated documentation files (the +"Software"), to deal in the Software without restriction, including +without limitation the rights to use, copy, modify, merge, publish, +distribute, sublicense, and/or sell copies of the Software, and to +permit persons to whom the Software is furnished to do so, subject to +the following conditions: + +The above copyright notice and this permission notice shall be +included in all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, +EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF +MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND +NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE +LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION +OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION +WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. + +==== + +Copyright and related rights for sample code are waived via CC0. Sample +code is defined as all source code contained within the demos directory. + +CC0: http://creativecommons.org/publicdomain/zero/1.0/ + +==== + +All files located in the node_modules and external directories are +externally maintained libraries used by this software which have their +own licenses; we recommend you read them, as their terms may differ from +the terms above. + +``` diff --git a/restful-ws/4.0/apidocs/link.svg b/restful-ws/4.0/apidocs/link.svg new file mode 100644 index 0000000000..7ccc5ed08c --- /dev/null +++ b/restful-ws/4.0/apidocs/link.svg @@ -0,0 +1,31 @@ + + + + + + + + diff --git a/restful-ws/4.0/apidocs/member-search-index.js b/restful-ws/4.0/apidocs/member-search-index.js new file mode 100644 index 0000000000..d6d036950e --- /dev/null +++ b/restful-ws/4.0/apidocs/member-search-index.js @@ -0,0 +1 @@ +memberSearchIndex = [{"p":"jakarta.ws.rs.client","c":"ClientRequestContext","l":"abortWith(Response)","u":"abortWith(jakarta.ws.rs.core.Response)"},{"p":"jakarta.ws.rs.container","c":"ContainerRequestContext","l":"abortWith(Response)","u":"abortWith(jakarta.ws.rs.core.Response)"},{"p":"jakarta.ws.rs.core","c":"Cookie.AbstractCookieBuilder","l":"AbstractCookieBuilder(String)","u":"%3Cinit%3E(java.lang.String)"},{"p":"jakarta.ws.rs.core","c":"AbstractMultivaluedMap","l":"AbstractMultivaluedMap(Map>)","u":"%3Cinit%3E(java.util.Map)"},{"p":"jakarta.ws.rs.core","c":"NewCookie.AbstractNewCookieBuilder","l":"AbstractNewCookieBuilder(Cookie)","u":"%3Cinit%3E(jakarta.ws.rs.core.Cookie)"},{"p":"jakarta.ws.rs.core","c":"NewCookie.AbstractNewCookieBuilder","l":"AbstractNewCookieBuilder(String)","u":"%3Cinit%3E(java.lang.String)"},{"p":"jakarta.ws.rs.core","c":"HttpHeaders","l":"ACCEPT"},{"p":"jakarta.ws.rs.core","c":"HttpHeaders","l":"ACCEPT_CHARSET"},{"p":"jakarta.ws.rs.core","c":"HttpHeaders","l":"ACCEPT_ENCODING"},{"p":"jakarta.ws.rs.core","c":"HttpHeaders","l":"ACCEPT_LANGUAGE"},{"p":"jakarta.ws.rs.client","c":"Invocation.Builder","l":"accept(MediaType...)","u":"accept(jakarta.ws.rs.core.MediaType...)"},{"p":"jakarta.ws.rs.client","c":"Invocation.Builder","l":"accept(String...)","u":"accept(java.lang.String...)"},{"p":"jakarta.ws.rs.core","c":"Response.Status","l":"ACCEPTED"},{"p":"jakarta.ws.rs.core","c":"Response","l":"accepted()"},{"p":"jakarta.ws.rs.core","c":"Response","l":"accepted(Object)","u":"accepted(java.lang.Object)"},{"p":"jakarta.ws.rs.client","c":"Invocation.Builder","l":"acceptEncoding(String...)","u":"acceptEncoding(java.lang.String...)"},{"p":"jakarta.ws.rs.client","c":"Invocation.Builder","l":"acceptLanguage(Locale...)","u":"acceptLanguage(java.util.Locale...)"},{"p":"jakarta.ws.rs.client","c":"Invocation.Builder","l":"acceptLanguage(String...)","u":"acceptLanguage(java.lang.String...)"},{"p":"jakarta.ws.rs.core","c":"Variant.VariantListBuilder","l":"add()"},{"p":"jakarta.ws.rs.core","c":"AbstractMultivaluedMap","l":"add(K, V)","u":"add(K,V)"},{"p":"jakarta.ws.rs.core","c":"MultivaluedMap","l":"add(K, V)","u":"add(K,V)"},{"p":"jakarta.ws.rs.core","c":"AbstractMultivaluedMap","l":"addAll(K, List)","u":"addAll(K,java.util.List)"},{"p":"jakarta.ws.rs.core","c":"MultivaluedMap","l":"addAll(K, List)","u":"addAll(K,java.util.List)"},{"p":"jakarta.ws.rs.core","c":"AbstractMultivaluedMap","l":"addAll(K, V...)","u":"addAll(K,V...)"},{"p":"jakarta.ws.rs.core","c":"MultivaluedMap","l":"addAll(K, V...)","u":"addAll(K,V...)"},{"p":"jakarta.ws.rs.core","c":"AbstractMultivaluedMap","l":"addFirst(K, V)","u":"addFirst(K,V)"},{"p":"jakarta.ws.rs.core","c":"MultivaluedMap","l":"addFirst(K, V)","u":"addFirst(K,V)"},{"p":"jakarta.ws.rs.core","c":"AbstractMultivaluedMap","l":"addFirstNull(List)","u":"addFirstNull(java.util.List)"},{"p":"jakarta.ws.rs.core","c":"AbstractMultivaluedMap","l":"addNull(List)","u":"addNull(java.util.List)"},{"p":"jakarta.ws.rs.core","c":"HttpHeaders","l":"ALLOW"},{"p":"jakarta.ws.rs.core","c":"Response.ResponseBuilder","l":"allow(Set)","u":"allow(java.util.Set)"},{"p":"jakarta.ws.rs.core","c":"Response.ResponseBuilder","l":"allow(String...)","u":"allow(java.lang.String...)"},{"p":"jakarta.ws.rs.core","c":"MediaType","l":"APPLICATION_ATOM_XML"},{"p":"jakarta.ws.rs.core","c":"MediaType","l":"APPLICATION_ATOM_XML_TYPE"},{"p":"jakarta.ws.rs.core","c":"MediaType","l":"APPLICATION_FORM_URLENCODED"},{"p":"jakarta.ws.rs.core","c":"MediaType","l":"APPLICATION_FORM_URLENCODED_TYPE"},{"p":"jakarta.ws.rs.core","c":"MediaType","l":"APPLICATION_JSON"},{"p":"jakarta.ws.rs.core","c":"MediaType","l":"APPLICATION_JSON_PATCH_JSON"},{"p":"jakarta.ws.rs.core","c":"MediaType","l":"APPLICATION_JSON_PATCH_JSON_TYPE"},{"p":"jakarta.ws.rs.core","c":"MediaType","l":"APPLICATION_JSON_TYPE"},{"p":"jakarta.ws.rs.core","c":"MediaType","l":"APPLICATION_MERGE_PATCH_JSON"},{"p":"jakarta.ws.rs.core","c":"MediaType","l":"APPLICATION_MERGE_PATCH_JSON_TYPE"},{"p":"jakarta.ws.rs.core","c":"MediaType","l":"APPLICATION_OCTET_STREAM"},{"p":"jakarta.ws.rs.core","c":"MediaType","l":"APPLICATION_OCTET_STREAM_TYPE"},{"p":"jakarta.ws.rs.core","c":"MediaType","l":"APPLICATION_SVG_XML"},{"p":"jakarta.ws.rs.core","c":"MediaType","l":"APPLICATION_SVG_XML_TYPE"},{"p":"jakarta.ws.rs.core","c":"MediaType","l":"APPLICATION_XHTML_XML"},{"p":"jakarta.ws.rs.core","c":"MediaType","l":"APPLICATION_XHTML_XML_TYPE"},{"p":"jakarta.ws.rs.core","c":"MediaType","l":"APPLICATION_XML"},{"p":"jakarta.ws.rs.core","c":"MediaType","l":"APPLICATION_XML_TYPE"},{"p":"jakarta.ws.rs.core","c":"Application","l":"Application()","u":"%3Cinit%3E()"},{"p":"jakarta.ws.rs.ext","c":"ReaderInterceptor","l":"aroundReadFrom(ReaderInterceptorContext)","u":"aroundReadFrom(jakarta.ws.rs.ext.ReaderInterceptorContext)"},{"p":"jakarta.ws.rs.ext","c":"WriterInterceptor","l":"aroundWriteTo(WriterInterceptorContext)","u":"aroundWriteTo(jakarta.ws.rs.ext.WriterInterceptorContext)"},{"p":"jakarta.ws.rs.core","c":"Form","l":"asMap()"},{"p":"jakarta.ws.rs.client","c":"Invocation.Builder","l":"async()"},{"p":"jakarta.ws.rs","c":"Priorities","l":"AUTHENTICATION"},{"p":"jakarta.ws.rs.core","c":"HttpHeaders","l":"AUTHORIZATION"},{"p":"jakarta.ws.rs","c":"Priorities","l":"AUTHORIZATION"},{"p":"jakarta.ws.rs.core","c":"Response.Status","l":"BAD_GATEWAY"},{"p":"jakarta.ws.rs.core","c":"Response.Status","l":"BAD_REQUEST"},{"p":"jakarta.ws.rs","c":"BadRequestException","l":"BadRequestException()","u":"%3Cinit%3E()"},{"p":"jakarta.ws.rs","c":"BadRequestException","l":"BadRequestException(Response)","u":"%3Cinit%3E(jakarta.ws.rs.core.Response)"},{"p":"jakarta.ws.rs","c":"BadRequestException","l":"BadRequestException(Response, Throwable)","u":"%3Cinit%3E(jakarta.ws.rs.core.Response,java.lang.Throwable)"},{"p":"jakarta.ws.rs","c":"BadRequestException","l":"BadRequestException(String)","u":"%3Cinit%3E(java.lang.String)"},{"p":"jakarta.ws.rs","c":"BadRequestException","l":"BadRequestException(String, Response)","u":"%3Cinit%3E(java.lang.String,jakarta.ws.rs.core.Response)"},{"p":"jakarta.ws.rs","c":"BadRequestException","l":"BadRequestException(String, Response, Throwable)","u":"%3Cinit%3E(java.lang.String,jakarta.ws.rs.core.Response,java.lang.Throwable)"},{"p":"jakarta.ws.rs","c":"BadRequestException","l":"BadRequestException(String, Throwable)","u":"%3Cinit%3E(java.lang.String,java.lang.Throwable)"},{"p":"jakarta.ws.rs","c":"BadRequestException","l":"BadRequestException(Throwable)","u":"%3Cinit%3E(java.lang.Throwable)"},{"p":"jakarta.ws.rs","c":"SeBootstrap.Configuration","l":"baseUri()"},{"p":"jakarta.ws.rs.core","c":"Link.Builder","l":"baseUri(String)","u":"baseUri(java.lang.String)"},{"p":"jakarta.ws.rs.core","c":"Link.Builder","l":"baseUri(URI)","u":"baseUri(java.net.URI)"},{"p":"jakarta.ws.rs","c":"SeBootstrap.Configuration","l":"baseUriBuilder()"},{"p":"jakarta.ws.rs.core","c":"SecurityContext","l":"BASIC_AUTH"},{"p":"jakarta.ws.rs.ext","c":"RuntimeDelegate","l":"bootstrap(Application, SeBootstrap.Configuration)","u":"bootstrap(jakarta.ws.rs.core.Application,jakarta.ws.rs.SeBootstrap.Configuration)"},{"p":"jakarta.ws.rs.ext","c":"RuntimeDelegate","l":"bootstrap(Class, SeBootstrap.Configuration)","u":"bootstrap(java.lang.Class,jakarta.ws.rs.SeBootstrap.Configuration)"},{"p":"jakarta.ws.rs.sse","c":"SseBroadcaster","l":"broadcast(OutboundSseEvent)","u":"broadcast(jakarta.ws.rs.sse.OutboundSseEvent)"},{"p":"jakarta.ws.rs.core","c":"Response","l":"bufferEntity()"},{"p":"jakarta.ws.rs.client","c":"ClientBuilder","l":"build()"},{"p":"jakarta.ws.rs.core","c":"Cookie.AbstractCookieBuilder","l":"build()"},{"p":"jakarta.ws.rs.core","c":"Cookie.Builder","l":"build()"},{"p":"jakarta.ws.rs.core","c":"EntityPart.Builder","l":"build()"},{"p":"jakarta.ws.rs.core","c":"NewCookie.AbstractNewCookieBuilder","l":"build()"},{"p":"jakarta.ws.rs.core","c":"NewCookie.Builder","l":"build()"},{"p":"jakarta.ws.rs.core","c":"Response.ResponseBuilder","l":"build()"},{"p":"jakarta.ws.rs.core","c":"Variant.VariantListBuilder","l":"build()"},{"p":"jakarta.ws.rs","c":"SeBootstrap.Configuration.Builder","l":"build()"},{"p":"jakarta.ws.rs.sse","c":"OutboundSseEvent.Builder","l":"build()"},{"p":"jakarta.ws.rs.sse","c":"SseEventSource.Builder","l":"build()"},{"p":"jakarta.ws.rs.core","c":"Link.Builder","l":"build(Object...)","u":"build(java.lang.Object...)"},{"p":"jakarta.ws.rs.core","c":"UriBuilder","l":"build(Object...)","u":"build(java.lang.Object...)"},{"p":"jakarta.ws.rs.core","c":"UriBuilder","l":"build(Object[], boolean)","u":"build(java.lang.Object[],boolean)"},{"p":"jakarta.ws.rs.client","c":"Invocation.Builder","l":"build(String)","u":"build(java.lang.String)"},{"p":"jakarta.ws.rs.client","c":"Invocation.Builder","l":"build(String, Entity)","u":"build(java.lang.String,jakarta.ws.rs.client.Entity)"},{"p":"jakarta.ws.rs.client","c":"Invocation.Builder","l":"buildDelete()"},{"p":"jakarta.ws.rs","c":"SeBootstrap.Configuration","l":"builder()"},{"p":"jakarta.ws.rs.sse","c":"SseEventSource.Builder","l":"Builder()","u":"%3Cinit%3E()"},{"p":"jakarta.ws.rs.core","c":"NewCookie.Builder","l":"Builder(Cookie)","u":"%3Cinit%3E(jakarta.ws.rs.core.Cookie)"},{"p":"jakarta.ws.rs.core","c":"Cookie.Builder","l":"Builder(String)","u":"%3Cinit%3E(java.lang.String)"},{"p":"jakarta.ws.rs.core","c":"NewCookie.Builder","l":"Builder(String)","u":"%3Cinit%3E(java.lang.String)"},{"p":"jakarta.ws.rs.core","c":"UriBuilder","l":"buildFromEncoded(Object...)","u":"buildFromEncoded(java.lang.Object...)"},{"p":"jakarta.ws.rs.core","c":"UriBuilder","l":"buildFromEncodedMap(Map)","u":"buildFromEncodedMap(java.util.Map)"},{"p":"jakarta.ws.rs.core","c":"UriBuilder","l":"buildFromMap(Map)","u":"buildFromMap(java.util.Map)"},{"p":"jakarta.ws.rs.core","c":"UriBuilder","l":"buildFromMap(Map, boolean)","u":"buildFromMap(java.util.Map,boolean)"},{"p":"jakarta.ws.rs.client","c":"Invocation.Builder","l":"buildGet()"},{"p":"jakarta.ws.rs.client","c":"Invocation.Builder","l":"buildPost(Entity)","u":"buildPost(jakarta.ws.rs.client.Entity)"},{"p":"jakarta.ws.rs.client","c":"Invocation.Builder","l":"buildPut(Entity)","u":"buildPut(jakarta.ws.rs.client.Entity)"},{"p":"jakarta.ws.rs.core","c":"Link.Builder","l":"buildRelativized(URI, Object...)","u":"buildRelativized(java.net.URI,java.lang.Object...)"},{"p":"jakarta.ws.rs.core","c":"HttpHeaders","l":"CACHE_CONTROL"},{"p":"jakarta.ws.rs.core","c":"CacheControl","l":"CacheControl()","u":"%3Cinit%3E()"},{"p":"jakarta.ws.rs.client","c":"Invocation.Builder","l":"cacheControl(CacheControl)","u":"cacheControl(jakarta.ws.rs.core.CacheControl)"},{"p":"jakarta.ws.rs.core","c":"Response.ResponseBuilder","l":"cacheControl(CacheControl)","u":"cacheControl(jakarta.ws.rs.core.CacheControl)"},{"p":"jakarta.ws.rs.container","c":"AsyncResponse","l":"cancel()"},{"p":"jakarta.ws.rs.container","c":"AsyncResponse","l":"cancel(Date)","u":"cancel(java.util.Date)"},{"p":"jakarta.ws.rs.container","c":"AsyncResponse","l":"cancel(int)"},{"p":"jakarta.ws.rs.core","c":"MediaType","l":"CHARSET_PARAMETER"},{"p":"jakarta.ws.rs.core","c":"AbstractMultivaluedMap","l":"clear()"},{"p":"jakarta.ws.rs","c":"RuntimeType","l":"CLIENT"},{"p":"jakarta.ws.rs.core","c":"SecurityContext","l":"CLIENT_CERT_AUTH"},{"p":"jakarta.ws.rs.core","c":"Response.Status.Family","l":"CLIENT_ERROR"},{"p":"jakarta.ws.rs.client","c":"ClientBuilder","l":"ClientBuilder()","u":"%3Cinit%3E()"},{"p":"jakarta.ws.rs","c":"ClientErrorException","l":"ClientErrorException(int)","u":"%3Cinit%3E(int)"},{"p":"jakarta.ws.rs","c":"ClientErrorException","l":"ClientErrorException(int, Throwable)","u":"%3Cinit%3E(int,java.lang.Throwable)"},{"p":"jakarta.ws.rs","c":"ClientErrorException","l":"ClientErrorException(Response)","u":"%3Cinit%3E(jakarta.ws.rs.core.Response)"},{"p":"jakarta.ws.rs","c":"ClientErrorException","l":"ClientErrorException(Response, Throwable)","u":"%3Cinit%3E(jakarta.ws.rs.core.Response,java.lang.Throwable)"},{"p":"jakarta.ws.rs","c":"ClientErrorException","l":"ClientErrorException(Response.Status)","u":"%3Cinit%3E(jakarta.ws.rs.core.Response.Status)"},{"p":"jakarta.ws.rs","c":"ClientErrorException","l":"ClientErrorException(Response.Status, Throwable)","u":"%3Cinit%3E(jakarta.ws.rs.core.Response.Status,java.lang.Throwable)"},{"p":"jakarta.ws.rs","c":"ClientErrorException","l":"ClientErrorException(String, int)","u":"%3Cinit%3E(java.lang.String,int)"},{"p":"jakarta.ws.rs","c":"ClientErrorException","l":"ClientErrorException(String, int, Throwable)","u":"%3Cinit%3E(java.lang.String,int,java.lang.Throwable)"},{"p":"jakarta.ws.rs","c":"ClientErrorException","l":"ClientErrorException(String, Response)","u":"%3Cinit%3E(java.lang.String,jakarta.ws.rs.core.Response)"},{"p":"jakarta.ws.rs","c":"ClientErrorException","l":"ClientErrorException(String, Response, Throwable)","u":"%3Cinit%3E(java.lang.String,jakarta.ws.rs.core.Response,java.lang.Throwable)"},{"p":"jakarta.ws.rs","c":"ClientErrorException","l":"ClientErrorException(String, Response.Status)","u":"%3Cinit%3E(java.lang.String,jakarta.ws.rs.core.Response.Status)"},{"p":"jakarta.ws.rs","c":"ClientErrorException","l":"ClientErrorException(String, Response.Status, Throwable)","u":"%3Cinit%3E(java.lang.String,jakarta.ws.rs.core.Response.Status,java.lang.Throwable)"},{"p":"jakarta.ws.rs.core","c":"Response.ResponseBuilder","l":"clone()"},{"p":"jakarta.ws.rs.core","c":"UriBuilder","l":"clone()"},{"p":"jakarta.ws.rs.client","c":"Client","l":"close()"},{"p":"jakarta.ws.rs.core","c":"Response","l":"close()"},{"p":"jakarta.ws.rs.sse","c":"SseBroadcaster","l":"close()"},{"p":"jakarta.ws.rs.sse","c":"SseEventSink","l":"close()"},{"p":"jakarta.ws.rs.sse","c":"SseEventSource","l":"close()"},{"p":"jakarta.ws.rs.sse","c":"SseBroadcaster","l":"close(boolean)"},{"p":"jakarta.ws.rs.sse","c":"SseEventSource","l":"close(long, TimeUnit)","u":"close(long,java.util.concurrent.TimeUnit)"},{"p":"jakarta.ws.rs.core","c":"NewCookie.AbstractNewCookieBuilder","l":"comment(String)","u":"comment(java.lang.String)"},{"p":"jakarta.ws.rs.sse","c":"OutboundSseEvent.Builder","l":"comment(String)","u":"comment(java.lang.String)"},{"p":"jakarta.ws.rs.client","c":"InvocationCallback","l":"completed(RESPONSE)"},{"p":"jakarta.ws.rs","c":"SeBootstrap.Instance","l":"configuration()"},{"p":"jakarta.ws.rs.core","c":"Feature","l":"configure(FeatureContext)","u":"configure(jakarta.ws.rs.core.FeatureContext)"},{"p":"jakarta.ws.rs.container","c":"DynamicFeature","l":"configure(ResourceInfo, FeatureContext)","u":"configure(jakarta.ws.rs.container.ResourceInfo,jakarta.ws.rs.core.FeatureContext)"},{"p":"jakarta.ws.rs.core","c":"Response.Status","l":"CONFLICT"},{"p":"jakarta.ws.rs.client","c":"ClientBuilder","l":"connectTimeout(long, TimeUnit)","u":"connectTimeout(long,java.util.concurrent.TimeUnit)"},{"p":"jakarta.ws.rs.client","c":"ClientRequestContext","l":"containsHeaderString(String, Predicate)","u":"containsHeaderString(java.lang.String,java.util.function.Predicate)"},{"p":"jakarta.ws.rs.client","c":"ClientResponseContext","l":"containsHeaderString(String, Predicate)","u":"containsHeaderString(java.lang.String,java.util.function.Predicate)"},{"p":"jakarta.ws.rs.container","c":"ContainerRequestContext","l":"containsHeaderString(String, Predicate)","u":"containsHeaderString(java.lang.String,java.util.function.Predicate)"},{"p":"jakarta.ws.rs.container","c":"ContainerResponseContext","l":"containsHeaderString(String, Predicate)","u":"containsHeaderString(java.lang.String,java.util.function.Predicate)"},{"p":"jakarta.ws.rs.core","c":"HttpHeaders","l":"containsHeaderString(String, Predicate)","u":"containsHeaderString(java.lang.String,java.util.function.Predicate)"},{"p":"jakarta.ws.rs.client","c":"ClientRequestContext","l":"containsHeaderString(String, String, Predicate)","u":"containsHeaderString(java.lang.String,java.lang.String,java.util.function.Predicate)"},{"p":"jakarta.ws.rs.client","c":"ClientResponseContext","l":"containsHeaderString(String, String, Predicate)","u":"containsHeaderString(java.lang.String,java.lang.String,java.util.function.Predicate)"},{"p":"jakarta.ws.rs.container","c":"ContainerRequestContext","l":"containsHeaderString(String, String, Predicate)","u":"containsHeaderString(java.lang.String,java.lang.String,java.util.function.Predicate)"},{"p":"jakarta.ws.rs.container","c":"ContainerResponseContext","l":"containsHeaderString(String, String, Predicate)","u":"containsHeaderString(java.lang.String,java.lang.String,java.util.function.Predicate)"},{"p":"jakarta.ws.rs.core","c":"HttpHeaders","l":"containsHeaderString(String, String, Predicate)","u":"containsHeaderString(java.lang.String,java.lang.String,java.util.function.Predicate)"},{"p":"jakarta.ws.rs.core","c":"AbstractMultivaluedMap","l":"containsKey(Object)","u":"containsKey(java.lang.Object)"},{"p":"jakarta.ws.rs.core","c":"AbstractMultivaluedMap","l":"containsValue(Object)","u":"containsValue(java.lang.Object)"},{"p":"jakarta.ws.rs.core","c":"HttpHeaders","l":"CONTENT_DISPOSITION"},{"p":"jakarta.ws.rs.core","c":"HttpHeaders","l":"CONTENT_ENCODING"},{"p":"jakarta.ws.rs.core","c":"HttpHeaders","l":"CONTENT_ID"},{"p":"jakarta.ws.rs.core","c":"HttpHeaders","l":"CONTENT_LANGUAGE"},{"p":"jakarta.ws.rs.core","c":"HttpHeaders","l":"CONTENT_LENGTH"},{"p":"jakarta.ws.rs.core","c":"HttpHeaders","l":"CONTENT_LOCATION"},{"p":"jakarta.ws.rs.core","c":"HttpHeaders","l":"CONTENT_TYPE"},{"p":"jakarta.ws.rs.core","c":"EntityPart.Builder","l":"content(InputStream)","u":"content(java.io.InputStream)"},{"p":"jakarta.ws.rs.core","c":"EntityPart.Builder","l":"content(Object)","u":"content(java.lang.Object)"},{"p":"jakarta.ws.rs.core","c":"EntityPart.Builder","l":"content(String, InputStream)","u":"content(java.lang.String,java.io.InputStream)"},{"p":"jakarta.ws.rs.core","c":"EntityPart.Builder","l":"content(T, Class)","u":"content(T,java.lang.Class)"},{"p":"jakarta.ws.rs.core","c":"EntityPart.Builder","l":"content(T, GenericType)","u":"content(T,jakarta.ws.rs.core.GenericType)"},{"p":"jakarta.ws.rs.core","c":"Response.ResponseBuilder","l":"contentLocation(URI)","u":"contentLocation(java.net.URI)"},{"p":"jakarta.ws.rs.core","c":"HttpHeaders","l":"COOKIE"},{"p":"jakarta.ws.rs.client","c":"Invocation.Builder","l":"cookie(Cookie)","u":"cookie(jakarta.ws.rs.core.Cookie)"},{"p":"jakarta.ws.rs.core","c":"Cookie","l":"Cookie(Cookie.AbstractCookieBuilder)","u":"%3Cinit%3E(jakarta.ws.rs.core.Cookie.AbstractCookieBuilder)"},{"p":"jakarta.ws.rs.core","c":"Response.ResponseBuilder","l":"cookie(NewCookie...)","u":"cookie(jakarta.ws.rs.core.NewCookie...)"},{"p":"jakarta.ws.rs.client","c":"Invocation.Builder","l":"cookie(String, String)","u":"cookie(java.lang.String,java.lang.String)"},{"p":"jakarta.ws.rs.core","c":"Cookie","l":"Cookie(String, String)","u":"%3Cinit%3E(java.lang.String,java.lang.String)"},{"p":"jakarta.ws.rs.core","c":"Cookie","l":"Cookie(String, String, String, String)","u":"%3Cinit%3E(java.lang.String,java.lang.String,java.lang.String,java.lang.String)"},{"p":"jakarta.ws.rs.core","c":"Cookie","l":"Cookie(String, String, String, String, int)","u":"%3Cinit%3E(java.lang.String,java.lang.String,java.lang.String,java.lang.String,int)"},{"p":"jakarta.ws.rs.ext","c":"RuntimeDelegate","l":"createConfigurationBuilder()"},{"p":"jakarta.ws.rs.core","c":"Response.Status","l":"CREATED"},{"p":"jakarta.ws.rs.core","c":"Response","l":"created(URI)","u":"created(java.net.URI)"},{"p":"jakarta.ws.rs.ext","c":"RuntimeDelegate","l":"createEndpoint(Application, Class)","u":"createEndpoint(jakarta.ws.rs.core.Application,java.lang.Class)"},{"p":"jakarta.ws.rs.ext","c":"RuntimeDelegate","l":"createEntityPartBuilder(String)","u":"createEntityPartBuilder(java.lang.String)"},{"p":"jakarta.ws.rs.ext","c":"RuntimeDelegate","l":"createHeaderDelegate(Class)","u":"createHeaderDelegate(java.lang.Class)"},{"p":"jakarta.ws.rs.ext","c":"RuntimeDelegate","l":"createLinkBuilder()"},{"p":"jakarta.ws.rs.ext","c":"RuntimeDelegate","l":"createResponseBuilder()"},{"p":"jakarta.ws.rs.ext","c":"RuntimeDelegate","l":"createUriBuilder()"},{"p":"jakarta.ws.rs.ext","c":"RuntimeDelegate","l":"createVariantListBuilder()"},{"p":"jakarta.ws.rs.sse","c":"OutboundSseEvent.Builder","l":"data(Class, Object)","u":"data(java.lang.Class,java.lang.Object)"},{"p":"jakarta.ws.rs.sse","c":"OutboundSseEvent.Builder","l":"data(GenericType, Object)","u":"data(jakarta.ws.rs.core.GenericType,java.lang.Object)"},{"p":"jakarta.ws.rs.sse","c":"OutboundSseEvent.Builder","l":"data(Object)","u":"data(java.lang.Object)"},{"p":"jakarta.ws.rs.core","c":"HttpHeaders","l":"DATE"},{"p":"jakarta.ws.rs.core","c":"NewCookie","l":"DEFAULT_MAX_AGE"},{"p":"jakarta.ws.rs","c":"SeBootstrap.Configuration","l":"DEFAULT_PORT"},{"p":"jakarta.ws.rs.core","c":"Cookie","l":"DEFAULT_VERSION"},{"p":"jakarta.ws.rs","c":"HttpMethod","l":"DELETE"},{"p":"jakarta.ws.rs.client","c":"AsyncInvoker","l":"delete()"},{"p":"jakarta.ws.rs.client","c":"CompletionStageRxInvoker","l":"delete()"},{"p":"jakarta.ws.rs.client","c":"RxInvoker","l":"delete()"},{"p":"jakarta.ws.rs.client","c":"SyncInvoker","l":"delete()"},{"p":"jakarta.ws.rs.client","c":"RxInvoker","l":"delete(Class)","u":"delete(java.lang.Class)"},{"p":"jakarta.ws.rs.client","c":"AsyncInvoker","l":"delete(Class)","u":"delete(java.lang.Class)"},{"p":"jakarta.ws.rs.client","c":"CompletionStageRxInvoker","l":"delete(Class)","u":"delete(java.lang.Class)"},{"p":"jakarta.ws.rs.client","c":"SyncInvoker","l":"delete(Class)","u":"delete(java.lang.Class)"},{"p":"jakarta.ws.rs.client","c":"RxInvoker","l":"delete(GenericType)","u":"delete(jakarta.ws.rs.core.GenericType)"},{"p":"jakarta.ws.rs.client","c":"AsyncInvoker","l":"delete(GenericType)","u":"delete(jakarta.ws.rs.core.GenericType)"},{"p":"jakarta.ws.rs.client","c":"CompletionStageRxInvoker","l":"delete(GenericType)","u":"delete(jakarta.ws.rs.core.GenericType)"},{"p":"jakarta.ws.rs.client","c":"SyncInvoker","l":"delete(GenericType)","u":"delete(jakarta.ws.rs.core.GenericType)"},{"p":"jakarta.ws.rs.client","c":"AsyncInvoker","l":"delete(InvocationCallback)","u":"delete(jakarta.ws.rs.client.InvocationCallback)"},{"p":"jakarta.ws.rs.core","c":"SecurityContext","l":"DIGEST_AUTH"},{"p":"jakarta.ws.rs.core","c":"Cookie.AbstractCookieBuilder","l":"domain(String)","u":"domain(java.lang.String)"},{"p":"jakarta.ws.rs.core","c":"Response.ResponseBuilder","l":"encoding(String)","u":"encoding(java.lang.String)"},{"p":"jakarta.ws.rs.core","c":"Variant","l":"encodings(String...)","u":"encodings(java.lang.String...)"},{"p":"jakarta.ws.rs.core","c":"Variant.VariantListBuilder","l":"encodings(String...)","u":"encodings(java.lang.String...)"},{"p":"jakarta.ws.rs","c":"Priorities","l":"ENTITY_CODER"},{"p":"jakarta.ws.rs.core","c":"Response.ResponseBuilder","l":"entity(Object)","u":"entity(java.lang.Object)"},{"p":"jakarta.ws.rs.core","c":"Response.ResponseBuilder","l":"entity(Object, Annotation[])","u":"entity(java.lang.Object,java.lang.annotation.Annotation[])"},{"p":"jakarta.ws.rs.client","c":"Entity","l":"entity(T, MediaType)","u":"entity(T,jakarta.ws.rs.core.MediaType)"},{"p":"jakarta.ws.rs.client","c":"Entity","l":"entity(T, MediaType, Annotation[])","u":"entity(T,jakarta.ws.rs.core.MediaType,java.lang.annotation.Annotation[])"},{"p":"jakarta.ws.rs.client","c":"Entity","l":"entity(T, String)","u":"entity(T,java.lang.String)"},{"p":"jakarta.ws.rs.client","c":"Entity","l":"entity(T, Variant)","u":"entity(T,jakarta.ws.rs.core.Variant)"},{"p":"jakarta.ws.rs.client","c":"Entity","l":"entity(T, Variant, Annotation[])","u":"entity(T,jakarta.ws.rs.core.Variant,java.lang.annotation.Annotation[])"},{"p":"jakarta.ws.rs.core","c":"EntityTag","l":"EntityTag(String)","u":"%3Cinit%3E(java.lang.String)"},{"p":"jakarta.ws.rs.core","c":"EntityTag","l":"EntityTag(String, boolean)","u":"%3Cinit%3E(java.lang.String,boolean)"},{"p":"jakarta.ws.rs.core","c":"AbstractMultivaluedMap","l":"entrySet()"},{"p":"jakarta.ws.rs.client","c":"Entity","l":"equals(Object)","u":"equals(java.lang.Object)"},{"p":"jakarta.ws.rs.core","c":"AbstractMultivaluedMap","l":"equals(Object)","u":"equals(java.lang.Object)"},{"p":"jakarta.ws.rs.core","c":"CacheControl","l":"equals(Object)","u":"equals(java.lang.Object)"},{"p":"jakarta.ws.rs.core","c":"Cookie","l":"equals(Object)","u":"equals(java.lang.Object)"},{"p":"jakarta.ws.rs.core","c":"EntityTag","l":"equals(Object)","u":"equals(java.lang.Object)"},{"p":"jakarta.ws.rs.core","c":"GenericEntity","l":"equals(Object)","u":"equals(java.lang.Object)"},{"p":"jakarta.ws.rs.core","c":"GenericType","l":"equals(Object)","u":"equals(java.lang.Object)"},{"p":"jakarta.ws.rs.core","c":"MediaType","l":"equals(Object)","u":"equals(java.lang.Object)"},{"p":"jakarta.ws.rs.core","c":"NewCookie","l":"equals(Object)","u":"equals(java.lang.Object)"},{"p":"jakarta.ws.rs.core","c":"Variant","l":"equals(Object)","u":"equals(java.lang.Object)"},{"p":"jakarta.ws.rs.core","c":"AbstractMultivaluedMap","l":"equalsIgnoreValueOrder(MultivaluedMap)","u":"equalsIgnoreValueOrder(jakarta.ws.rs.core.MultivaluedMap)"},{"p":"jakarta.ws.rs.core","c":"MultivaluedMap","l":"equalsIgnoreValueOrder(MultivaluedMap)","u":"equalsIgnoreValueOrder(jakarta.ws.rs.core.MultivaluedMap)"},{"p":"jakarta.ws.rs.core","c":"HttpHeaders","l":"ETAG"},{"p":"jakarta.ws.rs.core","c":"Request","l":"evaluatePreconditions()"},{"p":"jakarta.ws.rs.core","c":"Request","l":"evaluatePreconditions(Date)","u":"evaluatePreconditions(java.util.Date)"},{"p":"jakarta.ws.rs.core","c":"Request","l":"evaluatePreconditions(Date, EntityTag)","u":"evaluatePreconditions(java.util.Date,jakarta.ws.rs.core.EntityTag)"},{"p":"jakarta.ws.rs.core","c":"Request","l":"evaluatePreconditions(EntityTag)","u":"evaluatePreconditions(jakarta.ws.rs.core.EntityTag)"},{"p":"jakarta.ws.rs.client","c":"ClientBuilder","l":"executorService(ExecutorService)","u":"executorService(java.util.concurrent.ExecutorService)"},{"p":"jakarta.ws.rs.core","c":"HttpHeaders","l":"EXPECT"},{"p":"jakarta.ws.rs.core","c":"Response.Status","l":"EXPECTATION_FAILED"},{"p":"jakarta.ws.rs.core","c":"HttpHeaders","l":"EXPIRES"},{"p":"jakarta.ws.rs.core","c":"Response.ResponseBuilder","l":"expires(Date)","u":"expires(java.util.Date)"},{"p":"jakarta.ws.rs.core","c":"NewCookie.AbstractNewCookieBuilder","l":"expiry(Date)","u":"expiry(java.util.Date)"},{"p":"jakarta.ws.rs.client","c":"InvocationCallback","l":"failed(Throwable)","u":"failed(java.lang.Throwable)"},{"p":"jakarta.ws.rs.core","c":"Response.Status.Family","l":"familyOf(int)"},{"p":"jakarta.ws.rs.core","c":"EntityPart.Builder","l":"fileName(String)","u":"fileName(java.lang.String)"},{"p":"jakarta.ws.rs.client","c":"ClientRequestFilter","l":"filter(ClientRequestContext)","u":"filter(jakarta.ws.rs.client.ClientRequestContext)"},{"p":"jakarta.ws.rs.client","c":"ClientResponseFilter","l":"filter(ClientRequestContext, ClientResponseContext)","u":"filter(jakarta.ws.rs.client.ClientRequestContext,jakarta.ws.rs.client.ClientResponseContext)"},{"p":"jakarta.ws.rs.container","c":"ContainerRequestFilter","l":"filter(ContainerRequestContext)","u":"filter(jakarta.ws.rs.container.ContainerRequestContext)"},{"p":"jakarta.ws.rs.container","c":"ContainerResponseFilter","l":"filter(ContainerRequestContext, ContainerResponseContext)","u":"filter(jakarta.ws.rs.container.ContainerRequestContext,jakarta.ws.rs.container.ContainerResponseContext)"},{"p":"jakarta.ws.rs.core","c":"Response.Status","l":"FORBIDDEN"},{"p":"jakarta.ws.rs","c":"ForbiddenException","l":"ForbiddenException()","u":"%3Cinit%3E()"},{"p":"jakarta.ws.rs","c":"ForbiddenException","l":"ForbiddenException(Response)","u":"%3Cinit%3E(jakarta.ws.rs.core.Response)"},{"p":"jakarta.ws.rs","c":"ForbiddenException","l":"ForbiddenException(Response, Throwable)","u":"%3Cinit%3E(jakarta.ws.rs.core.Response,java.lang.Throwable)"},{"p":"jakarta.ws.rs","c":"ForbiddenException","l":"ForbiddenException(String)","u":"%3Cinit%3E(java.lang.String)"},{"p":"jakarta.ws.rs","c":"ForbiddenException","l":"ForbiddenException(String, Response)","u":"%3Cinit%3E(java.lang.String,jakarta.ws.rs.core.Response)"},{"p":"jakarta.ws.rs","c":"ForbiddenException","l":"ForbiddenException(String, Response, Throwable)","u":"%3Cinit%3E(java.lang.String,jakarta.ws.rs.core.Response,java.lang.Throwable)"},{"p":"jakarta.ws.rs","c":"ForbiddenException","l":"ForbiddenException(String, Throwable)","u":"%3Cinit%3E(java.lang.String,java.lang.Throwable)"},{"p":"jakarta.ws.rs","c":"ForbiddenException","l":"ForbiddenException(Throwable)","u":"%3Cinit%3E(java.lang.Throwable)"},{"p":"jakarta.ws.rs.core","c":"GenericType","l":"forInstance(Object)","u":"forInstance(java.lang.Object)"},{"p":"jakarta.ws.rs.core","c":"SecurityContext","l":"FORM_AUTH"},{"p":"jakarta.ws.rs.core","c":"Form","l":"Form()","u":"%3Cinit%3E()"},{"p":"jakarta.ws.rs.client","c":"Entity","l":"form(Form)","u":"form(jakarta.ws.rs.core.Form)"},{"p":"jakarta.ws.rs.client","c":"Entity","l":"form(MultivaluedMap)","u":"form(jakarta.ws.rs.core.MultivaluedMap)"},{"p":"jakarta.ws.rs.core","c":"Form","l":"Form(MultivaluedMap)","u":"%3Cinit%3E(jakarta.ws.rs.core.MultivaluedMap)"},{"p":"jakarta.ws.rs.core","c":"Form","l":"Form(String, String)","u":"%3Cinit%3E(java.lang.String,java.lang.String)"},{"p":"jakarta.ws.rs.core","c":"Response.Status","l":"FOUND"},{"p":"jakarta.ws.rs.core","c":"UriBuilder","l":"fragment(String)","u":"fragment(java.lang.String)"},{"p":"jakarta.ws.rs","c":"SeBootstrap.Configuration","l":"FREE_PORT"},{"p":"jakarta.ws.rs","c":"SeBootstrap.Configuration.Builder","l":"from(BiFunction, Optional>)","u":"from(java.util.function.BiFunction)"},{"p":"jakarta.ws.rs","c":"SeBootstrap.Configuration.Builder","l":"from(Object)","u":"from(java.lang.Object)"},{"p":"jakarta.ws.rs.core","c":"Link","l":"fromLink(Link)","u":"fromLink(jakarta.ws.rs.core.Link)"},{"p":"jakarta.ws.rs.core","c":"UriBuilder","l":"fromLink(Link)","u":"fromLink(jakarta.ws.rs.core.Link)"},{"p":"jakarta.ws.rs.core","c":"Link","l":"fromMethod(Class, String)","u":"fromMethod(java.lang.Class,java.lang.String)"},{"p":"jakarta.ws.rs.core","c":"UriBuilder","l":"fromMethod(Class, String)","u":"fromMethod(java.lang.Class,java.lang.String)"},{"p":"jakarta.ws.rs.core","c":"Link","l":"fromPath(String)","u":"fromPath(java.lang.String)"},{"p":"jakarta.ws.rs.core","c":"UriBuilder","l":"fromPath(String)","u":"fromPath(java.lang.String)"},{"p":"jakarta.ws.rs.core","c":"Link","l":"fromResource(Class)","u":"fromResource(java.lang.Class)"},{"p":"jakarta.ws.rs.core","c":"UriBuilder","l":"fromResource(Class)","u":"fromResource(java.lang.Class)"},{"p":"jakarta.ws.rs.core","c":"Response","l":"fromResponse(Response)","u":"fromResponse(jakarta.ws.rs.core.Response)"},{"p":"jakarta.ws.rs.core","c":"Response.Status","l":"fromStatusCode(int)"},{"p":"jakarta.ws.rs.ext","c":"ParamConverter","l":"fromString(String)","u":"fromString(java.lang.String)"},{"p":"jakarta.ws.rs.ext","c":"RuntimeDelegate.HeaderDelegate","l":"fromString(String)","u":"fromString(java.lang.String)"},{"p":"jakarta.ws.rs.core","c":"Link","l":"fromUri(String)","u":"fromUri(java.lang.String)"},{"p":"jakarta.ws.rs.core","c":"UriBuilder","l":"fromUri(String)","u":"fromUri(java.lang.String)"},{"p":"jakarta.ws.rs.core","c":"Link","l":"fromUri(URI)","u":"fromUri(java.net.URI)"},{"p":"jakarta.ws.rs.core","c":"UriBuilder","l":"fromUri(URI)","u":"fromUri(java.net.URI)"},{"p":"jakarta.ws.rs.core","c":"Link","l":"fromUriBuilder(UriBuilder)","u":"fromUriBuilder(jakarta.ws.rs.core.UriBuilder)"},{"p":"jakarta.ws.rs.core","c":"Response.Status","l":"GATEWAY_TIMEOUT"},{"p":"jakarta.ws.rs.core","c":"GenericEntity","l":"GenericEntity(T)","u":"%3Cinit%3E(T)"},{"p":"jakarta.ws.rs.core","c":"GenericEntity","l":"GenericEntity(T, Type)","u":"%3Cinit%3E(T,java.lang.reflect.Type)"},{"p":"jakarta.ws.rs.core","c":"GenericType","l":"GenericType()","u":"%3Cinit%3E()"},{"p":"jakarta.ws.rs.core","c":"GenericType","l":"GenericType(Type)","u":"%3Cinit%3E(java.lang.reflect.Type)"},{"p":"jakarta.ws.rs","c":"HttpMethod","l":"GET"},{"p":"jakarta.ws.rs.client","c":"AsyncInvoker","l":"get()"},{"p":"jakarta.ws.rs.client","c":"CompletionStageRxInvoker","l":"get()"},{"p":"jakarta.ws.rs.client","c":"RxInvoker","l":"get()"},{"p":"jakarta.ws.rs.client","c":"SyncInvoker","l":"get()"},{"p":"jakarta.ws.rs.client","c":"RxInvoker","l":"get(Class)","u":"get(java.lang.Class)"},{"p":"jakarta.ws.rs.client","c":"AsyncInvoker","l":"get(Class)","u":"get(java.lang.Class)"},{"p":"jakarta.ws.rs.client","c":"CompletionStageRxInvoker","l":"get(Class)","u":"get(java.lang.Class)"},{"p":"jakarta.ws.rs.client","c":"SyncInvoker","l":"get(Class)","u":"get(java.lang.Class)"},{"p":"jakarta.ws.rs.client","c":"RxInvoker","l":"get(GenericType)","u":"get(jakarta.ws.rs.core.GenericType)"},{"p":"jakarta.ws.rs.client","c":"AsyncInvoker","l":"get(GenericType)","u":"get(jakarta.ws.rs.core.GenericType)"},{"p":"jakarta.ws.rs.client","c":"CompletionStageRxInvoker","l":"get(GenericType)","u":"get(jakarta.ws.rs.core.GenericType)"},{"p":"jakarta.ws.rs.client","c":"SyncInvoker","l":"get(GenericType)","u":"get(jakarta.ws.rs.core.GenericType)"},{"p":"jakarta.ws.rs.client","c":"AsyncInvoker","l":"get(InvocationCallback)","u":"get(jakarta.ws.rs.client.InvocationCallback)"},{"p":"jakarta.ws.rs.core","c":"AbstractMultivaluedMap","l":"get(Object)","u":"get(java.lang.Object)"},{"p":"jakarta.ws.rs.core","c":"UriInfo","l":"getAbsolutePath()"},{"p":"jakarta.ws.rs.core","c":"UriInfo","l":"getAbsolutePathBuilder()"},{"p":"jakarta.ws.rs.client","c":"ClientRequestContext","l":"getAcceptableLanguages()"},{"p":"jakarta.ws.rs.container","c":"ContainerRequestContext","l":"getAcceptableLanguages()"},{"p":"jakarta.ws.rs.core","c":"HttpHeaders","l":"getAcceptableLanguages()"},{"p":"jakarta.ws.rs.client","c":"ClientRequestContext","l":"getAcceptableMediaTypes()"},{"p":"jakarta.ws.rs.container","c":"ContainerRequestContext","l":"getAcceptableMediaTypes()"},{"p":"jakarta.ws.rs.core","c":"HttpHeaders","l":"getAcceptableMediaTypes()"},{"p":"jakarta.ws.rs.client","c":"ClientResponseContext","l":"getAllowedMethods()"},{"p":"jakarta.ws.rs.container","c":"ContainerResponseContext","l":"getAllowedMethods()"},{"p":"jakarta.ws.rs.core","c":"Response","l":"getAllowedMethods()"},{"p":"jakarta.ws.rs.client","c":"Entity","l":"getAnnotations()"},{"p":"jakarta.ws.rs.ext","c":"InterceptorContext","l":"getAnnotations()"},{"p":"jakarta.ws.rs.core","c":"SecurityContext","l":"getAuthenticationScheme()"},{"p":"jakarta.ws.rs.core","c":"UriInfo","l":"getBaseUri()"},{"p":"jakarta.ws.rs.core","c":"UriInfo","l":"getBaseUriBuilder()"},{"p":"jakarta.ws.rs.core","c":"CacheControl","l":"getCacheExtension()"},{"p":"jakarta.ws.rs","c":"NotAuthorizedException","l":"getChallenges()"},{"p":"jakarta.ws.rs.core","c":"Application","l":"getClasses()"},{"p":"jakarta.ws.rs.core","c":"Configuration","l":"getClasses()"},{"p":"jakarta.ws.rs.client","c":"ClientRequestContext","l":"getClient()"},{"p":"jakarta.ws.rs.core","c":"NewCookie","l":"getComment()"},{"p":"jakarta.ws.rs.sse","c":"SseEvent","l":"getComment()"},{"p":"jakarta.ws.rs.client","c":"ClientRequestContext","l":"getConfiguration()"},{"p":"jakarta.ws.rs.core","c":"Configurable","l":"getConfiguration()"},{"p":"jakarta.ws.rs.core","c":"EntityPart","l":"getContent()"},{"p":"jakarta.ws.rs.core","c":"EntityPart","l":"getContent(Class)","u":"getContent(java.lang.Class)"},{"p":"jakarta.ws.rs.core","c":"EntityPart","l":"getContent(GenericType)","u":"getContent(jakarta.ws.rs.core.GenericType)"},{"p":"jakarta.ws.rs.ext","c":"ContextResolver","l":"getContext(Class)","u":"getContext(java.lang.Class)"},{"p":"jakarta.ws.rs.ext","c":"Providers","l":"getContextResolver(Class, MediaType)","u":"getContextResolver(java.lang.Class,jakarta.ws.rs.core.MediaType)"},{"p":"jakarta.ws.rs.core","c":"Configuration","l":"getContracts(Class)","u":"getContracts(java.lang.Class)"},{"p":"jakarta.ws.rs.ext","c":"ParamConverterProvider","l":"getConverter(Class, Type, Annotation[])","u":"getConverter(java.lang.Class,java.lang.reflect.Type,java.lang.annotation.Annotation[])"},{"p":"jakarta.ws.rs.client","c":"ClientRequestContext","l":"getCookies()"},{"p":"jakarta.ws.rs.client","c":"ClientResponseContext","l":"getCookies()"},{"p":"jakarta.ws.rs.container","c":"ContainerRequestContext","l":"getCookies()"},{"p":"jakarta.ws.rs.container","c":"ContainerResponseContext","l":"getCookies()"},{"p":"jakarta.ws.rs.core","c":"HttpHeaders","l":"getCookies()"},{"p":"jakarta.ws.rs.core","c":"Response","l":"getCookies()"},{"p":"jakarta.ws.rs.sse","c":"OutboundSseEvent","l":"getData()"},{"p":"jakarta.ws.rs.client","c":"ClientRequestContext","l":"getDate()"},{"p":"jakarta.ws.rs.client","c":"ClientResponseContext","l":"getDate()"},{"p":"jakarta.ws.rs.container","c":"ContainerRequestContext","l":"getDate()"},{"p":"jakarta.ws.rs.container","c":"ContainerResponseContext","l":"getDate()"},{"p":"jakarta.ws.rs.core","c":"HttpHeaders","l":"getDate()"},{"p":"jakarta.ws.rs.core","c":"Response","l":"getDate()"},{"p":"jakarta.ws.rs.core","c":"Cookie","l":"getDomain()"},{"p":"jakarta.ws.rs.client","c":"Entity","l":"getEncoding()"},{"p":"jakarta.ws.rs.core","c":"Variant","l":"getEncoding()"},{"p":"jakarta.ws.rs.client","c":"ClientRequestContext","l":"getEntity()"},{"p":"jakarta.ws.rs.client","c":"Entity","l":"getEntity()"},{"p":"jakarta.ws.rs.container","c":"ContainerResponseContext","l":"getEntity()"},{"p":"jakarta.ws.rs.core","c":"GenericEntity","l":"getEntity()"},{"p":"jakarta.ws.rs.core","c":"Response","l":"getEntity()"},{"p":"jakarta.ws.rs.ext","c":"WriterInterceptorContext","l":"getEntity()"},{"p":"jakarta.ws.rs.client","c":"ClientRequestContext","l":"getEntityAnnotations()"},{"p":"jakarta.ws.rs.container","c":"ContainerResponseContext","l":"getEntityAnnotations()"},{"p":"jakarta.ws.rs.client","c":"ClientRequestContext","l":"getEntityClass()"},{"p":"jakarta.ws.rs.container","c":"ContainerResponseContext","l":"getEntityClass()"},{"p":"jakarta.ws.rs.client","c":"ClientRequestContext","l":"getEntityStream()"},{"p":"jakarta.ws.rs.client","c":"ClientResponseContext","l":"getEntityStream()"},{"p":"jakarta.ws.rs.container","c":"ContainerRequestContext","l":"getEntityStream()"},{"p":"jakarta.ws.rs.container","c":"ContainerResponseContext","l":"getEntityStream()"},{"p":"jakarta.ws.rs.client","c":"ClientResponseContext","l":"getEntityTag()"},{"p":"jakarta.ws.rs.container","c":"ContainerResponseContext","l":"getEntityTag()"},{"p":"jakarta.ws.rs.core","c":"Response","l":"getEntityTag()"},{"p":"jakarta.ws.rs.client","c":"ClientRequestContext","l":"getEntityType()"},{"p":"jakarta.ws.rs.container","c":"ContainerResponseContext","l":"getEntityType()"},{"p":"jakarta.ws.rs.ext","c":"Providers","l":"getExceptionMapper(Class)","u":"getExceptionMapper(java.lang.Class)"},{"p":"jakarta.ws.rs.core","c":"NewCookie","l":"getExpiry()"},{"p":"jakarta.ws.rs.core","c":"Response.Status","l":"getFamily()"},{"p":"jakarta.ws.rs.core","c":"Response.StatusType","l":"getFamily()"},{"p":"jakarta.ws.rs.core","c":"EntityPart","l":"getFileName()"},{"p":"jakarta.ws.rs.core","c":"AbstractMultivaluedMap","l":"getFirst(K)"},{"p":"jakarta.ws.rs.core","c":"MultivaluedMap","l":"getFirst(K)"},{"p":"jakarta.ws.rs.ext","c":"InterceptorContext","l":"getGenericType()"},{"p":"jakarta.ws.rs.sse","c":"OutboundSseEvent","l":"getGenericType()"},{"p":"jakarta.ws.rs.client","c":"ClientRequestContext","l":"getHeaders()"},{"p":"jakarta.ws.rs.client","c":"ClientResponseContext","l":"getHeaders()"},{"p":"jakarta.ws.rs.container","c":"ContainerRequestContext","l":"getHeaders()"},{"p":"jakarta.ws.rs.container","c":"ContainerResponseContext","l":"getHeaders()"},{"p":"jakarta.ws.rs.core","c":"EntityPart","l":"getHeaders()"},{"p":"jakarta.ws.rs.core","c":"Response","l":"getHeaders()"},{"p":"jakarta.ws.rs.ext","c":"ReaderInterceptorContext","l":"getHeaders()"},{"p":"jakarta.ws.rs.ext","c":"WriterInterceptorContext","l":"getHeaders()"},{"p":"jakarta.ws.rs.client","c":"ClientRequestContext","l":"getHeaderString(String)","u":"getHeaderString(java.lang.String)"},{"p":"jakarta.ws.rs.client","c":"ClientResponseContext","l":"getHeaderString(String)","u":"getHeaderString(java.lang.String)"},{"p":"jakarta.ws.rs.container","c":"ContainerRequestContext","l":"getHeaderString(String)","u":"getHeaderString(java.lang.String)"},{"p":"jakarta.ws.rs.container","c":"ContainerResponseContext","l":"getHeaderString(String)","u":"getHeaderString(java.lang.String)"},{"p":"jakarta.ws.rs.core","c":"HttpHeaders","l":"getHeaderString(String)","u":"getHeaderString(java.lang.String)"},{"p":"jakarta.ws.rs.core","c":"Response","l":"getHeaderString(String)","u":"getHeaderString(java.lang.String)"},{"p":"jakarta.ws.rs.client","c":"Client","l":"getHostnameVerifier()"},{"p":"jakarta.ws.rs.sse","c":"SseEvent","l":"getId()"},{"p":"jakarta.ws.rs.ext","c":"ReaderInterceptorContext","l":"getInputStream()"},{"p":"jakarta.ws.rs.ext","c":"RuntimeDelegate","l":"getInstance()"},{"p":"jakarta.ws.rs.core","c":"Configuration","l":"getInstances()"},{"p":"jakarta.ws.rs.client","c":"ClientRequestContext","l":"getLanguage()"},{"p":"jakarta.ws.rs.client","c":"ClientResponseContext","l":"getLanguage()"},{"p":"jakarta.ws.rs.client","c":"Entity","l":"getLanguage()"},{"p":"jakarta.ws.rs.container","c":"ContainerRequestContext","l":"getLanguage()"},{"p":"jakarta.ws.rs.container","c":"ContainerResponseContext","l":"getLanguage()"},{"p":"jakarta.ws.rs.core","c":"HttpHeaders","l":"getLanguage()"},{"p":"jakarta.ws.rs.core","c":"Response","l":"getLanguage()"},{"p":"jakarta.ws.rs.core","c":"Variant","l":"getLanguage()"},{"p":"jakarta.ws.rs.core","c":"Variant","l":"getLanguageString()"},{"p":"jakarta.ws.rs.client","c":"ClientResponseContext","l":"getLastModified()"},{"p":"jakarta.ws.rs.container","c":"ContainerResponseContext","l":"getLastModified()"},{"p":"jakarta.ws.rs.core","c":"Response","l":"getLastModified()"},{"p":"jakarta.ws.rs.client","c":"ClientResponseContext","l":"getLength()"},{"p":"jakarta.ws.rs.container","c":"ContainerRequestContext","l":"getLength()"},{"p":"jakarta.ws.rs.container","c":"ContainerResponseContext","l":"getLength()"},{"p":"jakarta.ws.rs.core","c":"HttpHeaders","l":"getLength()"},{"p":"jakarta.ws.rs.core","c":"Response","l":"getLength()"},{"p":"jakarta.ws.rs.client","c":"ClientResponseContext","l":"getLink(String)","u":"getLink(java.lang.String)"},{"p":"jakarta.ws.rs.container","c":"ContainerResponseContext","l":"getLink(String)","u":"getLink(java.lang.String)"},{"p":"jakarta.ws.rs.core","c":"Response","l":"getLink(String)","u":"getLink(java.lang.String)"},{"p":"jakarta.ws.rs.client","c":"ClientResponseContext","l":"getLinkBuilder(String)","u":"getLinkBuilder(java.lang.String)"},{"p":"jakarta.ws.rs.container","c":"ContainerResponseContext","l":"getLinkBuilder(String)","u":"getLinkBuilder(java.lang.String)"},{"p":"jakarta.ws.rs.core","c":"Response","l":"getLinkBuilder(String)","u":"getLinkBuilder(java.lang.String)"},{"p":"jakarta.ws.rs.client","c":"ClientResponseContext","l":"getLinks()"},{"p":"jakarta.ws.rs.container","c":"ContainerResponseContext","l":"getLinks()"},{"p":"jakarta.ws.rs.core","c":"Response","l":"getLinks()"},{"p":"jakarta.ws.rs.client","c":"ClientResponseContext","l":"getLocation()"},{"p":"jakarta.ws.rs.container","c":"ContainerResponseContext","l":"getLocation()"},{"p":"jakarta.ws.rs.core","c":"Response","l":"getLocation()"},{"p":"jakarta.ws.rs","c":"RedirectionException","l":"getLocation()"},{"p":"jakarta.ws.rs.core","c":"UriInfo","l":"getMatchedResources()"},{"p":"jakarta.ws.rs.core","c":"UriInfo","l":"getMatchedResourceTemplate()"},{"p":"jakarta.ws.rs.core","c":"UriInfo","l":"getMatchedURIs()"},{"p":"jakarta.ws.rs.core","c":"UriInfo","l":"getMatchedURIs(boolean)"},{"p":"jakarta.ws.rs.core","c":"PathSegment","l":"getMatrixParameters()"},{"p":"jakarta.ws.rs.core","c":"CacheControl","l":"getMaxAge()"},{"p":"jakarta.ws.rs.core","c":"NewCookie","l":"getMaxAge()"},{"p":"jakarta.ws.rs.client","c":"ClientRequestContext","l":"getMediaType()"},{"p":"jakarta.ws.rs.client","c":"ClientResponseContext","l":"getMediaType()"},{"p":"jakarta.ws.rs.client","c":"Entity","l":"getMediaType()"},{"p":"jakarta.ws.rs.container","c":"ContainerRequestContext","l":"getMediaType()"},{"p":"jakarta.ws.rs.container","c":"ContainerResponseContext","l":"getMediaType()"},{"p":"jakarta.ws.rs.core","c":"EntityPart","l":"getMediaType()"},{"p":"jakarta.ws.rs.core","c":"HttpHeaders","l":"getMediaType()"},{"p":"jakarta.ws.rs.core","c":"Response","l":"getMediaType()"},{"p":"jakarta.ws.rs.core","c":"Variant","l":"getMediaType()"},{"p":"jakarta.ws.rs.ext","c":"InterceptorContext","l":"getMediaType()"},{"p":"jakarta.ws.rs.sse","c":"OutboundSseEvent","l":"getMediaType()"},{"p":"jakarta.ws.rs.ext","c":"Providers","l":"getMessageBodyReader(Class, Type, Annotation[], MediaType)","u":"getMessageBodyReader(java.lang.Class,java.lang.reflect.Type,java.lang.annotation.Annotation[],jakarta.ws.rs.core.MediaType)"},{"p":"jakarta.ws.rs.ext","c":"Providers","l":"getMessageBodyWriter(Class, Type, Annotation[], MediaType)","u":"getMessageBodyWriter(java.lang.Class,java.lang.reflect.Type,java.lang.annotation.Annotation[],jakarta.ws.rs.core.MediaType)"},{"p":"jakarta.ws.rs.core","c":"Response","l":"getMetadata()"},{"p":"jakarta.ws.rs.client","c":"ClientRequestContext","l":"getMethod()"},{"p":"jakarta.ws.rs.container","c":"ContainerRequestContext","l":"getMethod()"},{"p":"jakarta.ws.rs.core","c":"Request","l":"getMethod()"},{"p":"jakarta.ws.rs.core","c":"Cookie","l":"getName()"},{"p":"jakarta.ws.rs.core","c":"EntityPart","l":"getName()"},{"p":"jakarta.ws.rs.sse","c":"SseEvent","l":"getName()"},{"p":"jakarta.ws.rs.core","c":"CacheControl","l":"getNoCacheFields()"},{"p":"jakarta.ws.rs.ext","c":"WriterInterceptorContext","l":"getOutputStream()"},{"p":"jakarta.ws.rs.core","c":"MediaType","l":"getParameters()"},{"p":"jakarta.ws.rs.core","c":"Link","l":"getParams()"},{"p":"jakarta.ws.rs.core","c":"Cookie","l":"getPath()"},{"p":"jakarta.ws.rs.core","c":"PathSegment","l":"getPath()"},{"p":"jakarta.ws.rs.core","c":"UriInfo","l":"getPath()"},{"p":"jakarta.ws.rs.core","c":"UriInfo","l":"getPath(boolean)"},{"p":"jakarta.ws.rs.core","c":"UriInfo","l":"getPathParameters()"},{"p":"jakarta.ws.rs.core","c":"UriInfo","l":"getPathParameters(boolean)"},{"p":"jakarta.ws.rs.core","c":"UriInfo","l":"getPathSegments()"},{"p":"jakarta.ws.rs.core","c":"UriInfo","l":"getPathSegments(boolean)"},{"p":"jakarta.ws.rs.core","c":"CacheControl","l":"getPrivateFields()"},{"p":"jakarta.ws.rs.core","c":"Application","l":"getProperties()"},{"p":"jakarta.ws.rs.core","c":"Configuration","l":"getProperties()"},{"p":"jakarta.ws.rs.client","c":"ClientRequestContext","l":"getProperty(String)","u":"getProperty(java.lang.String)"},{"p":"jakarta.ws.rs.container","c":"ContainerRequestContext","l":"getProperty(String)","u":"getProperty(java.lang.String)"},{"p":"jakarta.ws.rs.core","c":"Configuration","l":"getProperty(String)","u":"getProperty(java.lang.String)"},{"p":"jakarta.ws.rs.ext","c":"InterceptorContext","l":"getProperty(String)","u":"getProperty(java.lang.String)"},{"p":"jakarta.ws.rs.client","c":"ClientRequestContext","l":"getPropertyNames()"},{"p":"jakarta.ws.rs.container","c":"ContainerRequestContext","l":"getPropertyNames()"},{"p":"jakarta.ws.rs.core","c":"Configuration","l":"getPropertyNames()"},{"p":"jakarta.ws.rs.ext","c":"InterceptorContext","l":"getPropertyNames()"},{"p":"jakarta.ws.rs.core","c":"UriInfo","l":"getQueryParameters()"},{"p":"jakarta.ws.rs.core","c":"UriInfo","l":"getQueryParameters(boolean)"},{"p":"jakarta.ws.rs.core","c":"GenericEntity","l":"getRawType()"},{"p":"jakarta.ws.rs.core","c":"GenericType","l":"getRawType()"},{"p":"jakarta.ws.rs.core","c":"Response.Status","l":"getReasonPhrase()"},{"p":"jakarta.ws.rs.core","c":"Response.StatusType","l":"getReasonPhrase()"},{"p":"jakarta.ws.rs.sse","c":"SseEvent","l":"getReconnectDelay()"},{"p":"jakarta.ws.rs.core","c":"Link","l":"getRel()"},{"p":"jakarta.ws.rs.core","c":"Link","l":"getRels()"},{"p":"jakarta.ws.rs.container","c":"ContainerRequestContext","l":"getRequest()"},{"p":"jakarta.ws.rs.core","c":"HttpHeaders","l":"getRequestHeader(String)","u":"getRequestHeader(java.lang.String)"},{"p":"jakarta.ws.rs.core","c":"HttpHeaders","l":"getRequestHeaders()"},{"p":"jakarta.ws.rs.core","c":"UriInfo","l":"getRequestUri()"},{"p":"jakarta.ws.rs.core","c":"UriInfo","l":"getRequestUriBuilder()"},{"p":"jakarta.ws.rs.container","c":"ResourceContext","l":"getResource(Class)","u":"getResource(java.lang.Class)"},{"p":"jakarta.ws.rs.container","c":"ResourceInfo","l":"getResourceClass()"},{"p":"jakarta.ws.rs.container","c":"ResourceInfo","l":"getResourceMethod()"},{"p":"jakarta.ws.rs.client","c":"ResponseProcessingException","l":"getResponse()"},{"p":"jakarta.ws.rs","c":"WebApplicationException","l":"getResponse()"},{"p":"jakarta.ws.rs","c":"ServiceUnavailableException","l":"getRetryTime(Date)","u":"getRetryTime(java.util.Date)"},{"p":"jakarta.ws.rs.core","c":"Configuration","l":"getRuntimeType()"},{"p":"jakarta.ws.rs.client","c":"RxInvokerProvider","l":"getRxInvoker(SyncInvoker, ExecutorService)","u":"getRxInvoker(jakarta.ws.rs.client.SyncInvoker,java.util.concurrent.ExecutorService)"},{"p":"jakarta.ws.rs.core","c":"NewCookie","l":"getSameSite()"},{"p":"jakarta.ws.rs.container","c":"ContainerRequestContext","l":"getSecurityContext()"},{"p":"jakarta.ws.rs.core","c":"Application","l":"getSingletons()"},{"p":"jakarta.ws.rs.ext","c":"MessageBodyWriter","l":"getSize(T, Class, Type, Annotation[], MediaType)","u":"getSize(T,java.lang.Class,java.lang.reflect.Type,java.lang.annotation.Annotation[],jakarta.ws.rs.core.MediaType)"},{"p":"jakarta.ws.rs.core","c":"CacheControl","l":"getSMaxAge()"},{"p":"jakarta.ws.rs.client","c":"Client","l":"getSslContext()"},{"p":"jakarta.ws.rs.client","c":"ClientResponseContext","l":"getStatus()"},{"p":"jakarta.ws.rs.container","c":"ContainerResponseContext","l":"getStatus()"},{"p":"jakarta.ws.rs.core","c":"Response","l":"getStatus()"},{"p":"jakarta.ws.rs.core","c":"Response.Status","l":"getStatusCode()"},{"p":"jakarta.ws.rs.core","c":"Response.StatusType","l":"getStatusCode()"},{"p":"jakarta.ws.rs.client","c":"ClientResponseContext","l":"getStatusInfo()"},{"p":"jakarta.ws.rs.container","c":"ContainerResponseContext","l":"getStatusInfo()"},{"p":"jakarta.ws.rs.core","c":"Response","l":"getStatusInfo()"},{"p":"jakarta.ws.rs.client","c":"ClientRequestContext","l":"getStringHeaders()"},{"p":"jakarta.ws.rs.container","c":"ContainerResponseContext","l":"getStringHeaders()"},{"p":"jakarta.ws.rs.core","c":"Response","l":"getStringHeaders()"},{"p":"jakarta.ws.rs.core","c":"MediaType","l":"getSubtype()"},{"p":"jakarta.ws.rs.core","c":"Link","l":"getTitle()"},{"p":"jakarta.ws.rs.core","c":"GenericEntity","l":"getType()"},{"p":"jakarta.ws.rs.core","c":"GenericType","l":"getType()"},{"p":"jakarta.ws.rs.core","c":"Link","l":"getType()"},{"p":"jakarta.ws.rs.core","c":"MediaType","l":"getType()"},{"p":"jakarta.ws.rs.ext","c":"InterceptorContext","l":"getType()"},{"p":"jakarta.ws.rs.sse","c":"OutboundSseEvent","l":"getType()"},{"p":"jakarta.ws.rs.client","c":"ClientRequestContext","l":"getUri()"},{"p":"jakarta.ws.rs.client","c":"WebTarget","l":"getUri()"},{"p":"jakarta.ws.rs.core","c":"Link","l":"getUri()"},{"p":"jakarta.ws.rs.client","c":"WebTarget","l":"getUriBuilder()"},{"p":"jakarta.ws.rs.core","c":"Link","l":"getUriBuilder()"},{"p":"jakarta.ws.rs.container","c":"ContainerRequestContext","l":"getUriInfo()"},{"p":"jakarta.ws.rs.core","c":"SecurityContext","l":"getUserPrincipal()"},{"p":"jakarta.ws.rs.core","c":"Cookie","l":"getValue()"},{"p":"jakarta.ws.rs.core","c":"EntityTag","l":"getValue()"},{"p":"jakarta.ws.rs.core","c":"AbstractMultivaluedMap","l":"getValues(K)"},{"p":"jakarta.ws.rs.client","c":"Entity","l":"getVariant()"},{"p":"jakarta.ws.rs.core","c":"Cookie","l":"getVersion()"},{"p":"jakarta.ws.rs.core","c":"Response.Status","l":"GONE"},{"p":"jakarta.ws.rs.container","c":"TimeoutHandler","l":"handleTimeout(AsyncResponse)","u":"handleTimeout(jakarta.ws.rs.container.AsyncResponse)"},{"p":"jakarta.ws.rs.client","c":"ClientRequestContext","l":"hasEntity()"},{"p":"jakarta.ws.rs.client","c":"ClientResponseContext","l":"hasEntity()"},{"p":"jakarta.ws.rs.container","c":"ContainerRequestContext","l":"hasEntity()"},{"p":"jakarta.ws.rs.container","c":"ContainerResponseContext","l":"hasEntity()"},{"p":"jakarta.ws.rs.core","c":"Response","l":"hasEntity()"},{"p":"jakarta.ws.rs.client","c":"Entity","l":"hashCode()"},{"p":"jakarta.ws.rs.core","c":"AbstractMultivaluedMap","l":"hashCode()"},{"p":"jakarta.ws.rs.core","c":"CacheControl","l":"hashCode()"},{"p":"jakarta.ws.rs.core","c":"Cookie","l":"hashCode()"},{"p":"jakarta.ws.rs.core","c":"EntityTag","l":"hashCode()"},{"p":"jakarta.ws.rs.core","c":"GenericEntity","l":"hashCode()"},{"p":"jakarta.ws.rs.core","c":"GenericType","l":"hashCode()"},{"p":"jakarta.ws.rs.core","c":"MediaType","l":"hashCode()"},{"p":"jakarta.ws.rs.core","c":"NewCookie","l":"hashCode()"},{"p":"jakarta.ws.rs.core","c":"Variant","l":"hashCode()"},{"p":"jakarta.ws.rs.client","c":"ClientResponseContext","l":"hasLink(String)","u":"hasLink(java.lang.String)"},{"p":"jakarta.ws.rs.container","c":"ContainerResponseContext","l":"hasLink(String)","u":"hasLink(java.lang.String)"},{"p":"jakarta.ws.rs.core","c":"Response","l":"hasLink(String)","u":"hasLink(java.lang.String)"},{"p":"jakarta.ws.rs.client","c":"ClientRequestContext","l":"hasProperty(String)","u":"hasProperty(java.lang.String)"},{"p":"jakarta.ws.rs.container","c":"ContainerRequestContext","l":"hasProperty(String)","u":"hasProperty(java.lang.String)"},{"p":"jakarta.ws.rs.core","c":"Configuration","l":"hasProperty(String)","u":"hasProperty(java.lang.String)"},{"p":"jakarta.ws.rs.ext","c":"InterceptorContext","l":"hasProperty(String)","u":"hasProperty(java.lang.String)"},{"p":"jakarta.ws.rs","c":"SeBootstrap.Configuration","l":"hasProperty(String)","u":"hasProperty(java.lang.String)"},{"p":"jakarta.ws.rs","c":"ServiceUnavailableException","l":"hasRetryAfter()"},{"p":"jakarta.ws.rs","c":"HttpMethod","l":"HEAD"},{"p":"jakarta.ws.rs.client","c":"AsyncInvoker","l":"head()"},{"p":"jakarta.ws.rs.client","c":"CompletionStageRxInvoker","l":"head()"},{"p":"jakarta.ws.rs.client","c":"RxInvoker","l":"head()"},{"p":"jakarta.ws.rs.client","c":"SyncInvoker","l":"head()"},{"p":"jakarta.ws.rs.client","c":"AsyncInvoker","l":"head(InvocationCallback)","u":"head(jakarta.ws.rs.client.InvocationCallback)"},{"p":"jakarta.ws.rs","c":"Priorities","l":"HEADER_DECORATOR"},{"p":"jakarta.ws.rs.client","c":"Invocation.Builder","l":"header(String, Object)","u":"header(java.lang.String,java.lang.Object)"},{"p":"jakarta.ws.rs.core","c":"Response.ResponseBuilder","l":"header(String, Object)","u":"header(java.lang.String,java.lang.Object)"},{"p":"jakarta.ws.rs.core","c":"EntityPart.Builder","l":"header(String, String...)","u":"header(java.lang.String,java.lang.String...)"},{"p":"jakarta.ws.rs.client","c":"Invocation.Builder","l":"headers(MultivaluedMap)","u":"headers(jakarta.ws.rs.core.MultivaluedMap)"},{"p":"jakarta.ws.rs.core","c":"EntityPart.Builder","l":"headers(MultivaluedMap)","u":"headers(jakarta.ws.rs.core.MultivaluedMap)"},{"p":"jakarta.ws.rs.core","c":"HttpHeaders","l":"HOST"},{"p":"jakarta.ws.rs","c":"SeBootstrap.Configuration","l":"HOST"},{"p":"jakarta.ws.rs","c":"SeBootstrap.Configuration","l":"host()"},{"p":"jakarta.ws.rs.core","c":"UriBuilder","l":"host(String)","u":"host(java.lang.String)"},{"p":"jakarta.ws.rs","c":"SeBootstrap.Configuration.Builder","l":"host(String)","u":"host(java.lang.String)"},{"p":"jakarta.ws.rs.client","c":"ClientBuilder","l":"hostnameVerifier(HostnameVerifier)","u":"hostnameVerifier(javax.net.ssl.HostnameVerifier)"},{"p":"jakarta.ws.rs.client","c":"Entity","l":"html(T)"},{"p":"jakarta.ws.rs.core","c":"Response.Status","l":"HTTP_VERSION_NOT_SUPPORTED"},{"p":"jakarta.ws.rs.core","c":"NewCookie.AbstractNewCookieBuilder","l":"httpOnly(boolean)"},{"p":"jakarta.ws.rs.sse","c":"OutboundSseEvent.Builder","l":"id(String)","u":"id(java.lang.String)"},{"p":"jakarta.ws.rs.core","c":"HttpHeaders","l":"IF_MATCH"},{"p":"jakarta.ws.rs.core","c":"HttpHeaders","l":"IF_MODIFIED_SINCE"},{"p":"jakarta.ws.rs.core","c":"HttpHeaders","l":"IF_NONE_MATCH"},{"p":"jakarta.ws.rs.core","c":"HttpHeaders","l":"IF_UNMODIFIED_SINCE"},{"p":"jakarta.ws.rs.core","c":"Response.Status.Family","l":"INFORMATIONAL"},{"p":"jakarta.ws.rs.container","c":"ResourceContext","l":"initResource(T)"},{"p":"jakarta.ws.rs.core","c":"Response.Status","l":"INTERNAL_SERVER_ERROR"},{"p":"jakarta.ws.rs","c":"InternalServerErrorException","l":"InternalServerErrorException()","u":"%3Cinit%3E()"},{"p":"jakarta.ws.rs","c":"InternalServerErrorException","l":"InternalServerErrorException(Response)","u":"%3Cinit%3E(jakarta.ws.rs.core.Response)"},{"p":"jakarta.ws.rs","c":"InternalServerErrorException","l":"InternalServerErrorException(Response, Throwable)","u":"%3Cinit%3E(jakarta.ws.rs.core.Response,java.lang.Throwable)"},{"p":"jakarta.ws.rs","c":"InternalServerErrorException","l":"InternalServerErrorException(String)","u":"%3Cinit%3E(java.lang.String)"},{"p":"jakarta.ws.rs","c":"InternalServerErrorException","l":"InternalServerErrorException(String, Response)","u":"%3Cinit%3E(java.lang.String,jakarta.ws.rs.core.Response)"},{"p":"jakarta.ws.rs","c":"InternalServerErrorException","l":"InternalServerErrorException(String, Response, Throwable)","u":"%3Cinit%3E(java.lang.String,jakarta.ws.rs.core.Response,java.lang.Throwable)"},{"p":"jakarta.ws.rs","c":"InternalServerErrorException","l":"InternalServerErrorException(String, Throwable)","u":"%3Cinit%3E(java.lang.String,java.lang.Throwable)"},{"p":"jakarta.ws.rs","c":"InternalServerErrorException","l":"InternalServerErrorException(Throwable)","u":"%3Cinit%3E(java.lang.Throwable)"},{"p":"jakarta.ws.rs.client","c":"Client","l":"invocation(Link)","u":"invocation(jakarta.ws.rs.core.Link)"},{"p":"jakarta.ws.rs.client","c":"Invocation","l":"invoke()"},{"p":"jakarta.ws.rs.client","c":"Invocation","l":"invoke(Class)","u":"invoke(java.lang.Class)"},{"p":"jakarta.ws.rs.client","c":"Invocation","l":"invoke(GenericType)","u":"invoke(jakarta.ws.rs.core.GenericType)"},{"p":"jakarta.ws.rs.container","c":"AsyncResponse","l":"isCancelled()"},{"p":"jakarta.ws.rs.core","c":"Response","l":"isClosed()"},{"p":"jakarta.ws.rs.sse","c":"SseEventSink","l":"isClosed()"},{"p":"jakarta.ws.rs.core","c":"MediaType","l":"isCompatible(MediaType)","u":"isCompatible(jakarta.ws.rs.core.MediaType)"},{"p":"jakarta.ws.rs.container","c":"AsyncResponse","l":"isDone()"},{"p":"jakarta.ws.rs.core","c":"AbstractMultivaluedMap","l":"isEmpty()"},{"p":"jakarta.ws.rs.sse","c":"InboundSseEvent","l":"isEmpty()"},{"p":"jakarta.ws.rs.core","c":"Configuration","l":"isEnabled(Class)","u":"isEnabled(java.lang.Class)"},{"p":"jakarta.ws.rs.core","c":"Configuration","l":"isEnabled(Feature)","u":"isEnabled(jakarta.ws.rs.core.Feature)"},{"p":"jakarta.ws.rs.core","c":"NewCookie","l":"isHttpOnly()"},{"p":"jakarta.ws.rs.core","c":"CacheControl","l":"isMustRevalidate()"},{"p":"jakarta.ws.rs.core","c":"CacheControl","l":"isNoCache()"},{"p":"jakarta.ws.rs.core","c":"CacheControl","l":"isNoStore()"},{"p":"jakarta.ws.rs.core","c":"CacheControl","l":"isNoTransform()"},{"p":"jakarta.ws.rs.sse","c":"SseEventSource","l":"isOpen()"},{"p":"jakarta.ws.rs.core","c":"CacheControl","l":"isPrivate()"},{"p":"jakarta.ws.rs.client","c":"RxInvokerProvider","l":"isProviderFor(Class)","u":"isProviderFor(java.lang.Class)"},{"p":"jakarta.ws.rs.core","c":"CacheControl","l":"isProxyRevalidate()"},{"p":"jakarta.ws.rs.ext","c":"MessageBodyReader","l":"isReadable(Class, Type, Annotation[], MediaType)","u":"isReadable(java.lang.Class,java.lang.reflect.Type,java.lang.annotation.Annotation[],jakarta.ws.rs.core.MediaType)"},{"p":"jakarta.ws.rs.sse","c":"SseEvent","l":"isReconnectDelaySet()"},{"p":"jakarta.ws.rs.core","c":"Configuration","l":"isRegistered(Class)","u":"isRegistered(java.lang.Class)"},{"p":"jakarta.ws.rs.core","c":"Configuration","l":"isRegistered(Object)","u":"isRegistered(java.lang.Object)"},{"p":"jakarta.ws.rs.core","c":"NewCookie","l":"isSecure()"},{"p":"jakarta.ws.rs.core","c":"SecurityContext","l":"isSecure()"},{"p":"jakarta.ws.rs.container","c":"AsyncResponse","l":"isSuspended()"},{"p":"jakarta.ws.rs.core","c":"SecurityContext","l":"isUserInRole(String)","u":"isUserInRole(java.lang.String)"},{"p":"jakarta.ws.rs.core","c":"EntityTag","l":"isWeak()"},{"p":"jakarta.ws.rs.core","c":"MediaType","l":"isWildcardSubtype()"},{"p":"jakarta.ws.rs.core","c":"MediaType","l":"isWildcardType()"},{"p":"jakarta.ws.rs.ext","c":"MessageBodyWriter","l":"isWriteable(Class, Type, Annotation[], MediaType)","u":"isWriteable(java.lang.Class,java.lang.reflect.Type,java.lang.annotation.Annotation[],jakarta.ws.rs.core.MediaType)"},{"p":"jakarta.ws.rs.client","c":"ClientBuilder","l":"JAXRS_DEFAULT_CLIENT_BUILDER_PROPERTY"},{"p":"jakarta.ws.rs.sse","c":"SseEventSource.Builder","l":"JAXRS_DEFAULT_SSE_BUILDER_PROPERTY"},{"p":"jakarta.ws.rs.ext","c":"RuntimeDelegate","l":"JAXRS_RUNTIME_DELEGATE_PROPERTY"},{"p":"jakarta.ws.rs.client","c":"Entity","l":"json(T)"},{"p":"jakarta.ws.rs.core","c":"AbstractMultivaluedMap","l":"keySet()"},{"p":"jakarta.ws.rs.client","c":"ClientBuilder","l":"keyStore(KeyStore, char[])","u":"keyStore(java.security.KeyStore,char[])"},{"p":"jakarta.ws.rs.client","c":"ClientBuilder","l":"keyStore(KeyStore, String)","u":"keyStore(java.security.KeyStore,java.lang.String)"},{"p":"jakarta.ws.rs.core","c":"Response.ResponseBuilder","l":"language(Locale)","u":"language(java.util.Locale)"},{"p":"jakarta.ws.rs.core","c":"Response.ResponseBuilder","l":"language(String)","u":"language(java.lang.String)"},{"p":"jakarta.ws.rs.core","c":"Variant","l":"languages(Locale...)","u":"languages(java.util.Locale...)"},{"p":"jakarta.ws.rs.core","c":"Variant.VariantListBuilder","l":"languages(Locale...)","u":"languages(java.util.Locale...)"},{"p":"jakarta.ws.rs.core","c":"HttpHeaders","l":"LAST_EVENT_ID_HEADER"},{"p":"jakarta.ws.rs.core","c":"HttpHeaders","l":"LAST_MODIFIED"},{"p":"jakarta.ws.rs.core","c":"Response.ResponseBuilder","l":"lastModified(Date)","u":"lastModified(java.util.Date)"},{"p":"jakarta.ws.rs.core","c":"NewCookie.SameSite","l":"LAX"},{"p":"jakarta.ws.rs.core","c":"Response.Status","l":"LENGTH_REQUIRED"},{"p":"jakarta.ws.rs.core","c":"HttpHeaders","l":"LINK"},{"p":"jakarta.ws.rs.core","c":"Link","l":"Link()","u":"%3Cinit%3E()"},{"p":"jakarta.ws.rs.core","c":"Link.Builder","l":"link(Link)","u":"link(jakarta.ws.rs.core.Link)"},{"p":"jakarta.ws.rs.core","c":"Link.Builder","l":"link(String)","u":"link(java.lang.String)"},{"p":"jakarta.ws.rs.core","c":"Response.ResponseBuilder","l":"link(String, String)","u":"link(java.lang.String,java.lang.String)"},{"p":"jakarta.ws.rs.core","c":"Response.ResponseBuilder","l":"link(URI, String)","u":"link(java.net.URI,java.lang.String)"},{"p":"jakarta.ws.rs.core","c":"Response.ResponseBuilder","l":"links(Link...)","u":"links(jakarta.ws.rs.core.Link...)"},{"p":"jakarta.ws.rs.core","c":"HttpHeaders","l":"LOCATION"},{"p":"jakarta.ws.rs.core","c":"Response.ResponseBuilder","l":"location(URI)","u":"location(java.net.URI)"},{"p":"jakarta.ws.rs","c":"SeBootstrap.Configuration.SSLClientAuthentication","l":"MANDATORY"},{"p":"jakarta.ws.rs.client","c":"WebTarget","l":"matrixParam(String, Object...)","u":"matrixParam(java.lang.String,java.lang.Object...)"},{"p":"jakarta.ws.rs.core","c":"UriBuilder","l":"matrixParam(String, Object...)","u":"matrixParam(java.lang.String,java.lang.Object...)"},{"p":"jakarta.ws.rs.core","c":"NewCookie.AbstractNewCookieBuilder","l":"maxAge(int)"},{"p":"jakarta.ws.rs.core","c":"MediaType","l":"MEDIA_TYPE_WILDCARD"},{"p":"jakarta.ws.rs.core","c":"MediaType","l":"MediaType()","u":"%3Cinit%3E()"},{"p":"jakarta.ws.rs.core","c":"EntityPart.Builder","l":"mediaType(MediaType)","u":"mediaType(jakarta.ws.rs.core.MediaType)"},{"p":"jakarta.ws.rs.sse","c":"OutboundSseEvent.Builder","l":"mediaType(MediaType)","u":"mediaType(jakarta.ws.rs.core.MediaType)"},{"p":"jakarta.ws.rs.core","c":"EntityPart.Builder","l":"mediaType(String)","u":"mediaType(java.lang.String)"},{"p":"jakarta.ws.rs.core","c":"MediaType","l":"MediaType(String, String)","u":"%3Cinit%3E(java.lang.String,java.lang.String)"},{"p":"jakarta.ws.rs.core","c":"MediaType","l":"MediaType(String, String, Map)","u":"%3Cinit%3E(java.lang.String,java.lang.String,java.util.Map)"},{"p":"jakarta.ws.rs.core","c":"MediaType","l":"MediaType(String, String, String)","u":"%3Cinit%3E(java.lang.String,java.lang.String,java.lang.String)"},{"p":"jakarta.ws.rs.core","c":"Variant","l":"mediaTypes(MediaType...)","u":"mediaTypes(jakarta.ws.rs.core.MediaType...)"},{"p":"jakarta.ws.rs.core","c":"Variant.VariantListBuilder","l":"mediaTypes(MediaType...)","u":"mediaTypes(jakarta.ws.rs.core.MediaType...)"},{"p":"jakarta.ws.rs.core","c":"Response.Status","l":"METHOD_NOT_ALLOWED"},{"p":"jakarta.ws.rs.client","c":"AsyncInvoker","l":"method(String)","u":"method(java.lang.String)"},{"p":"jakarta.ws.rs.client","c":"CompletionStageRxInvoker","l":"method(String)","u":"method(java.lang.String)"},{"p":"jakarta.ws.rs.client","c":"RxInvoker","l":"method(String)","u":"method(java.lang.String)"},{"p":"jakarta.ws.rs.client","c":"SyncInvoker","l":"method(String)","u":"method(java.lang.String)"},{"p":"jakarta.ws.rs.client","c":"RxInvoker","l":"method(String, Class)","u":"method(java.lang.String,java.lang.Class)"},{"p":"jakarta.ws.rs.client","c":"AsyncInvoker","l":"method(String, Class)","u":"method(java.lang.String,java.lang.Class)"},{"p":"jakarta.ws.rs.client","c":"CompletionStageRxInvoker","l":"method(String, Class)","u":"method(java.lang.String,java.lang.Class)"},{"p":"jakarta.ws.rs.client","c":"SyncInvoker","l":"method(String, Class)","u":"method(java.lang.String,java.lang.Class)"},{"p":"jakarta.ws.rs.client","c":"AsyncInvoker","l":"method(String, Entity)","u":"method(java.lang.String,jakarta.ws.rs.client.Entity)"},{"p":"jakarta.ws.rs.client","c":"CompletionStageRxInvoker","l":"method(String, Entity)","u":"method(java.lang.String,jakarta.ws.rs.client.Entity)"},{"p":"jakarta.ws.rs.client","c":"RxInvoker","l":"method(String, Entity)","u":"method(java.lang.String,jakarta.ws.rs.client.Entity)"},{"p":"jakarta.ws.rs.client","c":"SyncInvoker","l":"method(String, Entity)","u":"method(java.lang.String,jakarta.ws.rs.client.Entity)"},{"p":"jakarta.ws.rs.client","c":"RxInvoker","l":"method(String, Entity, Class)","u":"method(java.lang.String,jakarta.ws.rs.client.Entity,java.lang.Class)"},{"p":"jakarta.ws.rs.client","c":"AsyncInvoker","l":"method(String, Entity, Class)","u":"method(java.lang.String,jakarta.ws.rs.client.Entity,java.lang.Class)"},{"p":"jakarta.ws.rs.client","c":"CompletionStageRxInvoker","l":"method(String, Entity, Class)","u":"method(java.lang.String,jakarta.ws.rs.client.Entity,java.lang.Class)"},{"p":"jakarta.ws.rs.client","c":"SyncInvoker","l":"method(String, Entity, Class)","u":"method(java.lang.String,jakarta.ws.rs.client.Entity,java.lang.Class)"},{"p":"jakarta.ws.rs.client","c":"RxInvoker","l":"method(String, Entity, GenericType)","u":"method(java.lang.String,jakarta.ws.rs.client.Entity,jakarta.ws.rs.core.GenericType)"},{"p":"jakarta.ws.rs.client","c":"AsyncInvoker","l":"method(String, Entity, GenericType)","u":"method(java.lang.String,jakarta.ws.rs.client.Entity,jakarta.ws.rs.core.GenericType)"},{"p":"jakarta.ws.rs.client","c":"CompletionStageRxInvoker","l":"method(String, Entity, GenericType)","u":"method(java.lang.String,jakarta.ws.rs.client.Entity,jakarta.ws.rs.core.GenericType)"},{"p":"jakarta.ws.rs.client","c":"SyncInvoker","l":"method(String, Entity, GenericType)","u":"method(java.lang.String,jakarta.ws.rs.client.Entity,jakarta.ws.rs.core.GenericType)"},{"p":"jakarta.ws.rs.client","c":"AsyncInvoker","l":"method(String, Entity, InvocationCallback)","u":"method(java.lang.String,jakarta.ws.rs.client.Entity,jakarta.ws.rs.client.InvocationCallback)"},{"p":"jakarta.ws.rs.client","c":"RxInvoker","l":"method(String, GenericType)","u":"method(java.lang.String,jakarta.ws.rs.core.GenericType)"},{"p":"jakarta.ws.rs.client","c":"AsyncInvoker","l":"method(String, GenericType)","u":"method(java.lang.String,jakarta.ws.rs.core.GenericType)"},{"p":"jakarta.ws.rs.client","c":"CompletionStageRxInvoker","l":"method(String, GenericType)","u":"method(java.lang.String,jakarta.ws.rs.core.GenericType)"},{"p":"jakarta.ws.rs.client","c":"SyncInvoker","l":"method(String, GenericType)","u":"method(java.lang.String,jakarta.ws.rs.core.GenericType)"},{"p":"jakarta.ws.rs.client","c":"AsyncInvoker","l":"method(String, InvocationCallback)","u":"method(java.lang.String,jakarta.ws.rs.client.InvocationCallback)"},{"p":"jakarta.ws.rs.core","c":"Response.Status","l":"MOVED_PERMANENTLY"},{"p":"jakarta.ws.rs.core","c":"MediaType","l":"MULTIPART_FORM_DATA"},{"p":"jakarta.ws.rs.core","c":"MediaType","l":"MULTIPART_FORM_DATA_TYPE"},{"p":"jakarta.ws.rs.core","c":"Response.Status","l":"MULTIPLE_CHOICES"},{"p":"jakarta.ws.rs.core","c":"MultivaluedHashMap","l":"MultivaluedHashMap()","u":"%3Cinit%3E()"},{"p":"jakarta.ws.rs.core","c":"MultivaluedHashMap","l":"MultivaluedHashMap(int)","u":"%3Cinit%3E(int)"},{"p":"jakarta.ws.rs.core","c":"MultivaluedHashMap","l":"MultivaluedHashMap(int, float)","u":"%3Cinit%3E(int,float)"},{"p":"jakarta.ws.rs.core","c":"MultivaluedHashMap","l":"MultivaluedHashMap(Map)","u":"%3Cinit%3E(java.util.Map)"},{"p":"jakarta.ws.rs.core","c":"MultivaluedHashMap","l":"MultivaluedHashMap(MultivaluedMap)","u":"%3Cinit%3E(jakarta.ws.rs.core.MultivaluedMap)"},{"p":"jakarta.ws.rs.sse","c":"OutboundSseEvent.Builder","l":"name(String)","u":"name(java.lang.String)"},{"p":"jakarta.ws.rs.core","c":"Response.Status","l":"NETWORK_AUTHENTICATION_REQUIRED"},{"p":"jakarta.ws.rs.sse","c":"Sse","l":"newBroadcaster()"},{"p":"jakarta.ws.rs.client","c":"ClientBuilder","l":"newBuilder()"},{"p":"jakarta.ws.rs.client","c":"ClientBuilder","l":"newClient()"},{"p":"jakarta.ws.rs.client","c":"ClientBuilder","l":"newClient(Configuration)","u":"newClient(jakarta.ws.rs.core.Configuration)"},{"p":"jakarta.ws.rs.core","c":"NewCookie","l":"NewCookie(Cookie)","u":"%3Cinit%3E(jakarta.ws.rs.core.Cookie)"},{"p":"jakarta.ws.rs.core","c":"NewCookie","l":"NewCookie(Cookie, String, int, boolean)","u":"%3Cinit%3E(jakarta.ws.rs.core.Cookie,java.lang.String,int,boolean)"},{"p":"jakarta.ws.rs.core","c":"NewCookie","l":"NewCookie(Cookie, String, int, Date, boolean, boolean)","u":"%3Cinit%3E(jakarta.ws.rs.core.Cookie,java.lang.String,int,java.util.Date,boolean,boolean)"},{"p":"jakarta.ws.rs.core","c":"NewCookie","l":"NewCookie(Cookie, String, int, Date, boolean, boolean, NewCookie.SameSite)","u":"%3Cinit%3E(jakarta.ws.rs.core.Cookie,java.lang.String,int,java.util.Date,boolean,boolean,jakarta.ws.rs.core.NewCookie.SameSite)"},{"p":"jakarta.ws.rs.core","c":"NewCookie","l":"NewCookie(NewCookie.AbstractNewCookieBuilder)","u":"%3Cinit%3E(jakarta.ws.rs.core.NewCookie.AbstractNewCookieBuilder)"},{"p":"jakarta.ws.rs.core","c":"NewCookie","l":"NewCookie(String, String)","u":"%3Cinit%3E(java.lang.String,java.lang.String)"},{"p":"jakarta.ws.rs.core","c":"NewCookie","l":"NewCookie(String, String, String, String, int, String, int, boolean)","u":"%3Cinit%3E(java.lang.String,java.lang.String,java.lang.String,java.lang.String,int,java.lang.String,int,boolean)"},{"p":"jakarta.ws.rs.core","c":"NewCookie","l":"NewCookie(String, String, String, String, int, String, int, Date, boolean, boolean)","u":"%3Cinit%3E(java.lang.String,java.lang.String,java.lang.String,java.lang.String,int,java.lang.String,int,java.util.Date,boolean,boolean)"},{"p":"jakarta.ws.rs.core","c":"NewCookie","l":"NewCookie(String, String, String, String, int, String, int, Date, boolean, boolean, NewCookie.SameSite)","u":"%3Cinit%3E(java.lang.String,java.lang.String,java.lang.String,java.lang.String,int,java.lang.String,int,java.util.Date,boolean,boolean,jakarta.ws.rs.core.NewCookie.SameSite)"},{"p":"jakarta.ws.rs.core","c":"NewCookie","l":"NewCookie(String, String, String, String, String, int, boolean)","u":"%3Cinit%3E(java.lang.String,java.lang.String,java.lang.String,java.lang.String,java.lang.String,int,boolean)"},{"p":"jakarta.ws.rs.core","c":"NewCookie","l":"NewCookie(String, String, String, String, String, int, boolean, boolean)","u":"%3Cinit%3E(java.lang.String,java.lang.String,java.lang.String,java.lang.String,java.lang.String,int,boolean,boolean)"},{"p":"jakarta.ws.rs.sse","c":"Sse","l":"newEvent(String)","u":"newEvent(java.lang.String)"},{"p":"jakarta.ws.rs.sse","c":"Sse","l":"newEvent(String, String)","u":"newEvent(java.lang.String,java.lang.String)"},{"p":"jakarta.ws.rs.sse","c":"Sse","l":"newEventBuilder()"},{"p":"jakarta.ws.rs.core","c":"Response.ResponseBuilder","l":"newInstance()"},{"p":"jakarta.ws.rs.core","c":"UriBuilder","l":"newInstance()"},{"p":"jakarta.ws.rs.core","c":"Variant.VariantListBuilder","l":"newInstance()"},{"p":"jakarta.ws.rs.core","c":"Response.Status","l":"NO_CONTENT"},{"p":"jakarta.ws.rs.container","c":"AsyncResponse","l":"NO_TIMEOUT"},{"p":"jakarta.ws.rs.core","c":"Response","l":"noContent()"},{"p":"jakarta.ws.rs.core","c":"NoContentException","l":"NoContentException(String)","u":"%3Cinit%3E(java.lang.String)"},{"p":"jakarta.ws.rs.core","c":"NoContentException","l":"NoContentException(String, Throwable)","u":"%3Cinit%3E(java.lang.String,java.lang.Throwable)"},{"p":"jakarta.ws.rs.core","c":"NoContentException","l":"NoContentException(Throwable)","u":"%3Cinit%3E(java.lang.Throwable)"},{"p":"jakarta.ws.rs.core","c":"NewCookie.SameSite","l":"NONE"},{"p":"jakarta.ws.rs","c":"SeBootstrap.Configuration.SSLClientAuthentication","l":"NONE"},{"p":"jakarta.ws.rs.core","c":"Response.Status","l":"NOT_ACCEPTABLE"},{"p":"jakarta.ws.rs.core","c":"Response.Status","l":"NOT_FOUND"},{"p":"jakarta.ws.rs.core","c":"Response.Status","l":"NOT_IMPLEMENTED"},{"p":"jakarta.ws.rs.core","c":"Response.Status","l":"NOT_MODIFIED"},{"p":"jakarta.ws.rs.core","c":"Response","l":"notAcceptable(List)","u":"notAcceptable(java.util.List)"},{"p":"jakarta.ws.rs","c":"NotAcceptableException","l":"NotAcceptableException()","u":"%3Cinit%3E()"},{"p":"jakarta.ws.rs","c":"NotAcceptableException","l":"NotAcceptableException(Response)","u":"%3Cinit%3E(jakarta.ws.rs.core.Response)"},{"p":"jakarta.ws.rs","c":"NotAcceptableException","l":"NotAcceptableException(Response, Throwable)","u":"%3Cinit%3E(jakarta.ws.rs.core.Response,java.lang.Throwable)"},{"p":"jakarta.ws.rs","c":"NotAcceptableException","l":"NotAcceptableException(String)","u":"%3Cinit%3E(java.lang.String)"},{"p":"jakarta.ws.rs","c":"NotAcceptableException","l":"NotAcceptableException(String, Response)","u":"%3Cinit%3E(java.lang.String,jakarta.ws.rs.core.Response)"},{"p":"jakarta.ws.rs","c":"NotAcceptableException","l":"NotAcceptableException(String, Response, Throwable)","u":"%3Cinit%3E(java.lang.String,jakarta.ws.rs.core.Response,java.lang.Throwable)"},{"p":"jakarta.ws.rs","c":"NotAcceptableException","l":"NotAcceptableException(String, Throwable)","u":"%3Cinit%3E(java.lang.String,java.lang.Throwable)"},{"p":"jakarta.ws.rs","c":"NotAcceptableException","l":"NotAcceptableException(Throwable)","u":"%3Cinit%3E(java.lang.Throwable)"},{"p":"jakarta.ws.rs","c":"NotAllowedException","l":"NotAllowedException(Response)","u":"%3Cinit%3E(jakarta.ws.rs.core.Response)"},{"p":"jakarta.ws.rs","c":"NotAllowedException","l":"NotAllowedException(Response, Throwable)","u":"%3Cinit%3E(jakarta.ws.rs.core.Response,java.lang.Throwable)"},{"p":"jakarta.ws.rs","c":"NotAllowedException","l":"NotAllowedException(String, Response)","u":"%3Cinit%3E(java.lang.String,jakarta.ws.rs.core.Response)"},{"p":"jakarta.ws.rs","c":"NotAllowedException","l":"NotAllowedException(String, Response, Throwable)","u":"%3Cinit%3E(java.lang.String,jakarta.ws.rs.core.Response,java.lang.Throwable)"},{"p":"jakarta.ws.rs","c":"NotAllowedException","l":"NotAllowedException(String, String, String...)","u":"%3Cinit%3E(java.lang.String,java.lang.String,java.lang.String...)"},{"p":"jakarta.ws.rs","c":"NotAllowedException","l":"NotAllowedException(String, String...)","u":"%3Cinit%3E(java.lang.String,java.lang.String...)"},{"p":"jakarta.ws.rs","c":"NotAllowedException","l":"NotAllowedException(String, Throwable, String...)","u":"%3Cinit%3E(java.lang.String,java.lang.Throwable,java.lang.String...)"},{"p":"jakarta.ws.rs","c":"NotAllowedException","l":"NotAllowedException(Throwable, String...)","u":"%3Cinit%3E(java.lang.Throwable,java.lang.String...)"},{"p":"jakarta.ws.rs","c":"NotAuthorizedException","l":"NotAuthorizedException(Object, Object...)","u":"%3Cinit%3E(java.lang.Object,java.lang.Object...)"},{"p":"jakarta.ws.rs","c":"NotAuthorizedException","l":"NotAuthorizedException(Response)","u":"%3Cinit%3E(jakarta.ws.rs.core.Response)"},{"p":"jakarta.ws.rs","c":"NotAuthorizedException","l":"NotAuthorizedException(Response, Throwable)","u":"%3Cinit%3E(jakarta.ws.rs.core.Response,java.lang.Throwable)"},{"p":"jakarta.ws.rs","c":"NotAuthorizedException","l":"NotAuthorizedException(String, Object, Object...)","u":"%3Cinit%3E(java.lang.String,java.lang.Object,java.lang.Object...)"},{"p":"jakarta.ws.rs","c":"NotAuthorizedException","l":"NotAuthorizedException(String, Response)","u":"%3Cinit%3E(java.lang.String,jakarta.ws.rs.core.Response)"},{"p":"jakarta.ws.rs","c":"NotAuthorizedException","l":"NotAuthorizedException(String, Response, Throwable)","u":"%3Cinit%3E(java.lang.String,jakarta.ws.rs.core.Response,java.lang.Throwable)"},{"p":"jakarta.ws.rs","c":"NotAuthorizedException","l":"NotAuthorizedException(String, Throwable, Object, Object...)","u":"%3Cinit%3E(java.lang.String,java.lang.Throwable,java.lang.Object,java.lang.Object...)"},{"p":"jakarta.ws.rs","c":"NotAuthorizedException","l":"NotAuthorizedException(Throwable, Object, Object...)","u":"%3Cinit%3E(java.lang.Throwable,java.lang.Object,java.lang.Object...)"},{"p":"jakarta.ws.rs","c":"NotFoundException","l":"NotFoundException()","u":"%3Cinit%3E()"},{"p":"jakarta.ws.rs","c":"NotFoundException","l":"NotFoundException(Response)","u":"%3Cinit%3E(jakarta.ws.rs.core.Response)"},{"p":"jakarta.ws.rs","c":"NotFoundException","l":"NotFoundException(Response, Throwable)","u":"%3Cinit%3E(jakarta.ws.rs.core.Response,java.lang.Throwable)"},{"p":"jakarta.ws.rs","c":"NotFoundException","l":"NotFoundException(String)","u":"%3Cinit%3E(java.lang.String)"},{"p":"jakarta.ws.rs","c":"NotFoundException","l":"NotFoundException(String, Response)","u":"%3Cinit%3E(java.lang.String,jakarta.ws.rs.core.Response)"},{"p":"jakarta.ws.rs","c":"NotFoundException","l":"NotFoundException(String, Response, Throwable)","u":"%3Cinit%3E(java.lang.String,jakarta.ws.rs.core.Response,java.lang.Throwable)"},{"p":"jakarta.ws.rs","c":"NotFoundException","l":"NotFoundException(String, Throwable)","u":"%3Cinit%3E(java.lang.String,java.lang.Throwable)"},{"p":"jakarta.ws.rs","c":"NotFoundException","l":"NotFoundException(Throwable)","u":"%3Cinit%3E(java.lang.Throwable)"},{"p":"jakarta.ws.rs.core","c":"Response","l":"notModified()"},{"p":"jakarta.ws.rs.core","c":"Response","l":"notModified(EntityTag)","u":"notModified(jakarta.ws.rs.core.EntityTag)"},{"p":"jakarta.ws.rs.core","c":"Response","l":"notModified(String)","u":"notModified(java.lang.String)"},{"p":"jakarta.ws.rs","c":"NotSupportedException","l":"NotSupportedException()","u":"%3Cinit%3E()"},{"p":"jakarta.ws.rs","c":"NotSupportedException","l":"NotSupportedException(Response)","u":"%3Cinit%3E(jakarta.ws.rs.core.Response)"},{"p":"jakarta.ws.rs","c":"NotSupportedException","l":"NotSupportedException(Response, Throwable)","u":"%3Cinit%3E(jakarta.ws.rs.core.Response,java.lang.Throwable)"},{"p":"jakarta.ws.rs","c":"NotSupportedException","l":"NotSupportedException(String)","u":"%3Cinit%3E(java.lang.String)"},{"p":"jakarta.ws.rs","c":"NotSupportedException","l":"NotSupportedException(String, Response)","u":"%3Cinit%3E(java.lang.String,jakarta.ws.rs.core.Response)"},{"p":"jakarta.ws.rs","c":"NotSupportedException","l":"NotSupportedException(String, Response, Throwable)","u":"%3Cinit%3E(java.lang.String,jakarta.ws.rs.core.Response,java.lang.Throwable)"},{"p":"jakarta.ws.rs","c":"NotSupportedException","l":"NotSupportedException(String, Throwable)","u":"%3Cinit%3E(java.lang.String,java.lang.Throwable)"},{"p":"jakarta.ws.rs","c":"NotSupportedException","l":"NotSupportedException(Throwable)","u":"%3Cinit%3E(java.lang.Throwable)"},{"p":"jakarta.ws.rs.core","c":"Response.Status","l":"OK"},{"p":"jakarta.ws.rs.core","c":"Response","l":"ok()"},{"p":"jakarta.ws.rs.core","c":"Response","l":"ok(Object)","u":"ok(java.lang.Object)"},{"p":"jakarta.ws.rs.core","c":"Response","l":"ok(Object, MediaType)","u":"ok(java.lang.Object,jakarta.ws.rs.core.MediaType)"},{"p":"jakarta.ws.rs.core","c":"Response","l":"ok(Object, String)","u":"ok(java.lang.Object,java.lang.String)"},{"p":"jakarta.ws.rs.core","c":"Response","l":"ok(Object, Variant)","u":"ok(java.lang.Object,jakarta.ws.rs.core.Variant)"},{"p":"jakarta.ws.rs.sse","c":"SseBroadcaster","l":"onClose(Consumer)","u":"onClose(java.util.function.Consumer)"},{"p":"jakarta.ws.rs.container","c":"CompletionCallback","l":"onComplete(Throwable)","u":"onComplete(java.lang.Throwable)"},{"p":"jakarta.ws.rs.container","c":"ConnectionCallback","l":"onDisconnect(AsyncResponse)","u":"onDisconnect(jakarta.ws.rs.container.AsyncResponse)"},{"p":"jakarta.ws.rs.sse","c":"SseBroadcaster","l":"onError(BiConsumer)","u":"onError(java.util.function.BiConsumer)"},{"p":"jakarta.ws.rs.sse","c":"SseEventSource","l":"open()"},{"p":"jakarta.ws.rs","c":"SeBootstrap.Configuration.SSLClientAuthentication","l":"OPTIONAL"},{"p":"jakarta.ws.rs","c":"HttpMethod","l":"OPTIONS"},{"p":"jakarta.ws.rs.client","c":"AsyncInvoker","l":"options()"},{"p":"jakarta.ws.rs.client","c":"CompletionStageRxInvoker","l":"options()"},{"p":"jakarta.ws.rs.client","c":"RxInvoker","l":"options()"},{"p":"jakarta.ws.rs.client","c":"SyncInvoker","l":"options()"},{"p":"jakarta.ws.rs.client","c":"RxInvoker","l":"options(Class)","u":"options(java.lang.Class)"},{"p":"jakarta.ws.rs.client","c":"AsyncInvoker","l":"options(Class)","u":"options(java.lang.Class)"},{"p":"jakarta.ws.rs.client","c":"CompletionStageRxInvoker","l":"options(Class)","u":"options(java.lang.Class)"},{"p":"jakarta.ws.rs.client","c":"SyncInvoker","l":"options(Class)","u":"options(java.lang.Class)"},{"p":"jakarta.ws.rs.client","c":"RxInvoker","l":"options(GenericType)","u":"options(jakarta.ws.rs.core.GenericType)"},{"p":"jakarta.ws.rs.client","c":"AsyncInvoker","l":"options(GenericType)","u":"options(jakarta.ws.rs.core.GenericType)"},{"p":"jakarta.ws.rs.client","c":"CompletionStageRxInvoker","l":"options(GenericType)","u":"options(jakarta.ws.rs.core.GenericType)"},{"p":"jakarta.ws.rs.client","c":"SyncInvoker","l":"options(GenericType)","u":"options(jakarta.ws.rs.core.GenericType)"},{"p":"jakarta.ws.rs.client","c":"AsyncInvoker","l":"options(InvocationCallback)","u":"options(jakarta.ws.rs.client.InvocationCallback)"},{"p":"jakarta.ws.rs.core","c":"Response.Status.Family","l":"OTHER"},{"p":"jakarta.ws.rs.core","c":"Form","l":"param(String, String)","u":"param(java.lang.String,java.lang.String)"},{"p":"jakarta.ws.rs.core","c":"Link.Builder","l":"param(String, String)","u":"param(java.lang.String,java.lang.String)"},{"p":"jakarta.ws.rs.core","c":"Response.Status","l":"PARTIAL_CONTENT"},{"p":"jakarta.ws.rs","c":"HttpMethod","l":"PATCH"},{"p":"jakarta.ws.rs.core","c":"UriBuilder","l":"path(Class)","u":"path(java.lang.Class)"},{"p":"jakarta.ws.rs.core","c":"UriBuilder","l":"path(Class, String)","u":"path(java.lang.Class,java.lang.String)"},{"p":"jakarta.ws.rs.core","c":"UriBuilder","l":"path(Method)","u":"path(java.lang.reflect.Method)"},{"p":"jakarta.ws.rs.client","c":"WebTarget","l":"path(String)","u":"path(java.lang.String)"},{"p":"jakarta.ws.rs.core","c":"Cookie.AbstractCookieBuilder","l":"path(String)","u":"path(java.lang.String)"},{"p":"jakarta.ws.rs.core","c":"UriBuilder","l":"path(String)","u":"path(java.lang.String)"},{"p":"jakarta.ws.rs.core","c":"Response.Status","l":"PAYMENT_REQUIRED"},{"p":"jakarta.ws.rs.core","c":"Response.Status","l":"PERMANENT_REDIRECT"},{"p":"jakarta.ws.rs","c":"SeBootstrap.Configuration","l":"PORT"},{"p":"jakarta.ws.rs","c":"SeBootstrap.Configuration","l":"port()"},{"p":"jakarta.ws.rs.core","c":"UriBuilder","l":"port(int)"},{"p":"jakarta.ws.rs","c":"SeBootstrap.Configuration.Builder","l":"port(Integer)","u":"port(java.lang.Integer)"},{"p":"jakarta.ws.rs","c":"HttpMethod","l":"POST"},{"p":"jakarta.ws.rs.client","c":"AsyncInvoker","l":"post(Entity)","u":"post(jakarta.ws.rs.client.Entity)"},{"p":"jakarta.ws.rs.client","c":"CompletionStageRxInvoker","l":"post(Entity)","u":"post(jakarta.ws.rs.client.Entity)"},{"p":"jakarta.ws.rs.client","c":"RxInvoker","l":"post(Entity)","u":"post(jakarta.ws.rs.client.Entity)"},{"p":"jakarta.ws.rs.client","c":"SyncInvoker","l":"post(Entity)","u":"post(jakarta.ws.rs.client.Entity)"},{"p":"jakarta.ws.rs.client","c":"RxInvoker","l":"post(Entity, Class)","u":"post(jakarta.ws.rs.client.Entity,java.lang.Class)"},{"p":"jakarta.ws.rs.client","c":"AsyncInvoker","l":"post(Entity, Class)","u":"post(jakarta.ws.rs.client.Entity,java.lang.Class)"},{"p":"jakarta.ws.rs.client","c":"CompletionStageRxInvoker","l":"post(Entity, Class)","u":"post(jakarta.ws.rs.client.Entity,java.lang.Class)"},{"p":"jakarta.ws.rs.client","c":"SyncInvoker","l":"post(Entity, Class)","u":"post(jakarta.ws.rs.client.Entity,java.lang.Class)"},{"p":"jakarta.ws.rs.client","c":"RxInvoker","l":"post(Entity, GenericType)","u":"post(jakarta.ws.rs.client.Entity,jakarta.ws.rs.core.GenericType)"},{"p":"jakarta.ws.rs.client","c":"AsyncInvoker","l":"post(Entity, GenericType)","u":"post(jakarta.ws.rs.client.Entity,jakarta.ws.rs.core.GenericType)"},{"p":"jakarta.ws.rs.client","c":"CompletionStageRxInvoker","l":"post(Entity, GenericType)","u":"post(jakarta.ws.rs.client.Entity,jakarta.ws.rs.core.GenericType)"},{"p":"jakarta.ws.rs.client","c":"SyncInvoker","l":"post(Entity, GenericType)","u":"post(jakarta.ws.rs.client.Entity,jakarta.ws.rs.core.GenericType)"},{"p":"jakarta.ws.rs.client","c":"AsyncInvoker","l":"post(Entity, InvocationCallback)","u":"post(jakarta.ws.rs.client.Entity,jakarta.ws.rs.client.InvocationCallback)"},{"p":"jakarta.ws.rs.core","c":"Response.Status","l":"PRECONDITION_FAILED"},{"p":"jakarta.ws.rs.core","c":"Response.Status","l":"PRECONDITION_REQUIRED"},{"p":"jakarta.ws.rs.ext","c":"ReaderInterceptorContext","l":"proceed()"},{"p":"jakarta.ws.rs.ext","c":"WriterInterceptorContext","l":"proceed()"},{"p":"jakarta.ws.rs","c":"ProcessingException","l":"ProcessingException(String)","u":"%3Cinit%3E(java.lang.String)"},{"p":"jakarta.ws.rs","c":"ProcessingException","l":"ProcessingException(String, Throwable)","u":"%3Cinit%3E(java.lang.String,java.lang.Throwable)"},{"p":"jakarta.ws.rs","c":"ProcessingException","l":"ProcessingException(Throwable)","u":"%3Cinit%3E(java.lang.Throwable)"},{"p":"jakarta.ws.rs","c":"SeBootstrap.Configuration","l":"property(String)","u":"property(java.lang.String)"},{"p":"jakarta.ws.rs.client","c":"Invocation.Builder","l":"property(String, Object)","u":"property(java.lang.String,java.lang.Object)"},{"p":"jakarta.ws.rs.client","c":"Invocation","l":"property(String, Object)","u":"property(java.lang.String,java.lang.Object)"},{"p":"jakarta.ws.rs.core","c":"Configurable","l":"property(String, Object)","u":"property(java.lang.String,java.lang.Object)"},{"p":"jakarta.ws.rs","c":"SeBootstrap.Configuration.Builder","l":"property(String, Object)","u":"property(java.lang.String,java.lang.Object)"},{"p":"jakarta.ws.rs","c":"SeBootstrap.Configuration","l":"PROTOCOL"},{"p":"jakarta.ws.rs","c":"SeBootstrap.Configuration","l":"protocol()"},{"p":"jakarta.ws.rs","c":"SeBootstrap.Configuration.Builder","l":"protocol(String)","u":"protocol(java.lang.String)"},{"p":"jakarta.ws.rs.core","c":"Response.Status","l":"PROXY_AUTHENTICATION_REQUIRED"},{"p":"jakarta.ws.rs","c":"HttpMethod","l":"PUT"},{"p":"jakarta.ws.rs.client","c":"AsyncInvoker","l":"put(Entity)","u":"put(jakarta.ws.rs.client.Entity)"},{"p":"jakarta.ws.rs.client","c":"CompletionStageRxInvoker","l":"put(Entity)","u":"put(jakarta.ws.rs.client.Entity)"},{"p":"jakarta.ws.rs.client","c":"RxInvoker","l":"put(Entity)","u":"put(jakarta.ws.rs.client.Entity)"},{"p":"jakarta.ws.rs.client","c":"SyncInvoker","l":"put(Entity)","u":"put(jakarta.ws.rs.client.Entity)"},{"p":"jakarta.ws.rs.client","c":"RxInvoker","l":"put(Entity, Class)","u":"put(jakarta.ws.rs.client.Entity,java.lang.Class)"},{"p":"jakarta.ws.rs.client","c":"AsyncInvoker","l":"put(Entity, Class)","u":"put(jakarta.ws.rs.client.Entity,java.lang.Class)"},{"p":"jakarta.ws.rs.client","c":"CompletionStageRxInvoker","l":"put(Entity, Class)","u":"put(jakarta.ws.rs.client.Entity,java.lang.Class)"},{"p":"jakarta.ws.rs.client","c":"SyncInvoker","l":"put(Entity, Class)","u":"put(jakarta.ws.rs.client.Entity,java.lang.Class)"},{"p":"jakarta.ws.rs.client","c":"RxInvoker","l":"put(Entity, GenericType)","u":"put(jakarta.ws.rs.client.Entity,jakarta.ws.rs.core.GenericType)"},{"p":"jakarta.ws.rs.client","c":"AsyncInvoker","l":"put(Entity, GenericType)","u":"put(jakarta.ws.rs.client.Entity,jakarta.ws.rs.core.GenericType)"},{"p":"jakarta.ws.rs.client","c":"CompletionStageRxInvoker","l":"put(Entity, GenericType)","u":"put(jakarta.ws.rs.client.Entity,jakarta.ws.rs.core.GenericType)"},{"p":"jakarta.ws.rs.client","c":"SyncInvoker","l":"put(Entity, GenericType)","u":"put(jakarta.ws.rs.client.Entity,jakarta.ws.rs.core.GenericType)"},{"p":"jakarta.ws.rs.client","c":"AsyncInvoker","l":"put(Entity, InvocationCallback)","u":"put(jakarta.ws.rs.client.Entity,jakarta.ws.rs.client.InvocationCallback)"},{"p":"jakarta.ws.rs.core","c":"AbstractMultivaluedMap","l":"put(K, List)","u":"put(K,java.util.List)"},{"p":"jakarta.ws.rs.core","c":"AbstractMultivaluedMap","l":"putAll(Map>)","u":"putAll(java.util.Map)"},{"p":"jakarta.ws.rs.core","c":"AbstractMultivaluedMap","l":"putSingle(K, V)","u":"putSingle(K,V)"},{"p":"jakarta.ws.rs.core","c":"MultivaluedMap","l":"putSingle(K, V)","u":"putSingle(K,V)"},{"p":"jakarta.ws.rs.client","c":"WebTarget","l":"queryParam(String, Object...)","u":"queryParam(java.lang.String,java.lang.Object...)"},{"p":"jakarta.ws.rs.core","c":"UriBuilder","l":"queryParam(String, Object...)","u":"queryParam(java.lang.String,java.lang.Object...)"},{"p":"jakarta.ws.rs.sse","c":"InboundSseEvent","l":"readData()"},{"p":"jakarta.ws.rs.sse","c":"InboundSseEvent","l":"readData(Class)","u":"readData(java.lang.Class)"},{"p":"jakarta.ws.rs.sse","c":"InboundSseEvent","l":"readData(Class, MediaType)","u":"readData(java.lang.Class,jakarta.ws.rs.core.MediaType)"},{"p":"jakarta.ws.rs.sse","c":"InboundSseEvent","l":"readData(GenericType)","u":"readData(jakarta.ws.rs.core.GenericType)"},{"p":"jakarta.ws.rs.sse","c":"InboundSseEvent","l":"readData(GenericType, MediaType)","u":"readData(jakarta.ws.rs.core.GenericType,jakarta.ws.rs.core.MediaType)"},{"p":"jakarta.ws.rs.core","c":"Response","l":"readEntity(Class)","u":"readEntity(java.lang.Class)"},{"p":"jakarta.ws.rs.core","c":"Response","l":"readEntity(Class, Annotation[])","u":"readEntity(java.lang.Class,java.lang.annotation.Annotation[])"},{"p":"jakarta.ws.rs.core","c":"Response","l":"readEntity(GenericType)","u":"readEntity(jakarta.ws.rs.core.GenericType)"},{"p":"jakarta.ws.rs.core","c":"Response","l":"readEntity(GenericType, Annotation[])","u":"readEntity(jakarta.ws.rs.core.GenericType,java.lang.annotation.Annotation[])"},{"p":"jakarta.ws.rs.ext","c":"MessageBodyReader","l":"readFrom(Class, Type, Annotation[], MediaType, MultivaluedMap, InputStream)","u":"readFrom(java.lang.Class,java.lang.reflect.Type,java.lang.annotation.Annotation[],jakarta.ws.rs.core.MediaType,jakarta.ws.rs.core.MultivaluedMap,java.io.InputStream)"},{"p":"jakarta.ws.rs.client","c":"ClientBuilder","l":"readTimeout(long, TimeUnit)","u":"readTimeout(long,java.util.concurrent.TimeUnit)"},{"p":"jakarta.ws.rs.sse","c":"SseEvent","l":"RECONNECT_NOT_SET"},{"p":"jakarta.ws.rs.sse","c":"OutboundSseEvent.Builder","l":"reconnectDelay(long)"},{"p":"jakarta.ws.rs.sse","c":"SseEventSource.Builder","l":"reconnectingEvery(long, TimeUnit)","u":"reconnectingEvery(long,java.util.concurrent.TimeUnit)"},{"p":"jakarta.ws.rs.core","c":"Response.Status.Family","l":"REDIRECTION"},{"p":"jakarta.ws.rs","c":"RedirectionException","l":"RedirectionException(int, URI)","u":"%3Cinit%3E(int,java.net.URI)"},{"p":"jakarta.ws.rs","c":"RedirectionException","l":"RedirectionException(Response)","u":"%3Cinit%3E(jakarta.ws.rs.core.Response)"},{"p":"jakarta.ws.rs","c":"RedirectionException","l":"RedirectionException(Response.Status, URI)","u":"%3Cinit%3E(jakarta.ws.rs.core.Response.Status,java.net.URI)"},{"p":"jakarta.ws.rs","c":"RedirectionException","l":"RedirectionException(String, int, URI)","u":"%3Cinit%3E(java.lang.String,int,java.net.URI)"},{"p":"jakarta.ws.rs","c":"RedirectionException","l":"RedirectionException(String, Response)","u":"%3Cinit%3E(java.lang.String,jakarta.ws.rs.core.Response)"},{"p":"jakarta.ws.rs","c":"RedirectionException","l":"RedirectionException(String, Response.Status, URI)","u":"%3Cinit%3E(java.lang.String,jakarta.ws.rs.core.Response.Status,java.net.URI)"},{"p":"jakarta.ws.rs.container","c":"AsyncResponse","l":"register(Class)","u":"register(java.lang.Class)"},{"p":"jakarta.ws.rs.core","c":"Configurable","l":"register(Class)","u":"register(java.lang.Class)"},{"p":"jakarta.ws.rs.container","c":"AsyncResponse","l":"register(Class, Class...)","u":"register(java.lang.Class,java.lang.Class...)"},{"p":"jakarta.ws.rs.core","c":"Configurable","l":"register(Class, Class...)","u":"register(java.lang.Class,java.lang.Class...)"},{"p":"jakarta.ws.rs.core","c":"Configurable","l":"register(Class, int)","u":"register(java.lang.Class,int)"},{"p":"jakarta.ws.rs.core","c":"Configurable","l":"register(Class, Map, Integer>)","u":"register(java.lang.Class,java.util.Map)"},{"p":"jakarta.ws.rs.sse","c":"SseEventSource","l":"register(Consumer)","u":"register(java.util.function.Consumer)"},{"p":"jakarta.ws.rs.sse","c":"SseEventSource","l":"register(Consumer, Consumer)","u":"register(java.util.function.Consumer,java.util.function.Consumer)"},{"p":"jakarta.ws.rs.sse","c":"SseEventSource","l":"register(Consumer, Consumer, Runnable)","u":"register(java.util.function.Consumer,java.util.function.Consumer,java.lang.Runnable)"},{"p":"jakarta.ws.rs.container","c":"AsyncResponse","l":"register(Object)","u":"register(java.lang.Object)"},{"p":"jakarta.ws.rs.core","c":"Configurable","l":"register(Object)","u":"register(java.lang.Object)"},{"p":"jakarta.ws.rs.core","c":"Configurable","l":"register(Object, Class...)","u":"register(java.lang.Object,java.lang.Class...)"},{"p":"jakarta.ws.rs.core","c":"Configurable","l":"register(Object, int)","u":"register(java.lang.Object,int)"},{"p":"jakarta.ws.rs.core","c":"Configurable","l":"register(Object, Map, Integer>)","u":"register(java.lang.Object,java.util.Map)"},{"p":"jakarta.ws.rs.container","c":"AsyncResponse","l":"register(Object, Object...)","u":"register(java.lang.Object,java.lang.Object...)"},{"p":"jakarta.ws.rs.sse","c":"SseBroadcaster","l":"register(SseEventSink)","u":"register(jakarta.ws.rs.sse.SseEventSink)"},{"p":"jakarta.ws.rs.core","c":"Link","l":"REL"},{"p":"jakarta.ws.rs.core","c":"Link.Builder","l":"rel(String)","u":"rel(java.lang.String)"},{"p":"jakarta.ws.rs.core","c":"UriInfo","l":"relativize(URI)","u":"relativize(java.net.URI)"},{"p":"jakarta.ws.rs.core","c":"AbstractMultivaluedMap","l":"remove(Object)","u":"remove(java.lang.Object)"},{"p":"jakarta.ws.rs.client","c":"ClientRequestContext","l":"removeProperty(String)","u":"removeProperty(java.lang.String)"},{"p":"jakarta.ws.rs.container","c":"ContainerRequestContext","l":"removeProperty(String)","u":"removeProperty(java.lang.String)"},{"p":"jakarta.ws.rs.ext","c":"InterceptorContext","l":"removeProperty(String)","u":"removeProperty(java.lang.String)"},{"p":"jakarta.ws.rs.core","c":"Response.ResponseBuilder","l":"replaceAll(MultivaluedMap)","u":"replaceAll(jakarta.ws.rs.core.MultivaluedMap)"},{"p":"jakarta.ws.rs.core","c":"UriBuilder","l":"replaceMatrix(String)","u":"replaceMatrix(java.lang.String)"},{"p":"jakarta.ws.rs.core","c":"UriBuilder","l":"replaceMatrixParam(String, Object...)","u":"replaceMatrixParam(java.lang.String,java.lang.Object...)"},{"p":"jakarta.ws.rs.core","c":"UriBuilder","l":"replacePath(String)","u":"replacePath(java.lang.String)"},{"p":"jakarta.ws.rs.core","c":"UriBuilder","l":"replaceQuery(String)","u":"replaceQuery(java.lang.String)"},{"p":"jakarta.ws.rs.core","c":"UriBuilder","l":"replaceQueryParam(String, Object...)","u":"replaceQueryParam(java.lang.String,java.lang.Object...)"},{"p":"jakarta.ws.rs.core","c":"Response.Status","l":"REQUEST_ENTITY_TOO_LARGE"},{"p":"jakarta.ws.rs.core","c":"Response.Status","l":"REQUEST_HEADER_FIELDS_TOO_LARGE"},{"p":"jakarta.ws.rs.core","c":"Response.Status","l":"REQUEST_TIMEOUT"},{"p":"jakarta.ws.rs.core","c":"Response.Status","l":"REQUEST_URI_TOO_LONG"},{"p":"jakarta.ws.rs.client","c":"WebTarget","l":"request()"},{"p":"jakarta.ws.rs.client","c":"WebTarget","l":"request(MediaType...)","u":"request(jakarta.ws.rs.core.MediaType...)"},{"p":"jakarta.ws.rs.client","c":"WebTarget","l":"request(String...)","u":"request(java.lang.String...)"},{"p":"jakarta.ws.rs.core","c":"Response.Status","l":"REQUESTED_RANGE_NOT_SATISFIABLE"},{"p":"jakarta.ws.rs.core","c":"Response.Status","l":"RESET_CONTENT"},{"p":"jakarta.ws.rs.core","c":"UriInfo","l":"resolve(URI)","u":"resolve(java.net.URI)"},{"p":"jakarta.ws.rs.client","c":"WebTarget","l":"resolveTemplate(String, Object)","u":"resolveTemplate(java.lang.String,java.lang.Object)"},{"p":"jakarta.ws.rs.core","c":"UriBuilder","l":"resolveTemplate(String, Object)","u":"resolveTemplate(java.lang.String,java.lang.Object)"},{"p":"jakarta.ws.rs.client","c":"WebTarget","l":"resolveTemplate(String, Object, boolean)","u":"resolveTemplate(java.lang.String,java.lang.Object,boolean)"},{"p":"jakarta.ws.rs.core","c":"UriBuilder","l":"resolveTemplate(String, Object, boolean)","u":"resolveTemplate(java.lang.String,java.lang.Object,boolean)"},{"p":"jakarta.ws.rs.client","c":"WebTarget","l":"resolveTemplateFromEncoded(String, Object)","u":"resolveTemplateFromEncoded(java.lang.String,java.lang.Object)"},{"p":"jakarta.ws.rs.core","c":"UriBuilder","l":"resolveTemplateFromEncoded(String, Object)","u":"resolveTemplateFromEncoded(java.lang.String,java.lang.Object)"},{"p":"jakarta.ws.rs.client","c":"WebTarget","l":"resolveTemplates(Map)","u":"resolveTemplates(java.util.Map)"},{"p":"jakarta.ws.rs.core","c":"UriBuilder","l":"resolveTemplates(Map)","u":"resolveTemplates(java.util.Map)"},{"p":"jakarta.ws.rs.client","c":"WebTarget","l":"resolveTemplates(Map, boolean)","u":"resolveTemplates(java.util.Map,boolean)"},{"p":"jakarta.ws.rs.core","c":"UriBuilder","l":"resolveTemplates(Map, boolean)","u":"resolveTemplates(java.util.Map,boolean)"},{"p":"jakarta.ws.rs.client","c":"WebTarget","l":"resolveTemplatesFromEncoded(Map)","u":"resolveTemplatesFromEncoded(java.util.Map)"},{"p":"jakarta.ws.rs.core","c":"UriBuilder","l":"resolveTemplatesFromEncoded(Map)","u":"resolveTemplatesFromEncoded(java.util.Map)"},{"p":"jakarta.ws.rs.core","c":"Response","l":"Response()","u":"%3Cinit%3E()"},{"p":"jakarta.ws.rs.core","c":"Response.ResponseBuilder","l":"ResponseBuilder()","u":"%3Cinit%3E()"},{"p":"jakarta.ws.rs.client","c":"ResponseProcessingException","l":"ResponseProcessingException(Response, String)","u":"%3Cinit%3E(jakarta.ws.rs.core.Response,java.lang.String)"},{"p":"jakarta.ws.rs.client","c":"ResponseProcessingException","l":"ResponseProcessingException(Response, String, Throwable)","u":"%3Cinit%3E(jakarta.ws.rs.core.Response,java.lang.String,java.lang.Throwable)"},{"p":"jakarta.ws.rs.client","c":"ResponseProcessingException","l":"ResponseProcessingException(Response, Throwable)","u":"%3Cinit%3E(jakarta.ws.rs.core.Response,java.lang.Throwable)"},{"p":"jakarta.ws.rs.container","c":"AsyncResponse","l":"resume(Object)","u":"resume(java.lang.Object)"},{"p":"jakarta.ws.rs.container","c":"AsyncResponse","l":"resume(Throwable)","u":"resume(java.lang.Throwable)"},{"p":"jakarta.ws.rs.core","c":"HttpHeaders","l":"RETRY_AFTER"},{"p":"jakarta.ws.rs","c":"SeBootstrap.Configuration","l":"ROOT_PATH"},{"p":"jakarta.ws.rs","c":"SeBootstrap.Configuration","l":"rootPath()"},{"p":"jakarta.ws.rs","c":"SeBootstrap.Configuration.Builder","l":"rootPath(String)","u":"rootPath(java.lang.String)"},{"p":"jakarta.ws.rs.ext","c":"RuntimeDelegate","l":"RuntimeDelegate()","u":"%3Cinit%3E()"},{"p":"jakarta.ws.rs.client","c":"Invocation.Builder","l":"rx()"},{"p":"jakarta.ws.rs.client","c":"Invocation.Builder","l":"rx(Class)","u":"rx(java.lang.Class)"},{"p":"jakarta.ws.rs.core","c":"NewCookie.AbstractNewCookieBuilder","l":"sameSite(NewCookie.SameSite)","u":"sameSite(jakarta.ws.rs.core.NewCookie.SameSite)"},{"p":"jakarta.ws.rs.client","c":"ClientBuilder","l":"scheduledExecutorService(ScheduledExecutorService)","u":"scheduledExecutorService(java.util.concurrent.ScheduledExecutorService)"},{"p":"jakarta.ws.rs.core","c":"UriBuilder","l":"scheme(String)","u":"scheme(java.lang.String)"},{"p":"jakarta.ws.rs.core","c":"UriBuilder","l":"schemeSpecificPart(String)","u":"schemeSpecificPart(java.lang.String)"},{"p":"jakarta.ws.rs.core","c":"NewCookie.AbstractNewCookieBuilder","l":"secure(boolean)"},{"p":"jakarta.ws.rs.core","c":"Response.Status","l":"SEE_OTHER"},{"p":"jakarta.ws.rs.core","c":"Response","l":"seeOther(URI)","u":"seeOther(java.net.URI)"},{"p":"jakarta.ws.rs.core","c":"UriBuilder","l":"segment(String...)","u":"segment(java.lang.String...)"},{"p":"jakarta.ws.rs.core","c":"Request","l":"selectVariant(List)","u":"selectVariant(java.util.List)"},{"p":"jakarta.ws.rs.sse","c":"SseEventSink","l":"send(OutboundSseEvent)","u":"send(jakarta.ws.rs.sse.OutboundSseEvent)"},{"p":"jakarta.ws.rs","c":"RuntimeType","l":"SERVER"},{"p":"jakarta.ws.rs.core","c":"Response.Status.Family","l":"SERVER_ERROR"},{"p":"jakarta.ws.rs.core","c":"MediaType","l":"SERVER_SENT_EVENTS"},{"p":"jakarta.ws.rs.core","c":"MediaType","l":"SERVER_SENT_EVENTS_TYPE"},{"p":"jakarta.ws.rs.core","c":"Response","l":"serverError()"},{"p":"jakarta.ws.rs","c":"ServerErrorException","l":"ServerErrorException(int)","u":"%3Cinit%3E(int)"},{"p":"jakarta.ws.rs","c":"ServerErrorException","l":"ServerErrorException(int, Throwable)","u":"%3Cinit%3E(int,java.lang.Throwable)"},{"p":"jakarta.ws.rs","c":"ServerErrorException","l":"ServerErrorException(Response)","u":"%3Cinit%3E(jakarta.ws.rs.core.Response)"},{"p":"jakarta.ws.rs","c":"ServerErrorException","l":"ServerErrorException(Response, Throwable)","u":"%3Cinit%3E(jakarta.ws.rs.core.Response,java.lang.Throwable)"},{"p":"jakarta.ws.rs","c":"ServerErrorException","l":"ServerErrorException(Response.Status)","u":"%3Cinit%3E(jakarta.ws.rs.core.Response.Status)"},{"p":"jakarta.ws.rs","c":"ServerErrorException","l":"ServerErrorException(Response.Status, Throwable)","u":"%3Cinit%3E(jakarta.ws.rs.core.Response.Status,java.lang.Throwable)"},{"p":"jakarta.ws.rs","c":"ServerErrorException","l":"ServerErrorException(String, int)","u":"%3Cinit%3E(java.lang.String,int)"},{"p":"jakarta.ws.rs","c":"ServerErrorException","l":"ServerErrorException(String, int, Throwable)","u":"%3Cinit%3E(java.lang.String,int,java.lang.Throwable)"},{"p":"jakarta.ws.rs","c":"ServerErrorException","l":"ServerErrorException(String, Response)","u":"%3Cinit%3E(java.lang.String,jakarta.ws.rs.core.Response)"},{"p":"jakarta.ws.rs","c":"ServerErrorException","l":"ServerErrorException(String, Response, Throwable)","u":"%3Cinit%3E(java.lang.String,jakarta.ws.rs.core.Response,java.lang.Throwable)"},{"p":"jakarta.ws.rs","c":"ServerErrorException","l":"ServerErrorException(String, Response.Status)","u":"%3Cinit%3E(java.lang.String,jakarta.ws.rs.core.Response.Status)"},{"p":"jakarta.ws.rs","c":"ServerErrorException","l":"ServerErrorException(String, Response.Status, Throwable)","u":"%3Cinit%3E(java.lang.String,jakarta.ws.rs.core.Response.Status,java.lang.Throwable)"},{"p":"jakarta.ws.rs.core","c":"Response.Status","l":"SERVICE_UNAVAILABLE"},{"p":"jakarta.ws.rs","c":"ServiceUnavailableException","l":"ServiceUnavailableException()","u":"%3Cinit%3E()"},{"p":"jakarta.ws.rs","c":"ServiceUnavailableException","l":"ServiceUnavailableException(Date)","u":"%3Cinit%3E(java.util.Date)"},{"p":"jakarta.ws.rs","c":"ServiceUnavailableException","l":"ServiceUnavailableException(Date, Throwable)","u":"%3Cinit%3E(java.util.Date,java.lang.Throwable)"},{"p":"jakarta.ws.rs","c":"ServiceUnavailableException","l":"ServiceUnavailableException(Long)","u":"%3Cinit%3E(java.lang.Long)"},{"p":"jakarta.ws.rs","c":"ServiceUnavailableException","l":"ServiceUnavailableException(Long, Throwable)","u":"%3Cinit%3E(java.lang.Long,java.lang.Throwable)"},{"p":"jakarta.ws.rs","c":"ServiceUnavailableException","l":"ServiceUnavailableException(Response)","u":"%3Cinit%3E(jakarta.ws.rs.core.Response)"},{"p":"jakarta.ws.rs","c":"ServiceUnavailableException","l":"ServiceUnavailableException(Response, Throwable)","u":"%3Cinit%3E(jakarta.ws.rs.core.Response,java.lang.Throwable)"},{"p":"jakarta.ws.rs","c":"ServiceUnavailableException","l":"ServiceUnavailableException(String)","u":"%3Cinit%3E(java.lang.String)"},{"p":"jakarta.ws.rs","c":"ServiceUnavailableException","l":"ServiceUnavailableException(String, Date)","u":"%3Cinit%3E(java.lang.String,java.util.Date)"},{"p":"jakarta.ws.rs","c":"ServiceUnavailableException","l":"ServiceUnavailableException(String, Date, Throwable)","u":"%3Cinit%3E(java.lang.String,java.util.Date,java.lang.Throwable)"},{"p":"jakarta.ws.rs","c":"ServiceUnavailableException","l":"ServiceUnavailableException(String, Long)","u":"%3Cinit%3E(java.lang.String,java.lang.Long)"},{"p":"jakarta.ws.rs","c":"ServiceUnavailableException","l":"ServiceUnavailableException(String, Long, Throwable)","u":"%3Cinit%3E(java.lang.String,java.lang.Long,java.lang.Throwable)"},{"p":"jakarta.ws.rs","c":"ServiceUnavailableException","l":"ServiceUnavailableException(String, Response)","u":"%3Cinit%3E(java.lang.String,jakarta.ws.rs.core.Response)"},{"p":"jakarta.ws.rs","c":"ServiceUnavailableException","l":"ServiceUnavailableException(String, Response, Throwable)","u":"%3Cinit%3E(java.lang.String,jakarta.ws.rs.core.Response,java.lang.Throwable)"},{"p":"jakarta.ws.rs.core","c":"HttpHeaders","l":"SET_COOKIE"},{"p":"jakarta.ws.rs.ext","c":"InterceptorContext","l":"setAnnotations(Annotation[])","u":"setAnnotations(java.lang.annotation.Annotation[])"},{"p":"jakarta.ws.rs.client","c":"ClientRequestContext","l":"setEntity(Object)","u":"setEntity(java.lang.Object)"},{"p":"jakarta.ws.rs.container","c":"ContainerResponseContext","l":"setEntity(Object)","u":"setEntity(java.lang.Object)"},{"p":"jakarta.ws.rs.ext","c":"WriterInterceptorContext","l":"setEntity(Object)","u":"setEntity(java.lang.Object)"},{"p":"jakarta.ws.rs.client","c":"ClientRequestContext","l":"setEntity(Object, Annotation[], MediaType)","u":"setEntity(java.lang.Object,java.lang.annotation.Annotation[],jakarta.ws.rs.core.MediaType)"},{"p":"jakarta.ws.rs.container","c":"ContainerResponseContext","l":"setEntity(Object, Annotation[], MediaType)","u":"setEntity(java.lang.Object,java.lang.annotation.Annotation[],jakarta.ws.rs.core.MediaType)"},{"p":"jakarta.ws.rs.client","c":"ClientResponseContext","l":"setEntityStream(InputStream)","u":"setEntityStream(java.io.InputStream)"},{"p":"jakarta.ws.rs.container","c":"ContainerRequestContext","l":"setEntityStream(InputStream)","u":"setEntityStream(java.io.InputStream)"},{"p":"jakarta.ws.rs.client","c":"ClientRequestContext","l":"setEntityStream(OutputStream)","u":"setEntityStream(java.io.OutputStream)"},{"p":"jakarta.ws.rs.container","c":"ContainerResponseContext","l":"setEntityStream(OutputStream)","u":"setEntityStream(java.io.OutputStream)"},{"p":"jakarta.ws.rs.ext","c":"InterceptorContext","l":"setGenericType(Type)","u":"setGenericType(java.lang.reflect.Type)"},{"p":"jakarta.ws.rs.ext","c":"ReaderInterceptorContext","l":"setInputStream(InputStream)","u":"setInputStream(java.io.InputStream)"},{"p":"jakarta.ws.rs.ext","c":"RuntimeDelegate","l":"setInstance(RuntimeDelegate)","u":"setInstance(jakarta.ws.rs.ext.RuntimeDelegate)"},{"p":"jakarta.ws.rs.core","c":"CacheControl","l":"setMaxAge(int)"},{"p":"jakarta.ws.rs.ext","c":"InterceptorContext","l":"setMediaType(MediaType)","u":"setMediaType(jakarta.ws.rs.core.MediaType)"},{"p":"jakarta.ws.rs.client","c":"ClientRequestContext","l":"setMethod(String)","u":"setMethod(java.lang.String)"},{"p":"jakarta.ws.rs.container","c":"ContainerRequestContext","l":"setMethod(String)","u":"setMethod(java.lang.String)"},{"p":"jakarta.ws.rs.core","c":"CacheControl","l":"setMustRevalidate(boolean)"},{"p":"jakarta.ws.rs.core","c":"CacheControl","l":"setNoCache(boolean)"},{"p":"jakarta.ws.rs.core","c":"CacheControl","l":"setNoStore(boolean)"},{"p":"jakarta.ws.rs.core","c":"CacheControl","l":"setNoTransform(boolean)"},{"p":"jakarta.ws.rs.ext","c":"WriterInterceptorContext","l":"setOutputStream(OutputStream)","u":"setOutputStream(java.io.OutputStream)"},{"p":"jakarta.ws.rs.core","c":"CacheControl","l":"setPrivate(boolean)"},{"p":"jakarta.ws.rs.client","c":"ClientRequestContext","l":"setProperty(String, Object)","u":"setProperty(java.lang.String,java.lang.Object)"},{"p":"jakarta.ws.rs.container","c":"ContainerRequestContext","l":"setProperty(String, Object)","u":"setProperty(java.lang.String,java.lang.Object)"},{"p":"jakarta.ws.rs.ext","c":"InterceptorContext","l":"setProperty(String, Object)","u":"setProperty(java.lang.String,java.lang.Object)"},{"p":"jakarta.ws.rs.core","c":"CacheControl","l":"setProxyRevalidate(boolean)"},{"p":"jakarta.ws.rs.container","c":"ContainerRequestContext","l":"setRequestUri(URI)","u":"setRequestUri(java.net.URI)"},{"p":"jakarta.ws.rs.container","c":"ContainerRequestContext","l":"setRequestUri(URI, URI)","u":"setRequestUri(java.net.URI,java.net.URI)"},{"p":"jakarta.ws.rs.container","c":"ContainerRequestContext","l":"setSecurityContext(SecurityContext)","u":"setSecurityContext(jakarta.ws.rs.core.SecurityContext)"},{"p":"jakarta.ws.rs.core","c":"CacheControl","l":"setSMaxAge(int)"},{"p":"jakarta.ws.rs.client","c":"ClientResponseContext","l":"setStatus(int)"},{"p":"jakarta.ws.rs.container","c":"ContainerResponseContext","l":"setStatus(int)"},{"p":"jakarta.ws.rs.client","c":"ClientResponseContext","l":"setStatusInfo(Response.StatusType)","u":"setStatusInfo(jakarta.ws.rs.core.Response.StatusType)"},{"p":"jakarta.ws.rs.container","c":"ContainerResponseContext","l":"setStatusInfo(Response.StatusType)","u":"setStatusInfo(jakarta.ws.rs.core.Response.StatusType)"},{"p":"jakarta.ws.rs.container","c":"AsyncResponse","l":"setTimeout(long, TimeUnit)","u":"setTimeout(long,java.util.concurrent.TimeUnit)"},{"p":"jakarta.ws.rs.container","c":"AsyncResponse","l":"setTimeoutHandler(TimeoutHandler)","u":"setTimeoutHandler(jakarta.ws.rs.container.TimeoutHandler)"},{"p":"jakarta.ws.rs.ext","c":"InterceptorContext","l":"setType(Class)","u":"setType(java.lang.Class)"},{"p":"jakarta.ws.rs.client","c":"ClientRequestContext","l":"setUri(URI)","u":"setUri(java.net.URI)"},{"p":"jakarta.ws.rs.core","c":"AbstractMultivaluedMap","l":"size()"},{"p":"jakarta.ws.rs","c":"SeBootstrap.Configuration","l":"SSL_CLIENT_AUTHENTICATION"},{"p":"jakarta.ws.rs","c":"SeBootstrap.Configuration","l":"SSL_CONTEXT"},{"p":"jakarta.ws.rs","c":"SeBootstrap.Configuration","l":"sslClientAuthentication()"},{"p":"jakarta.ws.rs","c":"SeBootstrap.Configuration.Builder","l":"sslClientAuthentication(SeBootstrap.Configuration.SSLClientAuthentication)","u":"sslClientAuthentication(jakarta.ws.rs.SeBootstrap.Configuration.SSLClientAuthentication)"},{"p":"jakarta.ws.rs","c":"SeBootstrap.Configuration","l":"sslContext()"},{"p":"jakarta.ws.rs.client","c":"ClientBuilder","l":"sslContext(SSLContext)","u":"sslContext(javax.net.ssl.SSLContext)"},{"p":"jakarta.ws.rs","c":"SeBootstrap.Configuration.Builder","l":"sslContext(SSLContext)","u":"sslContext(javax.net.ssl.SSLContext)"},{"p":"jakarta.ws.rs","c":"SeBootstrap","l":"start(Application)","u":"start(jakarta.ws.rs.core.Application)"},{"p":"jakarta.ws.rs","c":"SeBootstrap","l":"start(Application, SeBootstrap.Configuration)","u":"start(jakarta.ws.rs.core.Application,jakarta.ws.rs.SeBootstrap.Configuration)"},{"p":"jakarta.ws.rs","c":"SeBootstrap","l":"start(Class)","u":"start(java.lang.Class)"},{"p":"jakarta.ws.rs","c":"SeBootstrap","l":"start(Class, SeBootstrap.Configuration)","u":"start(java.lang.Class,jakarta.ws.rs.SeBootstrap.Configuration)"},{"p":"jakarta.ws.rs.core","c":"Response.ResponseBuilder","l":"status(int)"},{"p":"jakarta.ws.rs.core","c":"Response","l":"status(int)"},{"p":"jakarta.ws.rs.core","c":"Response.ResponseBuilder","l":"status(int, String)","u":"status(int,java.lang.String)"},{"p":"jakarta.ws.rs.core","c":"Response","l":"status(int, String)","u":"status(int,java.lang.String)"},{"p":"jakarta.ws.rs.core","c":"Response.ResponseBuilder","l":"status(Response.Status)","u":"status(jakarta.ws.rs.core.Response.Status)"},{"p":"jakarta.ws.rs.core","c":"Response","l":"status(Response.Status)","u":"status(jakarta.ws.rs.core.Response.Status)"},{"p":"jakarta.ws.rs.core","c":"Response.ResponseBuilder","l":"status(Response.StatusType)","u":"status(jakarta.ws.rs.core.Response.StatusType)"},{"p":"jakarta.ws.rs.core","c":"Response","l":"status(Response.StatusType)","u":"status(jakarta.ws.rs.core.Response.StatusType)"},{"p":"jakarta.ws.rs","c":"SeBootstrap.Instance","l":"stop()"},{"p":"jakarta.ws.rs","c":"SeBootstrap.Instance","l":"stopOnShutdown(Consumer)","u":"stopOnShutdown(java.util.function.Consumer)"},{"p":"jakarta.ws.rs.core","c":"AbstractMultivaluedMap","l":"store"},{"p":"jakarta.ws.rs.core","c":"NewCookie.SameSite","l":"STRICT"},{"p":"jakarta.ws.rs.client","c":"Invocation","l":"submit()"},{"p":"jakarta.ws.rs.client","c":"Invocation","l":"submit(Class)","u":"submit(java.lang.Class)"},{"p":"jakarta.ws.rs.client","c":"Invocation","l":"submit(GenericType)","u":"submit(jakarta.ws.rs.core.GenericType)"},{"p":"jakarta.ws.rs.client","c":"Invocation","l":"submit(InvocationCallback)","u":"submit(jakarta.ws.rs.client.InvocationCallback)"},{"p":"jakarta.ws.rs.core","c":"Response.Status.Family","l":"SUCCESSFUL"},{"p":"jakarta.ws.rs.core","c":"Response.ResponseBuilder","l":"tag(EntityTag)","u":"tag(jakarta.ws.rs.core.EntityTag)"},{"p":"jakarta.ws.rs.core","c":"Response.ResponseBuilder","l":"tag(String)","u":"tag(java.lang.String)"},{"p":"jakarta.ws.rs.client","c":"Client","l":"target(Link)","u":"target(jakarta.ws.rs.core.Link)"},{"p":"jakarta.ws.rs.client","c":"Client","l":"target(String)","u":"target(java.lang.String)"},{"p":"jakarta.ws.rs.client","c":"Client","l":"target(URI)","u":"target(java.net.URI)"},{"p":"jakarta.ws.rs.client","c":"Client","l":"target(UriBuilder)","u":"target(jakarta.ws.rs.core.UriBuilder)"},{"p":"jakarta.ws.rs.sse","c":"SseEventSource.Builder","l":"target(WebTarget)","u":"target(jakarta.ws.rs.client.WebTarget)"},{"p":"jakarta.ws.rs.sse","c":"SseEventSource","l":"target(WebTarget)","u":"target(jakarta.ws.rs.client.WebTarget)"},{"p":"jakarta.ws.rs.core","c":"Response.Status","l":"TEMPORARY_REDIRECT"},{"p":"jakarta.ws.rs.core","c":"Response","l":"temporaryRedirect(URI)","u":"temporaryRedirect(java.net.URI)"},{"p":"jakarta.ws.rs.core","c":"MediaType","l":"TEXT_HTML"},{"p":"jakarta.ws.rs.core","c":"MediaType","l":"TEXT_HTML_TYPE"},{"p":"jakarta.ws.rs.core","c":"MediaType","l":"TEXT_PLAIN"},{"p":"jakarta.ws.rs.core","c":"MediaType","l":"TEXT_PLAIN_TYPE"},{"p":"jakarta.ws.rs.core","c":"MediaType","l":"TEXT_XML"},{"p":"jakarta.ws.rs.core","c":"MediaType","l":"TEXT_XML_TYPE"},{"p":"jakarta.ws.rs.client","c":"Entity","l":"text(T)"},{"p":"jakarta.ws.rs.core","c":"Link","l":"TITLE"},{"p":"jakarta.ws.rs.core","c":"Link.Builder","l":"title(String)","u":"title(java.lang.String)"},{"p":"jakarta.ws.rs.core","c":"NewCookie","l":"toCookie()"},{"p":"jakarta.ws.rs.core","c":"Response.StatusType","l":"toEnum()"},{"p":"jakarta.ws.rs.core","c":"Response.Status","l":"TOO_MANY_REQUESTS"},{"p":"jakarta.ws.rs.ext","c":"ExceptionMapper","l":"toResponse(E)"},{"p":"jakarta.ws.rs.client","c":"Entity","l":"toString()"},{"p":"jakarta.ws.rs.core","c":"AbstractMultivaluedMap","l":"toString()"},{"p":"jakarta.ws.rs.core","c":"CacheControl","l":"toString()"},{"p":"jakarta.ws.rs.core","c":"Cookie","l":"toString()"},{"p":"jakarta.ws.rs.core","c":"EntityTag","l":"toString()"},{"p":"jakarta.ws.rs.core","c":"GenericEntity","l":"toString()"},{"p":"jakarta.ws.rs.core","c":"GenericType","l":"toString()"},{"p":"jakarta.ws.rs.core","c":"Link","l":"toString()"},{"p":"jakarta.ws.rs.core","c":"MediaType","l":"toString()"},{"p":"jakarta.ws.rs.core","c":"NewCookie","l":"toString()"},{"p":"jakarta.ws.rs.core","c":"Response.Status","l":"toString()"},{"p":"jakarta.ws.rs.core","c":"Variant","l":"toString()"},{"p":"jakarta.ws.rs.ext","c":"ParamConverter","l":"toString(T)"},{"p":"jakarta.ws.rs.ext","c":"RuntimeDelegate.HeaderDelegate","l":"toString(T)"},{"p":"jakarta.ws.rs.core","c":"UriBuilder","l":"toTemplate()"},{"p":"jakarta.ws.rs.client","c":"AsyncInvoker","l":"trace()"},{"p":"jakarta.ws.rs.client","c":"CompletionStageRxInvoker","l":"trace()"},{"p":"jakarta.ws.rs.client","c":"RxInvoker","l":"trace()"},{"p":"jakarta.ws.rs.client","c":"SyncInvoker","l":"trace()"},{"p":"jakarta.ws.rs.client","c":"RxInvoker","l":"trace(Class)","u":"trace(java.lang.Class)"},{"p":"jakarta.ws.rs.client","c":"AsyncInvoker","l":"trace(Class)","u":"trace(java.lang.Class)"},{"p":"jakarta.ws.rs.client","c":"CompletionStageRxInvoker","l":"trace(Class)","u":"trace(java.lang.Class)"},{"p":"jakarta.ws.rs.client","c":"SyncInvoker","l":"trace(Class)","u":"trace(java.lang.Class)"},{"p":"jakarta.ws.rs.client","c":"RxInvoker","l":"trace(GenericType)","u":"trace(jakarta.ws.rs.core.GenericType)"},{"p":"jakarta.ws.rs.client","c":"AsyncInvoker","l":"trace(GenericType)","u":"trace(jakarta.ws.rs.core.GenericType)"},{"p":"jakarta.ws.rs.client","c":"CompletionStageRxInvoker","l":"trace(GenericType)","u":"trace(jakarta.ws.rs.core.GenericType)"},{"p":"jakarta.ws.rs.client","c":"SyncInvoker","l":"trace(GenericType)","u":"trace(jakarta.ws.rs.core.GenericType)"},{"p":"jakarta.ws.rs.client","c":"AsyncInvoker","l":"trace(InvocationCallback)","u":"trace(jakarta.ws.rs.client.InvocationCallback)"},{"p":"jakarta.ws.rs.client","c":"ClientBuilder","l":"trustStore(KeyStore)","u":"trustStore(java.security.KeyStore)"},{"p":"jakarta.ws.rs.core","c":"Link","l":"TYPE"},{"p":"jakarta.ws.rs.core","c":"Response.ResponseBuilder","l":"type(MediaType)","u":"type(jakarta.ws.rs.core.MediaType)"},{"p":"jakarta.ws.rs.core","c":"Link.Builder","l":"type(String)","u":"type(java.lang.String)"},{"p":"jakarta.ws.rs.core","c":"Response.ResponseBuilder","l":"type(String)","u":"type(java.lang.String)"},{"p":"jakarta.ws.rs.core","c":"Response.Status","l":"UNAUTHORIZED"},{"p":"jakarta.ws.rs.core","c":"Response.Status","l":"UNAVAILABLE_FOR_LEGAL_REASONS"},{"p":"jakarta.ws.rs.core","c":"Response.Status","l":"UNSUPPORTED_MEDIA_TYPE"},{"p":"jakarta.ws.rs","c":"SeBootstrap.Instance.StopResult","l":"unwrap(Class)","u":"unwrap(java.lang.Class)"},{"p":"jakarta.ws.rs","c":"SeBootstrap.Instance","l":"unwrap(Class)","u":"unwrap(java.lang.Class)"},{"p":"jakarta.ws.rs.core","c":"Link.Builder","l":"uri(String)","u":"uri(java.lang.String)"},{"p":"jakarta.ws.rs.core","c":"UriBuilder","l":"uri(String)","u":"uri(java.lang.String)"},{"p":"jakarta.ws.rs.core","c":"Link.Builder","l":"uri(URI)","u":"uri(java.net.URI)"},{"p":"jakarta.ws.rs.core","c":"UriBuilder","l":"uri(URI)","u":"uri(java.net.URI)"},{"p":"jakarta.ws.rs.core","c":"UriBuilder","l":"UriBuilder()","u":"%3Cinit%3E()"},{"p":"jakarta.ws.rs.core","c":"Link.Builder","l":"uriBuilder(UriBuilder)","u":"uriBuilder(jakarta.ws.rs.core.UriBuilder)"},{"p":"jakarta.ws.rs.core","c":"UriBuilderException","l":"UriBuilderException()","u":"%3Cinit%3E()"},{"p":"jakarta.ws.rs.core","c":"UriBuilderException","l":"UriBuilderException(String)","u":"%3Cinit%3E(java.lang.String)"},{"p":"jakarta.ws.rs.core","c":"UriBuilderException","l":"UriBuilderException(String, Throwable)","u":"%3Cinit%3E(java.lang.String,java.lang.Throwable)"},{"p":"jakarta.ws.rs.core","c":"UriBuilderException","l":"UriBuilderException(Throwable)","u":"%3Cinit%3E(java.lang.Throwable)"},{"p":"jakarta.ws.rs.core","c":"Response.Status","l":"USE_PROXY"},{"p":"jakarta.ws.rs","c":"Priorities","l":"USER"},{"p":"jakarta.ws.rs.core","c":"HttpHeaders","l":"USER_AGENT"},{"p":"jakarta.ws.rs.core","c":"UriBuilder","l":"userInfo(String)","u":"userInfo(java.lang.String)"},{"p":"jakarta.ws.rs","c":"ApplicationPath","l":"value()"},{"p":"jakarta.ws.rs","c":"ConstrainedTo","l":"value()"},{"p":"jakarta.ws.rs","c":"Consumes","l":"value()"},{"p":"jakarta.ws.rs","c":"CookieParam","l":"value()"},{"p":"jakarta.ws.rs","c":"DefaultValue","l":"value()"},{"p":"jakarta.ws.rs","c":"FormParam","l":"value()"},{"p":"jakarta.ws.rs","c":"HeaderParam","l":"value()"},{"p":"jakarta.ws.rs","c":"HttpMethod","l":"value()"},{"p":"jakarta.ws.rs","c":"MatrixParam","l":"value()"},{"p":"jakarta.ws.rs","c":"Path","l":"value()"},{"p":"jakarta.ws.rs","c":"PathParam","l":"value()"},{"p":"jakarta.ws.rs","c":"Produces","l":"value()"},{"p":"jakarta.ws.rs","c":"QueryParam","l":"value()"},{"p":"jakarta.ws.rs.core","c":"Cookie.AbstractCookieBuilder","l":"value(String)","u":"value(java.lang.String)"},{"p":"jakarta.ws.rs.core","c":"CacheControl","l":"valueOf(String)","u":"valueOf(java.lang.String)"},{"p":"jakarta.ws.rs.core","c":"Cookie","l":"valueOf(String)","u":"valueOf(java.lang.String)"},{"p":"jakarta.ws.rs.core","c":"EntityTag","l":"valueOf(String)","u":"valueOf(java.lang.String)"},{"p":"jakarta.ws.rs.core","c":"Link","l":"valueOf(String)","u":"valueOf(java.lang.String)"},{"p":"jakarta.ws.rs.core","c":"MediaType","l":"valueOf(String)","u":"valueOf(java.lang.String)"},{"p":"jakarta.ws.rs.core","c":"NewCookie.SameSite","l":"valueOf(String)","u":"valueOf(java.lang.String)"},{"p":"jakarta.ws.rs.core","c":"NewCookie","l":"valueOf(String)","u":"valueOf(java.lang.String)"},{"p":"jakarta.ws.rs.core","c":"Response.Status.Family","l":"valueOf(String)","u":"valueOf(java.lang.String)"},{"p":"jakarta.ws.rs.core","c":"Response.Status","l":"valueOf(String)","u":"valueOf(java.lang.String)"},{"p":"jakarta.ws.rs","c":"RuntimeType","l":"valueOf(String)","u":"valueOf(java.lang.String)"},{"p":"jakarta.ws.rs","c":"SeBootstrap.Configuration.SSLClientAuthentication","l":"valueOf(String)","u":"valueOf(java.lang.String)"},{"p":"jakarta.ws.rs.core","c":"AbstractMultivaluedMap","l":"values()"},{"p":"jakarta.ws.rs.core","c":"NewCookie.SameSite","l":"values()"},{"p":"jakarta.ws.rs.core","c":"Response.Status.Family","l":"values()"},{"p":"jakarta.ws.rs.core","c":"Response.Status","l":"values()"},{"p":"jakarta.ws.rs","c":"RuntimeType","l":"values()"},{"p":"jakarta.ws.rs","c":"SeBootstrap.Configuration.SSLClientAuthentication","l":"values()"},{"p":"jakarta.ws.rs.core","c":"Variant","l":"Variant(MediaType, Locale, String)","u":"%3Cinit%3E(jakarta.ws.rs.core.MediaType,java.util.Locale,java.lang.String)"},{"p":"jakarta.ws.rs.core","c":"Variant","l":"Variant(MediaType, String, String)","u":"%3Cinit%3E(jakarta.ws.rs.core.MediaType,java.lang.String,java.lang.String)"},{"p":"jakarta.ws.rs.core","c":"Variant","l":"Variant(MediaType, String, String, String)","u":"%3Cinit%3E(jakarta.ws.rs.core.MediaType,java.lang.String,java.lang.String,java.lang.String)"},{"p":"jakarta.ws.rs.core","c":"Variant","l":"Variant(MediaType, String, String, String, String)","u":"%3Cinit%3E(jakarta.ws.rs.core.MediaType,java.lang.String,java.lang.String,java.lang.String,java.lang.String)"},{"p":"jakarta.ws.rs.core","c":"Response.ResponseBuilder","l":"variant(Variant)","u":"variant(jakarta.ws.rs.core.Variant)"},{"p":"jakarta.ws.rs.core","c":"Variant.VariantListBuilder","l":"VariantListBuilder()","u":"%3Cinit%3E()"},{"p":"jakarta.ws.rs.core","c":"Response.ResponseBuilder","l":"variants(List)","u":"variants(java.util.List)"},{"p":"jakarta.ws.rs.core","c":"Response.ResponseBuilder","l":"variants(Variant...)","u":"variants(jakarta.ws.rs.core.Variant...)"},{"p":"jakarta.ws.rs.core","c":"HttpHeaders","l":"VARY"},{"p":"jakarta.ws.rs.core","c":"Cookie.AbstractCookieBuilder","l":"version(int)"},{"p":"jakarta.ws.rs","c":"WebApplicationException","l":"WebApplicationException()","u":"%3Cinit%3E()"},{"p":"jakarta.ws.rs","c":"WebApplicationException","l":"WebApplicationException(int)","u":"%3Cinit%3E(int)"},{"p":"jakarta.ws.rs","c":"WebApplicationException","l":"WebApplicationException(Response)","u":"%3Cinit%3E(jakarta.ws.rs.core.Response)"},{"p":"jakarta.ws.rs","c":"WebApplicationException","l":"WebApplicationException(Response.Status)","u":"%3Cinit%3E(jakarta.ws.rs.core.Response.Status)"},{"p":"jakarta.ws.rs","c":"WebApplicationException","l":"WebApplicationException(String)","u":"%3Cinit%3E(java.lang.String)"},{"p":"jakarta.ws.rs","c":"WebApplicationException","l":"WebApplicationException(String, int)","u":"%3Cinit%3E(java.lang.String,int)"},{"p":"jakarta.ws.rs","c":"WebApplicationException","l":"WebApplicationException(String, Response)","u":"%3Cinit%3E(java.lang.String,jakarta.ws.rs.core.Response)"},{"p":"jakarta.ws.rs","c":"WebApplicationException","l":"WebApplicationException(String, Response.Status)","u":"%3Cinit%3E(java.lang.String,jakarta.ws.rs.core.Response.Status)"},{"p":"jakarta.ws.rs","c":"WebApplicationException","l":"WebApplicationException(String, Throwable)","u":"%3Cinit%3E(java.lang.String,java.lang.Throwable)"},{"p":"jakarta.ws.rs","c":"WebApplicationException","l":"WebApplicationException(String, Throwable, int)","u":"%3Cinit%3E(java.lang.String,java.lang.Throwable,int)"},{"p":"jakarta.ws.rs","c":"WebApplicationException","l":"WebApplicationException(String, Throwable, Response)","u":"%3Cinit%3E(java.lang.String,java.lang.Throwable,jakarta.ws.rs.core.Response)"},{"p":"jakarta.ws.rs","c":"WebApplicationException","l":"WebApplicationException(String, Throwable, Response.Status)","u":"%3Cinit%3E(java.lang.String,java.lang.Throwable,jakarta.ws.rs.core.Response.Status)"},{"p":"jakarta.ws.rs","c":"WebApplicationException","l":"WebApplicationException(Throwable)","u":"%3Cinit%3E(java.lang.Throwable)"},{"p":"jakarta.ws.rs","c":"WebApplicationException","l":"WebApplicationException(Throwable, int)","u":"%3Cinit%3E(java.lang.Throwable,int)"},{"p":"jakarta.ws.rs","c":"WebApplicationException","l":"WebApplicationException(Throwable, Response)","u":"%3Cinit%3E(java.lang.Throwable,jakarta.ws.rs.core.Response)"},{"p":"jakarta.ws.rs","c":"WebApplicationException","l":"WebApplicationException(Throwable, Response.Status)","u":"%3Cinit%3E(java.lang.Throwable,jakarta.ws.rs.core.Response.Status)"},{"p":"jakarta.ws.rs.core","c":"MediaType","l":"WILDCARD"},{"p":"jakarta.ws.rs.core","c":"MediaType","l":"WILDCARD_TYPE"},{"p":"jakarta.ws.rs.core","c":"MediaType","l":"withCharset(String)","u":"withCharset(java.lang.String)"},{"p":"jakarta.ws.rs.client","c":"ClientBuilder","l":"withConfig(Configuration)","u":"withConfig(jakarta.ws.rs.core.Configuration)"},{"p":"jakarta.ws.rs.core","c":"EntityPart","l":"withFileName(String)","u":"withFileName(java.lang.String)"},{"p":"jakarta.ws.rs.core","c":"EntityPart","l":"withName(String)","u":"withName(java.lang.String)"},{"p":"jakarta.ws.rs.core","c":"StreamingOutput","l":"write(OutputStream)","u":"write(java.io.OutputStream)"},{"p":"jakarta.ws.rs.ext","c":"MessageBodyWriter","l":"writeTo(T, Class, Type, Annotation[], MediaType, MultivaluedMap, OutputStream)","u":"writeTo(T,java.lang.Class,java.lang.reflect.Type,java.lang.annotation.Annotation[],jakarta.ws.rs.core.MediaType,jakarta.ws.rs.core.MultivaluedMap,java.io.OutputStream)"},{"p":"jakarta.ws.rs.core","c":"HttpHeaders","l":"WWW_AUTHENTICATE"},{"p":"jakarta.ws.rs.client","c":"Entity","l":"xhtml(T)"},{"p":"jakarta.ws.rs.client","c":"Entity","l":"xml(T)"}];updateSearchResults(); \ No newline at end of file diff --git a/restful-ws/4.0/apidocs/module-search-index.js b/restful-ws/4.0/apidocs/module-search-index.js new file mode 100644 index 0000000000..fb6851075e --- /dev/null +++ b/restful-ws/4.0/apidocs/module-search-index.js @@ -0,0 +1 @@ +moduleSearchIndex = [{"l":"jakarta.ws.rs"}];updateSearchResults(); \ No newline at end of file diff --git a/restful-ws/4.0/apidocs/overview-summary.html b/restful-ws/4.0/apidocs/overview-summary.html new file mode 100644 index 0000000000..01e15bba45 --- /dev/null +++ b/restful-ws/4.0/apidocs/overview-summary.html @@ -0,0 +1,25 @@ + + + + +Jakarta RESTful WS API 4.0.0 API + + + + + + + + + + +
+ +

index.html

+
+ + diff --git a/restful-ws/4.0/apidocs/overview-tree.html b/restful-ws/4.0/apidocs/overview-tree.html new file mode 100644 index 0000000000..ed9b83a847 --- /dev/null +++ b/restful-ws/4.0/apidocs/overview-tree.html @@ -0,0 +1,310 @@ + + + + +Class Hierarchy (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Hierarchy For All Packages

+
+Package Hierarchies: + +
+

Class Hierarchy

+ +
+
+

Interface Hierarchy

+ +
+
+

Annotation Interface Hierarchy

+ +
+
+

Enum Class Hierarchy

+ +
+
+
+
+

Copyright © 2018, 2024 Eclipse Foundation.
Use is subject to license terms.

+
+
+
+ + diff --git a/restful-ws/4.0/apidocs/package-search-index.js b/restful-ws/4.0/apidocs/package-search-index.js new file mode 100644 index 0000000000..a866d06a76 --- /dev/null +++ b/restful-ws/4.0/apidocs/package-search-index.js @@ -0,0 +1 @@ +packageSearchIndex = [{"l":"All Packages","u":"allpackages-index.html"},{"m":"jakarta.ws.rs","l":"jakarta.ws.rs"},{"m":"jakarta.ws.rs","l":"jakarta.ws.rs.client"},{"m":"jakarta.ws.rs","l":"jakarta.ws.rs.container"},{"m":"jakarta.ws.rs","l":"jakarta.ws.rs.core"},{"m":"jakarta.ws.rs","l":"jakarta.ws.rs.ext"},{"m":"jakarta.ws.rs","l":"jakarta.ws.rs.sse"}];updateSearchResults(); \ No newline at end of file diff --git a/restful-ws/4.0/apidocs/resources/EFSL.html b/restful-ws/4.0/apidocs/resources/EFSL.html new file mode 100644 index 0000000000..c222f1b928 --- /dev/null +++ b/restful-ws/4.0/apidocs/resources/EFSL.html @@ -0,0 +1,72 @@ + + + Eclipse Foundation Specification License - v1.0 + + +

Eclipse Foundation Specification License - v1.0

+

By using and/or copying this document, or the Eclipse Foundation + document from which this statement is linked, you (the licensee) agree + that you have read, understood, and will comply with the following + terms and conditions:

+ +

Permission to copy, and distribute the contents of this document, or + the Eclipse Foundation document from which this statement is linked, in + any medium for any purpose and without fee or royalty is hereby + granted, provided that you include the following on ALL copies of the + document, or portions thereof, that you use:

+ +
    +
  • link or URL to the original Eclipse Foundation document.
    • +
  • All existing copyright notices, or if one does not exist, a notice + (hypertext is preferred, but a textual representation is permitted) + of the form: "Copyright © [$date-of-document] + Eclipse Foundation, Inc. <<url to this license>> + " +
    • +
+ +

Inclusion of the full text of this NOTICE must be provided. We + request that authorship attribution be provided in any software, + documents, or other items or products that you create pursuant to the + implementation of the contents of this document, or any portion + thereof.

+ +

No right to create modifications or derivatives of Eclipse Foundation + documents is granted pursuant to this license, except anyone may + prepare and distribute derivative works and portions of this document + in software that implements the specification, in supporting materials + accompanying such software, and in documentation of such software, + PROVIDED that all such works include the notice below. HOWEVER, the + publication of derivative works of this document for use as a technical + specification is expressly prohibited.

+ +

The notice is:

+ +

"Copyright © [$date-of-document] Eclipse Foundation. This software or + document includes material copied from or derived from [title and URI + of the Eclipse Foundation specification document]."

+ +

Disclaimers

+ +

THIS DOCUMENT IS PROVIDED "AS IS," AND THE COPYRIGHT + HOLDERS AND THE ECLIPSE FOUNDATION MAKE NO REPRESENTATIONS OR + WARRANTIES, EXPRESS OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, + WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, + NON-INFRINGEMENT, OR TITLE; THAT THE CONTENTS OF THE DOCUMENT ARE + SUITABLE FOR ANY PURPOSE; NOR THAT THE IMPLEMENTATION OF SUCH CONTENTS + WILL NOT INFRINGE ANY THIRD PARTY PATENTS, COPYRIGHTS, TRADEMARKS OR + OTHER RIGHTS.

+ +

THE COPYRIGHT HOLDERS AND THE ECLIPSE FOUNDATION WILL NOT BE LIABLE + FOR ANY DIRECT, INDIRECT, SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT + OF ANY USE OF THE DOCUMENT OR THE PERFORMANCE OR IMPLEMENTATION OF THE + CONTENTS THEREOF.

+ +

The name and trademarks of the copyright holders or the Eclipse + Foundation may NOT be used in advertising or publicity pertaining to + this document or its contents without specific, written prior + permission. Title to copyright in this document will at all times + remain with copyright holders.

+ + + diff --git a/restful-ws/4.0/apidocs/resources/glass.png b/restful-ws/4.0/apidocs/resources/glass.png new file mode 100644 index 0000000000000000000000000000000000000000..a7f591f467a1c0c949bbc510156a0c1afb860a6e GIT binary patch literal 499 zcmVJoRsvExf%rEN>jUL}qZ_~k#FbE+Q;{`;0FZwVNX2n-^JoI; zP;4#$8DIy*Yk-P>VN(DUKmPse7mx+ExD4O|;?E5D0Z5($mjO3`*anwQU^s{ZDK#Lz zj>~{qyaIx5K!t%=G&2IJNzg!ChRpyLkO7}Ry!QaotAHAMpbB3AF(}|_f!G-oI|uK6 z`id_dumai5K%C3Y$;tKS_iqMPHg<*|-@e`liWLAggVM!zAP#@l;=c>S03;{#04Z~5 zN_+ss=Yg6*hTr59mzMwZ@+l~q!+?ft!fF66AXT#wWavHt30bZWFCK%!BNk}LN?0Hg z1VF_nfs`Lm^DjYZ1(1uD0u4CSIr)XAaqW6IT{!St5~1{i=i}zAy76p%_|w8rh@@c0Axr!ns=D-X+|*sY6!@wacG9%)Qn*O zl0sa739kT-&_?#oVxXF6tOnqTD)cZ}2vi$`ZU8RLAlo8=_z#*P3xI~i!lEh+Pdu-L zx{d*wgjtXbnGX_Yf@Tc7Q3YhLhPvc8noGJs2DA~1DySiA&6V{5JzFt ojAY1KXm~va;tU{v7C?Xj0BHw!K;2aXV*mgE07*qoM6N<$f;4TDA^-pY literal 0 HcmV?d00001 diff --git a/restful-ws/4.0/apidocs/script-dir/jquery-3.6.1.min.js b/restful-ws/4.0/apidocs/script-dir/jquery-3.6.1.min.js new file mode 100644 index 0000000000..2c69bc908b --- /dev/null +++ b/restful-ws/4.0/apidocs/script-dir/jquery-3.6.1.min.js @@ -0,0 +1,2 @@ +/*! jQuery v3.6.1 | (c) OpenJS Foundation and other contributors | jquery.org/license */ +!function(e,t){"use strict";"object"==typeof module&&"object"==typeof module.exports?module.exports=e.document?t(e,!0):function(e){if(!e.document)throw new Error("jQuery requires a window with a document");return t(e)}:t(e)}("undefined"!=typeof window?window:this,function(C,e){"use strict";var t=[],r=Object.getPrototypeOf,s=t.slice,g=t.flat?function(e){return t.flat.call(e)}:function(e){return t.concat.apply([],e)},u=t.push,i=t.indexOf,n={},o=n.toString,y=n.hasOwnProperty,a=y.toString,l=a.call(Object),v={},m=function(e){return"function"==typeof e&&"number"!=typeof e.nodeType&&"function"!=typeof e.item},x=function(e){return null!=e&&e===e.window},E=C.document,c={type:!0,src:!0,nonce:!0,noModule:!0};function b(e,t,n){var r,i,o=(n=n||E).createElement("script");if(o.text=e,t)for(r in c)(i=t[r]||t.getAttribute&&t.getAttribute(r))&&o.setAttribute(r,i);n.head.appendChild(o).parentNode.removeChild(o)}function w(e){return null==e?e+"":"object"==typeof e||"function"==typeof e?n[o.call(e)]||"object":typeof e}var f="3.6.1",S=function(e,t){return new S.fn.init(e,t)};function p(e){var t=!!e&&"length"in e&&e.length,n=w(e);return!m(e)&&!x(e)&&("array"===n||0===t||"number"==typeof t&&0+~]|"+M+")"+M+"*"),U=new RegExp(M+"|>"),X=new RegExp(F),V=new RegExp("^"+I+"$"),G={ID:new RegExp("^#("+I+")"),CLASS:new RegExp("^\\.("+I+")"),TAG:new RegExp("^("+I+"|[*])"),ATTR:new RegExp("^"+W),PSEUDO:new RegExp("^"+F),CHILD:new RegExp("^:(only|first|last|nth|nth-last)-(child|of-type)(?:\\("+M+"*(even|odd|(([+-]|)(\\d*)n|)"+M+"*(?:([+-]|)"+M+"*(\\d+)|))"+M+"*\\)|)","i"),bool:new RegExp("^(?:"+R+")$","i"),needsContext:new RegExp("^"+M+"*[>+~]|:(even|odd|eq|gt|lt|nth|first|last)(?:\\("+M+"*((?:-\\d)?\\d*)"+M+"*\\)|)(?=[^-]|$)","i")},Y=/HTML$/i,Q=/^(?:input|select|textarea|button)$/i,J=/^h\d$/i,K=/^[^{]+\{\s*\[native \w/,Z=/^(?:#([\w-]+)|(\w+)|\.([\w-]+))$/,ee=/[+~]/,te=new RegExp("\\\\[\\da-fA-F]{1,6}"+M+"?|\\\\([^\\r\\n\\f])","g"),ne=function(e,t){var n="0x"+e.slice(1)-65536;return t||(n<0?String.fromCharCode(n+65536):String.fromCharCode(n>>10|55296,1023&n|56320))},re=/([\0-\x1f\x7f]|^-?\d)|^-$|[^\0-\x1f\x7f-\uFFFF\w-]/g,ie=function(e,t){return t?"\0"===e?"\ufffd":e.slice(0,-1)+"\\"+e.charCodeAt(e.length-1).toString(16)+" ":"\\"+e},oe=function(){T()},ae=be(function(e){return!0===e.disabled&&"fieldset"===e.nodeName.toLowerCase()},{dir:"parentNode",next:"legend"});try{H.apply(t=O.call(p.childNodes),p.childNodes),t[p.childNodes.length].nodeType}catch(e){H={apply:t.length?function(e,t){L.apply(e,O.call(t))}:function(e,t){var n=e.length,r=0;while(e[n++]=t[r++]);e.length=n-1}}}function se(t,e,n,r){var i,o,a,s,u,l,c,f=e&&e.ownerDocument,p=e?e.nodeType:9;if(n=n||[],"string"!=typeof t||!t||1!==p&&9!==p&&11!==p)return n;if(!r&&(T(e),e=e||C,E)){if(11!==p&&(u=Z.exec(t)))if(i=u[1]){if(9===p){if(!(a=e.getElementById(i)))return n;if(a.id===i)return n.push(a),n}else if(f&&(a=f.getElementById(i))&&v(e,a)&&a.id===i)return n.push(a),n}else{if(u[2])return H.apply(n,e.getElementsByTagName(t)),n;if((i=u[3])&&d.getElementsByClassName&&e.getElementsByClassName)return H.apply(n,e.getElementsByClassName(i)),n}if(d.qsa&&!N[t+" "]&&(!y||!y.test(t))&&(1!==p||"object"!==e.nodeName.toLowerCase())){if(c=t,f=e,1===p&&(U.test(t)||z.test(t))){(f=ee.test(t)&&ve(e.parentNode)||e)===e&&d.scope||((s=e.getAttribute("id"))?s=s.replace(re,ie):e.setAttribute("id",s=S)),o=(l=h(t)).length;while(o--)l[o]=(s?"#"+s:":scope")+" "+xe(l[o]);c=l.join(",")}try{return H.apply(n,f.querySelectorAll(c)),n}catch(e){N(t,!0)}finally{s===S&&e.removeAttribute("id")}}}return g(t.replace(B,"$1"),e,n,r)}function ue(){var r=[];return function e(t,n){return r.push(t+" ")>b.cacheLength&&delete e[r.shift()],e[t+" "]=n}}function le(e){return e[S]=!0,e}function ce(e){var t=C.createElement("fieldset");try{return!!e(t)}catch(e){return!1}finally{t.parentNode&&t.parentNode.removeChild(t),t=null}}function fe(e,t){var n=e.split("|"),r=n.length;while(r--)b.attrHandle[n[r]]=t}function pe(e,t){var n=t&&e,r=n&&1===e.nodeType&&1===t.nodeType&&e.sourceIndex-t.sourceIndex;if(r)return r;if(n)while(n=n.nextSibling)if(n===t)return-1;return e?1:-1}function de(t){return function(e){return"input"===e.nodeName.toLowerCase()&&e.type===t}}function he(n){return function(e){var t=e.nodeName.toLowerCase();return("input"===t||"button"===t)&&e.type===n}}function ge(t){return function(e){return"form"in e?e.parentNode&&!1===e.disabled?"label"in e?"label"in e.parentNode?e.parentNode.disabled===t:e.disabled===t:e.isDisabled===t||e.isDisabled!==!t&&ae(e)===t:e.disabled===t:"label"in e&&e.disabled===t}}function ye(a){return le(function(o){return o=+o,le(function(e,t){var n,r=a([],e.length,o),i=r.length;while(i--)e[n=r[i]]&&(e[n]=!(t[n]=e[n]))})})}function ve(e){return e&&"undefined"!=typeof e.getElementsByTagName&&e}for(e in d=se.support={},i=se.isXML=function(e){var t=e&&e.namespaceURI,n=e&&(e.ownerDocument||e).documentElement;return!Y.test(t||n&&n.nodeName||"HTML")},T=se.setDocument=function(e){var t,n,r=e?e.ownerDocument||e:p;return r!=C&&9===r.nodeType&&r.documentElement&&(a=(C=r).documentElement,E=!i(C),p!=C&&(n=C.defaultView)&&n.top!==n&&(n.addEventListener?n.addEventListener("unload",oe,!1):n.attachEvent&&n.attachEvent("onunload",oe)),d.scope=ce(function(e){return a.appendChild(e).appendChild(C.createElement("div")),"undefined"!=typeof e.querySelectorAll&&!e.querySelectorAll(":scope fieldset div").length}),d.attributes=ce(function(e){return e.className="i",!e.getAttribute("className")}),d.getElementsByTagName=ce(function(e){return e.appendChild(C.createComment("")),!e.getElementsByTagName("*").length}),d.getElementsByClassName=K.test(C.getElementsByClassName),d.getById=ce(function(e){return a.appendChild(e).id=S,!C.getElementsByName||!C.getElementsByName(S).length}),d.getById?(b.filter.ID=function(e){var t=e.replace(te,ne);return function(e){return e.getAttribute("id")===t}},b.find.ID=function(e,t){if("undefined"!=typeof t.getElementById&&E){var n=t.getElementById(e);return n?[n]:[]}}):(b.filter.ID=function(e){var n=e.replace(te,ne);return function(e){var t="undefined"!=typeof e.getAttributeNode&&e.getAttributeNode("id");return t&&t.value===n}},b.find.ID=function(e,t){if("undefined"!=typeof t.getElementById&&E){var n,r,i,o=t.getElementById(e);if(o){if((n=o.getAttributeNode("id"))&&n.value===e)return[o];i=t.getElementsByName(e),r=0;while(o=i[r++])if((n=o.getAttributeNode("id"))&&n.value===e)return[o]}return[]}}),b.find.TAG=d.getElementsByTagName?function(e,t){return"undefined"!=typeof t.getElementsByTagName?t.getElementsByTagName(e):d.qsa?t.querySelectorAll(e):void 0}:function(e,t){var n,r=[],i=0,o=t.getElementsByTagName(e);if("*"===e){while(n=o[i++])1===n.nodeType&&r.push(n);return r}return o},b.find.CLASS=d.getElementsByClassName&&function(e,t){if("undefined"!=typeof t.getElementsByClassName&&E)return t.getElementsByClassName(e)},s=[],y=[],(d.qsa=K.test(C.querySelectorAll))&&(ce(function(e){var t;a.appendChild(e).innerHTML="",e.querySelectorAll("[msallowcapture^='']").length&&y.push("[*^$]="+M+"*(?:''|\"\")"),e.querySelectorAll("[selected]").length||y.push("\\["+M+"*(?:value|"+R+")"),e.querySelectorAll("[id~="+S+"-]").length||y.push("~="),(t=C.createElement("input")).setAttribute("name",""),e.appendChild(t),e.querySelectorAll("[name='']").length||y.push("\\["+M+"*name"+M+"*="+M+"*(?:''|\"\")"),e.querySelectorAll(":checked").length||y.push(":checked"),e.querySelectorAll("a#"+S+"+*").length||y.push(".#.+[+~]"),e.querySelectorAll("\\\f"),y.push("[\\r\\n\\f]")}),ce(function(e){e.innerHTML="";var t=C.createElement("input");t.setAttribute("type","hidden"),e.appendChild(t).setAttribute("name","D"),e.querySelectorAll("[name=d]").length&&y.push("name"+M+"*[*^$|!~]?="),2!==e.querySelectorAll(":enabled").length&&y.push(":enabled",":disabled"),a.appendChild(e).disabled=!0,2!==e.querySelectorAll(":disabled").length&&y.push(":enabled",":disabled"),e.querySelectorAll("*,:x"),y.push(",.*:")})),(d.matchesSelector=K.test(c=a.matches||a.webkitMatchesSelector||a.mozMatchesSelector||a.oMatchesSelector||a.msMatchesSelector))&&ce(function(e){d.disconnectedMatch=c.call(e,"*"),c.call(e,"[s!='']:x"),s.push("!=",F)}),y=y.length&&new RegExp(y.join("|")),s=s.length&&new RegExp(s.join("|")),t=K.test(a.compareDocumentPosition),v=t||K.test(a.contains)?function(e,t){var n=9===e.nodeType?e.documentElement:e,r=t&&t.parentNode;return e===r||!(!r||1!==r.nodeType||!(n.contains?n.contains(r):e.compareDocumentPosition&&16&e.compareDocumentPosition(r)))}:function(e,t){if(t)while(t=t.parentNode)if(t===e)return!0;return!1},j=t?function(e,t){if(e===t)return l=!0,0;var n=!e.compareDocumentPosition-!t.compareDocumentPosition;return n||(1&(n=(e.ownerDocument||e)==(t.ownerDocument||t)?e.compareDocumentPosition(t):1)||!d.sortDetached&&t.compareDocumentPosition(e)===n?e==C||e.ownerDocument==p&&v(p,e)?-1:t==C||t.ownerDocument==p&&v(p,t)?1:u?P(u,e)-P(u,t):0:4&n?-1:1)}:function(e,t){if(e===t)return l=!0,0;var n,r=0,i=e.parentNode,o=t.parentNode,a=[e],s=[t];if(!i||!o)return e==C?-1:t==C?1:i?-1:o?1:u?P(u,e)-P(u,t):0;if(i===o)return pe(e,t);n=e;while(n=n.parentNode)a.unshift(n);n=t;while(n=n.parentNode)s.unshift(n);while(a[r]===s[r])r++;return r?pe(a[r],s[r]):a[r]==p?-1:s[r]==p?1:0}),C},se.matches=function(e,t){return se(e,null,null,t)},se.matchesSelector=function(e,t){if(T(e),d.matchesSelector&&E&&!N[t+" "]&&(!s||!s.test(t))&&(!y||!y.test(t)))try{var n=c.call(e,t);if(n||d.disconnectedMatch||e.document&&11!==e.document.nodeType)return n}catch(e){N(t,!0)}return 0":{dir:"parentNode",first:!0}," ":{dir:"parentNode"},"+":{dir:"previousSibling",first:!0},"~":{dir:"previousSibling"}},preFilter:{ATTR:function(e){return e[1]=e[1].replace(te,ne),e[3]=(e[3]||e[4]||e[5]||"").replace(te,ne),"~="===e[2]&&(e[3]=" "+e[3]+" "),e.slice(0,4)},CHILD:function(e){return e[1]=e[1].toLowerCase(),"nth"===e[1].slice(0,3)?(e[3]||se.error(e[0]),e[4]=+(e[4]?e[5]+(e[6]||1):2*("even"===e[3]||"odd"===e[3])),e[5]=+(e[7]+e[8]||"odd"===e[3])):e[3]&&se.error(e[0]),e},PSEUDO:function(e){var t,n=!e[6]&&e[2];return G.CHILD.test(e[0])?null:(e[3]?e[2]=e[4]||e[5]||"":n&&X.test(n)&&(t=h(n,!0))&&(t=n.indexOf(")",n.length-t)-n.length)&&(e[0]=e[0].slice(0,t),e[2]=n.slice(0,t)),e.slice(0,3))}},filter:{TAG:function(e){var t=e.replace(te,ne).toLowerCase();return"*"===e?function(){return!0}:function(e){return e.nodeName&&e.nodeName.toLowerCase()===t}},CLASS:function(e){var t=m[e+" "];return t||(t=new RegExp("(^|"+M+")"+e+"("+M+"|$)"))&&m(e,function(e){return t.test("string"==typeof e.className&&e.className||"undefined"!=typeof e.getAttribute&&e.getAttribute("class")||"")})},ATTR:function(n,r,i){return function(e){var t=se.attr(e,n);return null==t?"!="===r:!r||(t+="","="===r?t===i:"!="===r?t!==i:"^="===r?i&&0===t.indexOf(i):"*="===r?i&&-1:\x20\t\r\n\f]*)[\x20\t\r\n\f]*\/?>(?:<\/\1>|)$/i;function j(e,n,r){return m(n)?S.grep(e,function(e,t){return!!n.call(e,t,e)!==r}):n.nodeType?S.grep(e,function(e){return e===n!==r}):"string"!=typeof n?S.grep(e,function(e){return-1)[^>]*|#([\w-]+))$/;(S.fn.init=function(e,t,n){var r,i;if(!e)return this;if(n=n||D,"string"==typeof e){if(!(r="<"===e[0]&&">"===e[e.length-1]&&3<=e.length?[null,e,null]:q.exec(e))||!r[1]&&t)return!t||t.jquery?(t||n).find(e):this.constructor(t).find(e);if(r[1]){if(t=t instanceof S?t[0]:t,S.merge(this,S.parseHTML(r[1],t&&t.nodeType?t.ownerDocument||t:E,!0)),N.test(r[1])&&S.isPlainObject(t))for(r in t)m(this[r])?this[r](t[r]):this.attr(r,t[r]);return this}return(i=E.getElementById(r[2]))&&(this[0]=i,this.length=1),this}return e.nodeType?(this[0]=e,this.length=1,this):m(e)?void 0!==n.ready?n.ready(e):e(S):S.makeArray(e,this)}).prototype=S.fn,D=S(E);var L=/^(?:parents|prev(?:Until|All))/,H={children:!0,contents:!0,next:!0,prev:!0};function O(e,t){while((e=e[t])&&1!==e.nodeType);return e}S.fn.extend({has:function(e){var t=S(e,this),n=t.length;return this.filter(function(){for(var e=0;e\x20\t\r\n\f]*)/i,he=/^$|^module$|\/(?:java|ecma)script/i;ce=E.createDocumentFragment().appendChild(E.createElement("div")),(fe=E.createElement("input")).setAttribute("type","radio"),fe.setAttribute("checked","checked"),fe.setAttribute("name","t"),ce.appendChild(fe),v.checkClone=ce.cloneNode(!0).cloneNode(!0).lastChild.checked,ce.innerHTML="",v.noCloneChecked=!!ce.cloneNode(!0).lastChild.defaultValue,ce.innerHTML="",v.option=!!ce.lastChild;var ge={thead:[1,"","
"],col:[2,"","
"],tr:[2,"","
"],td:[3,"","
"],_default:[0,"",""]};function ye(e,t){var n;return n="undefined"!=typeof e.getElementsByTagName?e.getElementsByTagName(t||"*"):"undefined"!=typeof e.querySelectorAll?e.querySelectorAll(t||"*"):[],void 0===t||t&&A(e,t)?S.merge([e],n):n}function ve(e,t){for(var n=0,r=e.length;n",""]);var me=/<|&#?\w+;/;function xe(e,t,n,r,i){for(var o,a,s,u,l,c,f=t.createDocumentFragment(),p=[],d=0,h=e.length;d\s*$/g;function je(e,t){return A(e,"table")&&A(11!==t.nodeType?t:t.firstChild,"tr")&&S(e).children("tbody")[0]||e}function De(e){return e.type=(null!==e.getAttribute("type"))+"/"+e.type,e}function qe(e){return"true/"===(e.type||"").slice(0,5)?e.type=e.type.slice(5):e.removeAttribute("type"),e}function Le(e,t){var n,r,i,o,a,s;if(1===t.nodeType){if(Y.hasData(e)&&(s=Y.get(e).events))for(i in Y.remove(t,"handle events"),s)for(n=0,r=s[i].length;n").attr(n.scriptAttrs||{}).prop({charset:n.scriptCharset,src:n.url}).on("load error",i=function(e){r.remove(),i=null,e&&t("error"===e.type?404:200,e.type)}),E.head.appendChild(r[0])},abort:function(){i&&i()}}});var Ut,Xt=[],Vt=/(=)\?(?=&|$)|\?\?/;S.ajaxSetup({jsonp:"callback",jsonpCallback:function(){var e=Xt.pop()||S.expando+"_"+Ct.guid++;return this[e]=!0,e}}),S.ajaxPrefilter("json jsonp",function(e,t,n){var r,i,o,a=!1!==e.jsonp&&(Vt.test(e.url)?"url":"string"==typeof e.data&&0===(e.contentType||"").indexOf("application/x-www-form-urlencoded")&&Vt.test(e.data)&&"data");if(a||"jsonp"===e.dataTypes[0])return r=e.jsonpCallback=m(e.jsonpCallback)?e.jsonpCallback():e.jsonpCallback,a?e[a]=e[a].replace(Vt,"$1"+r):!1!==e.jsonp&&(e.url+=(Et.test(e.url)?"&":"?")+e.jsonp+"="+r),e.converters["script json"]=function(){return o||S.error(r+" was not called"),o[0]},e.dataTypes[0]="json",i=C[r],C[r]=function(){o=arguments},n.always(function(){void 0===i?S(C).removeProp(r):C[r]=i,e[r]&&(e.jsonpCallback=t.jsonpCallback,Xt.push(r)),o&&m(i)&&i(o[0]),o=i=void 0}),"script"}),v.createHTMLDocument=((Ut=E.implementation.createHTMLDocument("").body).innerHTML="
",2===Ut.childNodes.length),S.parseHTML=function(e,t,n){return"string"!=typeof e?[]:("boolean"==typeof t&&(n=t,t=!1),t||(v.createHTMLDocument?((r=(t=E.implementation.createHTMLDocument("")).createElement("base")).href=E.location.href,t.head.appendChild(r)):t=E),o=!n&&[],(i=N.exec(e))?[t.createElement(i[1])]:(i=xe([e],t,o),o&&o.length&&S(o).remove(),S.merge([],i.childNodes)));var r,i,o},S.fn.load=function(e,t,n){var r,i,o,a=this,s=e.indexOf(" ");return-1").append(S.parseHTML(e)).find(r):e)}).always(n&&function(e,t){a.each(function(){n.apply(this,o||[e.responseText,t,e])})}),this},S.expr.pseudos.animated=function(t){return S.grep(S.timers,function(e){return t===e.elem}).length},S.offset={setOffset:function(e,t,n){var r,i,o,a,s,u,l=S.css(e,"position"),c=S(e),f={};"static"===l&&(e.style.position="relative"),s=c.offset(),o=S.css(e,"top"),u=S.css(e,"left"),("absolute"===l||"fixed"===l)&&-1<(o+u).indexOf("auto")?(a=(r=c.position()).top,i=r.left):(a=parseFloat(o)||0,i=parseFloat(u)||0),m(t)&&(t=t.call(e,n,S.extend({},s))),null!=t.top&&(f.top=t.top-s.top+a),null!=t.left&&(f.left=t.left-s.left+i),"using"in t?t.using.call(e,f):c.css(f)}},S.fn.extend({offset:function(t){if(arguments.length)return void 0===t?this:this.each(function(e){S.offset.setOffset(this,t,e)});var e,n,r=this[0];return r?r.getClientRects().length?(e=r.getBoundingClientRect(),n=r.ownerDocument.defaultView,{top:e.top+n.pageYOffset,left:e.left+n.pageXOffset}):{top:0,left:0}:void 0},position:function(){if(this[0]){var e,t,n,r=this[0],i={top:0,left:0};if("fixed"===S.css(r,"position"))t=r.getBoundingClientRect();else{t=this.offset(),n=r.ownerDocument,e=r.offsetParent||n.documentElement;while(e&&(e===n.body||e===n.documentElement)&&"static"===S.css(e,"position"))e=e.parentNode;e&&e!==r&&1===e.nodeType&&((i=S(e).offset()).top+=S.css(e,"borderTopWidth",!0),i.left+=S.css(e,"borderLeftWidth",!0))}return{top:t.top-i.top-S.css(r,"marginTop",!0),left:t.left-i.left-S.css(r,"marginLeft",!0)}}},offsetParent:function(){return this.map(function(){var e=this.offsetParent;while(e&&"static"===S.css(e,"position"))e=e.offsetParent;return e||re})}}),S.each({scrollLeft:"pageXOffset",scrollTop:"pageYOffset"},function(t,i){var o="pageYOffset"===i;S.fn[t]=function(e){return B(this,function(e,t,n){var r;if(x(e)?r=e:9===e.nodeType&&(r=e.defaultView),void 0===n)return r?r[i]:e[t];r?r.scrollTo(o?r.pageXOffset:n,o?n:r.pageYOffset):e[t]=n},t,e,arguments.length)}}),S.each(["top","left"],function(e,n){S.cssHooks[n]=_e(v.pixelPosition,function(e,t){if(t)return t=Be(e,n),Pe.test(t)?S(e).position()[n]+"px":t})}),S.each({Height:"height",Width:"width"},function(a,s){S.each({padding:"inner"+a,content:s,"":"outer"+a},function(r,o){S.fn[o]=function(e,t){var n=arguments.length&&(r||"boolean"!=typeof e),i=r||(!0===e||!0===t?"margin":"border");return B(this,function(e,t,n){var r;return x(e)?0===o.indexOf("outer")?e["inner"+a]:e.document.documentElement["client"+a]:9===e.nodeType?(r=e.documentElement,Math.max(e.body["scroll"+a],r["scroll"+a],e.body["offset"+a],r["offset"+a],r["client"+a])):void 0===n?S.css(e,t,i):S.style(e,t,n,i)},s,n?e:void 0,n)}})}),S.each(["ajaxStart","ajaxStop","ajaxComplete","ajaxError","ajaxSuccess","ajaxSend"],function(e,t){S.fn[t]=function(e){return this.on(t,e)}}),S.fn.extend({bind:function(e,t,n){return this.on(e,null,t,n)},unbind:function(e,t){return this.off(e,null,t)},delegate:function(e,t,n,r){return this.on(t,e,n,r)},undelegate:function(e,t,n){return 1===arguments.length?this.off(e,"**"):this.off(t,e||"**",n)},hover:function(e,t){return this.mouseenter(e).mouseleave(t||e)}}),S.each("blur focus focusin focusout resize scroll click dblclick mousedown mouseup mousemove mouseover mouseout mouseenter mouseleave change select submit keydown keypress keyup contextmenu".split(" "),function(e,n){S.fn[n]=function(e,t){return 0",options:{classes:{},disabled:!1,create:null},_createWidget:function(t,e){e=x(e||this.defaultElement||this)[0],this.element=x(e),this.uuid=i++,this.eventNamespace="."+this.widgetName+this.uuid,this.bindings=x(),this.hoverable=x(),this.focusable=x(),this.classesElementLookup={},e!==this&&(x.data(e,this.widgetFullName,this),this._on(!0,this.element,{remove:function(t){t.target===e&&this.destroy()}}),this.document=x(e.style?e.ownerDocument:e.document||e),this.window=x(this.document[0].defaultView||this.document[0].parentWindow)),this.options=x.widget.extend({},this.options,this._getCreateOptions(),t),this._create(),this.options.disabled&&this._setOptionDisabled(this.options.disabled),this._trigger("create",null,this._getCreateEventData()),this._init()},_getCreateOptions:function(){return{}},_getCreateEventData:x.noop,_create:x.noop,_init:x.noop,destroy:function(){var i=this;this._destroy(),x.each(this.classesElementLookup,function(t,e){i._removeClass(e,t)}),this.element.off(this.eventNamespace).removeData(this.widgetFullName),this.widget().off(this.eventNamespace).removeAttr("aria-disabled"),this.bindings.off(this.eventNamespace)},_destroy:x.noop,widget:function(){return this.element},option:function(t,e){var i,s,n,o=t;if(0===arguments.length)return x.widget.extend({},this.options);if("string"==typeof t)if(o={},t=(i=t.split(".")).shift(),i.length){for(s=o[t]=x.widget.extend({},this.options[t]),n=0;n
"),i=e.children()[0];return x("body").append(e),t=i.offsetWidth,e.css("overflow","scroll"),t===(i=i.offsetWidth)&&(i=e[0].clientWidth),e.remove(),s=t-i},getScrollInfo:function(t){var e=t.isWindow||t.isDocument?"":t.element.css("overflow-x"),i=t.isWindow||t.isDocument?"":t.element.css("overflow-y"),e="scroll"===e||"auto"===e&&t.widthC(E(s),E(n))?o.important="horizontal":o.important="vertical",c.using.call(this,t,o)}),l.offset(x.extend(u,{using:t}))})},x.ui.position={fit:{left:function(t,e){var i=e.within,s=i.isWindow?i.scrollLeft:i.offset.left,n=i.width,o=t.left-e.collisionPosition.marginLeft,l=s-o,a=o+e.collisionWidth-n-s;e.collisionWidth>n?0n?0",delay:300,options:{icons:{submenu:"ui-icon-caret-1-e"},items:"> *",menus:"ul",position:{my:"left top",at:"right top"},role:"menu",blur:null,focus:null,select:null},_create:function(){this.activeMenu=this.element,this.mouseHandled=!1,this.lastMousePosition={x:null,y:null},this.element.uniqueId().attr({role:this.options.role,tabIndex:0}),this._addClass("ui-menu","ui-widget ui-widget-content"),this._on({"mousedown .ui-menu-item":function(t){t.preventDefault(),this._activateItem(t)},"click .ui-menu-item":function(t){var e=x(t.target),i=x(x.ui.safeActiveElement(this.document[0]));!this.mouseHandled&&e.not(".ui-state-disabled").length&&(this.select(t),t.isPropagationStopped()||(this.mouseHandled=!0),e.has(".ui-menu").length?this.expand(t):!this.element.is(":focus")&&i.closest(".ui-menu").length&&(this.element.trigger("focus",[!0]),this.active&&1===this.active.parents(".ui-menu").length&&clearTimeout(this.timer)))},"mouseenter .ui-menu-item":"_activateItem","mousemove .ui-menu-item":"_activateItem",mouseleave:"collapseAll","mouseleave .ui-menu":"collapseAll",focus:function(t,e){var i=this.active||this._menuItems().first();e||this.focus(t,i)},blur:function(t){this._delay(function(){x.contains(this.element[0],x.ui.safeActiveElement(this.document[0]))||this.collapseAll(t)})},keydown:"_keydown"}),this.refresh(),this._on(this.document,{click:function(t){this._closeOnDocumentClick(t)&&this.collapseAll(t,!0),this.mouseHandled=!1}})},_activateItem:function(t){var e,i;this.previousFilter||t.clientX===this.lastMousePosition.x&&t.clientY===this.lastMousePosition.y||(this.lastMousePosition={x:t.clientX,y:t.clientY},e=x(t.target).closest(".ui-menu-item"),i=x(t.currentTarget),e[0]===i[0]&&(i.is(".ui-state-active")||(this._removeClass(i.siblings().children(".ui-state-active"),null,"ui-state-active"),this.focus(t,i))))},_destroy:function(){var t=this.element.find(".ui-menu-item").removeAttr("role aria-disabled").children(".ui-menu-item-wrapper").removeUniqueId().removeAttr("tabIndex role aria-haspopup");this.element.removeAttr("aria-activedescendant").find(".ui-menu").addBack().removeAttr("role aria-labelledby aria-expanded aria-hidden aria-disabled tabIndex").removeUniqueId().show(),t.children().each(function(){var t=x(this);t.data("ui-menu-submenu-caret")&&t.remove()})},_keydown:function(t){var e,i,s,n=!0;switch(t.keyCode){case x.ui.keyCode.PAGE_UP:this.previousPage(t);break;case x.ui.keyCode.PAGE_DOWN:this.nextPage(t);break;case x.ui.keyCode.HOME:this._move("first","first",t);break;case x.ui.keyCode.END:this._move("last","last",t);break;case x.ui.keyCode.UP:this.previous(t);break;case x.ui.keyCode.DOWN:this.next(t);break;case x.ui.keyCode.LEFT:this.collapse(t);break;case x.ui.keyCode.RIGHT:this.active&&!this.active.is(".ui-state-disabled")&&this.expand(t);break;case x.ui.keyCode.ENTER:case x.ui.keyCode.SPACE:this._activate(t);break;case x.ui.keyCode.ESCAPE:this.collapse(t);break;default:e=this.previousFilter||"",s=n=!1,i=96<=t.keyCode&&t.keyCode<=105?(t.keyCode-96).toString():String.fromCharCode(t.keyCode),clearTimeout(this.filterTimer),i===e?s=!0:i=e+i,e=this._filterMenuItems(i),(e=s&&-1!==e.index(this.active.next())?this.active.nextAll(".ui-menu-item"):e).length||(i=String.fromCharCode(t.keyCode),e=this._filterMenuItems(i)),e.length?(this.focus(t,e),this.previousFilter=i,this.filterTimer=this._delay(function(){delete this.previousFilter},1e3)):delete this.previousFilter}n&&t.preventDefault()},_activate:function(t){this.active&&!this.active.is(".ui-state-disabled")&&(this.active.children("[aria-haspopup='true']").length?this.expand(t):this.select(t))},refresh:function(){var t,e,s=this,n=this.options.icons.submenu,i=this.element.find(this.options.menus);this._toggleClass("ui-menu-icons",null,!!this.element.find(".ui-icon").length),e=i.filter(":not(.ui-menu)").hide().attr({role:this.options.role,"aria-hidden":"true","aria-expanded":"false"}).each(function(){var t=x(this),e=t.prev(),i=x("").data("ui-menu-submenu-caret",!0);s._addClass(i,"ui-menu-icon","ui-icon "+n),e.attr("aria-haspopup","true").prepend(i),t.attr("aria-labelledby",e.attr("id"))}),this._addClass(e,"ui-menu","ui-widget ui-widget-content ui-front"),(t=i.add(this.element).find(this.options.items)).not(".ui-menu-item").each(function(){var t=x(this);s._isDivider(t)&&s._addClass(t,"ui-menu-divider","ui-widget-content")}),i=(e=t.not(".ui-menu-item, .ui-menu-divider")).children().not(".ui-menu").uniqueId().attr({tabIndex:-1,role:this._itemRole()}),this._addClass(e,"ui-menu-item")._addClass(i,"ui-menu-item-wrapper"),t.filter(".ui-state-disabled").attr("aria-disabled","true"),this.active&&!x.contains(this.element[0],this.active[0])&&this.blur()},_itemRole:function(){return{menu:"menuitem",listbox:"option"}[this.options.role]},_setOption:function(t,e){var i;"icons"===t&&(i=this.element.find(".ui-menu-icon"),this._removeClass(i,null,this.options.icons.submenu)._addClass(i,null,e.submenu)),this._super(t,e)},_setOptionDisabled:function(t){this._super(t),this.element.attr("aria-disabled",String(t)),this._toggleClass(null,"ui-state-disabled",!!t)},focus:function(t,e){var i;this.blur(t,t&&"focus"===t.type),this._scrollIntoView(e),this.active=e.first(),i=this.active.children(".ui-menu-item-wrapper"),this._addClass(i,null,"ui-state-active"),this.options.role&&this.element.attr("aria-activedescendant",i.attr("id")),i=this.active.parent().closest(".ui-menu-item").children(".ui-menu-item-wrapper"),this._addClass(i,null,"ui-state-active"),t&&"keydown"===t.type?this._close():this.timer=this._delay(function(){this._close()},this.delay),(i=e.children(".ui-menu")).length&&t&&/^mouse/.test(t.type)&&this._startOpening(i),this.activeMenu=e.parent(),this._trigger("focus",t,{item:e})},_scrollIntoView:function(t){var e,i,s;this._hasScroll()&&(i=parseFloat(x.css(this.activeMenu[0],"borderTopWidth"))||0,s=parseFloat(x.css(this.activeMenu[0],"paddingTop"))||0,e=t.offset().top-this.activeMenu.offset().top-i-s,i=this.activeMenu.scrollTop(),s=this.activeMenu.height(),t=t.outerHeight(),e<0?this.activeMenu.scrollTop(i+e):s",options:{appendTo:null,autoFocus:!1,delay:300,minLength:1,position:{my:"left top",at:"left bottom",collision:"none"},source:null,change:null,close:null,focus:null,open:null,response:null,search:null,select:null},requestIndex:0,pending:0,liveRegionTimer:null,_create:function(){var i,s,n,t=this.element[0].nodeName.toLowerCase(),e="textarea"===t,t="input"===t;this.isMultiLine=e||!t&&this._isContentEditable(this.element),this.valueMethod=this.element[e||t?"val":"text"],this.isNewMenu=!0,this._addClass("ui-autocomplete-input"),this.element.attr("autocomplete","off"),this._on(this.element,{keydown:function(t){if(this.element.prop("readOnly"))s=n=i=!0;else{s=n=i=!1;var e=x.ui.keyCode;switch(t.keyCode){case e.PAGE_UP:i=!0,this._move("previousPage",t);break;case e.PAGE_DOWN:i=!0,this._move("nextPage",t);break;case e.UP:i=!0,this._keyEvent("previous",t);break;case e.DOWN:i=!0,this._keyEvent("next",t);break;case e.ENTER:this.menu.active&&(i=!0,t.preventDefault(),this.menu.select(t));break;case e.TAB:this.menu.active&&this.menu.select(t);break;case e.ESCAPE:this.menu.element.is(":visible")&&(this.isMultiLine||this._value(this.term),this.close(t),t.preventDefault());break;default:s=!0,this._searchTimeout(t)}}},keypress:function(t){if(i)return i=!1,void(this.isMultiLine&&!this.menu.element.is(":visible")||t.preventDefault());if(!s){var e=x.ui.keyCode;switch(t.keyCode){case e.PAGE_UP:this._move("previousPage",t);break;case e.PAGE_DOWN:this._move("nextPage",t);break;case e.UP:this._keyEvent("previous",t);break;case e.DOWN:this._keyEvent("next",t)}}},input:function(t){if(n)return n=!1,void t.preventDefault();this._searchTimeout(t)},focus:function(){this.selectedItem=null,this.previous=this._value()},blur:function(t){clearTimeout(this.searching),this.close(t),this._change(t)}}),this._initSource(),this.menu=x("
    ").appendTo(this._appendTo()).menu({role:null}).hide().attr({unselectable:"on"}).menu("instance"),this._addClass(this.menu.element,"ui-autocomplete","ui-front"),this._on(this.menu.element,{mousedown:function(t){t.preventDefault()},menufocus:function(t,e){var i,s;if(this.isNewMenu&&(this.isNewMenu=!1,t.originalEvent&&/^mouse/.test(t.originalEvent.type)))return this.menu.blur(),void this.document.one("mousemove",function(){x(t.target).trigger(t.originalEvent)});s=e.item.data("ui-autocomplete-item"),!1!==this._trigger("focus",t,{item:s})&&t.originalEvent&&/^key/.test(t.originalEvent.type)&&this._value(s.value),(i=e.item.attr("aria-label")||s.value)&&String.prototype.trim.call(i).length&&(clearTimeout(this.liveRegionTimer),this.liveRegionTimer=this._delay(function(){this.liveRegion.html(x("
    ").text(i))},100))},menuselect:function(t,e){var i=e.item.data("ui-autocomplete-item"),s=this.previous;this.element[0]!==x.ui.safeActiveElement(this.document[0])&&(this.element.trigger("focus"),this.previous=s,this._delay(function(){this.previous=s,this.selectedItem=i})),!1!==this._trigger("select",t,{item:i})&&this._value(i.value),this.term=this._value(),this.close(t),this.selectedItem=i}}),this.liveRegion=x("
    ",{role:"status","aria-live":"assertive","aria-relevant":"additions"}).appendTo(this.document[0].body),this._addClass(this.liveRegion,null,"ui-helper-hidden-accessible"),this._on(this.window,{beforeunload:function(){this.element.removeAttr("autocomplete")}})},_destroy:function(){clearTimeout(this.searching),this.element.removeAttr("autocomplete"),this.menu.element.remove(),this.liveRegion.remove()},_setOption:function(t,e){this._super(t,e),"source"===t&&this._initSource(),"appendTo"===t&&this.menu.element.appendTo(this._appendTo()),"disabled"===t&&e&&this.xhr&&this.xhr.abort()},_isEventTargetInWidget:function(t){var e=this.menu.element[0];return t.target===this.element[0]||t.target===e||x.contains(e,t.target)},_closeOnClickOutside:function(t){this._isEventTargetInWidget(t)||this.close()},_appendTo:function(){var t=this.options.appendTo;return t=!(t=!(t=t&&(t.jquery||t.nodeType?x(t):this.document.find(t).eq(0)))||!t[0]?this.element.closest(".ui-front, dialog"):t).length?this.document[0].body:t},_initSource:function(){var i,s,n=this;Array.isArray(this.options.source)?(i=this.options.source,this.source=function(t,e){e(x.ui.autocomplete.filter(i,t.term))}):"string"==typeof this.options.source?(s=this.options.source,this.source=function(t,e){n.xhr&&n.xhr.abort(),n.xhr=x.ajax({url:s,data:t,dataType:"json",success:function(t){e(t)},error:function(){e([])}})}):this.source=this.options.source},_searchTimeout:function(s){clearTimeout(this.searching),this.searching=this._delay(function(){var t=this.term===this._value(),e=this.menu.element.is(":visible"),i=s.altKey||s.ctrlKey||s.metaKey||s.shiftKey;t&&(e||i)||(this.selectedItem=null,this.search(null,s))},this.options.delay)},search:function(t,e){return t=null!=t?t:this._value(),this.term=this._value(),t.length").append(x("
    ").text(e.label)).appendTo(t)},_move:function(t,e){if(this.menu.element.is(":visible"))return this.menu.isFirstItem()&&/^previous/.test(t)||this.menu.isLastItem()&&/^next/.test(t)?(this.isMultiLine||this._value(this.term),void this.menu.blur()):void this.menu[t](e);this.search(null,e)},widget:function(){return this.menu.element},_value:function(){return this.valueMethod.apply(this.element,arguments)},_keyEvent:function(t,e){this.isMultiLine&&!this.menu.element.is(":visible")||(this._move(t,e),e.preventDefault())},_isContentEditable:function(t){if(!t.length)return!1;var e=t.prop("contentEditable");return"inherit"===e?this._isContentEditable(t.parent()):"true"===e}}),x.extend(x.ui.autocomplete,{escapeRegex:function(t){return t.replace(/[\-\[\]{}()*+?.,\\\^$|#\s]/g,"\\$&")},filter:function(t,e){var i=new RegExp(x.ui.autocomplete.escapeRegex(e),"i");return x.grep(t,function(t){return i.test(t.label||t.value||t)})}}),x.widget("ui.autocomplete",x.ui.autocomplete,{options:{messages:{noResults:"No search results.",results:function(t){return t+(1").text(e))},100))}});x.ui.autocomplete}); \ No newline at end of file diff --git a/restful-ws/4.0/apidocs/script.js b/restful-ws/4.0/apidocs/script.js new file mode 100644 index 0000000000..8b9691a167 --- /dev/null +++ b/restful-ws/4.0/apidocs/script.js @@ -0,0 +1,253 @@ +/* + * Copyright (c) 2013, 2023, Oracle and/or its affiliates. All rights reserved. + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * This code is free software; you can redistribute it and/or modify it + * under the terms of the GNU General Public License version 2 only, as + * published by the Free Software Foundation. Oracle designates this + * particular file as subject to the "Classpath" exception as provided + * by Oracle in the LICENSE file that accompanied this code. + * + * This code is distributed in the hope that it will be useful, but WITHOUT + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or + * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License + * version 2 for more details (a copy is included in the LICENSE file that + * accompanied this code). + * + * You should have received a copy of the GNU General Public License version + * 2 along with this work; if not, write to the Free Software Foundation, + * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. + * + * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA + * or visit www.oracle.com if you need additional information or have any + * questions. + */ + +var moduleSearchIndex; +var packageSearchIndex; +var typeSearchIndex; +var memberSearchIndex; +var tagSearchIndex; + +var oddRowColor = "odd-row-color"; +var evenRowColor = "even-row-color"; +var sortAsc = "sort-asc"; +var sortDesc = "sort-desc"; +var tableTab = "table-tab"; +var activeTableTab = "active-table-tab"; + +function loadScripts(doc, tag) { + createElem(doc, tag, 'search.js'); + + createElem(doc, tag, 'module-search-index.js'); + createElem(doc, tag, 'package-search-index.js'); + createElem(doc, tag, 'type-search-index.js'); + createElem(doc, tag, 'member-search-index.js'); + createElem(doc, tag, 'tag-search-index.js'); +} + +function createElem(doc, tag, path) { + var script = doc.createElement(tag); + var scriptElement = doc.getElementsByTagName(tag)[0]; + script.src = pathtoroot + path; + scriptElement.parentNode.insertBefore(script, scriptElement); +} + +// Helper for making content containing release names comparable lexicographically +function makeComparable(s) { + return s.toLowerCase().replace(/(\d+)/g, + function(n, m) { + return ("000" + m).slice(-4); + }); +} + +// Switches between two styles depending on a condition +function toggleStyle(classList, condition, trueStyle, falseStyle) { + if (condition) { + classList.remove(falseStyle); + classList.add(trueStyle); + } else { + classList.remove(trueStyle); + classList.add(falseStyle); + } +} + +// Sorts the rows in a table lexicographically by the content of a specific column +function sortTable(header, columnIndex, columns) { + var container = header.parentElement; + var descending = header.classList.contains(sortAsc); + container.querySelectorAll("div.table-header").forEach( + function(header) { + header.classList.remove(sortAsc); + header.classList.remove(sortDesc); + } + ) + var cells = container.children; + var rows = []; + for (var i = columns; i < cells.length; i += columns) { + rows.push(Array.prototype.slice.call(cells, i, i + columns)); + } + var comparator = function(a, b) { + var ka = makeComparable(a[columnIndex].textContent); + var kb = makeComparable(b[columnIndex].textContent); + if (ka < kb) + return descending ? 1 : -1; + if (ka > kb) + return descending ? -1 : 1; + return 0; + }; + var sorted = rows.sort(comparator); + var visible = 0; + sorted.forEach(function(row) { + if (row[0].style.display !== 'none') { + var isEvenRow = visible++ % 2 === 0; + } + row.forEach(function(cell) { + toggleStyle(cell.classList, isEvenRow, evenRowColor, oddRowColor); + container.appendChild(cell); + }) + }); + toggleStyle(header.classList, descending, sortDesc, sortAsc); +} + +// Toggles the visibility of a table category in all tables in a page +function toggleGlobal(checkbox, selected, columns) { + var display = checkbox.checked ? '' : 'none'; + document.querySelectorAll("div.table-tabs").forEach(function(t) { + var id = t.parentElement.getAttribute("id"); + var selectedClass = id + "-tab" + selected; + // if selected is empty string it selects all uncategorized entries + var selectUncategorized = !Boolean(selected); + var visible = 0; + document.querySelectorAll('div.' + id) + .forEach(function(elem) { + if (selectUncategorized) { + if (elem.className.indexOf(selectedClass) === -1) { + elem.style.display = display; + } + } else if (elem.classList.contains(selectedClass)) { + elem.style.display = display; + } + if (elem.style.display === '') { + var isEvenRow = visible++ % (columns * 2) < columns; + toggleStyle(elem.classList, isEvenRow, evenRowColor, oddRowColor); + } + }); + var displaySection = visible === 0 ? 'none' : ''; + t.parentElement.style.display = displaySection; + document.querySelector("li#contents-" + id).style.display = displaySection; + }) +} + +// Shows the elements of a table belonging to a specific category +function show(tableId, selected, columns) { + if (tableId !== selected) { + document.querySelectorAll('div.' + tableId + ':not(.' + selected + ')') + .forEach(function(elem) { + elem.style.display = 'none'; + }); + } + document.querySelectorAll('div.' + selected) + .forEach(function(elem, index) { + elem.style.display = ''; + var isEvenRow = index % (columns * 2) < columns; + toggleStyle(elem.classList, isEvenRow, evenRowColor, oddRowColor); + }); + updateTabs(tableId, selected); +} + +function updateTabs(tableId, selected) { + document.querySelector('div#' + tableId +' .summary-table') + .setAttribute('aria-labelledby', selected); + document.querySelectorAll('button[id^="' + tableId + '"]') + .forEach(function(tab, index) { + if (selected === tab.id || (tableId === selected && index === 0)) { + tab.className = activeTableTab; + tab.setAttribute('aria-selected', true); + tab.setAttribute('tabindex',0); + } else { + tab.className = tableTab; + tab.setAttribute('aria-selected', false); + tab.setAttribute('tabindex',-1); + } + }); +} + +function switchTab(e) { + var selected = document.querySelector('[aria-selected=true]'); + if (selected) { + if ((e.keyCode === 37 || e.keyCode === 38) && selected.previousSibling) { + // left or up arrow key pressed: move focus to previous tab + selected.previousSibling.click(); + selected.previousSibling.focus(); + e.preventDefault(); + } else if ((e.keyCode === 39 || e.keyCode === 40) && selected.nextSibling) { + // right or down arrow key pressed: move focus to next tab + selected.nextSibling.click(); + selected.nextSibling.focus(); + e.preventDefault(); + } + } +} + +var updateSearchResults = function() {}; + +function indexFilesLoaded() { + return moduleSearchIndex + && packageSearchIndex + && typeSearchIndex + && memberSearchIndex + && tagSearchIndex; +} +// Copy the contents of the local snippet to the clipboard +function copySnippet(button) { + copyToClipboard(button.nextElementSibling.innerText); + switchCopyLabel(button, button.firstElementChild); +} +function copyToClipboard(content) { + var textarea = document.createElement("textarea"); + textarea.style.height = 0; + document.body.appendChild(textarea); + textarea.value = content; + textarea.select(); + document.execCommand("copy"); + document.body.removeChild(textarea); +} +function switchCopyLabel(button, span) { + var copied = span.getAttribute("data-copied"); + button.classList.add("visible"); + var initialLabel = span.innerHTML; + span.innerHTML = copied; + setTimeout(function() { + button.classList.remove("visible"); + setTimeout(function() { + if (initialLabel !== copied) { + span.innerHTML = initialLabel; + } + }, 100); + }, 1900); +} +// Workaround for scroll position not being included in browser history (8249133) +document.addEventListener("DOMContentLoaded", function(e) { + var contentDiv = document.querySelector("div.flex-content"); + window.addEventListener("popstate", function(e) { + if (e.state !== null) { + contentDiv.scrollTop = e.state; + } + }); + window.addEventListener("hashchange", function(e) { + history.replaceState(contentDiv.scrollTop, document.title); + }); + var timeoutId; + contentDiv.addEventListener("scroll", function(e) { + if (timeoutId) { + clearTimeout(timeoutId); + } + timeoutId = setTimeout(function() { + history.replaceState(contentDiv.scrollTop, document.title); + }, 100); + }); + if (!location.hash) { + history.replaceState(contentDiv.scrollTop, document.title); + } +}); diff --git a/restful-ws/4.0/apidocs/search-page.js b/restful-ws/4.0/apidocs/search-page.js new file mode 100644 index 0000000000..540c90f57c --- /dev/null +++ b/restful-ws/4.0/apidocs/search-page.js @@ -0,0 +1,284 @@ +/* + * Copyright (c) 2022, 2023, Oracle and/or its affiliates. All rights reserved. + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * This code is free software; you can redistribute it and/or modify it + * under the terms of the GNU General Public License version 2 only, as + * published by the Free Software Foundation. Oracle designates this + * particular file as subject to the "Classpath" exception as provided + * by Oracle in the LICENSE file that accompanied this code. + * + * This code is distributed in the hope that it will be useful, but WITHOUT + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or + * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License + * version 2 for more details (a copy is included in the LICENSE file that + * accompanied this code). + * + * You should have received a copy of the GNU General Public License version + * 2 along with this work; if not, write to the Free Software Foundation, + * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. + * + * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA + * or visit www.oracle.com if you need additional information or have any + * questions. + */ + +"use strict"; +$(function() { + var copy = $("#page-search-copy"); + var expand = $("#page-search-expand"); + var searchLink = $("span#page-search-link"); + var redirect = $("input#search-redirect"); + function setSearchUrlTemplate() { + var href = document.location.href.split(/[#?]/)[0]; + href += "?q=" + "%s"; + if (redirect.is(":checked")) { + href += "&r=1"; + } + searchLink.html(href); + copy[0].onmouseenter(); + } + function copyLink(e) { + copyToClipboard(this.previousSibling.innerText); + switchCopyLabel(this, this.lastElementChild); + } + copy.click(copyLink); + copy[0].onmouseenter = function() {}; + redirect.click(setSearchUrlTemplate); + setSearchUrlTemplate(); + copy.prop("disabled", false); + redirect.prop("disabled", false); + expand.click(function (e) { + var searchInfo = $("div.page-search-info"); + if(this.parentElement.hasAttribute("open")) { + searchInfo.attr("style", "border-width: 0;"); + } else { + searchInfo.attr("style", "border-width: 1px;").height(searchInfo.prop("scrollHeight")); + } + }); +}); +$(window).on("load", function() { + var input = $("#page-search-input"); + var reset = $("#page-search-reset"); + var notify = $("#page-search-notify"); + var resultSection = $("div#result-section"); + var resultContainer = $("div#result-container"); + var searchTerm = ""; + var activeTab = ""; + var fixedTab = false; + var visibleTabs = []; + var feelingLucky = false; + function renderResults(result) { + if (!result.length) { + notify.html(messages.noResult); + } else if (result.length === 1) { + notify.html(messages.oneResult); + } else { + notify.html(messages.manyResults.replace("{0}", result.length)); + } + resultContainer.empty(); + var r = { + "types": [], + "members": [], + "packages": [], + "modules": [], + "searchTags": [] + }; + for (var i in result) { + var item = result[i]; + var arr = r[item.category]; + arr.push(item); + } + if (!activeTab || r[activeTab].length === 0 || !fixedTab) { + Object.keys(r).reduce(function(prev, curr) { + if (r[curr].length > 0 && r[curr][0].score > prev) { + activeTab = curr; + return r[curr][0].score; + } + return prev; + }, 0); + } + if (feelingLucky && activeTab) { + notify.html(messages.redirecting) + var firstItem = r[activeTab][0]; + window.location = getURL(firstItem.indexItem, firstItem.category); + return; + } + if (result.length > 20) { + if (searchTerm[searchTerm.length - 1] === ".") { + if (activeTab === "types" && r["members"].length > r["types"].length) { + activeTab = "members"; + } else if (activeTab === "packages" && r["types"].length > r["packages"].length) { + activeTab = "types"; + } + } + } + var categoryCount = Object.keys(r).reduce(function(prev, curr) { + return prev + (r[curr].length > 0 ? 1 : 0); + }, 0); + visibleTabs = []; + var tabContainer = $("
    ").appendTo(resultContainer); + for (var key in r) { + var id = "#result-tab-" + key.replace("searchTags", "search_tags"); + if (r[key].length) { + var count = r[key].length >= 1000 ? "999+" : r[key].length; + if (result.length > 20 && categoryCount > 1) { + var button = $("").appendTo(tabContainer); + button.click(key, function(e) { + fixedTab = true; + renderResult(e.data, $(this)); + }); + visibleTabs.push(key); + } else { + $("" + categories[key] + + " (" + count + ")").appendTo(tabContainer); + renderTable(key, r[key]).appendTo(resultContainer); + tabContainer = $("
    ").appendTo(resultContainer); + + } + } + } + if (activeTab && result.length > 20 && categoryCount > 1) { + $("button#result-tab-" + activeTab).addClass("active-table-tab"); + renderTable(activeTab, r[activeTab]).appendTo(resultContainer); + } + resultSection.show(); + function renderResult(category, button) { + activeTab = category; + setSearchUrl(); + resultContainer.find("div.summary-table").remove(); + renderTable(activeTab, r[activeTab]).appendTo(resultContainer); + button.siblings().removeClass("active-table-tab"); + button.addClass("active-table-tab"); + } + } + function selectTab(category) { + $("button#result-tab-" + category).click(); + } + function renderTable(category, items) { + var table = $("
    ") + .addClass(category === "modules" + ? "one-column-search-results" + : "two-column-search-results"); + var col1, col2; + if (category === "modules") { + col1 = "Module"; + } else if (category === "packages") { + col1 = "Module"; + col2 = "Package"; + } else if (category === "types") { + col1 = "Package"; + col2 = "Class" + } else if (category === "members") { + col1 = "Class"; + col2 = "Member"; + } else if (category === "searchTags") { + col1 = "Location"; + col2 = "Name"; + } + $("
    " + col1 + "
    ").appendTo(table); + if (category !== "modules") { + $("
    " + col2 + "
    ").appendTo(table); + } + $.each(items, function(index, item) { + var rowColor = index % 2 ? "odd-row-color" : "even-row-color"; + renderItem(item, table, rowColor); + }); + return table; + } + function renderItem(item, table, rowColor) { + var label = getHighlightedText(item.input, item.boundaries, item.prefix.length, item.input.length); + var link = $("") + .attr("href", getURL(item.indexItem, item.category)) + .attr("tabindex", "0") + .addClass("search-result-link") + .html(label); + var container = getHighlightedText(item.input, item.boundaries, 0, item.prefix.length - 1); + if (item.category === "searchTags") { + container = item.indexItem.h || ""; + } + if (item.category !== "modules") { + $("
    ").html(container).addClass("col-plain").addClass(rowColor).appendTo(table); + } + $("
    ").html(link).addClass("col-last").addClass(rowColor).appendTo(table); + } + var timeout; + function schedulePageSearch() { + if (timeout) { + clearTimeout(timeout); + } + timeout = setTimeout(function () { + doPageSearch() + }, 100); + } + function doPageSearch() { + setSearchUrl(); + var term = searchTerm = input.val().trim(); + if (term === "") { + notify.html(messages.enterTerm); + activeTab = ""; + fixedTab = false; + resultContainer.empty(); + resultSection.hide(); + } else { + notify.html(messages.searching); + doSearch({ term: term, maxResults: 1200 }, renderResults); + } + } + function setSearchUrl() { + var query = input.val().trim(); + var url = document.location.pathname; + if (query) { + url += "?q=" + encodeURI(query); + if (activeTab && fixedTab) { + url += "&c=" + activeTab; + } + } + history.replaceState({query: query}, "", url); + } + input.on("input", function(e) { + feelingLucky = false; + schedulePageSearch(); + }); + $(document).keydown(function(e) { + if ((e.ctrlKey || e.metaKey) && (e.key === "ArrowLeft" || e.key === "ArrowRight")) { + if (activeTab && visibleTabs.length > 1) { + var idx = visibleTabs.indexOf(activeTab); + idx += e.key === "ArrowLeft" ? visibleTabs.length - 1 : 1; + selectTab(visibleTabs[idx % visibleTabs.length]); + return false; + } + } + }); + reset.click(function() { + notify.html(messages.enterTerm); + resultSection.hide(); + activeTab = ""; + fixedTab = false; + resultContainer.empty(); + input.val('').focus(); + setSearchUrl(); + }); + input.prop("disabled", false); + reset.prop("disabled", false); + + var urlParams = new URLSearchParams(window.location.search); + if (urlParams.has("q")) { + input.val(urlParams.get("q")) + } + if (urlParams.has("c")) { + activeTab = urlParams.get("c"); + fixedTab = true; + } + if (urlParams.get("r")) { + feelingLucky = true; + } + if (input.val()) { + doPageSearch(); + } else { + notify.html(messages.enterTerm); + } + input.select().focus(); +}); diff --git a/restful-ws/4.0/apidocs/search.html b/restful-ws/4.0/apidocs/search.html new file mode 100644 index 0000000000..bb2af3951f --- /dev/null +++ b/restful-ws/4.0/apidocs/search.html @@ -0,0 +1,78 @@ + + + + +Search (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    +

    Search

    +
    + + +
    +Additional resources +
    +
    +
    +

    The help page provides an introduction to the scope and syntax of JavaDoc search.

    +

    You can use the <ctrl> or <cmd> keys in combination with the left and right arrow keys to switch between result tabs in this page.

    +

    The URL template below may be used to configure this page as a search engine in browsers that support this feature. It has been tested to work in Google Chrome and Mozilla Firefox. Note that other browsers may not support this feature or require a different URL format.

    +link +

    + +

    +
    +

    Loading search index...

    + +
    +
    +
    +

    Copyright © 2018, 2024 Eclipse Foundation.
    Use is subject to license terms.

    +
    +
    +
    + + diff --git a/restful-ws/4.0/apidocs/search.js b/restful-ws/4.0/apidocs/search.js new file mode 100644 index 0000000000..d3986705ef --- /dev/null +++ b/restful-ws/4.0/apidocs/search.js @@ -0,0 +1,458 @@ +/* + * Copyright (c) 2015, 2023, Oracle and/or its affiliates. All rights reserved. + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * This code is free software; you can redistribute it and/or modify it + * under the terms of the GNU General Public License version 2 only, as + * published by the Free Software Foundation. Oracle designates this + * particular file as subject to the "Classpath" exception as provided + * by Oracle in the LICENSE file that accompanied this code. + * + * This code is distributed in the hope that it will be useful, but WITHOUT + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or + * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License + * version 2 for more details (a copy is included in the LICENSE file that + * accompanied this code). + * + * You should have received a copy of the GNU General Public License version + * 2 along with this work; if not, write to the Free Software Foundation, + * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. + * + * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA + * or visit www.oracle.com if you need additional information or have any + * questions. + */ +"use strict"; +const messages = { + enterTerm: "Enter a search term", + noResult: "No results found", + oneResult: "Found one result", + manyResults: "Found {0} results", + loading: "Loading search index...", + searching: "Searching...", + redirecting: "Redirecting to first result...", + linkIcon: "Link icon", + linkToSection: "Link to this section" +} +const categories = { + modules: "Modules", + packages: "Packages", + types: "Classes and Interfaces", + members: "Members", + searchTags: "Search Tags" +}; +const highlight = "$&"; +const NO_MATCH = {}; +const MAX_RESULTS = 300; +function checkUnnamed(name, separator) { + return name === "" || !name ? "" : name + separator; +} +function escapeHtml(str) { + return str.replace(//g, ">"); +} +function getHighlightedText(str, boundaries, from, to) { + var start = from; + var text = ""; + for (var i = 0; i < boundaries.length; i += 2) { + var b0 = boundaries[i]; + var b1 = boundaries[i + 1]; + if (b0 >= to || b1 <= from) { + continue; + } + text += escapeHtml(str.slice(start, Math.max(start, b0))); + text += ""; + text += escapeHtml(str.slice(Math.max(start, b0), Math.min(to, b1))); + text += ""; + start = Math.min(to, b1); + } + text += escapeHtml(str.slice(start, to)); + return text; +} +function getURLPrefix(item, category) { + var urlPrefix = ""; + var slash = "/"; + if (category === "modules") { + return item.l + slash; + } else if (category === "packages" && item.m) { + return item.m + slash; + } else if (category === "types" || category === "members") { + if (item.m) { + urlPrefix = item.m + slash; + } else { + $.each(packageSearchIndex, function(index, it) { + if (it.m && item.p === it.l) { + urlPrefix = it.m + slash; + } + }); + } + } + return urlPrefix; +} +function getURL(item, category) { + if (item.url) { + return item.url; + } + var url = getURLPrefix(item, category); + if (category === "modules") { + url += "module-summary.html"; + } else if (category === "packages") { + if (item.u) { + url = item.u; + } else { + url += item.l.replace(/\./g, '/') + "/package-summary.html"; + } + } else if (category === "types") { + if (item.u) { + url = item.u; + } else { + url += checkUnnamed(item.p, "/").replace(/\./g, '/') + item.l + ".html"; + } + } else if (category === "members") { + url += checkUnnamed(item.p, "/").replace(/\./g, '/') + item.c + ".html" + "#"; + if (item.u) { + url += item.u; + } else { + url += item.l; + } + } else if (category === "searchTags") { + url += item.u; + } + item.url = url; + return url; +} +function createMatcher(term, camelCase) { + if (camelCase && !isUpperCase(term)) { + return null; // no need for camel-case matcher for lower case query + } + var pattern = ""; + var upperCase = []; + term.trim().split(/\s+/).forEach(function(w, index, array) { + var tokens = w.split(/(?=[A-Z,.()<>?[\/])/); + for (var i = 0; i < tokens.length; i++) { + var s = tokens[i]; + // ',' and '?' are the only delimiters commonly followed by space in java signatures + pattern += "(" + $.ui.autocomplete.escapeRegex(s).replace(/[,?]/g, "$&\\s*?") + ")"; + upperCase.push(false); + var isWordToken = /\w$/.test(s); + if (isWordToken) { + if (i === tokens.length - 1 && index < array.length - 1) { + // space in query string matches all delimiters + pattern += "(.*?)"; + upperCase.push(isUpperCase(s[0])); + } else { + if (!camelCase && isUpperCase(s) && s.length === 1) { + pattern += "()"; + } else { + pattern += "([a-z0-9$<>?[\\]]*?)"; + } + upperCase.push(isUpperCase(s[0])); + } + } else { + pattern += "()"; + upperCase.push(false); + } + } + }); + var re = new RegExp(pattern, "gi"); + re.upperCase = upperCase; + return re; +} +function findMatch(matcher, input, startOfName, endOfName) { + var from = startOfName; + matcher.lastIndex = from; + var match = matcher.exec(input); + // Expand search area until we get a valid result or reach the beginning of the string + while (!match || match.index + match[0].length < startOfName || endOfName < match.index) { + if (from === 0) { + return NO_MATCH; + } + from = input.lastIndexOf(".", from - 2) + 1; + matcher.lastIndex = from; + match = matcher.exec(input); + } + var boundaries = []; + var matchEnd = match.index + match[0].length; + var score = 5; + var start = match.index; + var prevEnd = -1; + for (var i = 1; i < match.length; i += 2) { + var isUpper = isUpperCase(input[start]); + var isMatcherUpper = matcher.upperCase[i]; + // capturing groups come in pairs, match and non-match + boundaries.push(start, start + match[i].length); + // make sure groups are anchored on a left word boundary + var prevChar = input[start - 1] || ""; + var nextChar = input[start + 1] || ""; + if (start !== 0 && !/[\W_]/.test(prevChar) && !/[\W_]/.test(input[start])) { + if (isUpper && (isLowerCase(prevChar) || isLowerCase(nextChar))) { + score -= 0.1; + } else if (isMatcherUpper && start === prevEnd) { + score -= isUpper ? 0.1 : 1.0; + } else { + return NO_MATCH; + } + } + prevEnd = start + match[i].length; + start += match[i].length + match[i + 1].length; + + // lower score for parts of the name that are missing + if (match[i + 1] && prevEnd < endOfName) { + score -= rateNoise(match[i + 1]); + } + } + // lower score if a type name contains unmatched camel-case parts + if (input[matchEnd - 1] !== "." && endOfName > matchEnd) + score -= rateNoise(input.slice(matchEnd, endOfName)); + score -= rateNoise(input.slice(0, Math.max(startOfName, match.index))); + + if (score <= 0) { + return NO_MATCH; + } + return { + input: input, + score: score, + boundaries: boundaries + }; +} +function isUpperCase(s) { + return s !== s.toLowerCase(); +} +function isLowerCase(s) { + return s !== s.toUpperCase(); +} +function rateNoise(str) { + return (str.match(/([.(])/g) || []).length / 5 + + (str.match(/([A-Z]+)/g) || []).length / 10 + + str.length / 20; +} +function doSearch(request, response) { + var term = request.term.trim(); + var maxResults = request.maxResults || MAX_RESULTS; + if (term.length === 0) { + return this.close(); + } + var matcher = { + plainMatcher: createMatcher(term, false), + camelCaseMatcher: createMatcher(term, true) + } + var indexLoaded = indexFilesLoaded(); + + function getPrefix(item, category) { + switch (category) { + case "packages": + return checkUnnamed(item.m, "/"); + case "types": + return checkUnnamed(item.p, "."); + case "members": + return checkUnnamed(item.p, ".") + item.c + "."; + default: + return ""; + } + } + function useQualifiedName(category) { + switch (category) { + case "packages": + return /[\s/]/.test(term); + case "types": + case "members": + return /[\s.]/.test(term); + default: + return false; + } + } + function searchIndex(indexArray, category) { + var matches = []; + if (!indexArray) { + if (!indexLoaded) { + matches.push({ l: messages.loading, category: category }); + } + return matches; + } + $.each(indexArray, function (i, item) { + var prefix = getPrefix(item, category); + var simpleName = item.l; + var qualifiedName = prefix + simpleName; + var useQualified = useQualifiedName(category); + var input = useQualified ? qualifiedName : simpleName; + var startOfName = useQualified ? prefix.length : 0; + var endOfName = category === "members" && input.indexOf("(", startOfName) > -1 + ? input.indexOf("(", startOfName) : input.length; + var m = findMatch(matcher.plainMatcher, input, startOfName, endOfName); + if (m === NO_MATCH && matcher.camelCaseMatcher) { + m = findMatch(matcher.camelCaseMatcher, input, startOfName, endOfName); + } + if (m !== NO_MATCH) { + m.indexItem = item; + m.prefix = prefix; + m.category = category; + if (!useQualified) { + m.input = qualifiedName; + m.boundaries = m.boundaries.map(function(b) { + return b + prefix.length; + }); + } + matches.push(m); + } + return true; + }); + return matches.sort(function(e1, e2) { + return e2.score - e1.score; + }).slice(0, maxResults); + } + + var result = searchIndex(moduleSearchIndex, "modules") + .concat(searchIndex(packageSearchIndex, "packages")) + .concat(searchIndex(typeSearchIndex, "types")) + .concat(searchIndex(memberSearchIndex, "members")) + .concat(searchIndex(tagSearchIndex, "searchTags")); + + if (!indexLoaded) { + updateSearchResults = function() { + doSearch(request, response); + } + } else { + updateSearchResults = function() {}; + } + response(result); +} +// JQuery search menu implementation +$.widget("custom.catcomplete", $.ui.autocomplete, { + _create: function() { + this._super(); + this.widget().menu("option", "items", "> .result-item"); + // workaround for search result scrolling + this.menu._scrollIntoView = function _scrollIntoView( item ) { + var borderTop, paddingTop, offset, scroll, elementHeight, itemHeight; + if ( this._hasScroll() ) { + borderTop = parseFloat( $.css( this.activeMenu[ 0 ], "borderTopWidth" ) ) || 0; + paddingTop = parseFloat( $.css( this.activeMenu[ 0 ], "paddingTop" ) ) || 0; + offset = item.offset().top - this.activeMenu.offset().top - borderTop - paddingTop; + scroll = this.activeMenu.scrollTop(); + elementHeight = this.activeMenu.height() - 26; + itemHeight = item.outerHeight(); + + if ( offset < 0 ) { + this.activeMenu.scrollTop( scroll + offset ); + } else if ( offset + itemHeight > elementHeight ) { + this.activeMenu.scrollTop( scroll + offset - elementHeight + itemHeight ); + } + } + }; + }, + _renderMenu: function(ul, items) { + var currentCategory = ""; + var widget = this; + widget.menu.bindings = $(); + $.each(items, function(index, item) { + if (item.category && item.category !== currentCategory) { + ul.append("
  • " + categories[item.category] + "
    • "); + currentCategory = item.category; + } + var li = widget._renderItemData(ul, item); + if (item.category) { + li.attr("aria-label", categories[item.category] + " : " + item.l); + } else { + li.attr("aria-label", item.l); + } + li.attr("class", "result-item"); + }); + ul.append("
  • Go to search page
    • "); + }, + _renderItem: function(ul, item) { + var li = $("
  • ").appendTo(ul); + var div = $("
    ").appendTo(li); + var label = item.l + ? item.l + : getHighlightedText(item.input, item.boundaries, 0, item.input.length); + var idx = item.indexItem; + if (item.category === "searchTags" && idx && idx.h) { + if (idx.d) { + div.html(label + " (" + idx.h + ")
    " + + idx.d + "
    "); + } else { + div.html(label + " (" + idx.h + ")"); + } + } else { + div.html(label); + } + return li; + } +}); +$(function() { + var expanded = false; + var windowWidth; + function collapse() { + if (expanded) { + $("div#navbar-top").removeAttr("style"); + $("button#navbar-toggle-button") + .removeClass("expanded") + .attr("aria-expanded", "false"); + expanded = false; + } + } + $("button#navbar-toggle-button").click(function (e) { + if (expanded) { + collapse(); + } else { + var navbar = $("div#navbar-top"); + navbar.height(navbar.prop("scrollHeight")); + $("button#navbar-toggle-button") + .addClass("expanded") + .attr("aria-expanded", "true"); + expanded = true; + windowWidth = window.innerWidth; + } + }); + $("ul.sub-nav-list-small li a").click(collapse); + $("input#search-input").focus(collapse); + $("main").click(collapse); + $("section[id] > :header, :header[id], :header:has(a[id])").each(function(idx, el) { + // Create anchor links for headers with an associated id attribute + var hdr = $(el); + var id = hdr.attr("id") || hdr.parent("section").attr("id") || hdr.children("a").attr("id"); + if (id) { + hdr.append(" " + messages.linkIcon +""); + } + }); + $(window).on("orientationchange", collapse).on("resize", function(e) { + if (expanded && windowWidth !== window.innerWidth) collapse(); + }); + var search = $("#search-input"); + var reset = $("#reset-button"); + search.catcomplete({ + minLength: 1, + delay: 200, + source: doSearch, + response: function(event, ui) { + if (!ui.content.length) { + ui.content.push({ l: messages.noResult }); + } else { + $("#search-input").empty(); + } + }, + autoFocus: true, + focus: function(event, ui) { + return false; + }, + position: { + collision: "flip" + }, + select: function(event, ui) { + if (ui.item.indexItem) { + var url = getURL(ui.item.indexItem, ui.item.category); + window.location.href = pathtoroot + url; + $("#search-input").focus(); + } + } + }); + search.val(''); + search.prop("disabled", false); + reset.prop("disabled", false); + reset.click(function() { + search.val('').focus(); + }); + search.focus(); +}); diff --git a/restful-ws/4.0/apidocs/serialized-form.html b/restful-ws/4.0/apidocs/serialized-form.html new file mode 100644 index 0000000000..aff1057251 --- /dev/null +++ b/restful-ws/4.0/apidocs/serialized-form.html @@ -0,0 +1,300 @@ + + + + +Serialized Form (Jakarta RESTful WS API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Serialized Form

    +
    + +
    +
    +
    +

    Copyright © 2018, 2024 Eclipse Foundation.
    Use is subject to license terms.

    +
    +
    +
    + + diff --git a/restful-ws/4.0/apidocs/stylesheet.css b/restful-ws/4.0/apidocs/stylesheet.css new file mode 100644 index 0000000000..f71489f86c --- /dev/null +++ b/restful-ws/4.0/apidocs/stylesheet.css @@ -0,0 +1,1272 @@ +/* + * Javadoc style sheet + */ + +@import url('resources/fonts/dejavu.css'); + +/* + * These CSS custom properties (variables) define the core color and font + * properties used in this stylesheet. + */ +:root { + /* body, block and code fonts */ + --body-font-family: 'DejaVu Sans', Arial, Helvetica, sans-serif; + --block-font-family: 'DejaVu Serif', Georgia, "Times New Roman", Times, serif; + --code-font-family: 'DejaVu Sans Mono', monospace; + /* Base font sizes for body and code elements */ + --body-font-size: 14px; + --code-font-size: 14px; + /* Text colors for body and block elements */ + --body-text-color: #353833; + --block-text-color: #474747; + /* Background colors for various structural elements */ + --body-background-color: #ffffff; + --section-background-color: #f8f8f8; + --detail-background-color: #ffffff; + /* Colors for navigation bar and table captions */ + --navbar-background-color: #4D7A97; + --navbar-text-color: #ffffff; + /* Background color for subnavigation and various headers */ + --subnav-background-color: #dee3e9; + /* Background and text colors for selected tabs and navigation items */ + --selected-background-color: #f8981d; + --selected-text-color: #253441; + --selected-link-color: #1f389c; + /* Background colors for generated tables */ + --even-row-color: #ffffff; + --odd-row-color: #eeeeef; + /* Text color for page title */ + --title-color: #2c4557; + /* Text colors for links */ + --link-color: #4A6782; + --link-color-active: #bb7a2a; + /* Snippet colors */ + --snippet-background-color: #ebecee; + --snippet-text-color: var(--block-text-color); + --snippet-highlight-color: #f7c590; + /* Border colors for structural elements and user defined tables */ + --border-color: #ededed; + --table-border-color: #000000; + /* Search input colors */ + --search-input-background-color: #ffffff; + --search-input-text-color: #000000; + --search-input-placeholder-color: #909090; + /* Highlight color for active search tag target */ + --search-tag-highlight-color: #ffff00; + /* Adjustments for icon and active background colors of copy-to-clipboard buttons */ + --copy-icon-brightness: 100%; + --copy-button-background-color-active: rgba(168, 168, 176, 0.3); + /* Colors for invalid tag notifications */ + --invalid-tag-background-color: #ffe6e6; + --invalid-tag-text-color: #000000; +} +/* + * Styles for individual HTML elements. + * + * These are styles that are specific to individual HTML elements. Changing them affects the style of a particular + * HTML element throughout the page. + */ +body { + background-color:var(--body-background-color); + color:var(--body-text-color); + font-family:var(--body-font-family); + font-size:var(--body-font-size); + margin:0; + padding:0; + height:100%; + width:100%; +} +iframe { + margin:0; + padding:0; + height:100%; + width:100%; + overflow-y:scroll; + border:none; +} +a:link, a:visited { + text-decoration:none; + color:var(--link-color); +} +a[href]:hover, a[href]:focus { + text-decoration:none; + color:var(--link-color-active); +} +pre { + font-family:var(--code-font-family); + font-size:1em; +} +h1 { + font-size:1.428em; +} +h2 { + font-size:1.285em; +} +h3 { + font-size:1.14em; +} +h4 { + font-size:1.072em; +} +h5 { + font-size:1.001em; +} +h6 { + font-size:0.93em; +} +/* Disable font boosting for selected elements */ +h1, h2, h3, h4, h5, h6, div.member-signature { + max-height: 1000em; +} +ul { + list-style-type:disc; +} +code, tt { + font-family:var(--code-font-family); +} +:not(h1, h2, h3, h4, h5, h6) > code, +:not(h1, h2, h3, h4, h5, h6) > tt { + font-size:var(--code-font-size); + padding-top:4px; + margin-top:8px; + line-height:1.4em; +} +dt code { + font-family:var(--code-font-family); + font-size:1em; + padding-top:4px; +} +.summary-table dt code { + font-family:var(--code-font-family); + font-size:1em; + vertical-align:top; + padding-top:4px; +} +sup { + font-size:8px; +} +button { + font-family: var(--body-font-family); + font-size: 1em; +} +/* + * Styles for HTML generated by javadoc. + * + * These are style classes that are used by the standard doclet to generate HTML documentation. + */ + +/* + * Styles for document title and copyright. + */ +.about-language { + float:right; + padding:0 21px 8px 8px; + font-size:0.915em; + margin-top:-9px; + height:2.9em; +} +.legal-copy { + margin-left:.5em; +} +/* + * Styles for navigation bar. + */ +@media screen { + div.flex-box { + position:fixed; + display:flex; + flex-direction:column; + height: 100%; + width: 100%; + } + header.flex-header { + flex: 0 0 auto; + } + div.flex-content { + flex: 1 1 auto; + overflow-y: auto; + } +} +.top-nav { + background-color:var(--navbar-background-color); + color:var(--navbar-text-color); + float:left; + width:100%; + clear:right; + min-height:2.8em; + padding:10px 0 0 0; + overflow:hidden; + font-size:0.857em; +} +button#navbar-toggle-button { + display:none; +} +ul.sub-nav-list-small { + display: none; +} +.sub-nav { + background-color:var(--subnav-background-color); + float:left; + width:100%; + overflow:hidden; + font-size:0.857em; +} +.sub-nav div { + clear:left; + float:left; + padding:6px; + text-transform:uppercase; +} +.sub-nav .sub-nav-list { + padding-top:4px; +} +ul.nav-list { + display:block; + margin:0 25px 0 0; + padding:0; +} +ul.sub-nav-list { + float:left; + margin:0 25px 0 0; + padding:0; +} +ul.nav-list li { + list-style:none; + float:left; + padding: 5px 6px; + text-transform:uppercase; +} +.sub-nav .nav-list-search { + float:right; + margin:0; + padding:6px; + clear:none; + text-align:right; + position:relative; +} +ul.sub-nav-list li { + list-style:none; + float:left; +} +.top-nav a:link, .top-nav a:active, .top-nav a:visited { + color:var(--navbar-text-color); + text-decoration:none; + text-transform:uppercase; +} +.top-nav a:hover { + color:var(--link-color-active); +} +.nav-bar-cell1-rev { + background-color:var(--selected-background-color); + color:var(--selected-text-color); + margin: auto 5px; +} +.skip-nav { + position:absolute; + top:auto; + left:-9999px; + overflow:hidden; +} +/* + * Hide navigation links and search box in print layout + */ +@media print { + ul.nav-list, div.sub-nav { + display:none; + } +} +/* + * Styles for page header. + */ +.title { + color:var(--title-color); + margin:10px 0; +} +.sub-title { + margin:5px 0 0 0; +} +ul.contents-list { + margin: 0 0 15px 0; + padding: 0; + list-style: none; +} +ul.contents-list li { + font-size:0.93em; +} +/* + * Styles for headings. + */ +body.class-declaration-page .summary h2, +body.class-declaration-page .details h2, +body.class-use-page h2, +body.module-declaration-page .block-list h2 { + font-style: italic; + padding:0; + margin:15px 0; +} +body.class-declaration-page .summary h3, +body.class-declaration-page .details h3, +body.class-declaration-page .summary .inherited-list h2 { + background-color:var(--subnav-background-color); + border:1px solid var(--border-color); + margin:0 0 6px -8px; + padding:7px 5px; +} +/* + * Styles for page layout containers. + */ +main { + clear:both; + padding:10px 20px; + position:relative; +} +dl.notes > dt { + font-family: var(--body-font-family); + font-size:0.856em; + font-weight:bold; + margin:10px 0 0 0; + color:var(--body-text-color); +} +dl.notes > dd { + margin:5px 10px 10px 0; + font-size:1em; + font-family:var(--block-font-family) +} +dl.name-value > dt { + margin-left:1px; + font-size:1.1em; + display:inline; + font-weight:bold; +} +dl.name-value > dd { + margin:0 0 0 1px; + font-size:1.1em; + display:inline; +} +/* + * Styles for lists. + */ +li.circle { + list-style:circle; +} +ul.horizontal li { + display:inline; + font-size:0.9em; +} +div.inheritance { + margin:0; + padding:0; +} +div.inheritance div.inheritance { + margin-left:2em; +} +ul.block-list, +ul.details-list, +ul.member-list, +ul.summary-list { + margin:10px 0 10px 0; + padding:0; +} +ul.block-list > li, +ul.details-list > li, +ul.member-list > li, +ul.summary-list > li { + list-style:none; + margin-bottom:15px; + line-height:1.4; +} +ul.ref-list { + padding:0; + margin:0; +} +ul.ref-list > li { + list-style:none; +} +.summary-table dl, .summary-table dl dt, .summary-table dl dd { + margin-top:0; + margin-bottom:1px; +} +ul.tag-list, ul.tag-list-long { + padding-left: 0; + list-style: none; +} +ul.tag-list li { + display: inline; +} +ul.tag-list li:not(:last-child):after, +ul.tag-list-long li:not(:last-child):after +{ + content: ", "; + white-space: pre-wrap; +} +ul.preview-feature-list { + list-style: none; + margin:0; + padding:0.1em; + line-height: 1.6em; +} +/* + * Styles for tables. + */ +.summary-table, .details-table { + width:100%; + border-spacing:0; + border:1px solid var(--border-color); + border-top:0; + padding:0; +} +.caption { + position:relative; + text-align:left; + background-repeat:no-repeat; + color:var(--selected-text-color); + clear:none; + overflow:hidden; + padding: 10px 0 0 1px; + margin:0; +} +.caption a:link, .caption a:visited { + color:var(--selected-link-color); +} +.caption a:hover, +.caption a:active { + color:var(--navbar-text-color); +} +.caption span { + font-weight:bold; + white-space:nowrap; + padding:5px 12px 7px 12px; + display:inline-block; + float:left; + background-color:var(--selected-background-color); + border: none; + height:16px; +} +div.table-tabs { + padding:10px 0 0 1px; + margin:10px 0 0 0; +} +div.table-tabs > button { + border: none; + cursor: pointer; + padding: 5px 12px 7px 12px; + font-weight: bold; + margin-right: 8px; +} +div.table-tabs > .active-table-tab { + background: var(--selected-background-color); + color: var(--selected-text-color); +} +div.table-tabs > button.table-tab { + background: var(--navbar-background-color); + color: var(--navbar-text-color); +} +.two-column-search-results { + display: grid; + grid-template-columns: minmax(400px, max-content) minmax(400px, auto); +} +div.checkboxes { + line-height: 2em; +} +div.checkboxes > span { + margin-left: 10px; +} +div.checkboxes > label { + margin-left: 8px; + white-space: nowrap; +} +div.checkboxes > label > input { + margin: 0 2px; +} +.two-column-summary { + display: grid; + grid-template-columns: minmax(25%, max-content) minmax(25%, auto); +} +.three-column-summary { + display: grid; + grid-template-columns: minmax(15%, max-content) minmax(20%, max-content) minmax(20%, auto); +} +.three-column-release-summary { + display: grid; + grid-template-columns: minmax(40%, max-content) minmax(10%, max-content) minmax(40%, auto); +} +.four-column-summary { + display: grid; + grid-template-columns: minmax(10%, max-content) minmax(15%, max-content) minmax(15%, max-content) minmax(15%, auto); +} +@media screen and (max-width: 1000px) { + .four-column-summary { + display: grid; + grid-template-columns: minmax(15%, max-content) minmax(15%, auto); + } +} +@media screen and (max-width: 800px) { + .two-column-search-results { + display: grid; + grid-template-columns: minmax(40%, max-content) minmax(40%, auto); + } + .three-column-summary { + display: grid; + grid-template-columns: minmax(10%, max-content) minmax(25%, auto); + } + .three-column-release-summary { + display: grid; + grid-template-columns: minmax(70%, max-content) minmax(30%, max-content) + } + .three-column-summary .col-last, + .three-column-release-summary .col-last{ + grid-column-end: span 2; + } +} +@media screen and (max-width: 600px) { + .two-column-summary { + display: grid; + grid-template-columns: 1fr; + } +} +.summary-table > div, .details-table > div { + text-align:left; + padding: 8px 3px 3px 7px; + overflow-x: auto; + scrollbar-width: thin; +} +.col-first, .col-second, .col-last, .col-constructor-name, .col-summary-item-name { + vertical-align:top; + padding-right:0; + padding-top:8px; + padding-bottom:3px; +} +.table-header { + background:var(--subnav-background-color); + font-weight: bold; +} +/* Sortable table columns */ +.table-header[onclick] { + cursor: pointer; +} +.table-header[onclick]::after { + content:""; + display:inline-block; + background-image:url('data:image/svg+xml; utf8, \ + \ + '); + background-size:100% 100%; + width:9px; + height:14px; + margin-left:4px; + margin-bottom:-3px; +} +.table-header[onclick].sort-asc::after { + background-image:url('data:image/svg+xml; utf8, \ + \ + \ + '); + +} +.table-header[onclick].sort-desc::after { + background-image:url('data:image/svg+xml; utf8, \ + \ + \ + '); +} +.col-first, .col-first { + font-size:0.93em; +} +.col-second, .col-second, .col-last, .col-constructor-name, .col-summary-item-name, .col-last { + font-size:0.93em; +} +.col-first, .col-second, .col-constructor-name { + vertical-align:top; + overflow: auto; +} +.col-last { + white-space:normal; +} +.col-first a:link, .col-first a:visited, +.col-second a:link, .col-second a:visited, +.col-first a:link, .col-first a:visited, +.col-second a:link, .col-second a:visited, +.col-constructor-name a:link, .col-constructor-name a:visited, +.col-summary-item-name a:link, .col-summary-item-name a:visited { + font-weight:bold; +} +.even-row-color, .even-row-color .table-header { + background-color:var(--even-row-color); +} +.odd-row-color, .odd-row-color .table-header { + background-color:var(--odd-row-color); +} +/* + * Styles for contents. + */ +div.block { + font-size:var(--body-font-size); + font-family:var(--block-font-family); +} +.col-last div { + padding-top:0; +} +.col-last a { + padding-bottom:3px; +} +.module-signature, +.package-signature, +.type-signature, +.member-signature { + font-family:var(--code-font-family); + font-size:1em; + margin:14px 0; + white-space: pre-wrap; +} +.module-signature, +.package-signature, +.type-signature { + margin-top: 0; +} +.member-signature .type-parameters-long, +.member-signature .parameters, +.member-signature .exceptions { + display: inline-block; + vertical-align: top; + white-space: pre; +} +.member-signature .type-parameters { + white-space: normal; +} +/* + * Styles for formatting effect. + */ +.source-line-no { + /* Color of line numbers in source pages can be set via custom property below */ + color:var(--source-linenumber-color, green); + padding:0 30px 0 0; +} +.block { + display:block; + margin:0 10px 5px 0; + color:var(--block-text-color); +} +.deprecated-label, .description-from-type-label, .implementation-label, .member-name-link, +.module-label-in-package, .module-label-in-type, .package-label-in-type, +.package-hierarchy-label, .type-name-label, .type-name-link, .search-tag-link, .preview-label { + font-weight:bold; +} +.deprecation-comment, .help-footnote, .preview-comment { + font-style:italic; +} +.deprecation-block { + font-size:1em; + font-family:var(--block-font-family); + border-style:solid; + border-width:thin; + border-radius:10px; + padding:10px; + margin-bottom:10px; + margin-right:10px; + display:inline-block; +} +.preview-block { + font-size:1em; + font-family:var(--block-font-family); + border-style:solid; + border-width:thin; + border-radius:10px; + padding:10px; + margin-bottom:10px; + margin-right:10px; + display:inline-block; +} +div.block div.deprecation-comment { + font-style:normal; +} +details.invalid-tag, span.invalid-tag { + font-size:1em; + font-family:var(--block-font-family); + color: var(--invalid-tag-text-color); + background: var(--invalid-tag-background-color); + border: thin solid var(--table-border-color); + border-radius:2px; + padding: 2px 4px; + display:inline-block; +} +details summary { + cursor: pointer; +} +/* + * Styles specific to HTML5 elements. + */ +main, nav, header, footer, section { + display:block; +} +/* + * Styles for javadoc search. + */ +.ui-state-active { + /* Overrides the color of selection used in jQuery UI */ + background: var(--selected-background-color); + border: 1px solid var(--selected-background-color); + color: var(--selected-text-color); +} +.ui-autocomplete-category { + font-weight:bold; + font-size:15px; + padding:7px 0 7px 3px; + background-color:var(--navbar-background-color); + color:var(--navbar-text-color); +} +.ui-autocomplete { + max-height:85%; + max-width:65%; + overflow-y:auto; + overflow-x:auto; + scrollbar-width: thin; + white-space:nowrap; + box-shadow: 0 3px 6px rgba(0,0,0,0.16), 0 3px 6px rgba(0,0,0,0.23); +} +ul.ui-autocomplete { + position:fixed; + z-index:1; + background-color: var(--body-background-color); +} +ul.ui-autocomplete li { + float:left; + clear:both; + min-width:100%; +} +ul.ui-autocomplete li.ui-static-link { + position:sticky; + bottom:0; + left:0; + background: var(--subnav-background-color); + padding: 5px 0; + font-family: var(--body-font-family); + font-size: 0.93em; + font-weight: bolder; + z-index: 2; +} +li.ui-static-link a, li.ui-static-link a:visited { + text-decoration:none; + color:var(--link-color); + float:right; + margin-right:20px; +} +.ui-autocomplete .result-item { + font-size: inherit; +} +.ui-autocomplete .result-highlight { + font-weight:bold; +} +#search-input, #page-search-input { + background-image:url('resources/glass.png'); + background-size:13px; + background-repeat:no-repeat; + background-position:2px 3px; + background-color: var(--search-input-background-color); + color: var(--search-input-text-color); + border-color: var(--border-color); + padding-left:20px; + width: 250px; + margin: 0; +} +#search-input { + margin-left: 4px; +} +#reset-button { + background-color: transparent; + background-image:url('resources/x.png'); + background-repeat:no-repeat; + background-size:contain; + border:0; + border-radius:0; + width:12px; + height:12px; + position:absolute; + right:12px; + top:10px; + font-size:0; +} +::placeholder { + color:var(--search-input-placeholder-color); + opacity: 1; +} +.search-tag-desc-result { + font-style:italic; + font-size:11px; +} +.search-tag-holder-result { + font-style:italic; + font-size:12px; +} +.search-tag-result:target { + background-color:var(--search-tag-highlight-color); +} +details.page-search-details { + display: inline-block; +} +div#result-container { + font-size: 1em; +} +div#result-container a.search-result-link { + padding: 0; + margin: 4px 0; + width: 100%; +} +#result-container .result-highlight { + font-weight:bolder; +} +.page-search-info { + background-color: var(--subnav-background-color); + border-radius: 3px; + border: 0 solid var(--border-color); + padding: 0 8px; + overflow: hidden; + height: 0; + transition: all 0.2s ease; +} +div.table-tabs > button.table-tab { + background: var(--navbar-background-color); + color: var(--navbar-text-color); +} +.page-search-header { + padding: 5px 12px 7px 12px; + font-weight: bold; + margin-right: 3px; + background-color:var(--navbar-background-color); + color:var(--navbar-text-color); + display: inline-block; +} +button.page-search-header { + border: none; + cursor: pointer; +} +span#page-search-link { + text-decoration: underline; +} +.module-graph span, .sealed-graph span { + display:none; + position:absolute; +} +.module-graph:hover span, .sealed-graph:hover span { + display:block; + margin: -100px 0 0 100px; + z-index: 1; +} +.inherited-list { + margin: 10px 0 10px 0; +} +section.class-description { + line-height: 1.4; +} +.summary section[class$="-summary"], .details section[class$="-details"], +.class-uses .detail, .serialized-class-details { + padding: 0 20px 5px 10px; + border: 1px solid var(--border-color); + background-color: var(--section-background-color); +} +.inherited-list, section[class$="-details"] .detail { + padding:0 0 5px 8px; + background-color:var(--detail-background-color); + border:none; +} +.vertical-separator { + padding: 0 5px; +} +ul.help-section-list { + margin: 0; +} +ul.help-subtoc > li { + display: inline-block; + padding-right: 5px; + font-size: smaller; +} +ul.help-subtoc > li::before { + content: "\2022" ; + padding-right:2px; +} +.help-note { + font-style: italic; +} +/* + * Indicator icon for external links. + */ +main a[href*="://"]::after { + content:""; + display:inline-block; + background-image:url('data:image/svg+xml; utf8, \ + \ + \ + '); + background-size:100% 100%; + width:7px; + height:7px; + margin-left:2px; + margin-bottom:4px; +} +main a[href*="://"]:hover::after, +main a[href*="://"]:focus::after { + background-image:url('data:image/svg+xml; utf8, \ + \ + \ + '); +} +/* + * Styles for header/section anchor links + */ +a.anchor-link { + opacity: 0; + transition: opacity 0.1s; +} +:hover > a.anchor-link { + opacity: 80%; +} +a.anchor-link:hover, +a.anchor-link:focus-visible, +a.anchor-link.visible { + opacity: 100%; +} +a.anchor-link > img { + width: 0.9em; + height: 0.9em; +} +/* + * Styles for copy-to-clipboard buttons + */ +button.copy { + opacity: 70%; + border: none; + border-radius: 3px; + position: relative; + background:none; + transition: opacity 0.3s; + cursor: pointer; +} +:hover > button.copy { + opacity: 80%; +} +button.copy:hover, +button.copy:active, +button.copy:focus-visible, +button.copy.visible { + opacity: 100%; +} +button.copy img { + position: relative; + background: none; + filter: brightness(var(--copy-icon-brightness)); +} +button.copy:active { + background-color: var(--copy-button-background-color-active); +} +button.copy span { + color: var(--body-text-color); + position: relative; + top: -0.1em; + transition: all 0.1s; + font-size: 0.76rem; + line-height: 1.2em; + opacity: 0; +} +button.copy:hover span, +button.copy:focus-visible span, +button.copy.visible span { + opacity: 100%; +} +/* search page copy button */ +button#page-search-copy { + margin-left: 0.4em; + padding:0.3em; + top:0.13em; +} +button#page-search-copy img { + width: 1.2em; + height: 1.2em; + padding: 0.01em 0; + top: 0.15em; +} +button#page-search-copy span { + color: var(--body-text-color); + line-height: 1.2em; + padding: 0.2em; + top: -0.18em; +} +div.page-search-info:hover button#page-search-copy span { + opacity: 100%; +} +/* snippet copy button */ +button.snippet-copy { + position: absolute; + top: 6px; + right: 6px; + height: 1.7em; + padding: 2px; +} +button.snippet-copy img { + width: 18px; + height: 18px; + padding: 0.05em 0; +} +button.snippet-copy span { + line-height: 1.2em; + padding: 0.2em; + position: relative; + top: -0.5em; +} +div.snippet-container:hover button.snippet-copy span { + opacity: 100%; +} +/* + * Styles for user-provided tables. + * + * borderless: + * No borders, vertical margins, styled caption. + * This style is provided for use with existing doc comments. + * In general, borderless tables should not be used for layout purposes. + * + * plain: + * Plain borders around table and cells, vertical margins, styled caption. + * Best for small tables or for complex tables for tables with cells that span + * rows and columns, when the "striped" style does not work well. + * + * striped: + * Borders around the table and vertical borders between cells, striped rows, + * vertical margins, styled caption. + * Best for tables that have a header row, and a body containing a series of simple rows. + */ + +table.borderless, +table.plain, +table.striped { + margin-top: 10px; + margin-bottom: 10px; +} +table.borderless > caption, +table.plain > caption, +table.striped > caption { + font-weight: bold; + font-size: smaller; +} +table.borderless th, table.borderless td, +table.plain th, table.plain td, +table.striped th, table.striped td { + padding: 2px 5px; +} +table.borderless, +table.borderless > thead > tr > th, table.borderless > tbody > tr > th, table.borderless > tr > th, +table.borderless > thead > tr > td, table.borderless > tbody > tr > td, table.borderless > tr > td { + border: none; +} +table.borderless > thead > tr, table.borderless > tbody > tr, table.borderless > tr { + background-color: transparent; +} +table.plain { + border-collapse: collapse; + border: 1px solid var(--table-border-color); +} +table.plain > thead > tr, table.plain > tbody tr, table.plain > tr { + background-color: transparent; +} +table.plain > thead > tr > th, table.plain > tbody > tr > th, table.plain > tr > th, +table.plain > thead > tr > td, table.plain > tbody > tr > td, table.plain > tr > td { + border: 1px solid var(--table-border-color); +} +table.striped { + border-collapse: collapse; + border: 1px solid var(--table-border-color); +} +table.striped > thead { + background-color: var(--subnav-background-color); +} +table.striped > thead > tr > th, table.striped > thead > tr > td { + border: 1px solid var(--table-border-color); +} +table.striped > tbody > tr:nth-child(even) { + background-color: var(--odd-row-color) +} +table.striped > tbody > tr:nth-child(odd) { + background-color: var(--even-row-color) +} +table.striped > tbody > tr > th, table.striped > tbody > tr > td { + border-left: 1px solid var(--table-border-color); + border-right: 1px solid var(--table-border-color); +} +table.striped > tbody > tr > th { + font-weight: normal; +} +/** + * Tweak style for small screens. + */ +@media screen and (max-width: 920px) { + header.flex-header { + max-height: 100vh; + overflow-y: auto; + } + div#navbar-top { + height: 2.8em; + transition: height 0.35s ease; + } + ul.nav-list { + display: block; + width: 40%; + float:left; + clear: left; + margin: 10px 0 0 0; + padding: 0; + } + ul.nav-list li { + float: none; + padding: 6px; + margin-left: 10px; + margin-top: 2px; + } + ul.sub-nav-list-small { + display:block; + height: 100%; + width: 50%; + float: right; + clear: right; + background-color: var(--subnav-background-color); + color: var(--body-text-color); + margin: 6px 0 0 0; + padding: 0; + } + ul.sub-nav-list-small ul { + padding-left: 20px; + } + ul.sub-nav-list-small a:link, ul.sub-nav-list-small a:visited { + color:var(--link-color); + } + ul.sub-nav-list-small a:hover { + color:var(--link-color-active); + } + ul.sub-nav-list-small li { + list-style:none; + float:none; + padding: 6px; + margin-top: 1px; + text-transform:uppercase; + } + ul.sub-nav-list-small > li { + margin-left: 10px; + } + ul.sub-nav-list-small li p { + margin: 5px 0; + } + div#navbar-sub-list { + display: none; + } + .top-nav a:link, .top-nav a:active, .top-nav a:visited { + display: block; + } + button#navbar-toggle-button { + width: 3.4em; + height: 2.8em; + background-color: transparent; + display: block; + float: left; + border: 0; + margin: 0 10px; + cursor: pointer; + font-size: 10px; + } + button#navbar-toggle-button .nav-bar-toggle-icon { + display: block; + width: 24px; + height: 3px; + margin: 1px 0 4px 0; + border-radius: 2px; + transition: all 0.1s; + background-color: var(--navbar-text-color); + } + button#navbar-toggle-button.expanded span.nav-bar-toggle-icon:nth-child(1) { + transform: rotate(45deg); + transform-origin: 10% 10%; + width: 26px; + } + button#navbar-toggle-button.expanded span.nav-bar-toggle-icon:nth-child(2) { + opacity: 0; + } + button#navbar-toggle-button.expanded span.nav-bar-toggle-icon:nth-child(3) { + transform: rotate(-45deg); + transform-origin: 10% 90%; + width: 26px; + } +} +@media screen and (max-width: 800px) { + .about-language { + padding-right: 16px; + } + ul.nav-list li { + margin-left: 5px; + } + ul.sub-nav-list-small > li { + margin-left: 5px; + } + main { + padding: 10px; + } + .summary section[class$="-summary"], .details section[class$="-details"], + .class-uses .detail, .serialized-class-details { + padding: 0 8px 5px 8px; + } + body { + -webkit-text-size-adjust: none; + } +} +@media screen and (max-width: 400px) { + .about-language { + font-size: 10px; + padding-right: 12px; + } +} +@media screen and (max-width: 400px) { + .nav-list-search { + width: 94%; + } + #search-input, #page-search-input { + width: 70%; + } +} +@media screen and (max-width: 320px) { + .nav-list-search > label { + display: none; + } + .nav-list-search { + width: 90%; + } + #search-input, #page-search-input { + width: 80%; + } +} + +pre.snippet { + background-color: var(--snippet-background-color); + color: var(--snippet-text-color); + padding: 10px; + margin: 12px 0; + overflow: auto; + white-space: pre; +} +div.snippet-container { + position: relative; +} +@media screen and (max-width: 800px) { + pre.snippet { + padding-top: 26px; + } + button.snippet-copy { + top: 4px; + right: 4px; + } +} +pre.snippet .italic { + font-style: italic; +} +pre.snippet .bold { + font-weight: bold; +} +pre.snippet .highlighted { + background-color: var(--snippet-highlight-color); + border-radius: 10%; +} diff --git a/restful-ws/4.0/apidocs/tag-search-index.js b/restful-ws/4.0/apidocs/tag-search-index.js new file mode 100644 index 0000000000..115fc87bc5 --- /dev/null +++ b/restful-ws/4.0/apidocs/tag-search-index.js @@ -0,0 +1 @@ +tagSearchIndex = [{"l":"Accessing Web Resources","h":"package jakarta.ws.rs.client","d":"Section","u":"jakarta.ws.rs/jakarta/ws/rs/client/package-summary.html#accessing-web-resources-heading"},{"l":"Client API Bootstrapping and Configuration","h":"package jakarta.ws.rs.client","d":"Section","u":"jakarta.ws.rs/jakarta/ws/rs/client/package-summary.html#client-api-bootstrapping-and-configuration-heading"},{"l":"Constant Field Values","h":"","u":"constant-values.html"},{"l":"Generic Invocations","h":"package jakarta.ws.rs.client","d":"Section","u":"jakarta.ws.rs/jakarta/ws/rs/client/package-summary.html#generic-invocations-heading"},{"l":"Provider extensions","h":"Overview","d":"Section","u":"index.html#provider-extensions-heading"},{"l":"Reconnect support","h":"interface jakarta.ws.rs.sse.SseEventSource","d":"Section","u":"jakarta.ws.rs/jakarta/ws/rs/sse/SseEventSource.html#reconnect-support-heading"},{"l":"Registering JAX-RS components.","h":"interface jakarta.ws.rs.core.Configurable","d":"Section","u":"jakarta.ws.rs/jakarta/ws/rs/core/Configurable.html#registering-jax-rs-components--heading"},{"l":"Serialized Form","h":"","u":"serialized-form.html"},{"l":"Setting properties.","h":"interface jakarta.ws.rs.core.Configurable","d":"Section","u":"jakarta.ws.rs/jakarta/ws/rs/core/Configurable.html#setting-properties--heading"},{"l":"The JAX-RS client API","h":"package jakarta.ws.rs.client","d":"Section","u":"jakarta.ws.rs/jakarta/ws/rs/client/package-summary.html#the-jax-rs-client-api-heading"},{"l":"Web resource clients","h":"Overview","d":"Section","u":"index.html#web-resource-clients-heading"},{"l":"Web resources","h":"Overview","d":"Section","u":"index.html#web-resources-heading"}];updateSearchResults(); \ No newline at end of file diff --git a/restful-ws/4.0/apidocs/type-search-index.js b/restful-ws/4.0/apidocs/type-search-index.js new file mode 100644 index 0000000000..195e09aeff --- /dev/null +++ b/restful-ws/4.0/apidocs/type-search-index.js @@ -0,0 +1 @@ +typeSearchIndex = [{"p":"jakarta.ws.rs.core","l":"Cookie.AbstractCookieBuilder"},{"p":"jakarta.ws.rs.core","l":"AbstractMultivaluedMap"},{"p":"jakarta.ws.rs.core","l":"NewCookie.AbstractNewCookieBuilder"},{"l":"All Classes and Interfaces","u":"allclasses-index.html"},{"p":"jakarta.ws.rs.core","l":"Application"},{"p":"jakarta.ws.rs","l":"ApplicationPath"},{"p":"jakarta.ws.rs.client","l":"AsyncInvoker"},{"p":"jakarta.ws.rs.container","l":"AsyncResponse"},{"p":"jakarta.ws.rs","l":"BadRequestException"},{"p":"jakarta.ws.rs","l":"BeanParam"},{"p":"jakarta.ws.rs.core","l":"Cookie.Builder"},{"p":"jakarta.ws.rs.core","l":"EntityPart.Builder"},{"p":"jakarta.ws.rs.client","l":"Invocation.Builder"},{"p":"jakarta.ws.rs.core","l":"Link.Builder"},{"p":"jakarta.ws.rs.core","l":"NewCookie.Builder"},{"p":"jakarta.ws.rs.sse","l":"OutboundSseEvent.Builder"},{"p":"jakarta.ws.rs","l":"SeBootstrap.Configuration.Builder"},{"p":"jakarta.ws.rs.sse","l":"SseEventSource.Builder"},{"p":"jakarta.ws.rs.core","l":"CacheControl"},{"p":"jakarta.ws.rs.client","l":"Client"},{"p":"jakarta.ws.rs.client","l":"ClientBuilder"},{"p":"jakarta.ws.rs","l":"ClientErrorException"},{"p":"jakarta.ws.rs.client","l":"ClientRequestContext"},{"p":"jakarta.ws.rs.client","l":"ClientRequestFilter"},{"p":"jakarta.ws.rs.client","l":"ClientResponseContext"},{"p":"jakarta.ws.rs.client","l":"ClientResponseFilter"},{"p":"jakarta.ws.rs.container","l":"CompletionCallback"},{"p":"jakarta.ws.rs.client","l":"CompletionStageRxInvoker"},{"p":"jakarta.ws.rs.core","l":"Configurable"},{"p":"jakarta.ws.rs.core","l":"Configuration"},{"p":"jakarta.ws.rs","l":"SeBootstrap.Configuration"},{"p":"jakarta.ws.rs.container","l":"ConnectionCallback"},{"p":"jakarta.ws.rs","l":"ConstrainedTo"},{"p":"jakarta.ws.rs","l":"Consumes"},{"p":"jakarta.ws.rs.container","l":"ContainerRequestContext"},{"p":"jakarta.ws.rs.container","l":"ContainerRequestFilter"},{"p":"jakarta.ws.rs.container","l":"ContainerResponseContext"},{"p":"jakarta.ws.rs.container","l":"ContainerResponseFilter"},{"p":"jakarta.ws.rs.core","l":"Context"},{"p":"jakarta.ws.rs.ext","l":"ContextResolver"},{"p":"jakarta.ws.rs.core","l":"Cookie"},{"p":"jakarta.ws.rs","l":"CookieParam"},{"p":"jakarta.ws.rs","l":"DefaultValue"},{"p":"jakarta.ws.rs","l":"DELETE"},{"p":"jakarta.ws.rs.container","l":"DynamicFeature"},{"p":"jakarta.ws.rs","l":"Encoded"},{"p":"jakarta.ws.rs.client","l":"Entity"},{"p":"jakarta.ws.rs.core","l":"EntityPart"},{"p":"jakarta.ws.rs.core","l":"EntityTag"},{"p":"jakarta.ws.rs.ext","l":"ExceptionMapper"},{"p":"jakarta.ws.rs.core","l":"Response.Status.Family"},{"p":"jakarta.ws.rs.core","l":"Feature"},{"p":"jakarta.ws.rs.core","l":"FeatureContext"},{"p":"jakarta.ws.rs","l":"ForbiddenException"},{"p":"jakarta.ws.rs.core","l":"Form"},{"p":"jakarta.ws.rs","l":"FormParam"},{"p":"jakarta.ws.rs.core","l":"GenericEntity"},{"p":"jakarta.ws.rs.core","l":"GenericType"},{"p":"jakarta.ws.rs","l":"GET"},{"p":"jakarta.ws.rs","l":"HEAD"},{"p":"jakarta.ws.rs.ext","l":"RuntimeDelegate.HeaderDelegate"},{"p":"jakarta.ws.rs","l":"HeaderParam"},{"p":"jakarta.ws.rs.core","l":"HttpHeaders"},{"p":"jakarta.ws.rs","l":"HttpMethod"},{"p":"jakarta.ws.rs.sse","l":"InboundSseEvent"},{"p":"jakarta.ws.rs","l":"SeBootstrap.Instance"},{"p":"jakarta.ws.rs.ext","l":"InterceptorContext"},{"p":"jakarta.ws.rs","l":"InternalServerErrorException"},{"p":"jakarta.ws.rs.client","l":"Invocation"},{"p":"jakarta.ws.rs.client","l":"InvocationCallback"},{"p":"jakarta.ws.rs.ext","l":"ParamConverter.Lazy"},{"p":"jakarta.ws.rs.core","l":"Link"},{"p":"jakarta.ws.rs","l":"MatrixParam"},{"p":"jakarta.ws.rs.core","l":"MediaType"},{"p":"jakarta.ws.rs.ext","l":"MessageBodyReader"},{"p":"jakarta.ws.rs.ext","l":"MessageBodyWriter"},{"p":"jakarta.ws.rs.core","l":"MultivaluedHashMap"},{"p":"jakarta.ws.rs.core","l":"MultivaluedMap"},{"p":"jakarta.ws.rs","l":"NameBinding"},{"p":"jakarta.ws.rs.core","l":"NewCookie"},{"p":"jakarta.ws.rs.core","l":"NoContentException"},{"p":"jakarta.ws.rs","l":"NotAcceptableException"},{"p":"jakarta.ws.rs","l":"NotAllowedException"},{"p":"jakarta.ws.rs","l":"NotAuthorizedException"},{"p":"jakarta.ws.rs","l":"NotFoundException"},{"p":"jakarta.ws.rs","l":"NotSupportedException"},{"p":"jakarta.ws.rs","l":"OPTIONS"},{"p":"jakarta.ws.rs.sse","l":"OutboundSseEvent"},{"p":"jakarta.ws.rs.ext","l":"ParamConverter"},{"p":"jakarta.ws.rs.ext","l":"ParamConverterProvider"},{"p":"jakarta.ws.rs","l":"PATCH"},{"p":"jakarta.ws.rs","l":"Path"},{"p":"jakarta.ws.rs","l":"PathParam"},{"p":"jakarta.ws.rs.core","l":"PathSegment"},{"p":"jakarta.ws.rs","l":"POST"},{"p":"jakarta.ws.rs.container","l":"PreMatching"},{"p":"jakarta.ws.rs","l":"Priorities"},{"p":"jakarta.ws.rs","l":"ProcessingException"},{"p":"jakarta.ws.rs","l":"Produces"},{"p":"jakarta.ws.rs.ext","l":"Provider"},{"p":"jakarta.ws.rs.ext","l":"Providers"},{"p":"jakarta.ws.rs","l":"PUT"},{"p":"jakarta.ws.rs","l":"QueryParam"},{"p":"jakarta.ws.rs.ext","l":"ReaderInterceptor"},{"p":"jakarta.ws.rs.ext","l":"ReaderInterceptorContext"},{"p":"jakarta.ws.rs","l":"RedirectionException"},{"p":"jakarta.ws.rs.core","l":"Request"},{"p":"jakarta.ws.rs.container","l":"ResourceContext"},{"p":"jakarta.ws.rs.container","l":"ResourceInfo"},{"p":"jakarta.ws.rs.core","l":"Response"},{"p":"jakarta.ws.rs.core","l":"Response.ResponseBuilder"},{"p":"jakarta.ws.rs.client","l":"ResponseProcessingException"},{"p":"jakarta.ws.rs.ext","l":"RuntimeDelegate"},{"p":"jakarta.ws.rs","l":"RuntimeType"},{"p":"jakarta.ws.rs.client","l":"RxInvoker"},{"p":"jakarta.ws.rs.client","l":"RxInvokerProvider"},{"p":"jakarta.ws.rs.core","l":"NewCookie.SameSite"},{"p":"jakarta.ws.rs","l":"SeBootstrap"},{"p":"jakarta.ws.rs.core","l":"SecurityContext"},{"p":"jakarta.ws.rs","l":"ServerErrorException"},{"p":"jakarta.ws.rs","l":"ServiceUnavailableException"},{"p":"jakarta.ws.rs.sse","l":"Sse"},{"p":"jakarta.ws.rs.sse","l":"SseBroadcaster"},{"p":"jakarta.ws.rs.sse","l":"SseEvent"},{"p":"jakarta.ws.rs.sse","l":"SseEventSink"},{"p":"jakarta.ws.rs.sse","l":"SseEventSource"},{"p":"jakarta.ws.rs","l":"SeBootstrap.Configuration.SSLClientAuthentication"},{"p":"jakarta.ws.rs.core","l":"Response.Status"},{"p":"jakarta.ws.rs.core","l":"Response.StatusType"},{"p":"jakarta.ws.rs","l":"SeBootstrap.Instance.StopResult"},{"p":"jakarta.ws.rs.core","l":"StreamingOutput"},{"p":"jakarta.ws.rs.container","l":"Suspended"},{"p":"jakarta.ws.rs.client","l":"SyncInvoker"},{"p":"jakarta.ws.rs.container","l":"TimeoutHandler"},{"p":"jakarta.ws.rs.core","l":"UriBuilder"},{"p":"jakarta.ws.rs.core","l":"UriBuilderException"},{"p":"jakarta.ws.rs.core","l":"UriInfo"},{"p":"jakarta.ws.rs.core","l":"Variant"},{"p":"jakarta.ws.rs.core","l":"Variant.VariantListBuilder"},{"p":"jakarta.ws.rs","l":"WebApplicationException"},{"p":"jakarta.ws.rs.client","l":"WebTarget"},{"p":"jakarta.ws.rs.ext","l":"WriterInterceptor"},{"p":"jakarta.ws.rs.ext","l":"WriterInterceptorContext"}];updateSearchResults(); \ No newline at end of file