From bdd1abb667e7a07bd95f6287491a74049873f459 Mon Sep 17 00:00:00 2001
From: Alwin Joseph <44426046+alwin-joseph@users.noreply.github.com>
Date: Tue, 26 Mar 2024 18:35:58 +0530
Subject: [PATCH] API/Javadoc Assertions for Jaxrs 4.0 (#1242)
---
.../JAXRSJavadocAssertions_4.0.0.html | 10359 ++++++++++++++
.../JAXRSJavadocAssertions_4.0.0.xml | 11538 ++++++++++++++++
2 files changed, 21897 insertions(+)
create mode 100644 jaxrs-tck/docs/assertions/JAXRSJavadocAssertions_4.0.0.html
create mode 100644 jaxrs-tck/docs/assertions/JAXRSJavadocAssertions_4.0.0.xml
diff --git a/jaxrs-tck/docs/assertions/JAXRSJavadocAssertions_4.0.0.html b/jaxrs-tck/docs/assertions/JAXRSJavadocAssertions_4.0.0.html
new file mode 100644
index 000000000..ff7ff702d
--- /dev/null
+++ b/jaxrs-tck/docs/assertions/JAXRSJavadocAssertions_4.0.0.html
@@ -0,0 +1,10359 @@
+
+
+
+ID | Return | Method/Field | Description | Required | Deprecated | Testable |
+
+JAXRS:JAVADOC:2 | String | jakarta.ws.rs.CookieParam.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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:3 | String | jakarta.ws.rs.DefaultValue.value
+ | The specified default value. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:4 | String | jakarta.ws.rs.FormParam.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". | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:5 | String | jakarta.ws.rs.HeaderParam.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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:6 | String | jakarta.ws.rs.HttpMethod.value
+ | Specifies the name of a HTTP method. E.g. "GET". | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:7 | String | jakarta.ws.rs.MatrixParam.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". | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:8 | String | jakarta.ws.rs.Path.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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:9 | String | jakarta.ws.rs.PathParam.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"). | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:11 | String | jakarta.ws.rs.QueryParam.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". | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:12 | Response | jakarta.ws.rs.WebApplicationException.getResponse
+ | Get the HTTP response. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:13 | WebApplicationException | jakarta.ws.rs.WebApplicationException.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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:14 | WebApplicationException | jakarta.ws.rs.WebApplicationException.WebApplicationException
+
+ (
+ 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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:15 | WebApplicationException | jakarta.ws.rs.WebApplicationException.WebApplicationException
+
+ (
+ int
+ )
+ | 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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:16 | WebApplicationException | jakarta.ws.rs.WebApplicationException.WebApplicationException
+
+ (
+ 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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:17 | WebApplicationException | jakarta.ws.rs.WebApplicationException.WebApplicationException
+
+ (
+ Throwable
+ )
+ | 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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:18 | WebApplicationException | jakarta.ws.rs.WebApplicationException.WebApplicationException
+
+ (
+ Throwable
+ , 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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:19 | WebApplicationException | jakarta.ws.rs.WebApplicationException.WebApplicationException
+
+ (
+ Throwable
+ , int
+ )
+ | 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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:20 | WebApplicationException | jakarta.ws.rs.WebApplicationException.WebApplicationException
+
+ (
+ Throwable
+ , 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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:21 | Application | jakarta.ws.rs.core.Application.Application
+ |
+
+ | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:22 | Set | jakarta.ws.rs.core.Application.getClasses
+ | Get a set of root resource, provider and Feature 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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:24 | CacheControl | jakarta.ws.rs.core.CacheControl.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 | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:25 | boolean | jakarta.ws.rs.core.CacheControl.equals
+
+ (
+ Object
+ )
+ | Compares object argument to this cache control to see if they are the same considering all property values. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:26 | Map | jakarta.ws.rs.core.CacheControl.getCacheExtension
+ | Corresponds to a set of extension cache control directives. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:27 | int | jakarta.ws.rs.core.CacheControl.getMaxAge
+ | Corresponds to the max-age cache control directive. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:28 | List | jakarta.ws.rs.core.CacheControl.getNoCacheFields
+ | Corresponds to the value of the no-cache cache control directive. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:29 | List | jakarta.ws.rs.core.CacheControl.getPrivateFields
+ | Corresponds to the value of the private cache control directive. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:30 | int | jakarta.ws.rs.core.CacheControl.getSMaxAge
+ | Corresponds to the s-maxage cache control directive. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:31 | int | jakarta.ws.rs.core.CacheControl.hashCode
+ | Generate hash code from cache control properties. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:32 | boolean | jakarta.ws.rs.core.CacheControl.isMustRevalidate
+ | Corresponds to the must-revalidate cache control directive. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:33 | boolean | jakarta.ws.rs.core.CacheControl.isNoCache
+ | Corresponds to the no-cache cache control directive. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:34 | boolean | jakarta.ws.rs.core.CacheControl.isNoStore
+ | Corresponds to the no-store cache control directive. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:35 | boolean | jakarta.ws.rs.core.CacheControl.isNoTransform
+ | Corresponds to the no-transform cache control directive. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:36 | boolean | jakarta.ws.rs.core.CacheControl.isPrivate
+ | Corresponds to the private cache control directive. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:37 | boolean | jakarta.ws.rs.core.CacheControl.isProxyRevalidate
+ | Corresponds to the proxy-revalidate cache control directive. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:38 | void | jakarta.ws.rs.core.CacheControl.setMaxAge
+
+ (
+ int
+ )
+ | Corresponds to the max-age cache control directive. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:39 | void | jakarta.ws.rs.core.CacheControl.setMustRevalidate
+
+ (
+ boolean
+ )
+ | Corresponds to the must-revalidate cache control directive. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:40 | void | jakarta.ws.rs.core.CacheControl.setNoCache
+
+ (
+ boolean
+ )
+ | Corresponds to the no-cache cache control directive. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:41 | void | jakarta.ws.rs.core.CacheControl.setNoStore
+
+ (
+ boolean
+ )
+ | Corresponds to the no-store cache control directive. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:42 | void | jakarta.ws.rs.core.CacheControl.setNoTransform
+
+ (
+ boolean
+ )
+ | Corresponds to the no-transform cache control directive. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:43 | void | jakarta.ws.rs.core.CacheControl.setPrivate
+
+ (
+ boolean
+ )
+ | Corresponds to the private cache control directive. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:44 | void | jakarta.ws.rs.core.CacheControl.setProxyRevalidate
+
+ (
+ boolean
+ )
+ | Corresponds to the must-revalidate cache control directive. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:45 | void | jakarta.ws.rs.core.CacheControl.setSMaxAge
+
+ (
+ int
+ )
+ | Corresponds to the s-maxage cache control directive. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:52 | boolean | jakarta.ws.rs.core.Cookie.equals
+
+ (
+ Object
+ )
+ | Compare for equality. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:53 | String | jakarta.ws.rs.core.Cookie.getDomain
+ | Get the domain of the cookie. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:54 | String | jakarta.ws.rs.core.Cookie.getName
+ | Get the name of the cookie. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:55 | String | jakarta.ws.rs.core.Cookie.getPath
+ | Get the path of the cookie. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:56 | String | jakarta.ws.rs.core.Cookie.getValue
+ | Get the value of the cookie. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:57 | int | jakarta.ws.rs.core.Cookie.getVersion
+ | Get the version of the cookie. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:58 | int | jakarta.ws.rs.core.Cookie.hashCode
+ | Generate a hash code by hashing all of the cookies properties. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:62 | EntityTag | jakarta.ws.rs.core.EntityTag.EntityTag
+
+ (
+ String
+ )
+ | Creates a new instance of a strong EntityTag. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:63 | EntityTag | jakarta.ws.rs.core.EntityTag.EntityTag
+
+ (
+ String
+ , boolean
+ )
+ | Creates a new instance of an EntityTag. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:64 | boolean | jakarta.ws.rs.core.EntityTag.equals
+
+ (
+ Object
+ )
+ | Compares obj to this tag to see if they are the same considering weakness and value. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:65 | String | jakarta.ws.rs.core.EntityTag.getValue
+ | Get the value of an EntityTag. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:66 | int | jakarta.ws.rs.core.EntityTag.hashCode
+ | Generate hashCode based on value and weakness. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:67 | boolean | jakarta.ws.rs.core.EntityTag.isWeak
+ | Check the strength of an EntityTag. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:71 | GenericEntity | jakarta.ws.rs.core.GenericEntity.GenericEntity
+
+ (
+ Object
+ , Type
+ )
+ | 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 then genericType could be the same or a superclass of ArrayList with the same generic type like List. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:72 | Object | jakarta.ws.rs.core.GenericEntity.getEntity
+ | Get the enclosed entity. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:73 | Class | jakarta.ws.rs.core.GenericEntity.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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:74 | Type | jakarta.ws.rs.core.GenericEntity.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 not ArrayList. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:75 | List | jakarta.ws.rs.core.HttpHeaders.getAcceptableLanguages
+ | Get a list of languages that are acceptable for the response. If no acceptable languages are specified, a read-only list containing a single wildcard java.util.Locale instance (with language field set to "*") is returned. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:76 | List | jakarta.ws.rs.core.HttpHeaders.getAcceptableMediaTypes
+ | Get a list of media types that are acceptable for the response. If no acceptable media types are specified, a read-only list containing a single jakarta.ws.rs.core.MediaType#WILDCARD_TYPE wildcard media type instance is returned. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:77 | Map | jakarta.ws.rs.core.HttpHeaders.getCookies
+ | Get any cookies that accompanied the request. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:78 | Locale | jakarta.ws.rs.core.HttpHeaders.getLanguage
+ | Get the language of the request entity. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:79 | MediaType | jakarta.ws.rs.core.HttpHeaders.getMediaType
+ | Get the media type of the request entity. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:81 | MultivaluedMap | jakarta.ws.rs.core.HttpHeaders.getRequestHeaders
+ | Get the values of HTTP request headers. The returned Map is case-insensitive wrt. keys and is read-only. The method never returns null. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:82 | boolean | jakarta.ws.rs.core.MediaType.equals
+
+ (
+ Object
+ )
+ | 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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:83 | Map | jakarta.ws.rs.core.MediaType.getParameters
+ | Getter for a read-only parameter map. Keys are case-insensitive. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:84 | String | jakarta.ws.rs.core.MediaType.getSubtype
+ | Getter for subtype. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:85 | String | jakarta.ws.rs.core.MediaType.getType
+ | Getter for primary type. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:86 | int | jakarta.ws.rs.core.MediaType.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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:88 | boolean | jakarta.ws.rs.core.MediaType.isWildcardSubtype
+ | Checks if the subtype is a wildcard. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:89 | boolean | jakarta.ws.rs.core.MediaType.isWildcardType
+ | Checks if the primary type is a wildcard. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:90 | MediaType | jakarta.ws.rs.core.MediaType.MediaType
+
+ (
+ String
+ , String
+ , Map
+ )
+ | Creates a new instance of MediaType with the supplied type, subtype and parameters. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:91 | MediaType | jakarta.ws.rs.core.MediaType.MediaType
+
+ (
+ String
+ , String
+ )
+ | Creates a new instance of MediaType with the supplied type and subtype. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:92 | MediaType | jakarta.ws.rs.core.MediaType.MediaType
+ | Creates a new instance of MediaType, both type and subtype are wildcards. Consider using the constant #WILDCARD_TYPE instead. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:93 | String | jakarta.ws.rs.core.MediaType.toString
+ | Convert the media type to a string suitable for use as the value of a corresponding HTTP header. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:94 | MediaType | jakarta.ws.rs.core.MediaType.valueOf
+
+ (
+ String
+ )
+ | Creates a new instance of MediaType by parsing the supplied string. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:96 | void | jakarta.ws.rs.core.MultivaluedMap.add
+
+ (
+ Object
+ , Object
+ )
+ | Add a value to the current list of values for the supplied key. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:97 | Object | jakarta.ws.rs.core.MultivaluedMap.getFirst
+
+ (
+ Object
+ )
+ | A shortcut to get the first value of the supplied key. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:98 | void | jakarta.ws.rs.core.MultivaluedMap.putSingle
+
+ (
+ Object
+ , Object
+ )
+ | Set the key's value to be a one item list consisting of the supplied value. Any existing values will be replaced. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:99 | boolean | jakarta.ws.rs.core.NewCookie.equals
+
+ (
+ Object
+ )
+ | Compare for equality. Use #toCookie() to compare a NewCookie to a Cookie considering only the common properties. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:100 | String | jakarta.ws.rs.core.NewCookie.getComment
+ | Get the comment associated with the cookie. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:101 | int | jakarta.ws.rs.core.NewCookie.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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:102 | int | jakarta.ws.rs.core.NewCookie.hashCode
+ | Generate a hash code by hashing all of the properties. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:103 | boolean | jakarta.ws.rs.core.NewCookie.isSecure
+ | Whether the cookie will only be sent over a secure connection. Defaults to false. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:109 | Cookie | jakarta.ws.rs.core.NewCookie.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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:113 | MultivaluedMap | jakarta.ws.rs.core.PathSegment.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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:114 | String | jakarta.ws.rs.core.PathSegment.getPath
+ | Get the path segment. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:115 | ResponseBuilder | jakarta.ws.rs.core.Request.evaluatePreconditions
+
+ (
+ EntityTag
+ )
+ | Evaluate request preconditions based on the passed in value. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:116 | ResponseBuilder | jakarta.ws.rs.core.Request.evaluatePreconditions
+
+ (
+ Date
+ )
+ | Evaluate request preconditions based on the passed in value. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:117 | ResponseBuilder | jakarta.ws.rs.core.Request.evaluatePreconditions
+
+ (
+ Date
+ , EntityTag
+ )
+ | Evaluate request preconditions based on the passed in value. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:118 | String | jakarta.ws.rs.core.Request.getMethod
+ | Get the request method, e.g. GET, POST, etc. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:119 | Variant | jakarta.ws.rs.core.Request.selectVariant
+
+ (
+ List
+ )
+ | 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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:121 | ResponseBuilder | jakarta.ws.rs.core.Response.created
+
+ (
+ URI
+ )
+ | Create a new ResponseBuilder for a created resource, set the location header using the supplied value. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:122 | ResponseBuilder | jakarta.ws.rs.core.Response.fromResponse
+
+ (
+ Response
+ )
+ | Create a new ResponseBuilder by performing a shallow copy of an existing Response. The returned builder has its own #getHeaders() 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 #bufferEntity() buffer the entity stream of the original response instance before passing it to this method. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:123 | Object | jakarta.ws.rs.core.Response.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 InputStream input stream the method will return the input stream. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:124 | MultivaluedMap | jakarta.ws.rs.core.Response.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 #64;Deprecated in a future release of JAX-RS API. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:125 | int | jakarta.ws.rs.core.Response.getStatus
+ | Get the status code associated with the response. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:126 | ResponseBuilder | jakarta.ws.rs.core.Response.noContent
+ | Create a new ResponseBuilder for an empty response. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:127 | ResponseBuilder | jakarta.ws.rs.core.Response.notAcceptable
+
+ (
+ List
+ )
+ | Create a new ResponseBuilder for a not acceptable response. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:128 | ResponseBuilder | jakarta.ws.rs.core.Response.notModified
+ | Create a new ResponseBuilder with a not-modified status. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:129 | ResponseBuilder | jakarta.ws.rs.core.Response.notModified
+
+ (
+ EntityTag
+ )
+ | Create a new ResponseBuilder with a not-modified status. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:130 | ResponseBuilder | jakarta.ws.rs.core.Response.notModified
+
+ (
+ String
+ )
+ | Create a new ResponseBuilder with a not-modified status and a strong entity tag. This is a shortcut for notModified(new EntityTag(value)). | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:131 | ResponseBuilder | jakarta.ws.rs.core.Response.ok
+ | Create a new ResponseBuilder with an OK status. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:132 | ResponseBuilder | jakarta.ws.rs.core.Response.ok
+
+ (
+ Object
+ )
+ | 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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:133 | ResponseBuilder | jakarta.ws.rs.core.Response.ok
+
+ (
+ Object
+ , MediaType
+ )
+ | 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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:134 | ResponseBuilder | jakarta.ws.rs.core.Response.ok
+
+ (
+ Object
+ , String
+ )
+ | 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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:135 | ResponseBuilder | jakarta.ws.rs.core.Response.ok
+
+ (
+ Object
+ , 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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:136 | ResponseBuilder | jakarta.ws.rs.core.Response.seeOther
+
+ (
+ URI
+ )
+ | Create a new ResponseBuilder for a redirection. Used in the redirect-after-POST (aka POST/redirect/GET) pattern. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:137 | ResponseBuilder | jakarta.ws.rs.core.Response.serverError
+ | Create a new ResponseBuilder with an server error status. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:138 | ResponseBuilder | jakarta.ws.rs.core.Response.status
+
+ (
+ Status
+ )
+ | Create a new ResponseBuilder with the supplied status. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:139 | ResponseBuilder | jakarta.ws.rs.core.Response.status
+
+ (
+ int
+ )
+ | Create a new ResponseBuilder with the supplied status. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:140 | ResponseBuilder | jakarta.ws.rs.core.Response.temporaryRedirect
+
+ (
+ URI
+ )
+ | Create a new ResponseBuilder for a temporary redirection. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:141 | Response | jakarta.ws.rs.core.Response.ResponseBuilder.build
+ | Create a Response instance from the current ResponseBuilder. The builder is reset to a blank state equivalent to calling the ok method. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:142 | ResponseBuilder | jakarta.ws.rs.core.Response.ResponseBuilder.cacheControl
+
+ (
+ CacheControl
+ )
+ | Set the cache control data of the message. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:143 | ResponseBuilder | jakarta.ws.rs.core.Response.ResponseBuilder.clone
+ | Create a copy of the ResponseBuilder preserving its state. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:144 | ResponseBuilder | jakarta.ws.rs.core.Response.ResponseBuilder.contentLocation
+
+ (
+ URI
+ )
+ | Set the content location. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:145 | ResponseBuilder | jakarta.ws.rs.core.Response.ResponseBuilder.cookie
+
+ (
+ NewCookie[]
+ )
+ | Add cookies to the response message. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:146 | ResponseBuilder | jakarta.ws.rs.core.Response.ResponseBuilder.entity
+
+ (
+ Object
+ )
+ | 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 java.io.InputStream input stream. A specific entity media type can be set using one of the type(...) methods. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:147 | ResponseBuilder | jakarta.ws.rs.core.Response.ResponseBuilder.expires
+
+ (
+ Date
+ )
+ | Set the response expiration date. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:148 | ResponseBuilder | jakarta.ws.rs.core.Response.ResponseBuilder.header
+
+ (
+ String
+ , Object
+ )
+ | Add an arbitrary header. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:149 | ResponseBuilder | jakarta.ws.rs.core.Response.ResponseBuilder.language
+
+ (
+ String
+ )
+ | Set the message entity language. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:150 | ResponseBuilder | jakarta.ws.rs.core.Response.ResponseBuilder.language
+
+ (
+ Locale
+ )
+ | Set the message entity language. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:151 | ResponseBuilder | jakarta.ws.rs.core.Response.ResponseBuilder.lastModified
+
+ (
+ Date
+ )
+ | Set the response entity last modification date. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:152 | ResponseBuilder | jakarta.ws.rs.core.Response.ResponseBuilder.location
+
+ (
+ URI
+ )
+ | Set the location. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:153 | ResponseBuilder | jakarta.ws.rs.core.Response.ResponseBuilder.status
+
+ (
+ int
+ )
+ | Set the status on the ResponseBuilder. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:154 | ResponseBuilder | jakarta.ws.rs.core.Response.ResponseBuilder.status
+
+ (
+ Status
+ )
+ | Set the status on the ResponseBuilder. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:155 | ResponseBuilder | jakarta.ws.rs.core.Response.ResponseBuilder.tag
+
+ (
+ EntityTag
+ )
+ | Set a response entity tag. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:156 | ResponseBuilder | jakarta.ws.rs.core.Response.ResponseBuilder.tag
+
+ (
+ String
+ )
+ | Set a strong response entity tag. This is a shortcut for tag(new EntityTag(value)). | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:157 | ResponseBuilder | jakarta.ws.rs.core.Response.ResponseBuilder.type
+
+ (
+ MediaType
+ )
+ | Set the message entity media type. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:158 | ResponseBuilder | jakarta.ws.rs.core.Response.ResponseBuilder.type
+
+ (
+ String
+ )
+ | Set the message entity media type. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:159 | ResponseBuilder | jakarta.ws.rs.core.Response.ResponseBuilder.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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:160 | ResponseBuilder | jakarta.ws.rs.core.Response.ResponseBuilder.variants
+
+ (
+ List
+ )
+ | Add a Vary header that lists the available variants. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:161 | Status | jakarta.ws.rs.core.Response.Status.fromStatusCode
+
+ (
+ int
+ )
+ | Convert a numerical status code into the corresponding Status. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:162 | Family | jakarta.ws.rs.core.Response.Status.getFamily
+ | Get the class of status code. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:163 | int | jakarta.ws.rs.core.Response.Status.getStatusCode
+ | Get the associated status code. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:164 | String | jakarta.ws.rs.core.Response.Status.toString
+ | Get the reason phrase. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:165 | Status | jakarta.ws.rs.core.Response.Status.valueOf
+
+ (
+ String
+ )
+ |
+
+ | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:166 | Status[] | jakarta.ws.rs.core.Response.Status.values
+ |
+
+ | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:167 | Family | jakarta.ws.rs.core.Response.Status.Family.valueOf
+
+ (
+ String
+ )
+ |
+
+ | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:168 | Family[] | jakarta.ws.rs.core.Response.Status.Family.values
+ |
+
+ | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:169 | String | jakarta.ws.rs.core.SecurityContext.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 | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:170 | Principal | jakarta.ws.rs.core.SecurityContext.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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:171 | boolean | jakarta.ws.rs.core.SecurityContext.isSecure
+ | Returns a boolean indicating whether this request was made using a secure channel, such as HTTPS. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:172 | boolean | jakarta.ws.rs.core.SecurityContext.isUserInRole
+
+ (
+ String
+ )
+ | 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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:173 | void | jakarta.ws.rs.core.StreamingOutput.write
+
+ (
+ OutputStream
+ )
+ | Called to write the message body. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:174 | void | jakarta.ws.rs.core.StreamingOutput.write
+
+ (
+ OutputStream
+ )
+ throws
+ IOException
+ | if an IO error is encountered | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:175 | void | jakarta.ws.rs.core.StreamingOutput.write
+
+ (
+ OutputStream
+ )
+ throws
+ WebApplicationException
+ | if a specific HTTP error response needs to be produced. Only effective if thrown prior to any bytes being written to output. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:176 | URI | jakarta.ws.rs.core.UriBuilder.build
+
+ (
+ Object[]
+ )
+ | 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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:177 | URI | jakarta.ws.rs.core.UriBuilder.build
+
+ (
+ Object[]
+ )
+ throws
+ IllegalArgumentException
+ | if there are any URI template parameters without a supplied value, or if a value is null. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:178 | URI | jakarta.ws.rs.core.UriBuilder.build
+
+ (
+ Object[]
+ )
+ throws
+ UriBuilderException
+ | if a URI cannot be constructed based on the current state of the builder. | true |
+
+ | false |
+
+
+JAXRS:JAVADOC:179 | URI | jakarta.ws.rs.core.UriBuilder.buildFromEncoded
+
+ (
+ Object[]
+ )
+ | 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". | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:180 | URI | jakarta.ws.rs.core.UriBuilder.buildFromEncoded
+
+ (
+ Object[]
+ )
+ throws
+ IllegalArgumentException
+ | if there are any URI template parameters without a supplied value, or if a value is null. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:181 | URI | jakarta.ws.rs.core.UriBuilder.buildFromEncoded
+
+ (
+ Object[]
+ )
+ throws
+ UriBuilderException
+ | if a URI cannot be constructed based on the current state of the builder. | true |
+
+ | false |
+
+
+JAXRS:JAVADOC:182 | URI | jakarta.ws.rs.core.UriBuilder.buildFromEncodedMap
+
+ (
+ Map
+ )
+ | 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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:183 | URI | jakarta.ws.rs.core.UriBuilder.buildFromEncodedMap
+
+ (
+ Map
+ )
+ throws
+ IllegalArgumentException
+ | if there are any URI template parameters without a supplied value, or if a template parameter value is null. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:184 | URI | jakarta.ws.rs.core.UriBuilder.buildFromEncodedMap
+
+ (
+ Map
+ )
+ throws
+ UriBuilderException
+ | if a URI cannot be constructed based on the current state of the builder. | true |
+
+ | false |
+
+
+JAXRS:JAVADOC:185 | URI | jakarta.ws.rs.core.UriBuilder.buildFromMap
+
+ (
+ Map
+ )
+ | 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(java.util.Map, boolean) buildFromMap(valueMap, true). To override this behavior use buildFromMap(valueMap, false) instead. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:188 | UriBuilder | jakarta.ws.rs.core.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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:189 | UriBuilder | jakarta.ws.rs.core.UriBuilder.fragment
+
+ (
+ String
+ )
+ | Set the URI fragment. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:190 | UriBuilder | jakarta.ws.rs.core.UriBuilder.fromPath
+
+ (
+ String
+ )
+ | Create a new instance representing a relative URI initialized from a URI path. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:191 | UriBuilder | jakarta.ws.rs.core.UriBuilder.fromPath
+
+ (
+ String
+ )
+ throws
+ IllegalArgumentException
+ | if path is null. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:192 | UriBuilder | jakarta.ws.rs.core.UriBuilder.fromResource
+
+ (
+ Class
+ )
+ | Create a new instance representing a relative URI initialized from a root resource class. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:194 | UriBuilder | jakarta.ws.rs.core.UriBuilder.fromUri
+
+ (
+ URI
+ )
+ | Create a new instance initialized from an existing URI. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:196 | UriBuilder | jakarta.ws.rs.core.UriBuilder.fromUri
+
+ (
+ String
+ )
+ | Create a new instance initialized from an existing URI. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:198 | UriBuilder | jakarta.ws.rs.core.UriBuilder.host
+
+ (
+ String
+ )
+ | Set the URI host. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:200 | UriBuilder | jakarta.ws.rs.core.UriBuilder.matrixParam
+
+ (
+ String
+ , Object[]
+ )
+ | 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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:202 | UriBuilder | jakarta.ws.rs.core.UriBuilder.path
+
+ (
+ String
+ )
+ | 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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:204 | UriBuilder | jakarta.ws.rs.core.UriBuilder.path
+
+ (
+ Class
+ )
+ | 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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:206 | UriBuilder | jakarta.ws.rs.core.UriBuilder.path
+
+ (
+ Class
+ , String
+ )
+ | 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 jakarta.ws.rs.Path. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:208 | UriBuilder | jakarta.ws.rs.core.UriBuilder.path
+
+ (
+ Method
+ )
+ | Append the path from a jakarta.ws.rs.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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:210 | UriBuilder | jakarta.ws.rs.core.UriBuilder.port
+
+ (
+ int
+ )
+ | Set the URI port. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:212 | UriBuilder | jakarta.ws.rs.core.UriBuilder.queryParam
+
+ (
+ String
+ , Object[]
+ )
+ | Append a query parameter to the existing set of query parameters. If multiple values are supplied the parameter will be added once per value. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:214 | UriBuilder | jakarta.ws.rs.core.UriBuilder.replaceMatrix
+
+ (
+ String
+ )
+ | 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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:216 | UriBuilder | jakarta.ws.rs.core.UriBuilder.replaceMatrixParam
+
+ (
+ String
+ , Object[]
+ )
+ | 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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:218 | UriBuilder | jakarta.ws.rs.core.UriBuilder.replacePath
+
+ (
+ String
+ )
+ | 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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:219 | UriBuilder | jakarta.ws.rs.core.UriBuilder.replaceQuery
+
+ (
+ String
+ )
+ | Set the URI query string. This method will overwrite any existing query parameters. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:221 | UriBuilder | jakarta.ws.rs.core.UriBuilder.replaceQueryParam
+
+ (
+ String
+ , Object[]
+ )
+ | Replace the existing value(s) of a query parameter. If multiple values are supplied the parameter will be added once per value. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:223 | UriBuilder | jakarta.ws.rs.core.UriBuilder.scheme
+
+ (
+ String
+ )
+ | Set the URI scheme. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:225 | UriBuilder | jakarta.ws.rs.core.UriBuilder.schemeSpecificPart
+
+ (
+ String
+ )
+ | Set the URI scheme-specific-part (see java.net.URI). This method will overwrite any existing values for authority, user-info, host, port and path. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:227 | UriBuilder | jakarta.ws.rs.core.UriBuilder.segment
+
+ (
+ String[]
+ )
+ | 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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:229 | UriBuilder | jakarta.ws.rs.core.UriBuilder.uri
+
+ (
+ URI
+ )
+ | Copies the non-null components of the supplied URI to the UriBuilder replacing any existing values for those components. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:231 | UriBuilder | jakarta.ws.rs.core.UriBuilder.userInfo
+
+ (
+ String
+ )
+ | Set the URI user-info. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:232 | UriBuilderException | jakarta.ws.rs.core.UriBuilderException.UriBuilderException
+ | Creates a new instance of UriBuilderException without detail message. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:233 | UriBuilderException | jakarta.ws.rs.core.UriBuilderException.UriBuilderException
+
+ (
+ String
+ )
+ | Constructs an instance of UriBuilderException with the specified detail message. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:234 | UriBuilderException | jakarta.ws.rs.core.UriBuilderException.UriBuilderException
+
+ (
+ String
+ , Throwable
+ )
+ | 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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:235 | UriBuilderException | jakarta.ws.rs.core.UriBuilderException.UriBuilderException
+
+ (
+ Throwable
+ )
+ | 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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:236 | URI | jakarta.ws.rs.core.UriInfo.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)). | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:237 | UriBuilder | jakarta.ws.rs.core.UriInfo.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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:238 | URI | jakarta.ws.rs.core.UriInfo.getBaseUri
+ | Get the base URI of the application. URIs of root resource classes are all relative to this base URI. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:239 | UriBuilder | jakarta.ws.rs.core.UriInfo.getBaseUriBuilder
+ | Get the base URI of the application in the form of a UriBuilder. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:242 | List | jakarta.ws.rs.core.UriInfo.getMatchedURIs
+
+ (
+ boolean
+ )
+ | 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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:243 | String | jakarta.ws.rs.core.UriInfo.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(boolean) getPath(true). | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:244 | String | jakarta.ws.rs.core.UriInfo.getPath
+
+ (
+ boolean
+ )
+ | Get the path of the current request relative to the base URI as a string. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:245 | MultivaluedMap | jakarta.ws.rs.core.UriInfo.getPathParameters
+ | Get the values of any embedded URI template parameters. All sequences of escaped octets are decoded, equivalent to #getPathParameters(boolean) getPathParameters(true). | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:246 | MultivaluedMap | jakarta.ws.rs.core.UriInfo.getPathParameters
+
+ (
+ boolean
+ )
+ | Get the values of any embedded URI template parameters. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:247 | List | jakarta.ws.rs.core.UriInfo.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). | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:248 | List | jakarta.ws.rs.core.UriInfo.getPathSegments
+
+ (
+ boolean
+ )
+ | 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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:249 | MultivaluedMap | jakarta.ws.rs.core.UriInfo.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(boolean) getQueryParameters(true). | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:250 | MultivaluedMap | jakarta.ws.rs.core.UriInfo.getQueryParameters
+
+ (
+ boolean
+ )
+ | Get the URI query parameters of the current request. The map keys are the names of the query parameters with any escaped characters decoded. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:251 | URI | jakarta.ws.rs.core.UriInfo.getRequestUri
+ | Get the absolute request URI including any query parameters. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:252 | UriBuilder | jakarta.ws.rs.core.UriInfo.getRequestUriBuilder
+ | Get the absolute request URI in the form of a UriBuilder. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:253 | VariantListBuilder | jakarta.ws.rs.core.Variant.encodings
+
+ (
+ String[]
+ )
+ | Create a VariantListBuilder initialized with a set of supported encodings. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:254 | boolean | jakarta.ws.rs.core.Variant.equals
+
+ (
+ Object
+ )
+ | Compares obj to this variant to see if they are the same considering all property values. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:255 | String | jakarta.ws.rs.core.Variant.getEncoding
+ | Get the encoding of the variant. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:256 | Locale | jakarta.ws.rs.core.Variant.getLanguage
+ | Get the language of the variant. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:257 | MediaType | jakarta.ws.rs.core.Variant.getMediaType
+ | Get the media type of the variant. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:258 | int | jakarta.ws.rs.core.Variant.hashCode
+ | Generate hash code from variant properties. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:259 | VariantListBuilder | jakarta.ws.rs.core.Variant.languages
+
+ (
+ Locale[]
+ )
+ | Create a VariantListBuilder initialized with a set of supported languages. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:260 | VariantListBuilder | jakarta.ws.rs.core.Variant.mediaTypes
+
+ (
+ MediaType[]
+ )
+ | Create a VariantListBuilder initialized with a set of supported media types. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:261 | String | jakarta.ws.rs.core.Variant.toString
+ |
+
+ | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:262 | Variant | jakarta.ws.rs.core.Variant.Variant
+
+ (
+ MediaType
+ , Locale
+ , String
+ )
+ | Create a new instance of Variant. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:263 | VariantListBuilder | jakarta.ws.rs.core.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 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 list = VariantListBuilder.newInstance() .languages(Locale.ENGLISH, Locale.FRENCH).encodings("zip", "identity").add() .languages(Locale.GERMAN).mediaTypes(MediaType.TEXT_PLAIN_TYPE) .build() | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:264 | List | jakarta.ws.rs.core.Variant.VariantListBuilder.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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:265 | VariantListBuilder | jakarta.ws.rs.core.Variant.VariantListBuilder.encodings
+
+ (
+ String[]
+ )
+ | Set the encoding(s) for this variant. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:266 | VariantListBuilder | jakarta.ws.rs.core.Variant.VariantListBuilder.languages
+
+ (
+ Locale[]
+ )
+ | Set the language(s) for this variant. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:267 | VariantListBuilder | jakarta.ws.rs.core.Variant.VariantListBuilder.mediaTypes
+
+ (
+ MediaType[]
+ )
+ | Set the media type(s) for this variant. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:268 | VariantListBuilder | jakarta.ws.rs.core.Variant.VariantListBuilder.newInstance
+ | Create a new builder instance. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:269 | Object | jakarta.ws.rs.ext.ContextResolver.getContext
+
+ (
+ Class
+ )
+ | Get a context of type T that is applicable to the supplied type. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:270 | Response | jakarta.ws.rs.ext.ExceptionMapper.toResponse
+
+ (
+ Throwable
+ )
+ | Map an exception to a jakarta.ws.rs.core.Response. Returning null results in a jakarta.ws.rs.core.Response.Status#NO_CONTENT response. Throwing a runtime exception results in a jakarta.ws.rs.core.Response.Status#INTERNAL_SERVER_ERROR response. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:271 | boolean | jakarta.ws.rs.ext.MessageBodyReader.isReadable
+
+ (
+ Class
+ , Type
+ , Annotation[]
+ , 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 java.lang.reflect.Type of the instance that should be produced. E.g. if the instance to be produced is List, the type parameter will be java.util.List and the genericType parameter will be java.lang.reflect.ParameterizedType java.lang.reflect.ParameterizedType. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:272 | Object | jakarta.ws.rs.ext.MessageBodyReader.readFrom
+
+ (
+ Class
+ , Type
+ , Annotation[]
+ , MediaType
+ , MultivaluedMap
+ , InputStream
+ )
+ | 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 jakarta.ws.rs.core.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 jakarta.ws.rs.BadRequestException wrapping the original NoContentException and rethrown for a standard processing by the registered jakarta.ws.rs.ext.ExceptionMapper exception mappers. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:273 | Object | jakarta.ws.rs.ext.MessageBodyReader.readFrom
+
+ (
+ Class
+ , Type
+ , Annotation[]
+ , MediaType
+ , MultivaluedMap
+ , InputStream
+ )
+ 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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:274 | Object | jakarta.ws.rs.ext.MessageBodyReader.readFrom
+
+ (
+ Class
+ , Type
+ , Annotation[]
+ , MediaType
+ , MultivaluedMap
+ , InputStream
+ )
+ throws
+ WebApplicationException
+ | if a specific HTTP error response needs to be produced. Only effective if thrown prior to the response being committed. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:275 | long | jakarta.ws.rs.ext.MessageBodyWriter.getSize
+
+ (
+ Object
+ , Class
+ , Type
+ , Annotation[]
+ , 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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:276 | boolean | jakarta.ws.rs.ext.MessageBodyWriter.isWriteable
+
+ (
+ Class
+ , Type
+ , Annotation[]
+ , MediaType
+ )
+ | Ascertain if the MessageBodyWriter supports a particular type. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:277 | void | jakarta.ws.rs.ext.MessageBodyWriter.writeTo
+
+ (
+ Object
+ , Class
+ , Type
+ , Annotation[]
+ , MediaType
+ , MultivaluedMap
+ , OutputStream
+ )
+ | 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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:278 | void | jakarta.ws.rs.ext.MessageBodyWriter.writeTo
+
+ (
+ Object
+ , Class
+ , Type
+ , Annotation[]
+ , MediaType
+ , MultivaluedMap
+ , OutputStream
+ )
+ throws
+ IOException
+ | if an IO error arises. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:279 | void | jakarta.ws.rs.ext.MessageBodyWriter.writeTo
+
+ (
+ Object
+ , Class
+ , Type
+ , Annotation[]
+ , MediaType
+ , MultivaluedMap
+ , OutputStream
+ )
+ throws
+ WebApplicationException
+ | if a specific HTTP error response needs to be produced. Only effective if thrown prior to the message being committed. | true |
+
+ | false |
+
+
+JAXRS:JAVADOC:281 | ExceptionMapper | jakarta.ws.rs.ext.Providers.getExceptionMapper
+
+ (
+ Class
+ )
+ | Get an exception mapping provider for a particular class of exception. Returns the provider whose generic type is the nearest superclass of type. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:284 | Object | jakarta.ws.rs.ext.RuntimeDelegate.createEndpoint
+
+ (
+ Application
+ , Class
+ )
+ | Create a configured instance of the supplied endpoint type. How the returned endpoint instance is published is dependent on the type of endpoint. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:285 | Object | jakarta.ws.rs.ext.RuntimeDelegate.createEndpoint
+
+ (
+ Application
+ , Class
+ )
+ throws
+ IllegalArgumentException
+ | if application is null or the requested endpoint type is not supported. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:286 | Object | jakarta.ws.rs.ext.RuntimeDelegate.createEndpoint
+
+ (
+ Application
+ , Class
+ )
+ throws
+ UnsupportedOperationException
+ | if the implementation supports no endpoint types. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:287 | HeaderDelegate | jakarta.ws.rs.ext.RuntimeDelegate.createHeaderDelegate
+
+ (
+ Class
+ )
+ | Obtain an instance of a HeaderDelegate for the supplied class. An implementation is required to support the following values for type: jakarta.ws.rs.core.CacheControl, jakarta.ws.rs.core.Cookie, jakarta.ws.rs.core.EntityTag, jakarta.ws.rs.core.Link, jakarta.ws.rs.core.NewCookie, jakarta.ws.rs.core.MediaType and java.util.Date. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:288 | ResponseBuilder | jakarta.ws.rs.ext.RuntimeDelegate.createResponseBuilder
+ | Create a new instance of a jakarta.ws.rs.core.Response.ResponseBuilder. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:289 | UriBuilder | jakarta.ws.rs.ext.RuntimeDelegate.createUriBuilder
+ | Create a new instance of a jakarta.ws.rs.core.UriBuilder. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:290 | VariantListBuilder | jakarta.ws.rs.ext.RuntimeDelegate.createVariantListBuilder
+ | Create a new instance of a jakarta.ws.rs.core.Variant.VariantListBuilder. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:291 | RuntimeDelegate | jakarta.ws.rs.ext.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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:292 | void | jakarta.ws.rs.ext.RuntimeDelegate.setInstance
+
+ (
+ RuntimeDelegate
+ )
+ | 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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:294 | Object | jakarta.ws.rs.ext.RuntimeDelegate.HeaderDelegate.fromString
+
+ (
+ String
+ )
+ | Parse the supplied value and create an instance of T. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:296 | String | jakarta.ws.rs.ext.RuntimeDelegate.HeaderDelegate.toString
+
+ (
+ Object
+ )
+ | Convert the supplied value to a String. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:297 | String | jakarta.ws.rs.ApplicationPath.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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:299 | ResponseBuilder | jakarta.ws.rs.core.Response.status
+
+ (
+ StatusType
+ )
+ | Create a new ResponseBuilder with the supplied status. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:300 | ResponseBuilder | jakarta.ws.rs.core.Response.ResponseBuilder.status
+
+ (
+ StatusType
+ )
+ | Set the status on the ResponseBuilder. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:301 | String | jakarta.ws.rs.core.Response.Status.getReasonPhrase
+ | Get the reason phrase. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:302 | Family | jakarta.ws.rs.core.Response.StatusType.getFamily
+ | Get the class of status code. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:303 | String | jakarta.ws.rs.core.Response.StatusType.getReasonPhrase
+ | Get the reason phrase. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:304 | int | jakarta.ws.rs.core.Response.StatusType.getStatusCode
+ | Get the associated status code. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:305 | BadRequestException | jakarta.ws.rs.BadRequestException.BadRequestException
+ | Construct a new bad client request exception. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:306 | BadRequestException | jakarta.ws.rs.BadRequestException.BadRequestException
+
+ (
+ Response
+ )
+ | Construct a new bad client request exception. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:307 | BadRequestException | jakarta.ws.rs.BadRequestException.BadRequestException
+
+ (
+ Throwable
+ )
+ | Construct a new bad client request exception. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:308 | BadRequestException | jakarta.ws.rs.BadRequestException.BadRequestException
+
+ (
+ Response
+ , Throwable
+ )
+ | Construct a new bad client request exception. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:310 | ClientErrorException | jakarta.ws.rs.ClientErrorException.ClientErrorException
+
+ (
+ Status
+ )
+ | Construct a new client error exception. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:311 | ClientErrorException | jakarta.ws.rs.ClientErrorException.ClientErrorException
+
+ (
+ int
+ )
+ | Construct a new client error exception. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:312 | ClientErrorException | jakarta.ws.rs.ClientErrorException.ClientErrorException
+
+ (
+ Response
+ )
+ | Construct a new client error exception. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:313 | ClientErrorException | jakarta.ws.rs.ClientErrorException.ClientErrorException
+
+ (
+ Status
+ , Throwable
+ )
+ | Construct a new client error exception. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:314 | ClientErrorException | jakarta.ws.rs.ClientErrorException.ClientErrorException
+
+ (
+ int
+ , Throwable
+ )
+ | Construct a new client error exception. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:315 | ClientErrorException | jakarta.ws.rs.ClientErrorException.ClientErrorException
+
+ (
+ Response
+ , Throwable
+ )
+ | Construct a new client error exception. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:319 | InternalServerErrorException | jakarta.ws.rs.InternalServerErrorException.InternalServerErrorException
+ | Construct a new internal server error exception. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:320 | InternalServerErrorException | jakarta.ws.rs.InternalServerErrorException.InternalServerErrorException
+
+ (
+ Response
+ )
+ | Construct a new internal server error exception. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:321 | InternalServerErrorException | jakarta.ws.rs.InternalServerErrorException.InternalServerErrorException
+
+ (
+ Throwable
+ )
+ | Construct a new internal server error exception. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:322 | InternalServerErrorException | jakarta.ws.rs.InternalServerErrorException.InternalServerErrorException
+
+ (
+ Response
+ , Throwable
+ )
+ | Construct a new internal server error exception. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:326 | NotAcceptableException | jakarta.ws.rs.NotAcceptableException.NotAcceptableException
+ | Construct a new "request not acceptable" exception. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:327 | NotAcceptableException | jakarta.ws.rs.NotAcceptableException.NotAcceptableException
+
+ (
+ Response
+ )
+ | Construct a new "request not acceptable" exception. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:328 | NotAcceptableException | jakarta.ws.rs.NotAcceptableException.NotAcceptableException
+
+ (
+ Throwable
+ )
+ | Construct a new "request not acceptable" exception. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:329 | NotAcceptableException | jakarta.ws.rs.NotAcceptableException.NotAcceptableException
+
+ (
+ Response
+ , Throwable
+ )
+ | Construct a new "request not acceptable" exception. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:331 | NotAllowedException | jakarta.ws.rs.NotAllowedException.NotAllowedException
+
+ (
+ 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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:332 | NotAllowedException | jakarta.ws.rs.NotAllowedException.NotAllowedException
+
+ (
+ Throwable
+ , String[]
+ )
+ | Construct a new method not allowed exception. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:333 | NotAllowedException | jakarta.ws.rs.NotAllowedException.NotAllowedException
+
+ (
+ Response
+ , Throwable
+ )
+ | Construct a new method not allowed exception. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:334 | List | jakarta.ws.rs.NotAuthorizedException.getChallenges
+ | Get the list of authorization challenges associated with the exception and applicable to the resource requested by the client. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:335 | NotAuthorizedException | jakarta.ws.rs.NotAuthorizedException.NotAuthorizedException
+
+ (
+ Object
+ , Object[]
+ )
+ | Construct a new "not authorized" exception. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:336 | NotAuthorizedException | jakarta.ws.rs.NotAuthorizedException.NotAuthorizedException
+
+ (
+ Response
+ )
+ | Construct a new "not authorized" exception. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:337 | NotAuthorizedException | jakarta.ws.rs.NotAuthorizedException.NotAuthorizedException
+
+ (
+ Throwable
+ , Object
+ , Object[]
+ )
+ | Construct a new "not authorized" exception. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:338 | NotAuthorizedException | jakarta.ws.rs.NotAuthorizedException.NotAuthorizedException
+
+ (
+ Response
+ , Throwable
+ )
+ | Construct a new "not authorized" exception. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:339 | NotFoundException | jakarta.ws.rs.NotFoundException.NotFoundException
+ | Construct a new "not found" exception. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:340 | NotFoundException | jakarta.ws.rs.NotFoundException.NotFoundException
+
+ (
+ Response
+ )
+ | Construct a new "not found" exception. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:341 | NotFoundException | jakarta.ws.rs.NotFoundException.NotFoundException
+
+ (
+ Throwable
+ )
+ | Construct a new "not found" exception. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:342 | NotFoundException | jakarta.ws.rs.NotFoundException.NotFoundException
+
+ (
+ Response
+ , Throwable
+ )
+ | Construct a new "not found" exception. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:343 | NotSupportedException | jakarta.ws.rs.NotSupportedException.NotSupportedException
+ | Construct a new unsupported media type exception. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:344 | NotSupportedException | jakarta.ws.rs.NotSupportedException.NotSupportedException
+
+ (
+ Response
+ )
+ | Construct a new unsupported media type exception. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:345 | NotSupportedException | jakarta.ws.rs.NotSupportedException.NotSupportedException
+
+ (
+ Throwable
+ )
+ | Construct a new unsupported media type exception. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:346 | NotSupportedException | jakarta.ws.rs.NotSupportedException.NotSupportedException
+
+ (
+ Response
+ , Throwable
+ )
+ | Construct a new unsupported media type exception. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:347 | URI | jakarta.ws.rs.RedirectionException.getLocation
+ | Get the redirection response location. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:348 | RedirectionException | jakarta.ws.rs.RedirectionException.RedirectionException
+
+ (
+ Status
+ , URI
+ )
+ | Construct a new redirection exception. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:349 | RedirectionException | jakarta.ws.rs.RedirectionException.RedirectionException
+
+ (
+ int
+ , URI
+ )
+ | Construct a new redirection exception. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:350 | RedirectionException | jakarta.ws.rs.RedirectionException.RedirectionException
+
+ (
+ Response
+ )
+ | Construct a new redirection exception. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:351 | ServerErrorException | jakarta.ws.rs.ServerErrorException.ServerErrorException
+
+ (
+ Status
+ )
+ | Construct a new server error exception. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:352 | ServerErrorException | jakarta.ws.rs.ServerErrorException.ServerErrorException
+
+ (
+ int
+ )
+ | Construct a new server error exception. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:353 | ServerErrorException | jakarta.ws.rs.ServerErrorException.ServerErrorException
+
+ (
+ Response
+ )
+ | Construct a new server error exception. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:354 | ServerErrorException | jakarta.ws.rs.ServerErrorException.ServerErrorException
+
+ (
+ Status
+ , Throwable
+ )
+ | Construct a new server error exception. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:355 | ServerErrorException | jakarta.ws.rs.ServerErrorException.ServerErrorException
+
+ (
+ int
+ , Throwable
+ )
+ | Construct a new server error exception. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:356 | ServerErrorException | jakarta.ws.rs.ServerErrorException.ServerErrorException
+
+ (
+ Response
+ , Throwable
+ )
+ | Construct a new server error exception. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:357 | Date | jakarta.ws.rs.ServiceUnavailableException.getRetryTime
+
+ (
+ Date
+ )
+ | Get the retry time for the failed request. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:359 | ServiceUnavailableException | jakarta.ws.rs.ServiceUnavailableException.ServiceUnavailableException
+ | Construct a new "service unavailable" exception without any "Retry-After" information specified for the failed request. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:360 | ServiceUnavailableException | jakarta.ws.rs.ServiceUnavailableException.ServiceUnavailableException
+
+ (
+ Long
+ )
+ | Construct a new "service unavailable" exception with an interval specifying the "Retry-After" information for the failed request. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:361 | ServiceUnavailableException | jakarta.ws.rs.ServiceUnavailableException.ServiceUnavailableException
+
+ (
+ Date
+ )
+ | Construct a new "service unavailable" exception with an interval specifying the "Retry-After" information for the failed request. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:362 | ServiceUnavailableException | jakarta.ws.rs.ServiceUnavailableException.ServiceUnavailableException
+
+ (
+ Response
+ )
+ | Construct a new "service unavailable" exception. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:363 | ServiceUnavailableException | jakarta.ws.rs.ServiceUnavailableException.ServiceUnavailableException
+
+ (
+ Date
+ , Throwable
+ )
+ | Construct a new "service unavailable" exception with a date specifying the "Retry-After" information for the failed request and an underlying request failure cause. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:364 | ServiceUnavailableException | jakarta.ws.rs.ServiceUnavailableException.ServiceUnavailableException
+
+ (
+ Long
+ , Throwable
+ )
+ | Construct a new "service unavailable" exception with an interval specifying the "Retry-After" information for the failed request and an underlying request failure cause. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:365 | ServiceUnavailableException | jakarta.ws.rs.ServiceUnavailableException.ServiceUnavailableException
+
+ (
+ Response
+ , Throwable
+ )
+ | Construct a new "service unavailable" exception. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:375 | Future | jakarta.ws.rs.client.AsyncInvoker.delete
+ | Invoke HTTP DELETE method for the current request asynchronously. Note that calling the java.util.concurrent.Future#get() method on the returned Future instance may throw an java.util.concurrent.ExecutionException that wraps a jakarta.ws.rs.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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:376 | Future | jakarta.ws.rs.client.AsyncInvoker.delete
+
+ (
+ Class
+ )
+ | Invoke HTTP DELETE method for the current request asynchronously. Note that calling the java.util.concurrent.Future#get() method on the returned Future instance may throw an java.util.concurrent.ExecutionException that wraps either a jakarta.ws.rs.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 jakarta.ws.rs.core.Response.Status.Family#SUCCESSFUL successful and the specified response type is not jakarta.ws.rs.core.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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:377 | Future | jakarta.ws.rs.client.AsyncInvoker.delete
+
+ (
+ GenericType
+ )
+ | Invoke HTTP DELETE method for the current request asynchronously. Note that calling the java.util.concurrent.Future#get() method on the returned Future instance may throw an java.util.concurrent.ExecutionException that wraps either a jakarta.ws.rs.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 jakarta.ws.rs.core.Response.Status.Family#SUCCESSFUL successful and the specified response type is not jakarta.ws.rs.core.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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:378 | Future | jakarta.ws.rs.client.AsyncInvoker.delete
+
+ (
+ InvocationCallback
+ )
+ | Invoke HTTP DELETE method for the current request asynchronously. Note that calling the java.util.concurrent.Future#get() method on the returned Future instance may throw an java.util.concurrent.ExecutionException that wraps either a jakarta.ws.rs.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 jakarta.ws.rs.core.Response.Status.Family#SUCCESSFUL successful and the generic type of the supplied response callback is not jakarta.ws.rs.core.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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:379 | Future | jakarta.ws.rs.client.AsyncInvoker.get
+ | Invoke HTTP GET method for the current request asynchronously. Note that calling the java.util.concurrent.Future#get() method on the returned Future instance may throw an java.util.concurrent.ExecutionException that wraps a jakarta.ws.rs.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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:380 | Future | jakarta.ws.rs.client.AsyncInvoker.get
+
+ (
+ Class
+ )
+ | Invoke HTTP GET method for the current request asynchronously. Note that calling the java.util.concurrent.Future#get() method on the returned Future instance may throw an java.util.concurrent.ExecutionException that wraps either a jakarta.ws.rs.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 jakarta.ws.rs.core.Response.Status.Family#SUCCESSFUL successful and the specified response type is not jakarta.ws.rs.core.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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:381 | Future | jakarta.ws.rs.client.AsyncInvoker.get
+
+ (
+ GenericType
+ )
+ | Invoke HTTP GET method for the current request asynchronously. Note that calling the java.util.concurrent.Future#get() method on the returned Future instance may throw an java.util.concurrent.ExecutionException that wraps either a jakarta.ws.rs.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 jakarta.ws.rs.core.Response.Status.Family#SUCCESSFUL successful and the specified response type is not jakarta.ws.rs.core.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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:382 | Future | jakarta.ws.rs.client.AsyncInvoker.get
+
+ (
+ InvocationCallback
+ )
+ | Invoke HTTP GET method for the current request asynchronously. Note that calling the java.util.concurrent.Future#get() method on the returned Future instance may throw an java.util.concurrent.ExecutionException that wraps either a jakarta.ws.rs.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 jakarta.ws.rs.core.Response.Status.Family#SUCCESSFUL successful and the generic type of the supplied response callback is not jakarta.ws.rs.core.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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:383 | Future | jakarta.ws.rs.client.AsyncInvoker.head
+ | Invoke HTTP HEAD method for the current request asynchronously. Note that calling the java.util.concurrent.Future#get() method on the returned Future instance may throw an java.util.concurrent.ExecutionException that wraps a jakarta.ws.rs.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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:384 | Future | jakarta.ws.rs.client.AsyncInvoker.head
+
+ (
+ InvocationCallback
+ )
+ | Invoke HTTP HEAD method for the current request asynchronously. Note that calling the java.util.concurrent.Future#get() method on the returned Future instance may throw an java.util.concurrent.ExecutionException that wraps a jakarta.ws.rs.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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:385 | Future | jakarta.ws.rs.client.AsyncInvoker.method
+
+ (
+ String
+ )
+ | Invoke an arbitrary method for the current request asynchronously. Note that calling the java.util.concurrent.Future#get() method on the returned Future instance may throw an java.util.concurrent.ExecutionException that wraps a jakarta.ws.rs.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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:386 | Future | jakarta.ws.rs.client.AsyncInvoker.method
+
+ (
+ String
+ , Class
+ )
+ | Invoke an arbitrary method for the current request asynchronously. Note that calling the java.util.concurrent.Future#get() method on the returned Future instance may throw an java.util.concurrent.ExecutionException that wraps either a jakarta.ws.rs.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 jakarta.ws.rs.core.Response.Status.Family#SUCCESSFUL successful and the specified response type is not jakarta.ws.rs.core.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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:387 | Future | jakarta.ws.rs.client.AsyncInvoker.method
+
+ (
+ String
+ , GenericType
+ )
+ | Invoke an arbitrary method for the current request asynchronously. Note that calling the java.util.concurrent.Future#get() method on the returned Future instance may throw an java.util.concurrent.ExecutionException that wraps either a jakarta.ws.rs.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 jakarta.ws.rs.core.Response.Status.Family#SUCCESSFUL successful and the specified response type is not jakarta.ws.rs.core.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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:388 | Future | jakarta.ws.rs.client.AsyncInvoker.method
+
+ (
+ String
+ , InvocationCallback
+ )
+ | Invoke an arbitrary method for the current request asynchronously. Note that calling the java.util.concurrent.Future#get() method on the returned Future instance may throw an java.util.concurrent.ExecutionException that wraps either a jakarta.ws.rs.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 jakarta.ws.rs.core.Response.Status.Family#SUCCESSFUL successful and the generic type of the supplied response callback is not jakarta.ws.rs.core.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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:389 | Future | jakarta.ws.rs.client.AsyncInvoker.method
+
+ (
+ String
+ , Entity
+ )
+ | Invoke an arbitrary method for the current request asynchronously. Note that calling the java.util.concurrent.Future#get() method on the returned Future instance may throw an java.util.concurrent.ExecutionException that wraps a jakarta.ws.rs.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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:390 | Future | jakarta.ws.rs.client.AsyncInvoker.method
+
+ (
+ String
+ , Entity
+ , Class
+ )
+ | Invoke an arbitrary method for the current request asynchronously. Note that calling the java.util.concurrent.Future#get() method on the returned Future instance may throw an java.util.concurrent.ExecutionException that wraps either a jakarta.ws.rs.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 jakarta.ws.rs.core.Response.Status.Family#SUCCESSFUL successful and the specified response type is not jakarta.ws.rs.core.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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:391 | Future | jakarta.ws.rs.client.AsyncInvoker.method
+
+ (
+ String
+ , Entity
+ , GenericType
+ )
+ | Invoke an arbitrary method for the current request asynchronously. Note that calling the java.util.concurrent.Future#get() method on the returned Future instance may throw an java.util.concurrent.ExecutionException that wraps either a jakarta.ws.rs.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 jakarta.ws.rs.core.Response.Status.Family#SUCCESSFUL successful and the specified response type is not jakarta.ws.rs.core.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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:392 | Future | jakarta.ws.rs.client.AsyncInvoker.method
+
+ (
+ String
+ , Entity
+ , InvocationCallback
+ )
+ | Invoke an arbitrary method for the current request asynchronously. Note that calling the java.util.concurrent.Future#get() method on the returned Future instance may throw an java.util.concurrent.ExecutionException that wraps either a jakarta.ws.rs.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 jakarta.ws.rs.core.Response.Status.Family#SUCCESSFUL successful and the generic type of the supplied response callback is not jakarta.ws.rs.core.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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:393 | Future | jakarta.ws.rs.client.AsyncInvoker.options
+ | Invoke HTTP OPTIONS method for the current request asynchronously. Note that calling the java.util.concurrent.Future#get() method on the returned Future instance may throw an java.util.concurrent.ExecutionException that wraps a jakarta.ws.rs.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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:394 | Future | jakarta.ws.rs.client.AsyncInvoker.options
+
+ (
+ Class
+ )
+ | Invoke HTTP OPTIONS method for the current request asynchronously. Note that calling the java.util.concurrent.Future#get() method on the returned Future instance may throw an java.util.concurrent.ExecutionException that wraps either a jakarta.ws.rs.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 jakarta.ws.rs.core.Response.Status.Family#SUCCESSFUL successful and the specified response type is not jakarta.ws.rs.core.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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:395 | Future | jakarta.ws.rs.client.AsyncInvoker.options
+
+ (
+ GenericType
+ )
+ | Invoke HTTP OPTIONS method for the current request asynchronously. Note that calling the java.util.concurrent.Future#get() method on the returned Future instance may throw an java.util.concurrent.ExecutionException that wraps either a jakarta.ws.rs.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 jakarta.ws.rs.core.Response.Status.Family#SUCCESSFUL successful and the specified response type is not jakarta.ws.rs.core.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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:396 | Future | jakarta.ws.rs.client.AsyncInvoker.options
+
+ (
+ InvocationCallback
+ )
+ | Invoke HTTP OPTIONS method for the current request asynchronously. Note that calling the java.util.concurrent.Future#get() method on the returned Future instance may throw an java.util.concurrent.ExecutionException that wraps either a jakarta.ws.rs.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 jakarta.ws.rs.core.Response.Status.Family#SUCCESSFUL successful and the generic type of the supplied response callback is not jakarta.ws.rs.core.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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:397 | Future | jakarta.ws.rs.client.AsyncInvoker.post
+
+ (
+ Entity
+ )
+ | Invoke HTTP POST method for the current request asynchronously. Note that calling the java.util.concurrent.Future#get() method on the returned Future instance may throw an java.util.concurrent.ExecutionException that wraps a jakarta.ws.rs.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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:398 | Future | jakarta.ws.rs.client.AsyncInvoker.post
+
+ (
+ Entity
+ , Class
+ )
+ | Invoke HTTP POST method for the current request asynchronously. Note that calling the java.util.concurrent.Future#get() method on the returned Future instance may throw an java.util.concurrent.ExecutionException that wraps either a jakarta.ws.rs.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 jakarta.ws.rs.core.Response.Status.Family#SUCCESSFUL successful and the specified response type is not jakarta.ws.rs.core.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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:399 | Future | jakarta.ws.rs.client.AsyncInvoker.post
+
+ (
+ Entity
+ , GenericType
+ )
+ | Invoke HTTP POST method for the current request asynchronously. Note that calling the java.util.concurrent.Future#get() method on the returned Future instance may throw an java.util.concurrent.ExecutionException that wraps either a jakarta.ws.rs.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 jakarta.ws.rs.core.Response.Status.Family#SUCCESSFUL successful and the specified response type is not jakarta.ws.rs.core.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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:400 | Future | jakarta.ws.rs.client.AsyncInvoker.post
+
+ (
+ Entity
+ , InvocationCallback
+ )
+ | Invoke HTTP POST method for the current request asynchronously. Note that calling the java.util.concurrent.Future#get() method on the returned Future instance may throw an java.util.concurrent.ExecutionException that wraps either a jakarta.ws.rs.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 jakarta.ws.rs.core.Response.Status.Family#SUCCESSFUL successful and the generic type of the supplied response callback is not jakarta.ws.rs.core.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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:401 | Future | jakarta.ws.rs.client.AsyncInvoker.put
+
+ (
+ Entity
+ )
+ | Invoke HTTP PUT method for the current request asynchronously. Note that calling the java.util.concurrent.Future#get() method on the returned Future instance may throw an java.util.concurrent.ExecutionException that wraps a jakarta.ws.rs.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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:402 | Future | jakarta.ws.rs.client.AsyncInvoker.put
+
+ (
+ Entity
+ , Class
+ )
+ | Invoke HTTP PUT method for the current request asynchronously. Note that calling the java.util.concurrent.Future#get() method on the returned Future instance may throw an java.util.concurrent.ExecutionException that wraps either a jakarta.ws.rs.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 jakarta.ws.rs.core.Response.Status.Family#SUCCESSFUL successful and the specified response type is not jakarta.ws.rs.core.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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:403 | Future | jakarta.ws.rs.client.AsyncInvoker.put
+
+ (
+ Entity
+ , GenericType
+ )
+ | Invoke HTTP PUT method for the current request asynchronously. Note that calling the java.util.concurrent.Future#get() method on the returned Future instance may throw an java.util.concurrent.ExecutionException that wraps either a jakarta.ws.rs.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 jakarta.ws.rs.core.Response.Status.Family#SUCCESSFUL successful and the specified response type is not jakarta.ws.rs.core.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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:404 | Future | jakarta.ws.rs.client.AsyncInvoker.put
+
+ (
+ Entity
+ , InvocationCallback
+ )
+ | Invoke HTTP PUT method for the current request asynchronously. Note that calling the java.util.concurrent.Future#get() method on the returned Future instance may throw an java.util.concurrent.ExecutionException that wraps either a jakarta.ws.rs.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 jakarta.ws.rs.core.Response.Status.Family#SUCCESSFUL successful and the generic type of the supplied response callback is not jakarta.ws.rs.core.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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:405 | Future | jakarta.ws.rs.client.AsyncInvoker.trace
+ | Invoke HTTP TRACE method for the current request asynchronously. Note that calling the java.util.concurrent.Future#get() method on the returned Future instance may throw an java.util.concurrent.ExecutionException that wraps a jakarta.ws.rs.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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:406 | Future | jakarta.ws.rs.client.AsyncInvoker.trace
+
+ (
+ Class
+ )
+ | Invoke HTTP TRACE method for the current request asynchronously. Note that calling the java.util.concurrent.Future#get() method on the returned Future instance may throw an java.util.concurrent.ExecutionException that wraps either a jakarta.ws.rs.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 jakarta.ws.rs.core.Response.Status.Family#SUCCESSFUL successful and the specified response type is not jakarta.ws.rs.core.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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:407 | Future | jakarta.ws.rs.client.AsyncInvoker.trace
+
+ (
+ GenericType
+ )
+ | Invoke HTTP TRACE method for the current request asynchronously. Note that calling the java.util.concurrent.Future#get() method on the returned Future instance may throw an java.util.concurrent.ExecutionException that wraps either a jakarta.ws.rs.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 jakarta.ws.rs.core.Response.Status.Family#SUCCESSFUL successful and the specified response type is not jakarta.ws.rs.core.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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:408 | Future | jakarta.ws.rs.client.AsyncInvoker.trace
+
+ (
+ InvocationCallback
+ )
+ | Invoke HTTP TRACE method for the current request asynchronously. Note that calling the java.util.concurrent.Future#get() method on the returned Future instance may throw an java.util.concurrent.ExecutionException that wraps either a jakarta.ws.rs.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 jakarta.ws.rs.core.Response.Status.Family#SUCCESSFUL successful and the generic type of the supplied response callback is not jakarta.ws.rs.core.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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:409 | void | jakarta.ws.rs.client.Client.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 WebTarget 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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:411 | Builder | jakarta.ws.rs.client.Client.invocation
+
+ (
+ 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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:413 | WebTarget | jakarta.ws.rs.client.Client.target
+
+ (
+ String
+ )
+ | Build a new web resource target. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:416 | WebTarget | jakarta.ws.rs.client.Client.target
+
+ (
+ URI
+ )
+ | Build a new web resource target. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:418 | WebTarget | jakarta.ws.rs.client.Client.target
+
+ (
+ UriBuilder
+ )
+ | Build a new web resource target. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:420 | WebTarget | jakarta.ws.rs.client.Client.target
+
+ (
+ Link
+ )
+ | Build a new web resource target. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:427 | void | jakarta.ws.rs.client.ClientRequestContext.abortWith
+
+ (
+ 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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:428 | List | jakarta.ws.rs.client.ClientRequestContext.getAcceptableLanguages
+ | Get a list of languages that are acceptable for the response. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:429 | List | jakarta.ws.rs.client.ClientRequestContext.getAcceptableMediaTypes
+ | Get a list of media types that are acceptable for the response. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:430 | Client | jakarta.ws.rs.client.ClientRequestContext.getClient
+ | Get the client instance associated with the request. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:432 | Map | jakarta.ws.rs.client.ClientRequestContext.getCookies
+ | Get any cookies that accompanied the request. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:433 | Date | jakarta.ws.rs.client.ClientRequestContext.getDate
+ | Get message date. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:434 | Object | jakarta.ws.rs.client.ClientRequestContext.getEntity
+ | Get the message entity Java instance. Returns null if the message does not contain an entity. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:435 | Annotation[] | jakarta.ws.rs.client.ClientRequestContext.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#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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:436 | Class | jakarta.ws.rs.client.ClientRequestContext.getEntityClass
+ | Get the raw entity type information. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:437 | OutputStream | jakarta.ws.rs.client.ClientRequestContext.getEntityStream
+ | Get the entity output stream. The JAX-RS runtime is responsible for closing the output stream. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:438 | Type | jakarta.ws.rs.client.ClientRequestContext.getEntityType
+ | Get the generic entity type information. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:439 | MultivaluedMap | jakarta.ws.rs.client.ClientRequestContext.getHeaders
+ | Get the mutable request headers multivalued map. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:441 | Locale | jakarta.ws.rs.client.ClientRequestContext.getLanguage
+ | Get the language of the entity. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:442 | MediaType | jakarta.ws.rs.client.ClientRequestContext.getMediaType
+ | Get the media type of the entity. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:443 | String | jakarta.ws.rs.client.ClientRequestContext.getMethod
+ | Get the request method. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:444 | Object | jakarta.ws.rs.client.ClientRequestContext.getProperty
+
+ (
+ String
+ )
+ | 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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:446 | MultivaluedMap | jakarta.ws.rs.client.ClientRequestContext.getStringHeaders
+ | Get a string view of header values associated with the message. Changes in the underlying #getHeaders() headers map are reflected in this view. The method converts the non-string header values to strings using a jakarta.ws.rs.ext.RuntimeDelegate.HeaderDelegate if one is available via jakarta.ws.rs.ext.RuntimeDelegate#createHeaderDelegate(java.lang.Class) for the class of the value or using the values toString method if a header delegate is not available. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:447 | URI | jakarta.ws.rs.client.ClientRequestContext.getUri
+ | Get the request URI. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:448 | boolean | jakarta.ws.rs.client.ClientRequestContext.hasEntity
+ | Check if there is an entity available in the request. The method returns true if the entity is present, returns false otherwise. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:449 | void | jakarta.ws.rs.client.ClientRequestContext.removeProperty
+
+ (
+ String
+ )
+ | Removes a property with the given name from the current request/response exchange context. After removal, subsequent calls to #getProperty to retrieve the property value will return null. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:450 | void | jakarta.ws.rs.client.ClientRequestContext.setEntity
+
+ (
+ Object
+ , Annotation[]
+ , 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 jakarta.ws.rs.core.GenericEntity if preservation of its generic type is required. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:451 | void | jakarta.ws.rs.client.ClientRequestContext.setEntityStream
+
+ (
+ OutputStream
+ )
+ | Set a new entity output stream. The JAX-RS runtime is responsible for closing the output stream. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:452 | void | jakarta.ws.rs.client.ClientRequestContext.setMethod
+
+ (
+ String
+ )
+ | Set the request method. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:453 | void | jakarta.ws.rs.client.ClientRequestContext.setProperty
+
+ (
+ String
+ , 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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:454 | void | jakarta.ws.rs.client.ClientRequestContext.setUri
+
+ (
+ URI
+ )
+ | Set a new request URI. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:455 | void | jakarta.ws.rs.client.ClientRequestFilter.filter
+
+ (
+ ClientRequestContext
+ )
+ | 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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:456 | void | jakarta.ws.rs.client.ClientRequestFilter.filter
+
+ (
+ ClientRequestContext
+ )
+ throws
+ IOException
+ | if an I/O exception occurs. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:457 | Set | jakarta.ws.rs.client.ClientResponseContext.getAllowedMethods
+ | Get the allowed HTTP methods from the Allow HTTP header. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:458 | Map | jakarta.ws.rs.client.ClientResponseContext.getCookies
+ | Get any new cookies set on the response message. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:459 | Date | jakarta.ws.rs.client.ClientResponseContext.getDate
+ | Get message date. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:460 | InputStream | jakarta.ws.rs.client.ClientResponseContext.getEntityStream
+ | Get the entity input stream. The JAX-RS runtime is responsible for closing the input stream. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:461 | EntityTag | jakarta.ws.rs.client.ClientResponseContext.getEntityTag
+ | Get the entity tag. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:462 | MultivaluedMap | jakarta.ws.rs.client.ClientResponseContext.getHeaders
+ | Get the mutable response headers multivalued map. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:463 | String | jakarta.ws.rs.client.ClientResponseContext.getHeaderString
+
+ (
+ String
+ )
+ | Get a message header as a single string value. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:464 | Locale | jakarta.ws.rs.client.ClientResponseContext.getLanguage
+ | Get the language of the entity. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:465 | Date | jakarta.ws.rs.client.ClientResponseContext.getLastModified
+ | Get the last modified date. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:466 | int | jakarta.ws.rs.client.ClientResponseContext.getLength
+ | Get Content-Length value. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:467 | Link | jakarta.ws.rs.client.ClientResponseContext.getLink
+
+ (
+ String
+ )
+ | Get the link for the relation. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:468 | Builder | jakarta.ws.rs.client.ClientResponseContext.getLinkBuilder
+
+ (
+ String
+ )
+ | Convenience method that returns a jakarta.ws.rs.core.Link.Builder Link.Builder for the relation. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:469 | Set | jakarta.ws.rs.client.ClientResponseContext.getLinks
+ | Get the links attached to the message as header. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:470 | URI | jakarta.ws.rs.client.ClientResponseContext.getLocation
+ | Get the location. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:471 | MediaType | jakarta.ws.rs.client.ClientResponseContext.getMediaType
+ | Get the media type of the entity. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:472 | int | jakarta.ws.rs.client.ClientResponseContext.getStatus
+ | Get the status code associated with the response. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:473 | StatusType | jakarta.ws.rs.client.ClientResponseContext.getStatusInfo
+ | Get the complete status information associated with the response. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:474 | boolean | jakarta.ws.rs.client.ClientResponseContext.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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:475 | boolean | jakarta.ws.rs.client.ClientResponseContext.hasLink
+
+ (
+ String
+ )
+ | Check if link for relation exists. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:476 | void | jakarta.ws.rs.client.ClientResponseContext.setEntityStream
+
+ (
+ InputStream
+ )
+ | Set a new entity input stream. The JAX-RS runtime is responsible for closing the input stream. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:477 | void | jakarta.ws.rs.client.ClientResponseContext.setStatus
+
+ (
+ int
+ )
+ | Set a new response status code. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:478 | void | jakarta.ws.rs.client.ClientResponseContext.setStatusInfo
+
+ (
+ StatusType
+ )
+ | Set the complete status information (status code and reason phrase) associated with the response. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:480 | void | jakarta.ws.rs.client.ClientResponseFilter.filter
+
+ (
+ ClientRequestContext
+ , ClientResponseContext
+ )
+ throws
+ IOException
+ | if an I/O exception occurs. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:492 | Entity | jakarta.ws.rs.client.Entity.entity
+
+ (
+ Object
+ , MediaType
+ )
+ | Create an entity using a supplied content media type. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:493 | Entity | jakarta.ws.rs.client.Entity.entity
+
+ (
+ Object
+ , MediaType
+ , Annotation[]
+ )
+ | Create an entity using a supplied content media type. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:494 | Entity | jakarta.ws.rs.client.Entity.entity
+
+ (
+ Object
+ , String
+ )
+ | Create an entity using a supplied content media type. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:496 | Entity | jakarta.ws.rs.client.Entity.entity
+
+ (
+ Object
+ , Variant
+ )
+ | Create an entity using a supplied content media type. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:497 | Entity | jakarta.ws.rs.client.Entity.entity
+
+ (
+ Object
+ , Variant
+ , Annotation[]
+ )
+ | Create an entity using a supplied content media type. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:500 | Annotation[] | jakarta.ws.rs.client.Entity.getAnnotations
+ | Get the entity annotations. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:501 | String | jakarta.ws.rs.client.Entity.getEncoding
+ | Get entity encoding. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:502 | Object | jakarta.ws.rs.client.Entity.getEntity
+ | Get entity data. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:503 | Locale | jakarta.ws.rs.client.Entity.getLanguage
+ | Get entity language. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:504 | MediaType | jakarta.ws.rs.client.Entity.getMediaType
+ | Get entity media type. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:505 | Variant | jakarta.ws.rs.client.Entity.getVariant
+ | Get entity Variant variant information. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:512 | Response | jakarta.ws.rs.client.Invocation.invoke
+ | Synchronously invoke the request and receive a response back. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:514 | Object | jakarta.ws.rs.client.Invocation.invoke
+
+ (
+ Class
+ )
+ | Synchronously invoke the request and receive a response of the specified type back. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:517 | Object | jakarta.ws.rs.client.Invocation.invoke
+
+ (
+ GenericType
+ )
+ | Synchronously invoke the request and receive a response of the specified generic type back. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:520 | Future | jakarta.ws.rs.client.Invocation.submit
+ | Submit the request for an asynchronous invocation and receive a future response back. Note that calling the java.util.concurrent.Future#get() method on the returned Future instance may throw an java.util.concurrent.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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:521 | Future | jakarta.ws.rs.client.Invocation.submit
+
+ (
+ Class
+ )
+ | Submit the request for an asynchronous invocation and receive a future response of the specified type back. Note that calling the java.util.concurrent.Future#get() method on the returned Future instance may throw an java.util.concurrent.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 jakarta.ws.rs.core.Response.Status.Family#SUCCESSFUL successful and the specified response type is not jakarta.ws.rs.core.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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:522 | Future | jakarta.ws.rs.client.Invocation.submit
+
+ (
+ GenericType
+ )
+ | Submit the request for an asynchronous invocation and receive a future response of the specified generic type back. Note that calling the java.util.concurrent.Future#get() method on the returned Future instance may throw an java.util.concurrent.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 jakarta.ws.rs.core.Response.Status.Family#SUCCESSFUL successful and the specified response type is not jakarta.ws.rs.core.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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:523 | Future | jakarta.ws.rs.client.Invocation.submit
+
+ (
+ InvocationCallback
+ )
+ | Submit the request for an asynchronous invocation and register an InvocationCallback to process the future result of the invocation. Note that calling the java.util.concurrent.Future#get() method on the returned Future instance may throw an java.util.concurrent.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 jakarta.ws.rs.core.Response.Status.Family#SUCCESSFUL successful and the generic type of the supplied response callback is not jakarta.ws.rs.core.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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:524 | Builder | jakarta.ws.rs.client.Invocation.Builder.acceptLanguage
+
+ (
+ Locale[]
+ )
+ | Add acceptable languages. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:525 | Builder | jakarta.ws.rs.client.Invocation.Builder.acceptLanguage
+
+ (
+ String[]
+ )
+ | Add acceptable languages. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:526 | AsyncInvoker | jakarta.ws.rs.client.Invocation.Builder.async
+ | Access the asynchronous uniform request invocation interface to asynchronously invoke the built request. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:527 | Invocation | jakarta.ws.rs.client.Invocation.Builder.build
+
+ (
+ String
+ )
+ | Build a request invocation using an arbitrary request method name. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:528 | Invocation | jakarta.ws.rs.client.Invocation.Builder.build
+
+ (
+ String
+ , Entity
+ )
+ | Build a request invocation using an arbitrary request method name and request entity. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:529 | Invocation | jakarta.ws.rs.client.Invocation.Builder.buildDelete
+ | Build a DELETE request invocation. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:530 | Invocation | jakarta.ws.rs.client.Invocation.Builder.buildGet
+ | Build a GET request invocation. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:531 | Invocation | jakarta.ws.rs.client.Invocation.Builder.buildPost
+
+ (
+ Entity
+ )
+ | Build a POST request invocation. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:532 | Invocation | jakarta.ws.rs.client.Invocation.Builder.buildPut
+
+ (
+ Entity
+ )
+ | Build a PUT request invocation. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:533 | Builder | jakarta.ws.rs.client.Invocation.Builder.cacheControl
+
+ (
+ CacheControl
+ )
+ | Set the cache control data of the message. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:535 | Builder | jakarta.ws.rs.client.Invocation.Builder.cookie
+
+ (
+ Cookie
+ )
+ | Add a cookie to be set. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:536 | Builder | jakarta.ws.rs.client.Invocation.Builder.cookie
+
+ (
+ String
+ , String
+ )
+ | Add a cookie to be set. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:537 | Builder | jakarta.ws.rs.client.Invocation.Builder.header
+
+ (
+ String
+ , Object
+ )
+ | Add an arbitrary header. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:538 | Builder | jakarta.ws.rs.client.Invocation.Builder.headers
+
+ (
+ MultivaluedMap
+ )
+ | Replaces all existing headers with the newly supplied headers. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:539 | void | jakarta.ws.rs.client.InvocationCallback.completed
+
+ (
+ Object
+ )
+ | 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 jakarta.ws.rs.core.Response instance will be automatically closed by the runtime. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:541 | Response | jakarta.ws.rs.client.SyncInvoker.delete
+ | Invoke HTTP DELETE method for the current request synchronously. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:543 | Object | jakarta.ws.rs.client.SyncInvoker.delete
+
+ (
+ Class
+ )
+ | Invoke HTTP DELETE method for the current request synchronously. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:546 | Object | jakarta.ws.rs.client.SyncInvoker.delete
+
+ (
+ GenericType
+ )
+ | Invoke HTTP DELETE method for the current request synchronously. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:549 | Response | jakarta.ws.rs.client.SyncInvoker.get
+ | Invoke HTTP GET method for the current request synchronously. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:551 | Object | jakarta.ws.rs.client.SyncInvoker.get
+
+ (
+ Class
+ )
+ | Invoke HTTP GET method for the current request synchronously. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:554 | Object | jakarta.ws.rs.client.SyncInvoker.get
+
+ (
+ GenericType
+ )
+ | Invoke HTTP GET method for the current request synchronously. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:557 | Response | jakarta.ws.rs.client.SyncInvoker.head
+ | Invoke HTTP HEAD method for the current request synchronously. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:559 | Response | jakarta.ws.rs.client.SyncInvoker.method
+
+ (
+ String
+ )
+ | Invoke an arbitrary method for the current request synchronously. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:561 | Object | jakarta.ws.rs.client.SyncInvoker.method
+
+ (
+ String
+ , Class
+ )
+ | Invoke an arbitrary method for the current request synchronously. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:564 | Object | jakarta.ws.rs.client.SyncInvoker.method
+
+ (
+ String
+ , GenericType
+ )
+ | Invoke an arbitrary method for the current request synchronously. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:567 | Response | jakarta.ws.rs.client.SyncInvoker.method
+
+ (
+ String
+ , Entity
+ )
+ | Invoke an arbitrary method for the current request synchronously. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:569 | Object | jakarta.ws.rs.client.SyncInvoker.method
+
+ (
+ String
+ , Entity
+ , Class
+ )
+ | Invoke an arbitrary method for the current request synchronously. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:572 | Object | jakarta.ws.rs.client.SyncInvoker.method
+
+ (
+ String
+ , Entity
+ , GenericType
+ )
+ | Invoke an arbitrary method for the current request synchronously. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:575 | Response | jakarta.ws.rs.client.SyncInvoker.options
+ | Invoke HTTP OPTIONS method for the current request synchronously. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:577 | Object | jakarta.ws.rs.client.SyncInvoker.options
+
+ (
+ Class
+ )
+ | Invoke HTTP OPTIONS method for the current request synchronously. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:580 | Object | jakarta.ws.rs.client.SyncInvoker.options
+
+ (
+ GenericType
+ )
+ | Invoke HTTP OPTIONS method for the current request synchronously. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:583 | Response | jakarta.ws.rs.client.SyncInvoker.post
+
+ (
+ Entity
+ )
+ | Invoke HTTP POST method for the current request synchronously. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:585 | Object | jakarta.ws.rs.client.SyncInvoker.post
+
+ (
+ Entity
+ , Class
+ )
+ | Invoke HTTP POST method for the current request synchronously. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:588 | Object | jakarta.ws.rs.client.SyncInvoker.post
+
+ (
+ Entity
+ , GenericType
+ )
+ | Invoke HTTP POST method for the current request synchronously. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:591 | Response | jakarta.ws.rs.client.SyncInvoker.put
+
+ (
+ Entity
+ )
+ | Invoke HTTP PUT method for the current request synchronously. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:593 | Object | jakarta.ws.rs.client.SyncInvoker.put
+
+ (
+ Entity
+ , Class
+ )
+ | Invoke HTTP PUT method for the current request synchronously. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:596 | Object | jakarta.ws.rs.client.SyncInvoker.put
+
+ (
+ Entity
+ , GenericType
+ )
+ | Invoke HTTP PUT method for the current request synchronously. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:599 | Response | jakarta.ws.rs.client.SyncInvoker.trace
+ | Invoke HTTP TRACE method for the current request synchronously. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:601 | Object | jakarta.ws.rs.client.SyncInvoker.trace
+
+ (
+ Class
+ )
+ | Invoke HTTP TRACE method for the current request synchronously. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:604 | Object | jakarta.ws.rs.client.SyncInvoker.trace
+
+ (
+ GenericType
+ )
+ | Invoke HTTP TRACE method for the current request synchronously. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:608 | URI | jakarta.ws.rs.client.WebTarget.getUri
+ | Get the URI identifying the resource. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:609 | UriBuilder | jakarta.ws.rs.client.WebTarget.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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:610 | WebTarget | jakarta.ws.rs.client.WebTarget.matrixParam
+
+ (
+ String
+ , Object[]
+ )
+ | 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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:612 | WebTarget | jakarta.ws.rs.client.WebTarget.path
+
+ (
+ String
+ )
+ | 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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:618 | WebTarget | jakarta.ws.rs.client.WebTarget.queryParam
+
+ (
+ String
+ , Object[]
+ )
+ | 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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:622 | Builder | jakarta.ws.rs.client.WebTarget.request
+ | Start building a request to the targeted web resource. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:623 | Builder | jakarta.ws.rs.client.WebTarget.request
+
+ (
+ String[]
+ )
+ | 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); | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:624 | Builder | jakarta.ws.rs.client.WebTarget.request
+
+ (
+ MediaType[]
+ )
+ | 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); | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:628 | boolean | jakarta.ws.rs.container.AsyncResponse.isCancelled
+ | Check if the asynchronous response instance has been cancelled. Method returns true if this asynchronous response has been canceled before completion. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:629 | boolean | jakarta.ws.rs.container.AsyncResponse.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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:630 | boolean | jakarta.ws.rs.container.AsyncResponse.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). | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:645 | void | jakarta.ws.rs.container.AsyncResponse.setTimeoutHandler
+
+ (
+ TimeoutHandler
+ )
+ | 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 #NO_TIMEOUT indefinitely, the time-out handler may never be invoked. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:648 | void | jakarta.ws.rs.container.ConnectionCallback.onDisconnect
+
+ (
+ AsyncResponse
+ )
+ | This callback notification method is invoked in case the container detects that the remote client connection associated with the asynchronous response has been disconnected. | false |
+
+ | true |
+
+
+JAXRS:JAVADOC:649 | void | jakarta.ws.rs.container.ContainerRequestContext.abortWith
+
+ (
+ 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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:650 | List | jakarta.ws.rs.container.ContainerRequestContext.getAcceptableLanguages
+ | Get a list of languages that are acceptable for the response. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:651 | List | jakarta.ws.rs.container.ContainerRequestContext.getAcceptableMediaTypes
+ | Get a list of media types that are acceptable for the response. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:652 | Map | jakarta.ws.rs.container.ContainerRequestContext.getCookies
+ | Get any cookies that accompanied the request. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:653 | Date | jakarta.ws.rs.container.ContainerRequestContext.getDate
+ | Get message date. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:654 | InputStream | jakarta.ws.rs.container.ContainerRequestContext.getEntityStream
+ | Get the entity input stream. The JAX-RS runtime is responsible for closing the input stream. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:655 | MultivaluedMap | jakarta.ws.rs.container.ContainerRequestContext.getHeaders
+ | Get the mutable request headers multivalued map. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:656 | String | jakarta.ws.rs.container.ContainerRequestContext.getHeaderString
+
+ (
+ String
+ )
+ | Get a message header as a single string value. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:657 | Locale | jakarta.ws.rs.container.ContainerRequestContext.getLanguage
+ | Get the language of the entity. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:658 | int | jakarta.ws.rs.container.ContainerRequestContext.getLength
+ | Get Content-Length value. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:659 | MediaType | jakarta.ws.rs.container.ContainerRequestContext.getMediaType
+ | Get the media type of the entity. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:660 | String | jakarta.ws.rs.container.ContainerRequestContext.getMethod
+ | Get the request method. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:661 | Object | jakarta.ws.rs.container.ContainerRequestContext.getProperty
+
+ (
+ String
+ )
+ | 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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:663 | Request | jakarta.ws.rs.container.ContainerRequestContext.getRequest
+ | Get the injectable request information. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:664 | SecurityContext | jakarta.ws.rs.container.ContainerRequestContext.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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:665 | UriInfo | jakarta.ws.rs.container.ContainerRequestContext.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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:666 | boolean | jakarta.ws.rs.container.ContainerRequestContext.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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:667 | void | jakarta.ws.rs.container.ContainerRequestContext.removeProperty
+
+ (
+ String
+ )
+ | Removes a property with the given name from the current request/response exchange context. After removal, subsequent calls to #getProperty 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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:668 | void | jakarta.ws.rs.container.ContainerRequestContext.setEntityStream
+
+ (
+ InputStream
+ )
+ | Set a new entity input stream. The JAX-RS runtime is responsible for closing the input stream. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:669 | void | jakarta.ws.rs.container.ContainerRequestContext.setMethod
+
+ (
+ String
+ )
+ | 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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:671 | void | jakarta.ws.rs.container.ContainerRequestContext.setProperty
+
+ (
+ String
+ , 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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:672 | void | jakarta.ws.rs.container.ContainerRequestContext.setRequestUri
+
+ (
+ URI
+ )
+ | 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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:674 | void | jakarta.ws.rs.container.ContainerRequestContext.setRequestUri
+
+ (
+ URI
+ , URI
+ )
+ | 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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:676 | void | jakarta.ws.rs.container.ContainerRequestContext.setSecurityContext
+
+ (
+ SecurityContext
+ )
+ | 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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:677 | void | jakarta.ws.rs.container.ContainerRequestFilter.filter
+
+ (
+ ContainerRequestContext
+ )
+ | 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 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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:678 | void | jakarta.ws.rs.container.ContainerRequestFilter.filter
+
+ (
+ ContainerRequestContext
+ )
+ throws
+ IOException
+ | if an I/O exception occurs. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:679 | Set | jakarta.ws.rs.container.ContainerResponseContext.getAllowedMethods
+ | Get the allowed HTTP methods from the Allow HTTP header. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:680 | Map | jakarta.ws.rs.container.ContainerResponseContext.getCookies
+ | Get any new cookies set on the response message. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:681 | Date | jakarta.ws.rs.container.ContainerResponseContext.getDate
+ | Get message date. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:682 | Object | jakarta.ws.rs.container.ContainerResponseContext.getEntity
+ | Get the message entity Java instance. Returns null if the message does not contain an entity. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:684 | Class | jakarta.ws.rs.container.ContainerResponseContext.getEntityClass
+ | Get the raw entity type information. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:685 | OutputStream | jakarta.ws.rs.container.ContainerResponseContext.getEntityStream
+ | Get the entity output stream. The JAX-RS runtime is responsible for closing the output stream. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:686 | EntityTag | jakarta.ws.rs.container.ContainerResponseContext.getEntityTag
+ | Get the entity tag. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:687 | Type | jakarta.ws.rs.container.ContainerResponseContext.getEntityType
+ | Get the generic entity type information. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:688 | MultivaluedMap | jakarta.ws.rs.container.ContainerResponseContext.getHeaders
+ | Get the mutable response headers multivalued map. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:690 | Locale | jakarta.ws.rs.container.ContainerResponseContext.getLanguage
+ | Get the language of the entity. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:691 | Date | jakarta.ws.rs.container.ContainerResponseContext.getLastModified
+ | Get the last modified date. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:692 | int | jakarta.ws.rs.container.ContainerResponseContext.getLength
+ | Get Content-Length value. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:693 | Link | jakarta.ws.rs.container.ContainerResponseContext.getLink
+
+ (
+ String
+ )
+ | Get the link for the relation. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:694 | Builder | jakarta.ws.rs.container.ContainerResponseContext.getLinkBuilder
+
+ (
+ String
+ )
+ | Convenience method that returns a jakarta.ws.rs.core.Link.Builder Link.Builder for the relation. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:695 | Set | jakarta.ws.rs.container.ContainerResponseContext.getLinks
+ | Get the links attached to the message as header. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:696 | URI | jakarta.ws.rs.container.ContainerResponseContext.getLocation
+ | Get the location. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:697 | MediaType | jakarta.ws.rs.container.ContainerResponseContext.getMediaType
+ | Get the media type of the entity. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:698 | int | jakarta.ws.rs.container.ContainerResponseContext.getStatus
+ | Get the status code associated with the response. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:699 | StatusType | jakarta.ws.rs.container.ContainerResponseContext.getStatusInfo
+ | Get the complete status information associated with the response. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:700 | MultivaluedMap | jakarta.ws.rs.container.ContainerResponseContext.getStringHeaders
+ | Get a string view of header values associated with the message. Changes in the underlying #getHeaders() headers map are reflected in this view. The method converts the non-string header values to strings using a jakarta.ws.rs.ext.RuntimeDelegate.HeaderDelegate if one is available via jakarta.ws.rs.ext.RuntimeDelegate#createHeaderDelegate(java.lang.Class) for the class of the value or using the values toString method if a header delegate is not available. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:701 | boolean | jakarta.ws.rs.container.ContainerResponseContext.hasEntity
+ | Check if there is an entity available in the response. The method returns true if the entity is present, returns false otherwise. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:702 | boolean | jakarta.ws.rs.container.ContainerResponseContext.hasLink
+
+ (
+ String
+ )
+ | Check if link for relation exists. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:703 | void | jakarta.ws.rs.container.ContainerResponseContext.setEntity
+
+ (
+ Object
+ , Annotation[]
+ , 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 jakarta.ws.rs.core.GenericEntity if preservation of its generic type is required. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:704 | void | jakarta.ws.rs.container.ContainerResponseContext.setEntityStream
+
+ (
+ OutputStream
+ )
+ | Set a new entity output stream. The JAX-RS runtime is responsible for closing the output stream. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:705 | void | jakarta.ws.rs.container.ContainerResponseContext.setStatus
+
+ (
+ int
+ )
+ | Set a new response status code. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:706 | void | jakarta.ws.rs.container.ContainerResponseContext.setStatusInfo
+
+ (
+ StatusType
+ )
+ | Set the complete status information (status code and reason phrase) associated with the response. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:707 | void | jakarta.ws.rs.container.ContainerResponseFilter.filter
+
+ (
+ ContainerRequestContext
+ , ContainerResponseContext
+ )
+ | Filter method called after a response has been provided for a request (either by a ContainerRequestFilter 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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:708 | void | jakarta.ws.rs.container.ContainerResponseFilter.filter
+
+ (
+ ContainerRequestContext
+ , ContainerResponseContext
+ )
+ throws
+ IOException
+ | if an I/O exception occurs. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:710 | Object | jakarta.ws.rs.container.ResourceContext.getResource
+
+ (
+ Class
+ )
+ | 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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:721 | Class | jakarta.ws.rs.container.ResourceInfo.getResourceClass
+ | Get the resource class that is the target of a request, or null if this information is not available. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:722 | Method | jakarta.ws.rs.container.ResourceInfo.getResourceMethod
+ | Get the resource method that is the target of a request, or null if this information is not available. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:725 | void | jakarta.ws.rs.container.TimeoutHandler.handleTimeout
+
+ (
+ 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 jakarta.ws.rs.container.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 AsyncResponse#setTimeout(long, java.util.concurrent.TimeUnit) 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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:726 | AbstractMultivaluedMap | jakarta.ws.rs.core.AbstractMultivaluedMap.AbstractMultivaluedMap
+
+ (
+ Map
+ )
+ | Initialize the backing store in the abstract parent multivalued map implementation. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:727 | void | jakarta.ws.rs.core.AbstractMultivaluedMap.add
+
+ (
+ Object
+ , Object
+ )
+ | 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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:728 | void | jakarta.ws.rs.core.AbstractMultivaluedMap.addAll
+
+ (
+ Object
+ , Object[]
+ )
+ | 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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:729 | void | jakarta.ws.rs.core.AbstractMultivaluedMap.addAll
+
+ (
+ Object
+ , List
+ )
+ | 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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:730 | void | jakarta.ws.rs.core.AbstractMultivaluedMap.addFirst
+
+ (
+ Object
+ , Object
+ )
+ | 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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:731 | void | jakarta.ws.rs.core.AbstractMultivaluedMap.clear
+ |
+
+ | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:732 | boolean | jakarta.ws.rs.core.AbstractMultivaluedMap.containsKey
+
+ (
+ Object
+ )
+ |
+
+ | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:733 | boolean | jakarta.ws.rs.core.AbstractMultivaluedMap.containsValue
+
+ (
+ Object
+ )
+ |
+
+ | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:734 | Set | jakarta.ws.rs.core.AbstractMultivaluedMap.entrySet
+ |
+
+ | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:736 | boolean | jakarta.ws.rs.core.AbstractMultivaluedMap.equalsIgnoreValueOrder
+
+ (
+ 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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:737 | List | jakarta.ws.rs.core.AbstractMultivaluedMap.get
+
+ (
+ Object
+ )
+ |
+
+ | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:738 | Object | jakarta.ws.rs.core.AbstractMultivaluedMap.getFirst
+
+ (
+ Object
+ )
+ | A shortcut to get the first value of the supplied key. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:740 | boolean | jakarta.ws.rs.core.AbstractMultivaluedMap.isEmpty
+ |
+
+ | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:741 | Set | jakarta.ws.rs.core.AbstractMultivaluedMap.keySet
+ |
+
+ | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:742 | List | jakarta.ws.rs.core.AbstractMultivaluedMap.put
+
+ (
+ Object
+ , List
+ )
+ |
+
+ | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:743 | void | jakarta.ws.rs.core.AbstractMultivaluedMap.putAll
+
+ (
+ Map
+ )
+ |
+
+ | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:744 | void | jakarta.ws.rs.core.AbstractMultivaluedMap.putSingle
+
+ (
+ Object
+ , Object
+ )
+ | 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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:745 | List | jakarta.ws.rs.core.AbstractMultivaluedMap.remove
+
+ (
+ Object
+ )
+ |
+
+ | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:746 | int | jakarta.ws.rs.core.AbstractMultivaluedMap.size
+ |
+
+ | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:747 | String | jakarta.ws.rs.core.AbstractMultivaluedMap.toString
+ |
+
+ | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:748 | Collection | jakarta.ws.rs.core.AbstractMultivaluedMap.values
+ |
+
+ | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:754 | Configurable | jakarta.ws.rs.core.Configurable.register
+
+ (
+ Class
+ )
+ | Register a class of a custom JAX-RS component (such as an extension provider or a jakarta.ws.rs.core.Feature 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 jakarta.ws.rs.container.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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:755 | Configurable | jakarta.ws.rs.core.Configurable.register
+
+ (
+ Class
+ , int
+ )
+ | Register a class of a custom JAX-RS component (such as an extension provider or a jakarta.ws.rs.core.Feature 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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:756 | Configurable | jakarta.ws.rs.core.Configurable.register
+
+ (
+ Class
+ , Class[]
+ )
+ | Register a class of a custom JAX-RS component (such as an extension provider or a jakarta.ws.rs.core.Feature 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 Class#isAssignableFrom(Class) assignable from the registered component class MUST be ignored and implementations SHOULD raise a warning to inform users about the ignored contract(s). | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:759 | Configurable | jakarta.ws.rs.core.Configurable.register
+
+ (
+ Object
+ , int
+ )
+ | Register an instance of a custom JAX-RS component (such as an extension provider or a jakarta.ws.rs.core.Feature 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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:760 | Configurable | jakarta.ws.rs.core.Configurable.register
+
+ (
+ Object
+ , Class[]
+ )
+ | Register an instance of a custom JAX-RS component (such as an extension provider or a jakarta.ws.rs.core.Feature 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 Class#isAssignableFrom(Class) assignable from the registered component class MUST be ignored and implementations SHOULD raise a warning to inform users about the ignored contract(s). | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:765 | MultivaluedMap | jakarta.ws.rs.core.Form.asMap
+ | Returns multivalued map representation of the form. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:766 | Form | jakarta.ws.rs.core.Form.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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:767 | Form | jakarta.ws.rs.core.Form.Form
+
+ (
+ String
+ , String
+ )
+ | 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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:768 | Form | jakarta.ws.rs.core.Form.Form
+
+ (
+ MultivaluedMap
+ )
+ | 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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:769 | Form | jakarta.ws.rs.core.Form.param
+
+ (
+ String
+ , String
+ )
+ | Adds a new value to the specified form parameter. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:770 | boolean | jakarta.ws.rs.core.GenericEntity.equals
+
+ (
+ Object
+ )
+ |
+
+ | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:771 | int | jakarta.ws.rs.core.GenericEntity.hashCode
+ |
+
+ | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:772 | String | jakarta.ws.rs.core.GenericEntity.toString
+ |
+
+ | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:773 | boolean | jakarta.ws.rs.core.GenericType.equals
+
+ (
+ Object
+ )
+ |
+
+ | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:774 | GenericType | jakarta.ws.rs.core.GenericType.GenericType
+
+ (
+ Type
+ )
+ | Constructs a new generic type, supplying the generic type information and deriving the class. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:775 | Class | jakarta.ws.rs.core.GenericType.getRawType
+ | Returns the object representing the class or interface that declared the type represented by this generic type instance. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:776 | Type | jakarta.ws.rs.core.GenericType.getType
+ | Retrieve the type represented by the generic type instance. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:777 | int | jakarta.ws.rs.core.GenericType.hashCode
+ |
+
+ | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:778 | String | jakarta.ws.rs.core.GenericType.toString
+ |
+
+ | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:779 | Date | jakarta.ws.rs.core.HttpHeaders.getDate
+ | Get message date. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:781 | int | jakarta.ws.rs.core.HttpHeaders.getLength
+ | Get Content-Length value. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:783 | Builder | jakarta.ws.rs.core.Link.fromLink
+
+ (
+ Link
+ )
+ | Create a new builder instance initialized from another link. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:788 | Builder | jakarta.ws.rs.core.Link.fromUri
+
+ (
+ URI
+ )
+ | Create a new builder instance initialized from an existing URI. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:790 | Builder | jakarta.ws.rs.core.Link.fromUri
+
+ (
+ String
+ )
+ | Create a new builder instance initialized from an existing URI represented as a string. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:792 | Map | jakarta.ws.rs.core.Link.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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:793 | String | jakarta.ws.rs.core.Link.getRel
+ | Returns the value associated with the link rel param, or null if this param is not specified. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:794 | String | jakarta.ws.rs.core.Link.getTitle
+ | Returns the value associated with the link title param, or null if this param is not specified. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:795 | String | jakarta.ws.rs.core.Link.getType
+ | Returns the value associated with the link type param, or null if this param is not specified. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:796 | URI | jakarta.ws.rs.core.Link.getUri
+ | Returns the underlying URI associated with this link. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:797 | UriBuilder | jakarta.ws.rs.core.Link.getUriBuilder
+ | Convenience method that returns a jakarta.ws.rs.core.UriBuilder initialized with this link's underlying URI. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:799 | Link | jakarta.ws.rs.core.Link.Link
+ |
+
+ | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:800 | String | jakarta.ws.rs.core.Link.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, ; title="employee"; rel="manager friend" | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:804 | Link | jakarta.ws.rs.core.Link.Builder.build
+
+ (
+ Object[]
+ )
+ | 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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:807 | Builder | jakarta.ws.rs.core.Link.Builder.param
+
+ (
+ String
+ , String
+ )
+ | 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...). | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:809 | Builder | jakarta.ws.rs.core.Link.Builder.rel
+
+ (
+ String
+ )
+ | 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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:810 | Builder | jakarta.ws.rs.core.Link.Builder.title
+
+ (
+ String
+ )
+ | Convenience method to set a title on this link. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:811 | Builder | jakarta.ws.rs.core.Link.Builder.type
+
+ (
+ String
+ )
+ | Convenience method to set a type on this link. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:812 | Builder | jakarta.ws.rs.core.Link.Builder.uri
+
+ (
+ URI
+ )
+ | Set underlying URI template for the link being constructed. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:813 | Builder | jakarta.ws.rs.core.Link.Builder.uri
+
+ (
+ String
+ )
+ | Set underlying string representing URI template for the link being constructed. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:826 | MediaType | jakarta.ws.rs.core.MediaType.withCharset
+
+ (
+ String
+ )
+ | Create a new MediaType instance with the same type, subtype and parameters copied from the original instance and the supplied parameter. RAMETER parameter. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:827 | MultivaluedHashMap | jakarta.ws.rs.core.MultivaluedHashMap.MultivaluedHashMap
+ | Constructs an empty multivalued hash map with the default initial capacity (16) and the default load factor (0.75). | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:828 | MultivaluedHashMap | jakarta.ws.rs.core.MultivaluedHashMap.MultivaluedHashMap
+
+ (
+ int
+ )
+ | Constructs an empty multivalued hash map with the specified initial capacity and the default load factor (0.75). | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:829 | MultivaluedHashMap | jakarta.ws.rs.core.MultivaluedHashMap.MultivaluedHashMap
+
+ (
+ int
+ , float
+ )
+ | Constructs an empty multivalued hash map with the specified initial capacity and load factor. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:830 | MultivaluedHashMap | jakarta.ws.rs.core.MultivaluedHashMap.MultivaluedHashMap
+
+ (
+ MultivaluedMap
+ )
+ | 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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:831 | MultivaluedHashMap | jakarta.ws.rs.core.MultivaluedHashMap.MultivaluedHashMap
+
+ (
+ Map
+ )
+ | Constructs a new multivalued hash map with the same mappings as the specified single-valued Map . | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:832 | void | jakarta.ws.rs.core.MultivaluedMap.addAll
+
+ (
+ Object
+ , Object[]
+ )
+ | 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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:833 | void | jakarta.ws.rs.core.MultivaluedMap.addAll
+
+ (
+ Object
+ , List
+ )
+ | 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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:834 | void | jakarta.ws.rs.core.MultivaluedMap.addFirst
+
+ (
+ Object
+ , Object
+ )
+ | Add a value to the first position in the current list of values for the supplied key. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:835 | boolean | jakarta.ws.rs.core.MultivaluedMap.equalsIgnoreValueOrder
+
+ (
+ 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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:836 | ResponseBuilder | jakarta.ws.rs.core.Response.accepted
+ | Create a new ResponseBuilder with an ACCEPTED status. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:837 | ResponseBuilder | jakarta.ws.rs.core.Response.accepted
+
+ (
+ Object
+ )
+ | 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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:838 | boolean | jakarta.ws.rs.core.Response.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 #close() 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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:841 | void | jakarta.ws.rs.core.Response.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. #bufferEntity() 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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:843 | Set | jakarta.ws.rs.core.Response.getAllowedMethods
+ | Get the allowed HTTP methods from the Allow HTTP header. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:844 | Map | jakarta.ws.rs.core.Response.getCookies
+ | Get any new cookies set on the response message. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:845 | Date | jakarta.ws.rs.core.Response.getDate
+ | Get message date. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:847 | EntityTag | jakarta.ws.rs.core.Response.getEntityTag
+ | Get the entity tag. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:848 | MultivaluedMap | jakarta.ws.rs.core.Response.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 jakarta.ws.rs.ext.RuntimeDelegate.HeaderDelegate if one is available via jakarta.ws.rs.ext.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(). | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:849 | String | jakarta.ws.rs.core.Response.getHeaderString
+
+ (
+ String
+ )
+ | Get a message header as a single string value. Each single header value is converted to String using a jakarta.ws.rs.ext.RuntimeDelegate.HeaderDelegate if one is available via jakarta.ws.rs.ext.RuntimeDelegate#createHeaderDelegate(java.lang.Class) for the header value class or using its toString method if a header delegate is not available. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:850 | Locale | jakarta.ws.rs.core.Response.getLanguage
+ | Get the language of the message entity. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:851 | Date | jakarta.ws.rs.core.Response.getLastModified
+ | Get the last modified date. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:852 | int | jakarta.ws.rs.core.Response.getLength
+ | Get Content-Length value. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:853 | Link | jakarta.ws.rs.core.Response.getLink
+
+ (
+ String
+ )
+ | 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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:854 | Builder | jakarta.ws.rs.core.Response.getLinkBuilder
+
+ (
+ String
+ )
+ | Convenience method that returns a Link.Builder for the relation. See #getLink for more information. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:855 | Set | jakarta.ws.rs.core.Response.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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:856 | URI | jakarta.ws.rs.core.Response.getLocation
+ | Get the location. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:857 | MediaType | jakarta.ws.rs.core.Response.getMediaType
+ | Get the media type of the message entity. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:858 | StatusType | jakarta.ws.rs.core.Response.getStatusInfo
+ | Get the complete status information associated with the response. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:859 | MultivaluedMap | jakarta.ws.rs.core.Response.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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:860 | boolean | jakarta.ws.rs.core.Response.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 and 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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:862 | boolean | jakarta.ws.rs.core.Response.hasLink
+
+ (
+ String
+ )
+ | Check if link for relation exists. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:863 | Object | jakarta.ws.rs.core.Response.readEntity
+
+ (
+ Class
+ )
+ | Read the message entity input stream as an instance of specified Java type using a jakarta.ws.rs.ext.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 #bufferEntity() 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 java.io.InputStream input stream, this method automatically #close() 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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:866 | Object | jakarta.ws.rs.core.Response.readEntity
+
+ (
+ GenericType
+ )
+ | Read the message entity input stream as an instance of specified Java type using a jakarta.ws.rs.ext.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 #bufferEntity() 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 java.io.InputStream input stream, this method automatically #close() 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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:869 | Object | jakarta.ws.rs.core.Response.readEntity
+
+ (
+ Class
+ , Annotation[]
+ )
+ | Read the message entity input stream as an instance of specified Java type using a jakarta.ws.rs.ext.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 #bufferEntity() 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 java.io.InputStream input stream, this method automatically #close() 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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:872 | Object | jakarta.ws.rs.core.Response.readEntity
+
+ (
+ GenericType
+ , Annotation[]
+ )
+ | Read the message entity input stream as an instance of specified Java type using a jakarta.ws.rs.ext.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 #bufferEntity() 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 java.io.InputStream input stream, this method automatically #close() 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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:875 | ResponseBuilder | jakarta.ws.rs.core.Response.ResponseBuilder.allow
+
+ (
+ String[]
+ )
+ | Set the list of allowed methods for the resource. Any duplicate method names will be truncated to a single entry. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:876 | ResponseBuilder | jakarta.ws.rs.core.Response.ResponseBuilder.allow
+
+ (
+ Set
+ )
+ | Set the list of allowed methods for the resource. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:878 | ResponseBuilder | jakarta.ws.rs.core.Response.ResponseBuilder.encoding
+
+ (
+ String
+ )
+ | Set the message entity content encoding. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:879 | ResponseBuilder | jakarta.ws.rs.core.Response.ResponseBuilder.entity
+
+ (
+ Object
+ , Annotation[]
+ )
+ | 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 java.io.InputStream input stream. A specific entity media type can be set using one of the type(...) methods. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:880 | ResponseBuilder | jakarta.ws.rs.core.Response.ResponseBuilder.link
+
+ (
+ URI
+ , String
+ )
+ | Add a link header. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:881 | ResponseBuilder | jakarta.ws.rs.core.Response.ResponseBuilder.link
+
+ (
+ String
+ , String
+ )
+ | Add a link header. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:882 | ResponseBuilder | jakarta.ws.rs.core.Response.ResponseBuilder.links
+
+ (
+ Link[]
+ )
+ | Add one or more link headers. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:883 | ResponseBuilder | jakarta.ws.rs.core.Response.ResponseBuilder.replaceAll
+
+ (
+ MultivaluedMap
+ )
+ | Replaces all existing headers with the newly supplied headers. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:884 | ResponseBuilder | jakarta.ws.rs.core.Response.ResponseBuilder.variants
+
+ (
+ Variant[]
+ )
+ | Add a Vary header that lists the available variants. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:885 | Family | jakarta.ws.rs.core.Response.Status.Family.familyOf
+
+ (
+ int
+ )
+ | Get the response status family for the status code. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:886 | URI | jakarta.ws.rs.core.UriBuilder.build
+
+ (
+ Object[]
+ , boolean
+ )
+ | 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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:887 | URI | jakarta.ws.rs.core.UriBuilder.build
+
+ (
+ Object[]
+ , boolean
+ )
+ throws
+ IllegalArgumentException
+ | if there are any URI template parameters without a supplied value, or if a value is null. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:888 | URI | jakarta.ws.rs.core.UriBuilder.build
+
+ (
+ Object[]
+ , boolean
+ )
+ throws
+ UriBuilderException
+ | if a URI cannot be constructed based on the current state of the builder. | true |
+
+ | false |
+
+
+JAXRS:JAVADOC:889 | URI | jakarta.ws.rs.core.UriBuilder.buildFromMap
+
+ (
+ Map
+ , boolean
+ )
+ | 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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:890 | URI | jakarta.ws.rs.core.UriBuilder.buildFromMap
+
+ (
+ Map
+ , boolean
+ )
+ throws
+ IllegalArgumentException
+ | if there are any URI template parameters without a supplied value, or if a template parameter value is null. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:891 | URI | jakarta.ws.rs.core.UriBuilder.buildFromMap
+
+ (
+ Map
+ , boolean
+ )
+ throws
+ UriBuilderException
+ | if a URI cannot be constructed based on the current state of the builder. | true |
+
+ | false |
+
+
+JAXRS:JAVADOC:892 | UriBuilder | jakarta.ws.rs.core.UriBuilder.fromLink
+
+ (
+ Link
+ )
+ | Create a new instance initialized from a Link. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:894 | UriBuilder | jakarta.ws.rs.core.UriBuilder.fromMethod
+
+ (
+ Class
+ , String
+ )
+ | Create a new instance representing a relative URI initialized from a jakarta.ws.rs.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 jakarta.ws.rs.Path. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:896 | String | jakarta.ws.rs.core.UriBuilder.toTemplate
+ | Get the URI template string represented by this URI builder. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:897 | UriBuilder | jakarta.ws.rs.core.UriBuilder.uri
+
+ (
+ String
+ )
+ | Parses the uriTemplate string and copies the parsed components of the supplied URI to the UriBuilder replacing any existing values for those components. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:899 | String | jakarta.ws.rs.core.Variant.getLanguageString
+ | Get the string representation of the variant language, or null if no language has been set. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:900 | Variant | jakarta.ws.rs.core.Variant.Variant
+
+ (
+ MediaType
+ , String
+ , String
+ )
+ | Create a new instance of Variant. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:901 | Variant | jakarta.ws.rs.core.Variant.Variant
+
+ (
+ MediaType
+ , String
+ , String
+ , String
+ )
+ | Create a new instance of Variant. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:902 | Variant | jakarta.ws.rs.core.Variant.Variant
+
+ (
+ MediaType
+ , String
+ , String
+ , String
+ , String
+ )
+ | Create a new instance of Variant. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:903 | Annotation[] | jakarta.ws.rs.ext.InterceptorContext.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 java.lang.reflect.Method#getParameterAnnotations 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 java.lang.reflect.Method#getAnnotations() 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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:904 | Type | jakarta.ws.rs.ext.InterceptorContext.getGenericType
+ | Get the type of the object to be produced or written. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:905 | MediaType | jakarta.ws.rs.ext.InterceptorContext.getMediaType
+ | Get media type of HTTP entity. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:906 | Object | jakarta.ws.rs.ext.InterceptorContext.getProperty
+
+ (
+ String
+ )
+ | 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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:908 | Class | jakarta.ws.rs.ext.InterceptorContext.getType
+ | Get Java type supported by corresponding message body provider. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:909 | void | jakarta.ws.rs.ext.InterceptorContext.removeProperty
+
+ (
+ String
+ )
+ | Removes a property with the given name from the current request/response exchange context. After removal, subsequent calls to #getProperty 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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:910 | void | jakarta.ws.rs.ext.InterceptorContext.setAnnotations
+
+ (
+ Annotation[]
+ )
+ | 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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:911 | void | jakarta.ws.rs.ext.InterceptorContext.setGenericType
+
+ (
+ Type
+ )
+ | Update type of the object to be produced or written. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:912 | void | jakarta.ws.rs.ext.InterceptorContext.setMediaType
+
+ (
+ MediaType
+ )
+ | Update media type of HTTP entity. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:913 | void | jakarta.ws.rs.ext.InterceptorContext.setProperty
+
+ (
+ String
+ , 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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:914 | void | jakarta.ws.rs.ext.InterceptorContext.setType
+
+ (
+ Class
+ )
+ | Update Java type before calling message body provider. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:915 | Object | jakarta.ws.rs.ext.ParamConverter.fromString
+
+ (
+ String
+ )
+ | Parse the supplied value and create an instance of T. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:917 | String | jakarta.ws.rs.ext.ParamConverter.toString
+
+ (
+ Object
+ )
+ | 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. | false |
+
+ | true |
+
+
+JAXRS:JAVADOC:919 | ParamConverter | jakarta.ws.rs.ext.ParamConverterProvider.getConverter
+
+ (
+ Class
+ , Type
+ , Annotation[]
+ )
+ | Obtain a ParamConverter that can provide from/to string conversion for an instance of a particular Java type. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:920 | Object | jakarta.ws.rs.ext.ReaderInterceptor.aroundReadFrom
+
+ (
+ ReaderInterceptorContext
+ )
+ | Interceptor method wrapping calls to MessageBodyReader#readFrom method. The parameters of the wrapped method called are available from context. Implementations of this method SHOULD explicitly call ReaderInterceptorContext#proceed to invoke the next interceptor in the chain, and ultimately the wrapped MessageBodyReader#readFrom method. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:921 | Object | jakarta.ws.rs.ext.ReaderInterceptor.aroundReadFrom
+
+ (
+ ReaderInterceptorContext
+ )
+ throws
+ IOException
+ | if an IO error arises or is thrown by the wrapped MessageBodyReader.readFrom method. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:922 | Object | jakarta.ws.rs.ext.ReaderInterceptor.aroundReadFrom
+
+ (
+ ReaderInterceptorContext
+ )
+ throws
+ WebApplicationException
+ | thrown by the wrapped MessageBodyReader.readFrom method. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:923 | MultivaluedMap | jakarta.ws.rs.ext.ReaderInterceptorContext.getHeaders
+ | Get mutable map of HTTP headers. Note that while the headers are mutable, a ReaderInterceptor reader interceptor should typically roll-back any header modifications once the call to #proceed() context.proceed() returns, to avoid externally visible side-effects of the interceptor invocation. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:924 | InputStream | jakarta.ws.rs.ext.ReaderInterceptorContext.getInputStream
+ | Get the input stream of the object to be read. The JAX-RS runtime is responsible for closing the input stream. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:925 | Object | jakarta.ws.rs.ext.ReaderInterceptorContext.proceed
+ | Proceed to the next interceptor in the chain. Return the result of the next interceptor invoked. Interceptors MUST explicitly call this method to continue the execution chain; the call to this method in the last interceptor of the chain will invoke the wrapped jakarta.ws.rs.ext.MessageBodyReader#readFrom. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:926 | Object | jakarta.ws.rs.ext.ReaderInterceptorContext.proceed
+ throws
+ IOException
+ | if an IO error arises or is thrown by the wrapped MessageBodyReader.readFrom method. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:927 | void | jakarta.ws.rs.ext.ReaderInterceptorContext.setInputStream
+
+ (
+ InputStream
+ )
+ | Set the input stream of the object to be read. For example, by wrapping it with another input stream. The JAX-RS runtime is responsible for closing the input stream that is set. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:928 | HeaderDelegate | jakarta.ws.rs.ext.RuntimeDelegate.createHeaderDelegate
+
+ (
+ Class
+ )
+ throws
+ IllegalArgumentException
+ | if type is null. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:930 | void | jakarta.ws.rs.ext.WriterInterceptor.aroundWriteTo
+
+ (
+ WriterInterceptorContext
+ )
+ | Interceptor method wrapping calls to MessageBodyWriter#writeTo method. The parameters of the wrapped method called are available from context. Implementations of this method SHOULD explicitly call WriterInterceptorContext#proceed to invoke the next interceptor in the chain, and ultimately the wrapped MessageBodyWriter.writeTo method. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:931 | void | jakarta.ws.rs.ext.WriterInterceptor.aroundWriteTo
+
+ (
+ WriterInterceptorContext
+ )
+ throws
+ IOException
+ | if an IO error arises or is thrown by the wrapped MessageBodyWriter.writeTo method. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:932 | void | jakarta.ws.rs.ext.WriterInterceptor.aroundWriteTo
+
+ (
+ WriterInterceptorContext
+ )
+ throws
+ WebApplicationException
+ | thrown by the wrapped MessageBodyWriter.writeTo method. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:933 | Object | jakarta.ws.rs.ext.WriterInterceptorContext.getEntity
+ | Get object to be written as HTTP entity. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:934 | MultivaluedMap | jakarta.ws.rs.ext.WriterInterceptorContext.getHeaders
+ | Get mutable map of HTTP headers. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:935 | OutputStream | jakarta.ws.rs.ext.WriterInterceptorContext.getOutputStream
+ | Get the output stream for the object to be written. The JAX-RS runtime is responsible for closing the output stream. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:936 | void | jakarta.ws.rs.ext.WriterInterceptorContext.proceed
+ | Proceed to the next interceptor in the chain. Interceptors MUST explicitly call this method to continue the execution chain; the call to this method in the last interceptor of the chain will invoke the wrapped jakarta.ws.rs.ext.MessageBodyWriter#writeTo method. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:937 | void | jakarta.ws.rs.ext.WriterInterceptorContext.proceed
+ throws
+ IOException
+ | if an IO error arises or is thrown by the wrapped MessageBodyWriter.writeTo method. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:938 | void | jakarta.ws.rs.ext.WriterInterceptorContext.setEntity
+
+ (
+ Object
+ )
+ | Update object to be written as HTTP entity. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:939 | void | jakarta.ws.rs.ext.WriterInterceptorContext.setOutputStream
+
+ (
+ OutputStream
+ )
+ | Set a new output stream for the object to be written. For example, by wrapping it with another output stream. The JAX-RS runtime is responsible for closing the output stream that is set. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:940 | WebTarget | jakarta.ws.rs.client.WebTarget.resolveTemplate
+
+ (
+ String
+ , Object
+ )
+ | 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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:942 | WebTarget | jakarta.ws.rs.client.WebTarget.resolveTemplate
+
+ (
+ String
+ , Object
+ , boolean
+ )
+ | 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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:944 | WebTarget | jakarta.ws.rs.client.WebTarget.resolveTemplateFromEncoded
+
+ (
+ String
+ , Object
+ )
+ | 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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:946 | WebTarget | jakarta.ws.rs.client.WebTarget.resolveTemplates
+
+ (
+ Map
+ )
+ | 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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:948 | WebTarget | jakarta.ws.rs.client.WebTarget.resolveTemplates
+
+ (
+ Map
+ , boolean
+ )
+ | 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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:950 | WebTarget | jakarta.ws.rs.client.WebTarget.resolveTemplatesFromEncoded
+
+ (
+ Map
+ )
+ | 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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:955 | Object | jakarta.ws.rs.container.ResourceContext.initResource
+
+ (
+ Object
+ )
+ | 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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:956 | List | jakarta.ws.rs.core.Link.getRels
+ | Returns the value associated with the link rel param as a list of strings or the empty list if rel is not defined. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:957 | UriBuilder | jakarta.ws.rs.core.UriBuilder.resolveTemplate
+
+ (
+ String
+ , Object
+ )
+ | 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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:959 | UriBuilder | jakarta.ws.rs.core.UriBuilder.resolveTemplate
+
+ (
+ String
+ , Object
+ , boolean
+ )
+ | 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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:961 | UriBuilder | jakarta.ws.rs.core.UriBuilder.resolveTemplateFromEncoded
+
+ (
+ String
+ , Object
+ )
+ | 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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:963 | UriBuilder | jakarta.ws.rs.core.UriBuilder.resolveTemplates
+
+ (
+ Map
+ )
+ | 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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:965 | UriBuilder | jakarta.ws.rs.core.UriBuilder.resolveTemplates
+
+ (
+ Map
+ , boolean
+ )
+ | 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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:966 | UriBuilder | jakarta.ws.rs.core.UriBuilder.resolveTemplates
+
+ (
+ Map
+ , boolean
+ )
+ throws
+ IllegalArgumentException
+ | if the name-value map or any of the names or values in the map is null. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:967 | UriBuilder | jakarta.ws.rs.core.UriBuilder.resolveTemplatesFromEncoded
+
+ (
+ Map
+ )
+ | 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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:969 | RuntimeType | jakarta.ws.rs.ConstrainedTo.value
+ | Define the RuntimeType constraint type to be placed on a JAX-RS provider. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:970 | ForbiddenException | jakarta.ws.rs.ForbiddenException.ForbiddenException
+ | Construct a new "forbidden" exception. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:971 | ForbiddenException | jakarta.ws.rs.ForbiddenException.ForbiddenException
+
+ (
+ Response
+ )
+ | Construct a new "forbidden" exception. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:972 | ForbiddenException | jakarta.ws.rs.ForbiddenException.ForbiddenException
+
+ (
+ Throwable
+ )
+ | Construct a new "forbidden" exception. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:973 | ForbiddenException | jakarta.ws.rs.ForbiddenException.ForbiddenException
+
+ (
+ Response
+ , Throwable
+ )
+ | Construct a new "forbidden" exception. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:974 | RuntimeType | jakarta.ws.rs.RuntimeType.valueOf
+
+ (
+ String
+ )
+ |
+
+ | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:975 | RuntimeType[] | jakarta.ws.rs.RuntimeType.values
+ |
+
+ | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:977 | Configuration | jakarta.ws.rs.client.ClientRequestContext.getConfiguration
+ | Get the immutable configuration of the request. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:978 | Collection | jakarta.ws.rs.client.ClientRequestContext.getPropertyNames
+ | Returns an immutable Collection collection containing the property names available within the context of the current request/response exchange context. Use the #getProperty method with a property name to get the value of a property. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:979 | void | jakarta.ws.rs.client.InvocationCallback.failed
+
+ (
+ Throwable
+ )
+ | Called when the invocation has failed for any reason. Note that the provided Throwable may be a jakarta.ws.rs.ProcessingException in case the invocation processing failure has been caused by a client-side runtime component error. The Throwable may also be a jakarta.ws.rs.WebApplicationException or one of its subclasses in case the response status code is not jakarta.ws.rs.core.Response.Status.Family#SUCCESSFUL successful and the generic callback type is not jakarta.ws.rs.core.Response. In case a processing of a properly received response fails, the wrapped processing exception will be of ResponseProcessingException type and will contain the jakarta.ws.rs.core.Response instance whose processing has failed. A java.util.concurrent.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 jakarta.ws.rs.core.Response instance will be automatically closed by the runtime. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:980 | boolean | jakarta.ws.rs.container.AsyncResponse.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 jakarta.ws.rs.core.Response.Status#SERVICE_UNAVAILABLE 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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:981 | boolean | jakarta.ws.rs.container.AsyncResponse.cancel
+
+ (
+ int
+ )
+ | 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 jakarta.ws.rs.core.Response.Status#SERVICE_UNAVAILABLE 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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:982 | boolean | jakarta.ws.rs.container.AsyncResponse.cancel
+
+ (
+ Date
+ )
+ | 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 jakarta.ws.rs.core.Response.Status#SERVICE_UNAVAILABLE 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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:983 | boolean | jakarta.ws.rs.container.AsyncResponse.resume
+
+ (
+ Object
+ )
+ | 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 jakarta.ws.rs.HttpMethod JAX-RS resource method. The asynchronous response must be still in a #isSuspended() 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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:984 | boolean | jakarta.ws.rs.container.AsyncResponse.resume
+
+ (
+ Throwable
+ )
+ | Resume the suspended request processing using the provided throwable. For the provided throwable same rules apply as for an exception thrown by a jakarta.ws.rs.HttpMethod 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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:986 | Collection | jakarta.ws.rs.container.ContainerRequestContext.getPropertyNames
+ | Returns an immutable java.util.Collection collection containing the property names available within the context of the current request/response exchange context. Use the #getProperty 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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:987 | void | jakarta.ws.rs.container.DynamicFeature.configure
+
+ (
+ ResourceInfo
+ , FeatureContext
+ )
+ | A callback method called by the JAX-RS runtime during the application deployment to register provider instances or classes in a jakarta.ws.rs.core.Configuration runtime configuration scope of a particular jakarta.ws.rs.HttpMethod 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: ContainerRequestFilterContainerResponseFilterReaderInterceptorWriterInterceptorjakarta.ws.rs.core.Feature 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 java.util.logging.Level#WARNING 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 jakarta.ws.rs.HttpMethod 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 ResourceInfo resource information. The responsibility of the feature is to properly update the supplied configuration context. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:988 | Configuration | jakarta.ws.rs.core.Configurable.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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:989 | Configurable | jakarta.ws.rs.core.Configurable.register
+
+ (
+ Class
+ , Map
+ )
+ | Register a class of a custom JAX-RS component (such as an extension provider or a jakarta.ws.rs.core.Feature 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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:990 | Configurable | jakarta.ws.rs.core.Configurable.register
+
+ (
+ Object
+ , Map
+ )
+ | Register an instance of a custom JAX-RS component (such as an extension provider or a jakarta.ws.rs.core.Feature 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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:993 | Map | jakarta.ws.rs.core.Configuration.getContracts
+
+ (
+ Class
+ )
+ | 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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:995 | Map | jakarta.ws.rs.core.Configuration.getProperties
+ | Get the immutable bag of configuration properties. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:996 | Object | jakarta.ws.rs.core.Configuration.getProperty
+
+ (
+ String
+ )
+ | Get the value for the property with a given name. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:997 | Collection | jakarta.ws.rs.core.Configuration.getPropertyNames
+ | Returns an immutable java.util.Collection collection containing the property names available within the context of the current configuration instance. Use the #getProperty method with a property name to get the value of a property. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:998 | RuntimeType | jakarta.ws.rs.core.Configuration.getRuntimeType
+ | Get the runtime type of this configuration context. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:999 | boolean | jakarta.ws.rs.core.Configuration.isEnabled
+
+ (
+ Feature
+ )
+ | Check if a particular Feature 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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1000 | boolean | jakarta.ws.rs.core.Configuration.isEnabled
+
+ (
+ Class
+ )
+ | Check if a Feature 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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1001 | boolean | jakarta.ws.rs.core.Configuration.isRegistered
+
+ (
+ Object
+ )
+ | Check if a particular JAX-RS component instance (such as providers or Feature 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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1002 | boolean | jakarta.ws.rs.core.Configuration.isRegistered
+
+ (
+ Class
+ )
+ | 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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1003 | boolean | jakarta.ws.rs.core.Feature.configure
+
+ (
+ FeatureContext
+ )
+ | 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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1005 | Builder | jakarta.ws.rs.core.Link.fromUriBuilder
+
+ (
+ UriBuilder
+ )
+ | Create a new builder instance initialized from a URI builder. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1006 | Builder | jakarta.ws.rs.core.Link.Builder.uriBuilder
+
+ (
+ UriBuilder
+ )
+ | Set underlying URI builder representing the URI template for the link being constructed. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1007 | Collection | jakarta.ws.rs.ext.InterceptorContext.getPropertyNames
+ | Returns an immutable java.util.Collection collection containing the property names available within the context of the current request/response exchange context. Use the #getProperty 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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1008 | Object | jakarta.ws.rs.ext.ReaderInterceptorContext.proceed
+ throws
+ WebApplicationException
+ | thrown by the wrapped MessageBodyReader.readFrom method. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1009 | void | jakarta.ws.rs.ext.WriterInterceptorContext.proceed
+ throws
+ WebApplicationException
+ | thrown by the wrapped MessageBodyWriter.writeTo method. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1010 | ProcessingException | jakarta.ws.rs.ProcessingException.ProcessingException
+
+ (
+ Throwable
+ )
+ | 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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1011 | ProcessingException | jakarta.ws.rs.ProcessingException.ProcessingException
+
+ (
+ String
+ , Throwable
+ )
+ | 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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1012 | ProcessingException | jakarta.ws.rs.ProcessingException.ProcessingException
+
+ (
+ String
+ )
+ | 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 #initCause. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1013 | SSLContext | jakarta.ws.rs.client.Client.getSslContext
+ | Get the SSL context configured to be used with the current client run-time. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1014 | Client | jakarta.ws.rs.client.ClientBuilder.build
+ | Build a new client instance using all the configuration previously specified in this client builder. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1015 | ClientBuilder | jakarta.ws.rs.client.ClientBuilder.hostnameVerifier
+
+ (
+ HostnameVerifier
+ )
+ | Set the hostname verifier to be used by the client to verify the endpoint's hostname against it's identification information. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1016 | ClientBuilder | jakarta.ws.rs.client.ClientBuilder.keyStore
+
+ (
+ KeyStore
+ , char[]
+ )
+ | 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 #sslContext(javax.net.ssl.SSLContext) 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). | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1017 | ClientBuilder | jakarta.ws.rs.client.ClientBuilder.keyStore
+
+ (
+ KeyStore
+ , String
+ )
+ | 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 #sslContext(javax.net.ssl.SSLContext) 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). | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1018 | ClientBuilder | jakarta.ws.rs.client.ClientBuilder.newBuilder
+ | Create a new ClientBuilder instance using the default client builder implementation class provided by the JAX-RS implementation provider. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1019 | Client | jakarta.ws.rs.client.ClientBuilder.newClient
+ | Create a new Client instance using the default client builder implementation class provided by the JAX-RS implementation provider. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1020 | Client | jakarta.ws.rs.client.ClientBuilder.newClient
+
+ (
+ Configuration
+ )
+ | Create a new custom-configured Client instance using the default client builder implementation class provided by the JAX-RS implementation provider. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1021 | ClientBuilder | jakarta.ws.rs.client.ClientBuilder.sslContext
+
+ (
+ SSLContext
+ )
+ | Set the SSL context that will be used when creating secured transport connections to server endpoints from WebTarget 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 #keyStore(java.security.KeyStore, char[]) key store or #trustStore(java.security.KeyStore) trust store values previously specified. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1022 | ClientBuilder | jakarta.ws.rs.client.ClientBuilder.trustStore
+
+ (
+ KeyStore
+ )
+ | 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 #sslContext(javax.net.ssl.SSLContext) 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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1023 | Builder | jakarta.ws.rs.client.Invocation.Builder.accept
+
+ (
+ String[]
+ )
+ | Add the accepted response media types. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1024 | Builder | jakarta.ws.rs.client.Invocation.Builder.accept
+
+ (
+ MediaType[]
+ )
+ | Add the accepted response media types. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1025 | Builder | jakarta.ws.rs.client.Invocation.Builder.acceptEncoding
+
+ (
+ String[]
+ )
+ | Add acceptable encodings. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1026 | Response | jakarta.ws.rs.client.ResponseProcessingException.getResponse
+ | Get the HTTP response for which the processing has failed. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1027 | ResponseProcessingException | jakarta.ws.rs.client.ResponseProcessingException.ResponseProcessingException
+
+ (
+ Response
+ , Throwable
+ )
+ | Constructs a new JAX-RS runtime response processing exception for a specific Response 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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1028 | ResponseProcessingException | jakarta.ws.rs.client.ResponseProcessingException.ResponseProcessingException
+
+ (
+ Response
+ , String
+ , Throwable
+ )
+ | 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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1029 | ResponseProcessingException | jakarta.ws.rs.client.ResponseProcessingException.ResponseProcessingException
+
+ (
+ Response
+ , String
+ )
+ | 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 #initCause. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1030 | Collection | jakarta.ws.rs.container.AsyncResponse.register
+
+ (
+ Class
+ )
+ | Register an asynchronous processing lifecycle callback class to receive lifecycle events for the asynchronous response based on the implemented callback interfaces. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1031 | Map | jakarta.ws.rs.container.AsyncResponse.register
+
+ (
+ Class
+ , Class[]
+ )
+ | Register asynchronous processing lifecycle callback classes to receive lifecycle events for the asynchronous response based on the implemented callback interfaces. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1032 | Collection | jakarta.ws.rs.container.AsyncResponse.register
+
+ (
+ Object
+ )
+ | Register an asynchronous processing lifecycle callback instance to receive lifecycle events for the asynchronous response based on the implemented callback interfaces. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1033 | Map | jakarta.ws.rs.container.AsyncResponse.register
+
+ (
+ Object
+ , Object[]
+ )
+ | Register an asynchronous processing lifecycle callback instances to receive lifecycle events for the asynchronous response based on the implemented callback interfaces. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1034 | boolean | jakarta.ws.rs.container.AsyncResponse.setTimeout
+
+ (
+ long
+ , TimeUnit
+ )
+ | Set/update the suspend timeout. The new suspend timeout values override any timeout value previously specified. The asynchronous response must be still in a #isSuspended() suspended state for this method to succeed. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1035 | Map | jakarta.ws.rs.core.Application.getProperties
+ | Get a map of custom application-wide properties. The returned properties are reflected in the application Configuration 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 and Servlet values may be used to extend or override values of the properties programmatically returned by this method. The default implementation returns an empty set. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1036 | Configurable | jakarta.ws.rs.core.Configurable.property
+
+ (
+ String
+ , Object
+ )
+ | 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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1038 | Builder | jakarta.ws.rs.core.Link.fromPath
+
+ (
+ String
+ )
+ | Convenience method to build a link from a path. Equivalent to fromUriBuilder(UriBuilder.fromPath(path)). | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1042 | Builder | jakarta.ws.rs.core.Link.Builder.link
+
+ (
+ Link
+ )
+ | Initialize builder using another link. Sets underlying URI and copies all parameters. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1044 | Date | jakarta.ws.rs.core.NewCookie.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 #getMaxAge() Max-Age to control cookie expiration, however some browsers do not understand Max-Age, in which case setting Expires parameter may be necessary. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1045 | boolean | jakarta.ws.rs.core.NewCookie.isHttpOnly
+ | Returns true if this cookie contains the HttpOnly attribute. This means that the cookie should not be accessible to scripting engines, like javascript. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1049 | URI | jakarta.ws.rs.core.UriInfo.relativize
+
+ (
+ URI
+ )
+ | Relativize a URI with respect to the current request URI. Relativization works as follows: If the URI to relativize is already relative, it is first resolved using #resolve(java.net.URI). 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. 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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1051 | URI | jakarta.ws.rs.core.UriInfo.resolve
+
+ (
+ 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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1053 | Builder | jakarta.ws.rs.ext.RuntimeDelegate.createLinkBuilder
+ | Create a new instance of a jakarta.ws.rs.core.Link.Builder. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1054 | Link | jakarta.ws.rs.core.Link.Builder.buildRelativized
+
+ (
+ URI
+ , Object[]
+ )
+ | 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 Link.Builder#build(java.lang.Object[]). Note that a base URI can be set on a relative link using Link.Builder#baseUri(java.net.URI). The state of the builder is unaffected; this method may be called multiple times on the same builder instance. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1056 | BadRequestException | jakarta.ws.rs.BadRequestException.BadRequestException
+
+ (
+ String
+ )
+ | Construct a new bad client request exception. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1057 | BadRequestException | jakarta.ws.rs.BadRequestException.BadRequestException
+
+ (
+ String
+ , Response
+ )
+ | Construct a new bad client request exception. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1058 | BadRequestException | jakarta.ws.rs.BadRequestException.BadRequestException
+
+ (
+ String
+ , Throwable
+ )
+ | Construct a new bad client request exception. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1059 | BadRequestException | jakarta.ws.rs.BadRequestException.BadRequestException
+
+ (
+ String
+ , Response
+ , Throwable
+ )
+ | Construct a new bad client request exception. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1060 | ClientErrorException | jakarta.ws.rs.ClientErrorException.ClientErrorException
+
+ (
+ String
+ , Status
+ )
+ | Construct a new client error exception. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1061 | ClientErrorException | jakarta.ws.rs.ClientErrorException.ClientErrorException
+
+ (
+ String
+ , int
+ )
+ | Construct a new client error exception. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1062 | ClientErrorException | jakarta.ws.rs.ClientErrorException.ClientErrorException
+
+ (
+ String
+ , Response
+ )
+ | Construct a new client error exception. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1063 | ClientErrorException | jakarta.ws.rs.ClientErrorException.ClientErrorException
+
+ (
+ String
+ , Status
+ , Throwable
+ )
+ | Construct a new client error exception. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1064 | ClientErrorException | jakarta.ws.rs.ClientErrorException.ClientErrorException
+
+ (
+ String
+ , int
+ , Throwable
+ )
+ | Construct a new client error exception. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1065 | ClientErrorException | jakarta.ws.rs.ClientErrorException.ClientErrorException
+
+ (
+ String
+ , Response
+ , Throwable
+ )
+ | Construct a new client error exception. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1066 | ForbiddenException | jakarta.ws.rs.ForbiddenException.ForbiddenException
+
+ (
+ String
+ )
+ | Construct a new "forbidden" exception. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1067 | ForbiddenException | jakarta.ws.rs.ForbiddenException.ForbiddenException
+
+ (
+ String
+ , Response
+ )
+ | Construct a new "forbidden" exception. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1068 | ForbiddenException | jakarta.ws.rs.ForbiddenException.ForbiddenException
+
+ (
+ String
+ , Throwable
+ )
+ | Construct a new "forbidden" exception. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1069 | ForbiddenException | jakarta.ws.rs.ForbiddenException.ForbiddenException
+
+ (
+ String
+ , Response
+ , Throwable
+ )
+ | Construct a new "forbidden" exception. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1070 | InternalServerErrorException | jakarta.ws.rs.InternalServerErrorException.InternalServerErrorException
+
+ (
+ String
+ )
+ | Construct a new internal server error exception. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1071 | InternalServerErrorException | jakarta.ws.rs.InternalServerErrorException.InternalServerErrorException
+
+ (
+ String
+ , Response
+ )
+ | Construct a new internal server error exception. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1072 | InternalServerErrorException | jakarta.ws.rs.InternalServerErrorException.InternalServerErrorException
+
+ (
+ String
+ , Throwable
+ )
+ | Construct a new internal server error exception. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1073 | InternalServerErrorException | jakarta.ws.rs.InternalServerErrorException.InternalServerErrorException
+
+ (
+ String
+ , Response
+ , Throwable
+ )
+ | Construct a new internal server error exception. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1074 | NotAcceptableException | jakarta.ws.rs.NotAcceptableException.NotAcceptableException
+
+ (
+ String
+ )
+ | Construct a new "request not acceptable" exception. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1075 | NotAcceptableException | jakarta.ws.rs.NotAcceptableException.NotAcceptableException
+
+ (
+ String
+ , Response
+ )
+ | Construct a new "request not acceptable" exception. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1076 | NotAcceptableException | jakarta.ws.rs.NotAcceptableException.NotAcceptableException
+
+ (
+ String
+ , Throwable
+ )
+ | Construct a new "request not acceptable" exception. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1077 | NotAcceptableException | jakarta.ws.rs.NotAcceptableException.NotAcceptableException
+
+ (
+ String
+ , Response
+ , Throwable
+ )
+ | Construct a new "request not acceptable" exception. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1078 | NotAllowedException | jakarta.ws.rs.NotAllowedException.NotAllowedException
+
+ (
+ String
+ , String[]
+ )
+ | Construct a new method not allowed exception. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1079 | NotAllowedException | jakarta.ws.rs.NotAllowedException.NotAllowedException
+
+ (
+ String
+ , String
+ , String[]
+ )
+ | Construct a new method not allowed exception. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1080 | NotAllowedException | jakarta.ws.rs.NotAllowedException.NotAllowedException
+
+ (
+ String
+ , 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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1081 | NotAllowedException | jakarta.ws.rs.NotAllowedException.NotAllowedException
+
+ (
+ String
+ , Throwable
+ , String[]
+ )
+ | Construct a new method not allowed exception. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1082 | NotAllowedException | jakarta.ws.rs.NotAllowedException.NotAllowedException
+
+ (
+ String
+ , Response
+ , Throwable
+ )
+ | Construct a new method not allowed exception. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1083 | NotAuthorizedException | jakarta.ws.rs.NotAuthorizedException.NotAuthorizedException
+
+ (
+ String
+ , Object
+ , Object[]
+ )
+ | Construct a new "not authorized" exception. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1084 | NotAuthorizedException | jakarta.ws.rs.NotAuthorizedException.NotAuthorizedException
+
+ (
+ String
+ , Response
+ )
+ | Construct a new "not authorized" exception. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1085 | NotAuthorizedException | jakarta.ws.rs.NotAuthorizedException.NotAuthorizedException
+
+ (
+ String
+ , Throwable
+ , Object
+ , Object[]
+ )
+ | Construct a new "not authorized" exception. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1086 | NotAuthorizedException | jakarta.ws.rs.NotAuthorizedException.NotAuthorizedException
+
+ (
+ String
+ , Response
+ , Throwable
+ )
+ | Construct a new "not authorized" exception. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1087 | NotFoundException | jakarta.ws.rs.NotFoundException.NotFoundException
+
+ (
+ String
+ )
+ | Construct a new "not found" exception. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1088 | NotFoundException | jakarta.ws.rs.NotFoundException.NotFoundException
+
+ (
+ String
+ , Response
+ )
+ | Construct a new "not found" exception. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1089 | NotFoundException | jakarta.ws.rs.NotFoundException.NotFoundException
+
+ (
+ String
+ , Throwable
+ )
+ | Construct a new "not found" exception. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1090 | NotFoundException | jakarta.ws.rs.NotFoundException.NotFoundException
+
+ (
+ String
+ , Response
+ , Throwable
+ )
+ | Construct a new "not found" exception. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1091 | NotSupportedException | jakarta.ws.rs.NotSupportedException.NotSupportedException
+
+ (
+ String
+ )
+ | Construct a new unsupported media type exception. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1092 | NotSupportedException | jakarta.ws.rs.NotSupportedException.NotSupportedException
+
+ (
+ String
+ , Response
+ )
+ | Construct a new unsupported media type exception. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1093 | NotSupportedException | jakarta.ws.rs.NotSupportedException.NotSupportedException
+
+ (
+ String
+ , Throwable
+ )
+ | Construct a new unsupported media type exception. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1094 | NotSupportedException | jakarta.ws.rs.NotSupportedException.NotSupportedException
+
+ (
+ String
+ , Response
+ , Throwable
+ )
+ | Construct a new unsupported media type exception. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1095 | RedirectionException | jakarta.ws.rs.RedirectionException.RedirectionException
+
+ (
+ String
+ , Status
+ , URI
+ )
+ | Construct a new redirection exception. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1096 | RedirectionException | jakarta.ws.rs.RedirectionException.RedirectionException
+
+ (
+ String
+ , int
+ , URI
+ )
+ | Construct a new redirection exception. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1097 | RedirectionException | jakarta.ws.rs.RedirectionException.RedirectionException
+
+ (
+ String
+ , Response
+ )
+ | Construct a new redirection exception. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1098 | ServerErrorException | jakarta.ws.rs.ServerErrorException.ServerErrorException
+
+ (
+ String
+ , Status
+ )
+ | Construct a new server error exception. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1099 | ServerErrorException | jakarta.ws.rs.ServerErrorException.ServerErrorException
+
+ (
+ String
+ , int
+ )
+ | Construct a new server error exception. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1100 | ServerErrorException | jakarta.ws.rs.ServerErrorException.ServerErrorException
+
+ (
+ String
+ , Response
+ )
+ | Construct a new server error exception. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1101 | ServerErrorException | jakarta.ws.rs.ServerErrorException.ServerErrorException
+
+ (
+ String
+ , Status
+ , Throwable
+ )
+ | Construct a new server error exception. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1102 | ServerErrorException | jakarta.ws.rs.ServerErrorException.ServerErrorException
+
+ (
+ String
+ , int
+ , Throwable
+ )
+ | Construct a new server error exception. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1103 | ServerErrorException | jakarta.ws.rs.ServerErrorException.ServerErrorException
+
+ (
+ String
+ , Response
+ , Throwable
+ )
+ | Construct a new server error exception. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1104 | ServiceUnavailableException | jakarta.ws.rs.ServiceUnavailableException.ServiceUnavailableException
+
+ (
+ String
+ )
+ | Construct a new "service unavailable" exception without any "Retry-After" information specified for the failed request. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1105 | ServiceUnavailableException | jakarta.ws.rs.ServiceUnavailableException.ServiceUnavailableException
+
+ (
+ String
+ , Long
+ )
+ | Construct a new "service unavailable" exception with an interval specifying the "Retry-After" information for the failed request. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1106 | ServiceUnavailableException | jakarta.ws.rs.ServiceUnavailableException.ServiceUnavailableException
+
+ (
+ String
+ , Date
+ )
+ | Construct a new "service unavailable" exception with an interval specifying the "Retry-After" information for the failed request. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1107 | ServiceUnavailableException | jakarta.ws.rs.ServiceUnavailableException.ServiceUnavailableException
+
+ (
+ String
+ , Response
+ )
+ | Construct a new "service unavailable" exception. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1108 | ServiceUnavailableException | jakarta.ws.rs.ServiceUnavailableException.ServiceUnavailableException
+
+ (
+ String
+ , Date
+ , Throwable
+ )
+ | Construct a new "service unavailable" exception with a date specifying the "Retry-After" information for the failed request and an underlying request failure cause. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1109 | ServiceUnavailableException | jakarta.ws.rs.ServiceUnavailableException.ServiceUnavailableException
+
+ (
+ String
+ , Long
+ , Throwable
+ )
+ | Construct a new "service unavailable" exception with an interval specifying the "Retry-After" information for the failed request and an underlying request failure cause. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1110 | ServiceUnavailableException | jakarta.ws.rs.ServiceUnavailableException.ServiceUnavailableException
+
+ (
+ String
+ , Response
+ , Throwable
+ )
+ | Construct a new "service unavailable" exception. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1111 | WebApplicationException | jakarta.ws.rs.WebApplicationException.WebApplicationException
+
+ (
+ String
+ )
+ | Construct a new instance with the supplied message and a default HTTP status code of 500. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1112 | WebApplicationException | jakarta.ws.rs.WebApplicationException.WebApplicationException
+
+ (
+ String
+ , Response
+ )
+ | Construct a new instance using the supplied message and response. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1113 | WebApplicationException | jakarta.ws.rs.WebApplicationException.WebApplicationException
+
+ (
+ String
+ , int
+ )
+ | Construct a new instance with a supplied message and HTTP status code. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1114 | WebApplicationException | jakarta.ws.rs.WebApplicationException.WebApplicationException
+
+ (
+ String
+ , Status
+ )
+ | Construct a new instance with the supplied message and HTTP status. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1115 | WebApplicationException | jakarta.ws.rs.WebApplicationException.WebApplicationException
+
+ (
+ String
+ , Throwable
+ )
+ | Construct a new instance with the supplied message, root cause and default HTTP status code of 500. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1116 | WebApplicationException | jakarta.ws.rs.WebApplicationException.WebApplicationException
+
+ (
+ String
+ , Throwable
+ , Response
+ )
+ | Construct a new instance with the supplied message, root cause and response. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1117 | WebApplicationException | jakarta.ws.rs.WebApplicationException.WebApplicationException
+
+ (
+ String
+ , Throwable
+ , int
+ )
+ | Construct a new instance with the supplied message, root cause and HTTP status code. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1118 | WebApplicationException | jakarta.ws.rs.WebApplicationException.WebApplicationException
+
+ (
+ String
+ , Throwable
+ , Status
+ )
+ | Construct a new instance with a the supplied message, root cause and HTTP status code. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1119 | HostnameVerifier | jakarta.ws.rs.client.Client.getHostnameVerifier
+ | Get the hostname verifier configured in the client or null in case no hostname verifier has been configured. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1120 | ClientBuilder | jakarta.ws.rs.client.ClientBuilder.withConfig
+
+ (
+ Configuration
+ )
+ | Set the internal configuration state to an externally provided configuration state. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1121 | void | jakarta.ws.rs.client.ClientRequestContext.setEntity
+
+ (
+ Object
+ )
+ | Set a new message entity. The existing entity #getEntityAnnotations() annotations and #getMediaType() media type are preserved. It is the callers responsibility to wrap the actual entity with jakarta.ws.rs.core.GenericEntity if preservation of its generic type is required. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1122 | Invocation | jakarta.ws.rs.client.Invocation.property
+
+ (
+ String
+ , Object
+ )
+ | 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 jakarta.ws.rs.ext.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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1123 | Builder | jakarta.ws.rs.client.Invocation.Builder.property
+
+ (
+ String
+ , Object
+ )
+ | 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 jakarta.ws.rs.ext.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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1124 | void | jakarta.ws.rs.container.ContainerResponseContext.setEntity
+
+ (
+ Object
+ )
+ | Set a new message entity. The existing entity #getEntityAnnotations() annotations and #getMediaType() media type are preserved. It is the callers responsibility to wrap the actual entity with jakarta.ws.rs.core.GenericEntity if preservation of its generic type is required. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1125 | Builder | jakarta.ws.rs.core.Link.Builder.baseUri
+
+ (
+ URI
+ )
+ | Set the base URI for resolution of relative URIs. If the underlying URI is already absolute, the base URI is ignored. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1126 | Builder | jakarta.ws.rs.core.Link.Builder.baseUri
+
+ (
+ String
+ )
+ | Set the base URI as a string for resolution of relative URIs. If the underlying URI is already absolute, the base URI is ignored. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1127 | NoContentException | jakarta.ws.rs.core.NoContentException.NoContentException
+
+ (
+ String
+ )
+ | Construct a new NoContentException instance. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1128 | NoContentException | jakarta.ws.rs.core.NoContentException.NoContentException
+
+ (
+ String
+ , Throwable
+ )
+ | Construct a new NoContentException instance. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1129 | NoContentException | jakarta.ws.rs.core.NoContentException.NoContentException
+
+ (
+ Throwable
+ )
+ | Construct a new NoContentException instance. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1130 | ClientBuilder | jakarta.ws.rs.client.ClientBuilder.connectTimeout
+
+ (
+ long
+ , TimeUnit
+ )
+ | Set the connect timeout. Value 0 represents infinity. Negative values are not allowed. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1132 | ClientBuilder | jakarta.ws.rs.client.ClientBuilder.readTimeout
+
+ (
+ long
+ , TimeUnit
+ )
+ | 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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1134 | CompletionStage | jakarta.ws.rs.client.CompletionStageRxInvoker.delete
+ | Invoke HTTP DELETE method for the current request. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1135 | CompletionStage | jakarta.ws.rs.client.CompletionStageRxInvoker.delete
+
+ (
+ Class
+ )
+ | Invoke HTTP DELETE method for the current request. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1136 | CompletionStage | jakarta.ws.rs.client.CompletionStageRxInvoker.delete
+
+ (
+ GenericType
+ )
+ | Invoke HTTP DELETE method for the current request. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1137 | CompletionStage | jakarta.ws.rs.client.CompletionStageRxInvoker.get
+ | Invoke HTTP GET method for the current request. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1138 | CompletionStage | jakarta.ws.rs.client.CompletionStageRxInvoker.get
+
+ (
+ Class
+ )
+ | Invoke HTTP GET method for the current request. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1139 | CompletionStage | jakarta.ws.rs.client.CompletionStageRxInvoker.get
+
+ (
+ GenericType
+ )
+ | Invoke HTTP GET method for the current request. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1140 | CompletionStage | jakarta.ws.rs.client.CompletionStageRxInvoker.head
+ | Invoke HTTP HEAD method for the current request. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1141 | CompletionStage | jakarta.ws.rs.client.CompletionStageRxInvoker.method
+
+ (
+ String
+ )
+ | Invoke an arbitrary method for the current request. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1142 | CompletionStage | jakarta.ws.rs.client.CompletionStageRxInvoker.method
+
+ (
+ String
+ , Class
+ )
+ | Invoke an arbitrary method for the current request. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1143 | CompletionStage | jakarta.ws.rs.client.CompletionStageRxInvoker.method
+
+ (
+ String
+ , GenericType
+ )
+ | Invoke an arbitrary method for the current request. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1144 | CompletionStage | jakarta.ws.rs.client.CompletionStageRxInvoker.method
+
+ (
+ String
+ , Entity
+ )
+ | Invoke an arbitrary method for the current request. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1145 | CompletionStage | jakarta.ws.rs.client.CompletionStageRxInvoker.method
+
+ (
+ String
+ , Entity
+ , Class
+ )
+ | Invoke an arbitrary method for the current request. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1146 | CompletionStage | jakarta.ws.rs.client.CompletionStageRxInvoker.method
+
+ (
+ String
+ , Entity
+ , GenericType
+ )
+ | Invoke an arbitrary method for the current request. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1147 | CompletionStage | jakarta.ws.rs.client.CompletionStageRxInvoker.options
+ | Invoke HTTP OPTIONS method for the current request. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1148 | CompletionStage | jakarta.ws.rs.client.CompletionStageRxInvoker.options
+
+ (
+ Class
+ )
+ | Invoke HTTP OPTIONS method for the current request. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1149 | CompletionStage | jakarta.ws.rs.client.CompletionStageRxInvoker.options
+
+ (
+ GenericType
+ )
+ | Invoke HTTP OPTIONS method for the current request. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1150 | CompletionStage | jakarta.ws.rs.client.CompletionStageRxInvoker.post
+
+ (
+ Entity
+ )
+ | Invoke HTTP POST method for the current request. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1151 | CompletionStage | jakarta.ws.rs.client.CompletionStageRxInvoker.post
+
+ (
+ Entity
+ , Class
+ )
+ | Invoke HTTP POST method for the current request. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1152 | CompletionStage | jakarta.ws.rs.client.CompletionStageRxInvoker.post
+
+ (
+ Entity
+ , GenericType
+ )
+ | Invoke HTTP POST method for the current request. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1153 | CompletionStage | jakarta.ws.rs.client.CompletionStageRxInvoker.put
+
+ (
+ Entity
+ )
+ | Invoke HTTP PUT method for the current request. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1154 | CompletionStage | jakarta.ws.rs.client.CompletionStageRxInvoker.put
+
+ (
+ Entity
+ , Class
+ )
+ | Invoke HTTP PUT method for the current request. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1155 | CompletionStage | jakarta.ws.rs.client.CompletionStageRxInvoker.put
+
+ (
+ Entity
+ , GenericType
+ )
+ | Invoke HTTP PUT method for the current request. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1156 | CompletionStage | jakarta.ws.rs.client.CompletionStageRxInvoker.trace
+ | Invoke HTTP TRACE method for the current request. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1157 | CompletionStage | jakarta.ws.rs.client.CompletionStageRxInvoker.trace
+
+ (
+ Class
+ )
+ | Invoke HTTP TRACE method for the current request. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1158 | CompletionStage | jakarta.ws.rs.client.CompletionStageRxInvoker.trace
+
+ (
+ GenericType
+ )
+ | Invoke HTTP TRACE method for the current request. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1159 | boolean | jakarta.ws.rs.client.Entity.equals
+
+ (
+ Object
+ )
+ |
+
+ | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1160 | int | jakarta.ws.rs.client.Entity.hashCode
+ |
+
+ | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1161 | String | jakarta.ws.rs.client.Entity.toString
+ |
+
+ | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1162 | CompletionStageRxInvoker | jakarta.ws.rs.client.Invocation.Builder.rx
+ | Access the default reactive invoker based on java.util.concurrent.CompletionStage. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1163 | RxInvoker | jakarta.ws.rs.client.Invocation.Builder.rx
+
+ (
+ Class
+ )
+ | 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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1164 | Object | jakarta.ws.rs.client.RxInvoker.delete
+ | Invoke HTTP DELETE method for the current request. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1165 | Object | jakarta.ws.rs.client.RxInvoker.delete
+
+ (
+ Class
+ )
+ | Invoke HTTP DELETE method for the current request. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1166 | Object | jakarta.ws.rs.client.RxInvoker.delete
+
+ (
+ GenericType
+ )
+ | Invoke HTTP DELETE method for the current request. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1167 | Object | jakarta.ws.rs.client.RxInvoker.get
+ | Invoke HTTP GET method for the current request. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1168 | Object | jakarta.ws.rs.client.RxInvoker.get
+
+ (
+ Class
+ )
+ | Invoke HTTP GET method for the current request. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1169 | Object | jakarta.ws.rs.client.RxInvoker.get
+
+ (
+ GenericType
+ )
+ | Invoke HTTP GET method for the current request. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1170 | Object | jakarta.ws.rs.client.RxInvoker.head
+ | Invoke HTTP HEAD method for the current request. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1171 | Object | jakarta.ws.rs.client.RxInvoker.method
+
+ (
+ String
+ )
+ | Invoke an arbitrary method for the current request. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1172 | Object | jakarta.ws.rs.client.RxInvoker.method
+
+ (
+ String
+ , Class
+ )
+ | Invoke an arbitrary method for the current request. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1173 | Object | jakarta.ws.rs.client.RxInvoker.method
+
+ (
+ String
+ , GenericType
+ )
+ | Invoke an arbitrary method for the current request. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1174 | Object | jakarta.ws.rs.client.RxInvoker.method
+
+ (
+ String
+ , Entity
+ )
+ | Invoke an arbitrary method for the current request. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1175 | Object | jakarta.ws.rs.client.RxInvoker.method
+
+ (
+ String
+ , Entity
+ , Class
+ )
+ | Invoke an arbitrary method for the current request. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1176 | Object | jakarta.ws.rs.client.RxInvoker.method
+
+ (
+ String
+ , Entity
+ , GenericType
+ )
+ | Invoke an arbitrary method for the current request. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1177 | Object | jakarta.ws.rs.client.RxInvoker.options
+ | Invoke HTTP OPTIONS method for the current request. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1178 | Object | jakarta.ws.rs.client.RxInvoker.options
+
+ (
+ Class
+ )
+ | Invoke HTTP OPTIONS method for the current request. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1179 | Object | jakarta.ws.rs.client.RxInvoker.options
+
+ (
+ GenericType
+ )
+ | Invoke HTTP OPTIONS method for the current request. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1180 | Object | jakarta.ws.rs.client.RxInvoker.post
+
+ (
+ Entity
+ )
+ | Invoke HTTP POST method for the current request. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1181 | Object | jakarta.ws.rs.client.RxInvoker.post
+
+ (
+ Entity
+ , Class
+ )
+ | Invoke HTTP POST method for the current request. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1182 | Object | jakarta.ws.rs.client.RxInvoker.post
+
+ (
+ Entity
+ , GenericType
+ )
+ | Invoke HTTP POST method for the current request. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1183 | Object | jakarta.ws.rs.client.RxInvoker.put
+
+ (
+ Entity
+ )
+ | Invoke HTTP PUT method for the current request. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1184 | Object | jakarta.ws.rs.client.RxInvoker.put
+
+ (
+ Entity
+ , Class
+ )
+ | Invoke HTTP PUT method for the current request. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1185 | Object | jakarta.ws.rs.client.RxInvoker.put
+
+ (
+ Entity
+ , GenericType
+ )
+ | Invoke HTTP PUT method for the current request. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1186 | Object | jakarta.ws.rs.client.RxInvoker.trace
+ | Invoke HTTP TRACE method for the current request. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1187 | Object | jakarta.ws.rs.client.RxInvoker.trace
+
+ (
+ Class
+ )
+ | Invoke HTTP TRACE method for the current request. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1188 | Object | jakarta.ws.rs.client.RxInvoker.trace
+
+ (
+ GenericType
+ )
+ | Invoke HTTP TRACE method for the current request. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1189 | RxInvoker | jakarta.ws.rs.client.RxInvokerProvider.getRxInvoker
+
+ (
+ SyncInvoker
+ , ExecutorService
+ )
+ | Get RxInvoker implementation instance. The returned instance has to be thread safe. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1190 | boolean | jakarta.ws.rs.client.RxInvokerProvider.isProviderFor
+
+ (
+ Class
+ )
+ | Determine if this is a provider for the given RxInvoker subclass. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1191 | GenericType | jakarta.ws.rs.core.GenericType.forInstance
+
+ (
+ Object
+ )
+ | Create a jakarta.ws.rs.core.GenericType generic type from a Java instance. If the supplied instance is a jakarta.ws.rs.core.GenericEntity, the generic type will be computed using the jakarta.ws.rs.core.GenericEntity#getType(). Otherwise instance.getClass() will be used. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1194 | ResponseBuilder | jakarta.ws.rs.core.Response.status
+
+ (
+ int
+ , String
+ )
+ | Create a new ResponseBuilder with the supplied status and reason phrase. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1195 | ResponseBuilder | jakarta.ws.rs.core.Response.ResponseBuilder.status
+
+ (
+ int
+ , String
+ )
+ | Set the status on the ResponseBuilder. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1196 | Status | jakarta.ws.rs.core.Response.StatusType.toEnum
+ | Get the this Status Type as a Status. Please note that returned status contains only a status code, the reason phrase is set to default one (corresponding to the status code). | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1197 | boolean | jakarta.ws.rs.sse.InboundSseEvent.isEmpty
+ | Check if the event is empty (i.e. does not contain any data). | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1198 | String | jakarta.ws.rs.sse.InboundSseEvent.readData
+ | Get the original event data as String. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1199 | Object | jakarta.ws.rs.sse.InboundSseEvent.readData
+
+ (
+ Class
+ )
+ | Read event data as a given Java type. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1200 | Object | jakarta.ws.rs.sse.InboundSseEvent.readData
+
+ (
+ GenericType
+ )
+ | Read event data as a given generic type. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1201 | Object | jakarta.ws.rs.sse.InboundSseEvent.readData
+
+ (
+ Class
+ , MediaType
+ )
+ | Read event data as a given Java type. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1202 | Object | jakarta.ws.rs.sse.InboundSseEvent.readData
+
+ (
+ GenericType
+ , MediaType
+ )
+ | Read event data as a given generic type. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1203 | Object | jakarta.ws.rs.sse.OutboundSseEvent.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 jakarta.ws.rs.ext.MessageBodyWriter that is selected based on the event #getType() type, #getGenericType() generic type} and #getMediaType() media type}. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1204 | Type | jakarta.ws.rs.sse.OutboundSseEvent.getGenericType
+ | Get generic data type. This information is used to select a proper jakarta.ws.rs.ext.MessageBodyWriter to be used for serializing the #getData() event data. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1205 | MediaType | jakarta.ws.rs.sse.OutboundSseEvent.getMediaType
+ | Get MediaType media type of the event data. This information is used to a select proper jakarta.ws.rs.ext.MessageBodyWriter to be used for serializing the #getData() event data. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1206 | Class | jakarta.ws.rs.sse.OutboundSseEvent.getType
+ | Get data type. This information is used to select a proper jakarta.ws.rs.ext.MessageBodyWriter to be used for serializing the #getData() event data. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1207 | OutboundSseEvent | jakarta.ws.rs.sse.OutboundSseEvent.Builder.build
+ | Build OutboundSseEvent. There are two valid configurations: if a Builder#comment(String) comment is set, all other parameters are optional. If event Builder#data(Class, Object) data and Builder#mediaType(MediaType) media type is set, event data will be serialized after the comment. if a Builder#comment(String) comment is not set, at least the event Builder#data(Class, Object) data must be set. All other parameters are optional. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1208 | Builder | jakarta.ws.rs.sse.OutboundSseEvent.Builder.comment
+
+ (
+ String
+ )
+ | 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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1209 | Builder | jakarta.ws.rs.sse.OutboundSseEvent.Builder.data
+
+ (
+ Class
+ , Object
+ )
+ | Set event data and java type of event data. Type information will be used for jakarta.ws.rs.ext.MessageBodyWriter lookup. Note that multiple invocations of this method result in previous even data being replaced with new one. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1210 | Builder | jakarta.ws.rs.sse.OutboundSseEvent.Builder.data
+
+ (
+ GenericType
+ , Object
+ )
+ | Set event data and a generic java type of event data. Type information will be used for jakarta.ws.rs.ext.MessageBodyWriter lookup. Note that multiple invocations of this method result in previous even data being replaced with new one. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1211 | Builder | jakarta.ws.rs.sse.OutboundSseEvent.Builder.data
+
+ (
+ Object
+ )
+ | 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 jakarta.ws.rs.core.GenericEntity. Note that multiple invocations of this method result in previous even data being replaced with new one. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1212 | Builder | jakarta.ws.rs.sse.OutboundSseEvent.Builder.id
+
+ (
+ String
+ )
+ | Set the event id. Will be send as a value of the SSE "id" field. This field is optional. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1213 | Builder | jakarta.ws.rs.sse.OutboundSseEvent.Builder.mediaType
+
+ (
+ MediaType
+ )
+ | Set the MediaType media type of the event data. This information is mandatory. The default value is MediaType#TEXT_PLAIN. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1214 | Builder | jakarta.ws.rs.sse.OutboundSseEvent.Builder.name
+
+ (
+ String
+ )
+ | Set event name. Will be send as a value of the SSE "event" field. This field is optional. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1215 | Builder | jakarta.ws.rs.sse.OutboundSseEvent.Builder.reconnectDelay
+
+ (
+ long
+ )
+ | 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 #getReconnectDelay(). | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1216 | SseBroadcaster | jakarta.ws.rs.sse.Sse.newBroadcaster
+ | Get a new Server-sent event broadcaster. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1217 | OutboundSseEvent | jakarta.ws.rs.sse.Sse.newEvent
+
+ (
+ String
+ )
+ | Create new OutboundSseEvent from provided data. The data can be string only and must not be null. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1218 | OutboundSseEvent | jakarta.ws.rs.sse.Sse.newEvent
+
+ (
+ String
+ , String
+ )
+ | Create new OutboundSseEvent from provided data and name. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1219 | Builder | jakarta.ws.rs.sse.Sse.newEventBuilder
+ | Get a new outbound event builder. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1220 | CompletionStage | jakarta.ws.rs.sse.SseBroadcaster.broadcast
+
+ (
+ OutboundSseEvent
+ )
+ | Publish an SSE event to all registered SseEventSink instances. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1224 | void | jakarta.ws.rs.sse.SseBroadcaster.register
+
+ (
+ SseEventSink
+ )
+ | Register provided SseEventSink instance to this SseBroadcaster. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1225 | String | jakarta.ws.rs.sse.SseEvent.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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1226 | String | jakarta.ws.rs.sse.SseEvent.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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1227 | String | jakarta.ws.rs.sse.SseEvent.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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1228 | long | jakarta.ws.rs.sse.SseEvent.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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1229 | boolean | jakarta.ws.rs.sse.SseEvent.isReconnectDelaySet
+ | Check if the connection retry time has been set in the event. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1230 | void | jakarta.ws.rs.sse.SseEventSink.close
+ | 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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1231 | boolean | jakarta.ws.rs.sse.SseEventSink.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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1232 | CompletionStage | jakarta.ws.rs.sse.SseEventSink.send
+
+ (
+ OutboundSseEvent
+ )
+ | Send an outbound Server-sent event to this sink. Event will be serialized and sent to the client. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1233 | void | jakarta.ws.rs.sse.SseEventSource.close
+ | Close this event source. The method will wait up to 5 seconds for the internal event processing tasks to complete. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1234 | boolean | jakarta.ws.rs.sse.SseEventSource.close
+
+ (
+ long
+ , TimeUnit
+ )
+ | 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 Thread#interrupted() interrupt flag on the thread before returning false. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1235 | boolean | jakarta.ws.rs.sse.SseEventSource.isOpen
+ | Check if this event source instance has already been #open() opened. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1236 | void | jakarta.ws.rs.sse.SseEventSource.open
+ | Open the connection to the supplied SSE underlying WebTarget web target and start processing incoming InboundSseEvent events. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1237 | void | jakarta.ws.rs.sse.SseEventSource.register
+
+ (
+ Consumer
+ )
+ | Register a InboundSseEvent consumer. Given consumer is invoked once per each received event. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1238 | void | jakarta.ws.rs.sse.SseEventSource.register
+
+ (
+ Consumer
+ , Consumer
+ )
+ | 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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1240 | Builder | jakarta.ws.rs.sse.SseEventSource.target
+
+ (
+ WebTarget
+ )
+ | Create a new SseEventSource.Builder event source builder that provides convenient way how to configure and fine-tune various aspects of a newly prepared event source instance. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1241 | SseEventSource | jakarta.ws.rs.sse.SseEventSource.Builder.build
+ | Build new SSE event source pointing at a SSE streaming WebTarget web target. The returned event source is ready, but not SseEventSource#open() connected to the SSE endpoint. It is expected that you will manually invoke its #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 #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 ScheduledExecutorService scheduled executor service. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1242 | Builder | jakarta.ws.rs.sse.SseEventSource.Builder.reconnectingEvery
+
+ (
+ long
+ , TimeUnit
+ )
+ | 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 + mechanism as described in the SseEventSource javadoc. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:46 | String | jakarta.ws.rs.core.CacheControl.toString
+ | Convert the cache control to a string suitable for use as the value of the corresponding HTTP header. | true | true | true |
+
+
+JAXRS:JAVADOC:47 | CacheControl | jakarta.ws.rs.core.CacheControl.valueOf
+
+ (
+ String
+ )
+ | Creates a new instance of CacheControl by parsing the supplied string. | true | true | true |
+
+
+JAXRS:JAVADOC:49 | Cookie | jakarta.ws.rs.core.Cookie.Cookie
+
+ (
+ String
+ , String
+ , String
+ , String
+ , int
+ )
+ | Create a new instance. | true | true | true |
+
+
+JAXRS:JAVADOC:50 | Cookie | jakarta.ws.rs.core.Cookie.Cookie
+
+ (
+ String
+ , String
+ , String
+ , String
+ )
+ | Create a new instance. | true | true | true |
+
+
+JAXRS:JAVADOC:51 | Cookie | jakarta.ws.rs.core.Cookie.Cookie
+
+ (
+ String
+ , String
+ )
+ | Create a new instance. | true | true | true |
+
+
+JAXRS:JAVADOC:59 | String | jakarta.ws.rs.core.Cookie.toString
+ | Convert the cookie to a string suitable for use as the value of the corresponding HTTP header. | true | true | true |
+
+
+JAXRS:JAVADOC:60 | Cookie | jakarta.ws.rs.core.Cookie.valueOf
+
+ (
+ String
+ )
+ | Creates a new instance of Cookie by parsing the supplied string. | true | true | true |
+
+
+JAXRS:JAVADOC:68 | String | jakarta.ws.rs.core.EntityTag.toString
+ | Convert the entity tag to a string suitable for use as the value of the corresponding HTTP header. | true | true | true |
+
+
+JAXRS:JAVADOC:69 | EntityTag | jakarta.ws.rs.core.EntityTag.valueOf
+
+ (
+ String
+ )
+ | Creates a new instance of EntityTag by parsing the supplied string. | true | true | true |
+
+
+JAXRS:JAVADOC:104 | NewCookie | jakarta.ws.rs.core.NewCookie.NewCookie
+
+ (
+ String
+ , String
+ )
+ | Create a new instance. | true | true | true |
+
+
+JAXRS:JAVADOC:105 | NewCookie | jakarta.ws.rs.core.NewCookie.NewCookie
+
+ (
+ String
+ , String
+ , String
+ , String
+ , String
+ , int
+ , boolean
+ )
+ | Create a new instance. | true | true | true |
+
+
+JAXRS:JAVADOC:106 | NewCookie | jakarta.ws.rs.core.NewCookie.NewCookie
+
+ (
+ String
+ , String
+ , String
+ , String
+ , int
+ , String
+ , int
+ , boolean
+ )
+ | Create a new instance. | true | true | true |
+
+
+JAXRS:JAVADOC:107 | NewCookie | jakarta.ws.rs.core.NewCookie.NewCookie
+
+ (
+ Cookie
+ )
+ | Create a new instance copying the information in the supplied cookie. | true | true | true |
+
+
+JAXRS:JAVADOC:108 | NewCookie | jakarta.ws.rs.core.NewCookie.NewCookie
+
+ (
+ Cookie
+ , String
+ , int
+ , boolean
+ )
+ | Create a new instance supplementing the information in the supplied cookie. | true | true | true |
+
+
+JAXRS:JAVADOC:110 | String | jakarta.ws.rs.core.NewCookie.toString
+ | Convert the cookie to a string suitable for use as the value of the corresponding HTTP header. | true | true | true |
+
+
+JAXRS:JAVADOC:111 | NewCookie | jakarta.ws.rs.core.NewCookie.valueOf
+
+ (
+ String
+ )
+ | Creates a new instance of NewCookie by parsing the supplied string. | true | true | true |
+
+
+JAXRS:JAVADOC:1046 | NewCookie | jakarta.ws.rs.core.NewCookie.NewCookie
+
+ (
+ String
+ , String
+ , String
+ , String
+ , String
+ , int
+ , boolean
+ , boolean
+ )
+ | Create a new instance. | true | true | true |
+
+
+JAXRS:JAVADOC:1047 | NewCookie | jakarta.ws.rs.core.NewCookie.NewCookie
+
+ (
+ String
+ , String
+ , String
+ , String
+ , int
+ , String
+ , int
+ , Date
+ , boolean
+ , boolean
+ )
+ | Create a new instance. | true | true | true |
+
+
+JAXRS:JAVADOC:1048 | NewCookie | jakarta.ws.rs.core.NewCookie.NewCookie
+
+ (
+ Cookie
+ , String
+ , int
+ , Date
+ , boolean
+ , boolean
+ )
+ | Create a new instance supplementing the information in the supplied cookie. | true | true | true |
+
+
+JAXRS:JAVADOC:1 | String[] | jakarta.ws.rs.Consumes.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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:10 | String[] | jakarta.ws.rs.Produces.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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:80 | List | jakarta.ws.rs.core.HttpHeaders.getRequestHeader
+
+ (
+ String
+ )
+ | Get the values of a HTTP request header if the header exists on the current request. The returned value will be a read-only List if the specified header exists or null if it does not. This is a shortcut for getRequestHeaders().get(name). | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:87 | boolean | jakarta.ws.rs.core.MediaType.isCompatible
+
+ (
+ MediaType
+ )
+ | 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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:240 | List | jakarta.ws.rs.core.UriInfo.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: #064;Path("foo") public class FooResource { #064;GET public String getFoo() {...} #064;Path("bar") public BarResource getBarResource() {...} } public class BarResource { #064;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 Request Called from Value(s) GET /foo FooResource.getFoo FooResource GET /foo/bar FooResource.getBarResource FooResource GET /foo/bar BarResource.getBar BarResource, 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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:241 | List | jakarta.ws.rs.core.UriInfo.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: #064;Path("foo") public class FooResource { #064;GET public String getFoo() {...} #064;Path("bar") public BarResource getBarResource() {...} } public class BarResource { #064;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 Request Called from Value(s) GET /foo FooResource.getFoo foo GET /foo/bar FooResource.getBarResource foo/bar, foo GET /foo/bar BarResource.getBar foo/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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:280 | ContextResolver | jakarta.ws.rs.ext.Providers.getContextResolver
+
+ (
+ Class
+ , 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 jakarta.ws.rs.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 jakarta.ws.rs.Produces (x/y gt; x #47;* gt; * #47;*) 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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:282 | MessageBodyReader | jakarta.ws.rs.ext.Providers.getMessageBodyReader
+
+ (
+ Class
+ , Type
+ , Annotation[]
+ , 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 jakarta.ws.rs.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 jakarta.ws.rs.Consumes (x/y gt; x #47;* gt; * #47;*) 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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:283 | MessageBodyWriter | jakarta.ws.rs.ext.Providers.getMessageBodyWriter
+
+ (
+ Class
+ , Type
+ , Annotation[]
+ , 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 jakarta.ws.rs.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 jakarta.ws.rs.Produces (x/y gt; x #47;* gt; * #47;*) 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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:298 | ResponseBuilder | jakarta.ws.rs.core.Request.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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:358 | boolean | jakarta.ws.rs.ServiceUnavailableException.hasRetryAfter
+ | Check if the underlying response contains the information on when is it possible to jakarta.ws.rs.core.HttpHeaders#RETRY_AFTER retry the request. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:479 | void | jakarta.ws.rs.client.ClientResponseFilter.filter
+
+ (
+ ClientRequestContext
+ , ClientResponseContext
+ )
+ | Filter method called after a response has been provided for a request (either by a ClientRequestFilter 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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:498 | Entity | jakarta.ws.rs.client.Entity.form
+
+ (
+ Form
+ )
+ | Create an form entity. .core.MediaType#APPLICATION_FORM_URLENCODED form entity. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:499 | Entity | jakarta.ws.rs.client.Entity.form
+
+ (
+ MultivaluedMap
+ )
+ | Create an form entity. .core.MediaType#APPLICATION_FORM_URLENCODED form entity. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:506 | Entity | jakarta.ws.rs.client.Entity.html
+
+ (
+ Object
+ )
+ | Create a entity. ws.rs.core.MediaType#TEXT_HTML entity. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:507 | Entity | jakarta.ws.rs.client.Entity.json
+
+ (
+ Object
+ )
+ | Create an entity. ws.rs.core.MediaType#APPLICATION_JSON entity. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:508 | Entity | jakarta.ws.rs.client.Entity.text
+
+ (
+ Object
+ )
+ | Create a entity. ws.rs.core.MediaType#TEXT_PLAIN entity. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:509 | Entity | jakarta.ws.rs.client.Entity.xhtml
+
+ (
+ Object
+ )
+ | Create an entity. ws.rs.core.MediaType#APPLICATION_XHTML_XML entity. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:510 | Entity | jakarta.ws.rs.client.Entity.xml
+
+ (
+ Object
+ )
+ | Create an entity. ws.rs.core.MediaType#APPLICATION_XML entity. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:683 | Annotation[] | jakarta.ws.rs.container.ContainerResponseContext.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 jakarta.ws.rs.core.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: #64;Path("my-resource") public class MyResource { private final Annotations[] extras = ... ; #64;GET #64;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: #64;Custom public class AnnotatedMe { ... } #64;Path("my-resource") public class MyResource { private final Annotations[] extras = ... ; #64;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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:735 | boolean | jakarta.ws.rs.core.AbstractMultivaluedMap.equals
+
+ (
+ Object
+ )
+ | This implementation delegates the method call to to the the underlying [key, multi-value] store. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:739 | int | jakarta.ws.rs.core.AbstractMultivaluedMap.hashCode
+ | This implementation delegates the method call to to the the underlying [key, multi-value] store. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:801 | Link | jakarta.ws.rs.core.Link.valueOf
+
+ (
+ String
+ )
+ | Simple parser to convert link header string representations into a link. link ::= ' lt;' uri 'gt;' (';' link-param)* link-param ::= name '=' quoted-string See RFC 5988 for more information. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:825 | MediaType | jakarta.ws.rs.core.MediaType.MediaType
+
+ (
+ String
+ , String
+ , String
+ )
+ | Creates a new instance of MediaType with the supplied type, subtype and parameter. AMETER parameter. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:985 | void | jakarta.ws.rs.container.CompletionCallback.onComplete
+
+ (
+ Throwable
+ )
+ | An unmapped throwable is propagated to the default exception mapper in case no jakarta.ws.rs.ext.ExceptionMapper 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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:992 | Set | jakarta.ws.rs.core.Configuration.getClasses
+ | Get the immutable set of registered JAX-RS component (such as provider, root resource or Feature 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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1037 | Builder | jakarta.ws.rs.core.Link.fromMethod
+
+ (
+ Class
+ , String
+ )
+ | Convenience method to build a link from a resource. Equivalent to Link.fromUriBuilder( 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 Link.Builder#baseUri(URI) 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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1039 | Builder | jakarta.ws.rs.core.Link.fromResource
+
+ (
+ Class
+ )
+ | Convenience method to build a link from a resource. Equivalent to Link.fromUriBuilder( 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 Link.Builder#baseUri(URI) 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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1043 | Builder | jakarta.ws.rs.core.Link.Builder.link
+
+ (
+ String
+ )
+ | Initialize builder using another link represented as a string. Uses simple parser to convert string representation into a link. link ::= ' lt;' uri 'gt;' (';' link-param)* link-param ::= name '=' quoted-string See RFC 5988 for more information. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1131 | ClientBuilder | jakarta.ws.rs.client.ClientBuilder.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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1133 | ClientBuilder | jakarta.ws.rs.client.ClientBuilder.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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1221 | void | jakarta.ws.rs.sse.SseBroadcaster.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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1222 | void | jakarta.ws.rs.sse.SseBroadcaster.onClose
+
+ (
+ Consumer
+ )
+ | 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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1223 | void | jakarta.ws.rs.sse.SseBroadcaster.onError
+
+ (
+ BiConsumer
+ )
+ | 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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1239 | void | jakarta.ws.rs.sse.SseEventSource.register
+
+ (
+ Consumer
+ , Consumer
+ , Runnable
+ )
+ | 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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1243 | CompletionStage | jakarta.ws.rs.SeBootstrap.start
+
+ (
+ Application
+ , 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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1244 | CompletionStage | jakarta.ws.rs.SeBootstrap.start
+
+ (
+ 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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1245 | CompletionStage | jakarta.ws.rs.SeBootstrap.start
+
+ (
+ Class
+ , 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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1246 | CompletionStage | jakarta.ws.rs.SeBootstrap.start
+
+ (
+ Class
+ )
+ | 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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1247 | URI | jakarta.ws.rs.SeBootstrap.Configuration.baseUri
+ | Convenience method that returns a built the URI for the application. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1248 | UriBuilder | jakarta.ws.rs.SeBootstrap.Configuration.baseUriBuilder
+ | Returns a UriBuilder that includes the application root path. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1249 | Builder | jakarta.ws.rs.SeBootstrap.Configuration.builder
+ | Creates a new bootstrap configuration builder instance. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1250 | boolean | jakarta.ws.rs.SeBootstrap.Configuration.hasProperty
+
+ (
+ String
+ )
+ | Returns whether the property with the given name is configured, either explicitly or by default. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1251 | String | jakarta.ws.rs.SeBootstrap.Configuration.host
+ | Convenience method to get the host to be used. Same as if calling #property(String) (String) property(HOST). | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1252 | int | jakarta.ws.rs.SeBootstrap.Configuration.port
+ | Convenience method to get the actually used port. Same as if calling #property(String) (int) property(PORT). If the port was not explicitly given, this will return the port chosen implicitly by the JAX-RS implementation. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1253 | Object | jakarta.ws.rs.SeBootstrap.Configuration.property
+
+ (
+ String
+ )
+ | Returns the value of the property with the given name, or null if there is no property of that name. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1254 | String | jakarta.ws.rs.SeBootstrap.Configuration.protocol
+ | Convenience method to get the protocol to be used. Same as if calling #property(String) (String) property(PROTOCOL). | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1255 | String | jakarta.ws.rs.SeBootstrap.Configuration.rootPath
+ | Convenience method to get the rootPath to be used. Same as if calling #property(String) (String) property(ROOT_PATH). | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1256 | SSLClientAuthentication | jakarta.ws.rs.SeBootstrap.Configuration.sslClientAuthentication
+ | Convenience method to get the secure socket client authentication policy. Same as if calling #property(String) (SSLClientAuthentication) property(SSL_CLIENT_AUTHENTICATION). | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1257 | SSLContext | jakarta.ws.rs.SeBootstrap.Configuration.sslContext
+ | Convenience method to get the sslContext to be used. Same as if calling #property(String) (SSLContext) property(SSL_CONTEXT). | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1258 | Configuration | jakarta.ws.rs.SeBootstrap.Configuration.Builder.build
+ | Builds a bootstrap configuration instance from the provided property values. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1259 | Builder | jakarta.ws.rs.SeBootstrap.Configuration.Builder.from
+
+ (
+ BiFunction
+ )
+ | 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 Optional#empty() empty. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1260 | Builder | jakarta.ws.rs.SeBootstrap.Configuration.Builder.from
+
+ (
+ Object
+ )
+ | 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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1261 | Builder | jakarta.ws.rs.SeBootstrap.Configuration.Builder.host
+
+ (
+ String
+ )
+ | Convenience method to set the host to be used. Same as if calling #property(String, Object) property(HOST, value). | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1262 | Builder | jakarta.ws.rs.SeBootstrap.Configuration.Builder.port
+
+ (
+ Integer
+ )
+ | Convenience method to set the port to be used. Same as if calling #property(String, Object) property(PORT, value). | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1263 | Builder | jakarta.ws.rs.SeBootstrap.Configuration.Builder.property
+
+ (
+ String
+ , Object
+ )
+ | Sets the property name to the provided value. This method does not check the validity, type or syntax of the provided value. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1264 | Builder | jakarta.ws.rs.SeBootstrap.Configuration.Builder.protocol
+
+ (
+ String
+ )
+ | Convenience method to set the protocol to be used. Same as if calling #property(String, Object) property(PROTOCOL, value). | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1265 | Builder | jakarta.ws.rs.SeBootstrap.Configuration.Builder.rootPath
+
+ (
+ String
+ )
+ | Convenience method to set the rootPath to be used. Same as if calling #property(String, Object) property(ROOT_PATH, value). | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1266 | Builder | jakarta.ws.rs.SeBootstrap.Configuration.Builder.sslClientAuthentication
+
+ (
+ SSLClientAuthentication
+ )
+ | Convenience method to set SSL client authentication policy. Same as if calling #property(String, Object) property(SSL_CLIENT_AUTHENTICATION, value). | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1267 | Builder | jakarta.ws.rs.SeBootstrap.Configuration.Builder.sslContext
+
+ (
+ SSLContext
+ )
+ | Convenience method to set the sslContext to be used. Same as if calling #property(String, Object) property(SSL_CONTEXT, value). | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1268 | SSLClientAuthentication | jakarta.ws.rs.SeBootstrap.Configuration.SSLClientAuthentication.valueOf
+
+ (
+ String
+ )
+ |
+
+ | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1269 | SSLClientAuthentication[] | jakarta.ws.rs.SeBootstrap.Configuration.SSLClientAuthentication.values
+ |
+
+ | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1270 | Configuration | jakarta.ws.rs.SeBootstrap.Instance.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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1271 | CompletionStage | jakarta.ws.rs.SeBootstrap.Instance.stop
+ | Initiate immediate shutdown of running application instance. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1272 | void | jakarta.ws.rs.SeBootstrap.Instance.stopOnShutdown
+
+ (
+ Consumer
+ )
+ | Registers a consumer for a StopResult which will be executed in a new thread during the JVM shutdown phase. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1273 | Object | jakarta.ws.rs.SeBootstrap.Instance.unwrap
+
+ (
+ Class
+ )
+ | 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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1274 | Object | jakarta.ws.rs.SeBootstrap.Instance.StopResult.unwrap
+
+ (
+ Class
+ )
+ | 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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1275 | boolean | jakarta.ws.rs.client.ClientRequestContext.hasProperty
+
+ (
+ String
+ )
+ | 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 method with a property name to get the value of a property. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1276 | boolean | jakarta.ws.rs.container.ContainerRequestContext.hasProperty
+
+ (
+ String
+ )
+ | 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 method with a property name to get the value of a property. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1277 | boolean | jakarta.ws.rs.core.Configuration.hasProperty
+
+ (
+ String
+ )
+ | Check whether the property with a given name is configured. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1278 | Cookie | jakarta.ws.rs.core.Cookie.AbstractCookieBuilder.build
+ | Build a new Cookie instance using all the configuration previously specified in this builder. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1279 | AbstractCookieBuilder | jakarta.ws.rs.core.Cookie.AbstractCookieBuilder.Cookie.AbstractCookieBuilder
+
+ (
+ String
+ )
+ | Create a new instance. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1280 | AbstractCookieBuilder | jakarta.ws.rs.core.Cookie.AbstractCookieBuilder.domain
+
+ (
+ String
+ )
+ | Set the domain of the cookie. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1281 | AbstractCookieBuilder | jakarta.ws.rs.core.Cookie.AbstractCookieBuilder.path
+
+ (
+ String
+ )
+ | Set the path of the cookie. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1282 | AbstractCookieBuilder | jakarta.ws.rs.core.Cookie.AbstractCookieBuilder.value
+
+ (
+ String
+ )
+ | Set the value of the cookie. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1283 | AbstractCookieBuilder | jakarta.ws.rs.core.Cookie.AbstractCookieBuilder.version
+
+ (
+ int
+ )
+ | Set the version of the cookie. Defaults to Cookie#DEFAULT_VERSION | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1284 | Cookie | jakarta.ws.rs.core.Cookie.Builder.build
+ | Build a new Cookie instance using all the configuration previously specified in this builder. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1286 | InputStream | jakarta.ws.rs.core.EntityPart.getContent
+ | Returns the input stream for this part. This is the content body of the part and is accessed as a stream to avoid loading potentially large amounts of data into the heap. It is the responsibility of the calling code to close this stream after receiving it. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1287 | Object | jakarta.ws.rs.core.EntityPart.getContent
+
+ (
+ Class
+ )
+ | Converts the content stream for this part to the specified class and returns it. The implementation must convert the stream by finding a jakarta.ws.rs.ext.MessageBodyReader that handles the specified type as well as the MediaType of the part. If no jakarta.ws.rs.ext.MessageBodyReader can be found to perform the conversion, this method will throw an IllegalArgumentException. The implementation is required to close the content stream when this method is invoked, so it may only be invoked once. Subsequent invocations will result in an IllegalStateException. Likewise this method will throw an IllegalStateException if it is called after calling #getContent or #getContent(GenericType). | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1288 | Object | jakarta.ws.rs.core.EntityPart.getContent
+
+ (
+ Class
+ )
+ throws
+ IllegalArgumentException
+ | if no jakarta.ws.rs.ext.MessageBodyReader can handle the conversion of this part to the specified type | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1289 | Object | jakarta.ws.rs.core.EntityPart.getContent
+
+ (
+ Class
+ )
+ throws
+ IllegalStateException
+ | if this method or any of the other getContent methods has already been invoked | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1290 | Object | jakarta.ws.rs.core.EntityPart.getContent
+
+ (
+ Class
+ )
+ throws
+ IOException
+ | if the jakarta.ws.rs.ext.MessageBodyReader#readFrom(Class, java.lang.reflect.Type, java.lang.annotation.Annotation[], MediaType, MultivaluedMap, InputStream) method throws an IOException | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1291 | Object | jakarta.ws.rs.core.EntityPart.getContent
+
+ (
+ Class
+ )
+ throws
+ WebApplicationException
+ | if the jakarta.ws.rs.ext.MessageBodyReader#readFrom(Class, java.lang.reflect.Type, java.lang.annotation.Annotation[], MediaType, MultivaluedMap, InputStream) method throws an WebApplicationException | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1292 | Object | jakarta.ws.rs.core.EntityPart.getContent
+
+ (
+ GenericType
+ )
+ | Converts the content stream for this part to the specified type and returns it. The implementation must convert the stream by finding a jakarta.ws.rs.ext.MessageBodyReader that handles the specified type as well as the MediaType of the part. If no jakarta.ws.rs.ext.MessageBodyReader can be found to perform the conversion, this method will throw an IllegalArgumentException. The implementation is required to close the content stream when this method is invoked, so it may only be invoked once. Subsequent invocations will result in an IllegalStateException. Likewise this method will throw an IllegalStateException if it is called after calling #getContent or #getContent(Class). | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1293 | Object | jakarta.ws.rs.core.EntityPart.getContent
+
+ (
+ GenericType
+ )
+ throws
+ IllegalArgumentException
+ | if no jakarta.ws.rs.ext.MessageBodyReader can handle the conversion of this part to the specified type | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1294 | Object | jakarta.ws.rs.core.EntityPart.getContent
+
+ (
+ GenericType
+ )
+ throws
+ IllegalStateException
+ | if this method or any of the other getContent methods has already been invoked | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1295 | Object | jakarta.ws.rs.core.EntityPart.getContent
+
+ (
+ GenericType
+ )
+ throws
+ IOException
+ | if the jakarta.ws.rs.ext.MessageBodyReader#readFrom(Class, java.lang.reflect.Type, java.lang.annotation.Annotation[], MediaType, MultivaluedMap, InputStream) method throws an IOException | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1296 | Object | jakarta.ws.rs.core.EntityPart.getContent
+
+ (
+ GenericType
+ )
+ throws
+ WebApplicationException
+ | if the jakarta.ws.rs.ext.MessageBodyReader#readFrom(Class, java.lang.reflect.Type, java.lang.annotation.Annotation[], MediaType, MultivaluedMap, InputStream) method throws an WebApplicationException | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1297 | Optional | jakarta.ws.rs.core.EntityPart.getFileName
+ | Returns the filename of this part. This will be the "filename" attribute of the Content-Disposition header for this part. A filename is not required in a part, so if a filename is not present it will return Optional.empty(). | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1298 | MultivaluedMap | jakarta.ws.rs.core.EntityPart.getHeaders
+ | Returns an immutable multivalued map of headers for this specific part. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1299 | MediaType | jakarta.ws.rs.core.EntityPart.getMediaType
+ | Returns the content type of this part, and equivalent to calling MediaType.valueOf(part.getHeaders().getFirst(HttpHeaders.CONTENT_TYPE)). | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1300 | String | jakarta.ws.rs.core.EntityPart.getName
+ | Returns the name of this part within the multipart entity. This will be the "name" attribute of the Content-Disposition header for this part. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1301 | Builder | jakarta.ws.rs.core.EntityPart.withFileName
+
+ (
+ String
+ )
+ | Creates a new EntityPart.Builder instance that sets the part name and fileName to the passed in partAndFileName value. Logically, this is the same as EntityPart.withName(x).fileName(x). | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1302 | Builder | jakarta.ws.rs.core.EntityPart.withName
+
+ (
+ String
+ )
+ | Creates a new EntityPart.Builder instance. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1303 | EntityPart | jakarta.ws.rs.core.EntityPart.Builder.build
+ | Builds a new EntityPart instance using the provided property values. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1304 | EntityPart | jakarta.ws.rs.core.EntityPart.Builder.build
+ throws
+ IllegalStateException
+ | if the content was not specified or no matching jakarta.ws.rs.ext.MessageBodyWriter was found. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1305 | EntityPart | jakarta.ws.rs.core.EntityPart.Builder.build
+ throws
+ IOException
+ | if the underlying jakarta.ws.rs.ext.MessageBodyWriter throws an IOException | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1306 | EntityPart | jakarta.ws.rs.core.EntityPart.Builder.build
+ throws
+ WebApplicationException
+ | if the underlying jakarta.ws.rs.ext.MessageBodyWriter throws a WebApplicationException | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1307 | Builder | jakarta.ws.rs.core.EntityPart.Builder.content
+
+ (
+ InputStream
+ )
+ | Sets the content for this part. The content of this builder must be specified before invoking the #build() method. The InputStream will be closed by the implementation code after sending the multipart data. Closing the stream before it is sent could result in unexpected behavior. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1308 | Builder | jakarta.ws.rs.core.EntityPart.Builder.content
+
+ (
+ InputStream
+ )
+ throws
+ IllegalArgumentException
+ | if content is null | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1309 | Builder | jakarta.ws.rs.core.EntityPart.Builder.content
+
+ (
+ String
+ , InputStream
+ )
+ | Convenience method, equivalent to calling fileName(fileName).content(content). | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1310 | Builder | jakarta.ws.rs.core.EntityPart.Builder.content
+
+ (
+ String
+ , InputStream
+ )
+ throws
+ IllegalArgumentException
+ | if either parameter is null. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1311 | Builder | jakarta.ws.rs.core.EntityPart.Builder.content
+
+ (
+ Object
+ , Class
+ )
+ | Sets the content for this part. The content of this builder must be specified before invoking the #build() method. If the content is specified using this method, then the #build() method is responsible for finding a registered jakarta.ws.rs.ext.MessageBodyWriter that is capable of writing the object type specified here using the default MediaType or the MediaType specified in the #mediaType(MediaType) or #mediaType(String) methods and using any headers specified via the #header(String, String...) or #headers(MultivaluedMap) methods. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1312 | Builder | jakarta.ws.rs.core.EntityPart.Builder.content
+
+ (
+ Object
+ , Class
+ )
+ throws
+ IllegalArgumentException
+ | if content is null | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1313 | Builder | jakarta.ws.rs.core.EntityPart.Builder.content
+
+ (
+ Object
+ )
+ | Sets the content for this part. The content of this builder must be specified before invoking the #build() method. If the content is specified using this method, then the #build() method is responsible for finding a registered jakarta.ws.rs.ext.MessageBodyWriter that is capable of writing the object's class type specified here using the default MediaType or the MediaType specified in the #mediaType(MediaType) or #mediaType(String) methods and using any headers specified via the #header(String, String...) or #headers(MultivaluedMap) methods. This is the equivalent of calling content(content, content.getClass()). | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1314 | Builder | jakarta.ws.rs.core.EntityPart.Builder.content
+
+ (
+ Object
+ )
+ throws
+ IllegalArgumentException
+ | if content is null | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1315 | Builder | jakarta.ws.rs.core.EntityPart.Builder.content
+
+ (
+ Object
+ , GenericType
+ )
+ | Sets the content for this part. The content of this builder must be specified before invoking the #build() method. If the content is specified using this method, then the #build() method is responsible for finding a registered jakarta.ws.rs.ext.MessageBodyWriter that is capable of writing the object type specified here using the default MediaType or the MediaType specified in the #mediaType(MediaType) or #mediaType(String) methods and using any headers specified via the #header(String, String...) or #headers(MultivaluedMap) methods. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1316 | Builder | jakarta.ws.rs.core.EntityPart.Builder.content
+
+ (
+ Object
+ , GenericType
+ )
+ throws
+ IllegalArgumentException
+ | if content is null | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1317 | Builder | jakarta.ws.rs.core.EntityPart.Builder.fileName
+
+ (
+ String
+ )
+ | Sets the file name for this part. The file name will be specified as an attribute in the Content-Disposition header of this part. When this method is called, the default media type used for the built part will be "application/octet-stream" if not otherwise specified. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1318 | Builder | jakarta.ws.rs.core.EntityPart.Builder.fileName
+
+ (
+ String
+ )
+ throws
+ IllegalArgumentException
+ | if fileName is null | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1319 | Builder | jakarta.ws.rs.core.EntityPart.Builder.header
+
+ (
+ String
+ , String[]
+ )
+ | Adds a new header or replaces a previously added header and sets the header value(s). | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1320 | Builder | jakarta.ws.rs.core.EntityPart.Builder.header
+
+ (
+ String
+ , String[]
+ )
+ throws
+ IllegalArgumentException
+ | if headerName is null | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1321 | Builder | jakarta.ws.rs.core.EntityPart.Builder.headers
+
+ (
+ MultivaluedMap
+ )
+ | Adds new headers or replaces previously added headers. The behavior of this method would be the same as if iterating over the entry set and invoking the #header(String, String...) method. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1322 | Builder | jakarta.ws.rs.core.EntityPart.Builder.headers
+
+ (
+ MultivaluedMap
+ )
+ throws
+ IllegalArgumentException
+ | if newHeaders is null | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1323 | Builder | jakarta.ws.rs.core.EntityPart.Builder.mediaType
+
+ (
+ MediaType
+ )
+ | Sets the media type for the EntityPart. This will also set the Content-Type header for this part. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1324 | Builder | jakarta.ws.rs.core.EntityPart.Builder.mediaType
+
+ (
+ MediaType
+ )
+ throws
+ IllegalArgumentException
+ | if mediaType is null | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1325 | Builder | jakarta.ws.rs.core.EntityPart.Builder.mediaType
+
+ (
+ String
+ )
+ | Convenience method for setting the media type for the EntityPart. This will also set the Content-Type header for this part. This call is effectively the same as mediaType(MediaType.valueOf(mediaTypeString)). | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1326 | Builder | jakarta.ws.rs.core.EntityPart.Builder.mediaType
+
+ (
+ String
+ )
+ throws
+ IllegalArgumentException
+ | if mediaTypeString cannot be parsed or is null | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1327 | SameSite | jakarta.ws.rs.core.NewCookie.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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1328 | NewCookie | jakarta.ws.rs.core.NewCookie.NewCookie
+
+ (
+ String
+ , String
+ , String
+ , String
+ , int
+ , String
+ , int
+ , Date
+ , boolean
+ , boolean
+ , SameSite
+ )
+ | Create a new instance. | true | true | true |
+
+
+JAXRS:JAVADOC:1329 | NewCookie | jakarta.ws.rs.core.NewCookie.NewCookie
+
+ (
+ Cookie
+ , String
+ , int
+ , Date
+ , boolean
+ , boolean
+ , SameSite
+ )
+ | Create a new instance supplementing the information in the supplied cookie. | true | true | true |
+
+
+JAXRS:JAVADOC:1330 | NewCookie | jakarta.ws.rs.core.NewCookie.AbstractNewCookieBuilder.build
+ | Build a new NewCookie instance using all the configuration previously specified in this builder. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1331 | AbstractNewCookieBuilder | jakarta.ws.rs.core.NewCookie.AbstractNewCookieBuilder.comment
+
+ (
+ String
+ )
+ | Set the comment associated with the cookie. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1332 | AbstractNewCookieBuilder | jakarta.ws.rs.core.NewCookie.AbstractNewCookieBuilder.expiry
+
+ (
+ Date
+ )
+ | 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 #maxAge(int) Max-Age to control cookie expiration, however some browsers do not understand Max-Age, in which case setting Expires parameter may be necessary. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1333 | AbstractNewCookieBuilder | jakarta.ws.rs.core.NewCookie.AbstractNewCookieBuilder.httpOnly
+
+ (
+ boolean
+ )
+ | Whether the cookie will only be visible as part of an HTTP request. Defaults to false. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1334 | AbstractNewCookieBuilder | jakarta.ws.rs.core.NewCookie.AbstractNewCookieBuilder.maxAge
+
+ (
+ int
+ )
+ | 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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1335 | AbstractNewCookieBuilder | jakarta.ws.rs.core.NewCookie.AbstractNewCookieBuilder.NewCookie.AbstractNewCookieBuilder
+
+ (
+ String
+ )
+ | Create a new instance. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1336 | AbstractNewCookieBuilder | jakarta.ws.rs.core.NewCookie.AbstractNewCookieBuilder.NewCookie.AbstractNewCookieBuilder
+
+ (
+ Cookie
+ )
+ | Create a new instance supplementing the information in the supplied cookie. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1337 | AbstractNewCookieBuilder | jakarta.ws.rs.core.NewCookie.AbstractNewCookieBuilder.sameSite
+
+ (
+ SameSite
+ )
+ | Set the attribute that controls whether the cookie is sent with cross-origin requests, providing protection against cross-site request forgery. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1338 | AbstractNewCookieBuilder | jakarta.ws.rs.core.NewCookie.AbstractNewCookieBuilder.secure
+
+ (
+ boolean
+ )
+ | Whether the cookie will only be sent over a secure connection. Defaults to false. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1339 | NewCookie | jakarta.ws.rs.core.NewCookie.Builder.build
+ | Build a new NewCookie instance using all the configuration previously specified in this builder. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1340 | Builder | jakarta.ws.rs.core.NewCookie.Builder.NewCookie.Builder
+
+ (
+ String
+ )
+ | Create a new instance. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1341 | Builder | jakarta.ws.rs.core.NewCookie.Builder.NewCookie.Builder
+
+ (
+ Cookie
+ )
+ | Create a new instance supplementing the information in the supplied cookie. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1342 | SameSite | jakarta.ws.rs.core.NewCookie.SameSite.valueOf
+
+ (
+ String
+ )
+ |
+
+ | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1343 | SameSite[] | jakarta.ws.rs.core.NewCookie.SameSite.values
+ |
+
+ | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1344 | boolean | jakarta.ws.rs.core.Response.isClosed
+ | Check if the response is closed. The method returns true if the response is closed, returns false otherwise. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1345 | UriBuilder | jakarta.ws.rs.core.UriBuilder.newInstance
+ | Creates a new instance of UriBuilder. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1346 | boolean | jakarta.ws.rs.ext.InterceptorContext.hasProperty
+
+ (
+ String
+ )
+ | 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 method with a property name to get the value of a property. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1347 | CompletionStage | jakarta.ws.rs.ext.RuntimeDelegate.bootstrap
+
+ (
+ Application
+ , 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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1348 | CompletionStage | jakarta.ws.rs.ext.RuntimeDelegate.bootstrap
+
+ (
+ Class
+ , 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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1349 | Builder | jakarta.ws.rs.ext.RuntimeDelegate.createConfigurationBuilder
+ | Create a new instance of a jakarta.ws.rs.SeBootstrap.Configuration.Builder. This method is not intended to be invoked by applications. Call SeBootstrap.Configuration#builder() instead. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1350 | Builder | jakarta.ws.rs.ext.RuntimeDelegate.createEntityPartBuilder
+
+ (
+ String
+ )
+ | Create a new instance of a jakarta.ws.rs.core.EntityPart.Builder. This method is not intended to be invoked by applications. Call EntityPart#withName(String) instead. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1351 | Builder | jakarta.ws.rs.ext.RuntimeDelegate.createEntityPartBuilder
+
+ (
+ String
+ )
+ throws
+ IllegalArgumentException
+ | if partName is null. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1352 | void | jakarta.ws.rs.sse.SseBroadcaster.close
+
+ (
+ boolean
+ )
+ | 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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:440__OLD | String | jakarta.ws.rs.client.ClientRequestContext.getHeaderString
+
+ (
+ String
+ )
+ | Get a message header as a single string value. Each single header value is converted to String using a jakarta.ws.rs.ext.RuntimeDelegate.HeaderDelegate if one is available via jakarta.ws.rs.ext.RuntimeDelegate#createHeaderDelegate(java.lang.Class) for the header value class or using its toString method if a header delegate is not available. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:440 | String | jakarta.ws.rs.client.ClientRequestContext.getHeaderString
+
+ (
+ String
+ )
+ | Get a message header as a single string value. Each single non-string header value is converted to String using a jakarta.ws.rs.ext.RuntimeDelegate.HeaderDelegate if one is available via jakarta.ws.rs.ext.RuntimeDelegate#createHeaderDelegate(java.lang.Class) for the header value class or using its toString method if a header delegate is not available. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:689__OLD | String | jakarta.ws.rs.container.ContainerResponseContext.getHeaderString
+
+ (
+ String
+ )
+ | Get a message header as a single string value. Each single header value is converted to String using a jakarta.ws.rs.ext.RuntimeDelegate.HeaderDelegate if one is available via jakarta.ws.rs.ext.RuntimeDelegate#createHeaderDelegate(java.lang.Class) for the header value class or using its toString method if a header delegate is not available. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:689 | String | jakarta.ws.rs.container.ContainerResponseContext.getHeaderString
+
+ (
+ String
+ )
+ | Get a message header as a single string value. Each single non-string header value is converted to String using a jakarta.ws.rs.ext.RuntimeDelegate.HeaderDelegate if one is available via jakarta.ws.rs.ext.RuntimeDelegate#createHeaderDelegate(java.lang.Class) for the header value class or using its toString method if a header delegate is not available. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:758__OLD | Configurable | jakarta.ws.rs.core.Configurable.register
+
+ (
+ Object
+ )
+ | Register an instance of a custom JAX-RS component (such as an extension provider or a jakarta.ws.rs.core.Feature 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 jakarta.ws.rs.container.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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:758 | Configurable | jakarta.ws.rs.core.Configurable.register
+
+ (
+ Object
+ )
+ | Register an instance of a custom JAX-RS component (such as an extension provider or a jakarta.ws.rs.core.Feature 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 jakarta.ws.rs.container.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 by the JAX-RS runtime prior to use. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:780__OLD | String | jakarta.ws.rs.core.HttpHeaders.getHeaderString
+
+ (
+ String
+ )
+ | Get a HTTP header as a single string value. Each single header value is converted to String using a jakarta.ws.rs.ext.RuntimeDelegate.HeaderDelegate if one is available via jakarta.ws.rs.ext.RuntimeDelegate#createHeaderDelegate(java.lang.Class) for the header value class or using its toString method if a header delegate is not available. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:780 | String | jakarta.ws.rs.core.HttpHeaders.getHeaderString
+
+ (
+ String
+ )
+ | Get a HTTP header as a single string value. Each single non-string header value is converted to String using a jakarta.ws.rs.ext.RuntimeDelegate.HeaderDelegate if one is available via jakarta.ws.rs.ext.RuntimeDelegate#createHeaderDelegate(java.lang.Class) for the header value class or using its toString method if a header delegate is not available. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:994__OLD | Set | jakarta.ws.rs.core.Configuration.getInstances
+ | Get the immutable set of registered JAX-RS component (such as provider or Feature 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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:994 | Set | jakarta.ws.rs.core.Configuration.getInstances
+ | Get the immutable set of registered JAX-RS component (such as provider or Feature feature) instances to be utilized by the configurable instance. Fields and properties of returned instances are injected with their declared dependencies 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. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:23__OLD | Set | jakarta.ws.rs.core.Application.getSingletons
+ | Get a set of root resource, provider and Feature 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. | true | true | true |
+
+
+JAXRS:JAVADOC:23 | Set | jakarta.ws.rs.core.Application.getSingletons
+ | Get a set of root resource, provider and Feature feature instances. Fields and properties of returned instances are injected with their declared dependencies 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. | true | true | true |
+
+
+JAXRS:JAVADOC:1285__OLD | Builder | jakarta.ws.rs.core.Cookie.Builder.Cookie.Builder
+
+ (
+ String
+ )
+ |
+
+ | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1285 | Builder | jakarta.ws.rs.core.Cookie.Builder.Cookie.Builder
+
+ (
+ String
+ )
+ | Create a new instance. | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1353 | boolean | jakarta.ws.rs.client.ClientRequestContext.containsHeaderString
+
+ (
+ String
+ , String
+ , Predicate
+ )
+ | 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 jakarta.ws.rs.ext.RuntimeDelegate.HeaderDelegate if one is available via jakarta.ws.rs.ext.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). | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1354 | boolean | jakarta.ws.rs.client.ClientRequestContext.containsHeaderString
+
+ (
+ String
+ , Predicate
+ )
+ | 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 jakarta.ws.rs.ext.RuntimeDelegate.HeaderDelegate if one is available via jakarta.ws.rs.ext.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). | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1355 | boolean | jakarta.ws.rs.client.ClientResponseContext.containsHeaderString
+
+ (
+ String
+ , String
+ , Predicate
+ )
+ | 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). | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1356 | boolean | jakarta.ws.rs.client.ClientResponseContext.containsHeaderString
+
+ (
+ String
+ , Predicate
+ )
+ | 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). | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1357 | boolean | jakarta.ws.rs.container.ContainerRequestContext.containsHeaderString
+
+ (
+ String
+ , String
+ , Predicate
+ )
+ | 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). | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1358 | boolean | jakarta.ws.rs.container.ContainerRequestContext.containsHeaderString
+
+ (
+ String
+ , Predicate
+ )
+ | 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). | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1359 | boolean | jakarta.ws.rs.container.ContainerResponseContext.containsHeaderString
+
+ (
+ String
+ , String
+ , Predicate
+ )
+ | 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 jakarta.ws.rs.ext.RuntimeDelegate.HeaderDelegate if one is available via jakarta.ws.rs.ext.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). | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1360 | boolean | jakarta.ws.rs.container.ContainerResponseContext.containsHeaderString
+
+ (
+ String
+ , Predicate
+ )
+ | 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 jakarta.ws.rs.ext.RuntimeDelegate.HeaderDelegate if one is available via jakarta.ws.rs.ext.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). | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1361 | boolean | jakarta.ws.rs.core.HttpHeaders.containsHeaderString
+
+ (
+ String
+ , String
+ , Predicate
+ )
+ | 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 jakarta.ws.rs.ext.RuntimeDelegate.HeaderDelegate if one is available via jakarta.ws.rs.ext.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). | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1362 | boolean | jakarta.ws.rs.core.HttpHeaders.containsHeaderString
+
+ (
+ String
+ , Predicate
+ )
+ | 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 jakarta.ws.rs.ext.RuntimeDelegate.HeaderDelegate if one is available via jakarta.ws.rs.ext.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). | true |
+
+ | true |
+
+
+JAXRS:JAVADOC:1363 | void | jakarta.ws.rs.sse.SseEventSink.close
+ throws
+ IOException
+ | if an I/O error occurs. | true |
+
+ | true |
+
+
+
+
diff --git a/jaxrs-tck/docs/assertions/JAXRSJavadocAssertions_4.0.0.xml b/jaxrs-tck/docs/assertions/JAXRSJavadocAssertions_4.0.0.xml
new file mode 100644
index 000000000..fa878a129
--- /dev/null
+++ b/jaxrs-tck/docs/assertions/JAXRSJavadocAssertions_4.0.0.xml
@@ -0,0 +1,11538 @@
+
+
+
+
+