Index
All Classes and Interfaces|All Packages|Serialized Form
A
- accept(MediaType...) - Method in interface io.helidon.webclient.WebClientRequestBuilder
-
Media types which are accepted in the response.
- acceptedTypes() - Method in interface io.helidon.webclient.WebClientRequestHeaders
-
Returns a list of acceptedTypes ("Accept" header) content types in quality factor order.
- add(String, Iterable<String>) - Method in interface io.helidon.webclient.WebClientRequestHeaders
- add(String, String...) - Method in interface io.helidon.webclient.WebClientRequestHeaders
- addAccept(MediaType) - Method in interface io.helidon.webclient.WebClientRequestHeaders
-
Add accepted
MediaType. - addAll(Parameters) - Method in interface io.helidon.webclient.WebClientRequestHeaders
- addCookie(String, String) - Method in class io.helidon.webclient.WebClient.Builder
-
Add a default cookie.
- addCookie(String, String) - Method in interface io.helidon.webclient.WebClientRequestHeaders
-
Add a cookie to the request.
- addHeader(String, Iterable<String>) - Method in interface io.helidon.webclient.WebClientRequestBuilder
-
Adds header values for a specified name.
- addHeader(String, String...) - Method in class io.helidon.webclient.WebClient.Builder
-
Add a default header (such as accept).
- addHeader(String, String...) - Method in interface io.helidon.webclient.WebClientRequestBuilder
-
Adds header values for a specified name.
- addHeaders(Parameters) - Method in interface io.helidon.webclient.WebClientRequestBuilder
-
Copies all of the mappings from the specified
parametersto this response headers instance. - addMediaSupport(MediaSupport) - Method in class io.helidon.webclient.WebClient.Builder
- addNoProxy(String) - Method in class io.helidon.webclient.Proxy.Builder
-
Configure a host pattern that is not going through a proxy.
- addReader(MessageBodyReader<?>) - Method in class io.helidon.webclient.WebClient.Builder
- addService(WebClientService) - Method in class io.helidon.webclient.WebClient.Builder
-
Register new instance of
WebClientService. - addService(Supplier<? extends WebClientService>) - Method in class io.helidon.webclient.WebClient.Builder
-
Register new instance of
WebClientService. - addStreamReader(MessageBodyStreamReader<?>) - Method in class io.helidon.webclient.WebClient.Builder
- addStreamWriter(MessageBodyStreamWriter<?>) - Method in class io.helidon.webclient.WebClient.Builder
- addWriter(MessageBodyWriter<?>) - Method in class io.helidon.webclient.WebClient.Builder
- allowChunkedEncoding(boolean) - Method in interface io.helidon.webclient.WebClientRequestBuilder
-
Whether chunked
Http.Header.TRANSFER_ENCODINGshould be added to the headers if the entity is chunked. - allowedCipherSuite(List<String>) - Method in class io.helidon.webclient.WebClientTls.Builder
-
Set allowed cipher suite for the client.
B
- baseUri(String) - Method in class io.helidon.webclient.WebClient.Builder
-
Sets base uri for each request.
- baseUri(URI) - Method in class io.helidon.webclient.WebClient.Builder
-
Sets base uri for each request.
- baseUri(URL) - Method in class io.helidon.webclient.WebClient.Builder
-
Sets base url for each request.
- build() - Method in class io.helidon.webclient.Proxy.Builder
- build() - Method in class io.helidon.webclient.WebClient.Builder
- build() - Method in class io.helidon.webclient.WebClientTls.Builder
- builder() - Static method in class io.helidon.webclient.Proxy
-
Fluent API builder for new instances.
- builder() - Static method in interface io.helidon.webclient.WebClient
-
Fluent API builder for client.
- builder() - Static method in class io.helidon.webclient.WebClientTls
-
Fluent API builder for new instances.
C
- certificateTrustStore(KeyConfig) - Method in class io.helidon.webclient.WebClientTls.Builder
-
Sets new certificate trust store.
- clear() - Method in interface io.helidon.webclient.WebClientRequestHeaders
-
Clears all currently set headers.
- clientKeyStore(KeyConfig) - Method in class io.helidon.webclient.WebClientTls.Builder
-
Sets new certificate key store.
- close() - Method in interface io.helidon.webclient.WebClientResponse
-
Asynchronous close of the response.
- config(Config) - Method in class io.helidon.webclient.Proxy.Builder
-
Configure a metric from configuration.
- config(Config) - Method in class io.helidon.webclient.WebClient.Builder
-
Config of this client.
- config(Config) - Method in class io.helidon.webclient.WebClientTls.Builder
-
Configure a metric from configuration.
- configKey() - Method in interface io.helidon.webclient.spi.WebClientServiceProvider
-
Config key expected under
client.services.config. - connectTimeout(long, TimeUnit) - Method in class io.helidon.webclient.WebClient.Builder
-
Sets new connection timeout.
- connectTimeout(long, TimeUnit) - Method in interface io.helidon.webclient.WebClientRequestBuilder
-
Sets new connection timeout for this request.
- content() - Method in interface io.helidon.webclient.WebClientResponse
-
Content to access entity.
- contentLength() - Method in interface io.helidon.webclient.WebClientRequestHeaders
-
Returns content length if known.
- contentLength() - Method in interface io.helidon.webclient.WebClientResponseHeaders
-
Content length of the response payload.
- contentLength(long) - Method in interface io.helidon.webclient.WebClientRequestHeaders
-
Set a content length.
- contentType() - Method in interface io.helidon.webclient.WebClientRequestHeaders
-
Returns content type of the request.
- contentType() - Method in interface io.helidon.webclient.WebClientResponseHeaders
-
Returns content type of the response.
- contentType(MediaType) - Method in interface io.helidon.webclient.WebClientRequestBuilder
-
Content type of the request.
- contentType(MediaType) - Method in interface io.helidon.webclient.WebClientRequestHeaders
-
Set a content type.
- context() - Method in interface io.helidon.webclient.WebClientServiceRequest
-
Registry that can be used to propagate information from server (e.g.
- context() - Method in interface io.helidon.webclient.WebClientServiceResponse
-
Context in which this response is received.
- context(Context) - Method in class io.helidon.webclient.WebClient.Builder
-
Sets specific context which should be used in requests.
- context(Context) - Method in interface io.helidon.webclient.WebClientRequestBuilder
-
Explicitly configure a context to use.
- create() - Static method in class io.helidon.webclient.Proxy
-
Create from environment and system properties.
- create() - Static method in interface io.helidon.webclient.WebClient
-
Create a new WebClient.
- create(Config) - Static method in class io.helidon.webclient.Proxy
-
Create a new proxy instance from configuration.
- create(Config) - Method in interface io.helidon.webclient.spi.WebClientServiceProvider
-
Create a new service instance based on configuration.
- create(Config) - Static method in interface io.helidon.webclient.WebClient
-
Create a new WebClient based on
Config. - create(Path) - Static method in class io.helidon.webclient.FileSubscriber
-
Deprecated.Create a subscriber that consumes
DataChunksand writes them to a file.
D
- date() - Method in interface io.helidon.webclient.WebClientResponseHeaders
-
Returns value of header "Date" of the response.
- delete() - Method in interface io.helidon.webclient.WebClient
-
Create a request builder for a delete method.
- disableHostnameVerification(boolean) - Method in class io.helidon.webclient.WebClientTls.Builder
-
Sets if hostname verification should be disabled.
E
- equals(Object) - Method in class io.helidon.webclient.Proxy
- equals(Object) - Method in class io.helidon.webclient.WebClientTls
- etag() - Method in interface io.helidon.webclient.WebClientResponseHeaders
-
Returns value of header "ETag" of the response.
- expires() - Method in interface io.helidon.webclient.WebClientResponseHeaders
-
Returns value of header "Expires" of the response.
F
- FileSubscriber - Class in io.helidon.webclient
-
Deprecated, for removal: This API element is subject to removal in a future version.
- followRedirects(boolean) - Method in class io.helidon.webclient.WebClient.Builder
-
Sets if redirects should be followed or not.
- followRedirects(boolean) - Method in interface io.helidon.webclient.WebClientRequestBuilder
-
Sets if redirects should be followed at this request or not.
- fragment(String) - Method in interface io.helidon.webclient.WebClientRequestBuilder
-
Fragment of the request.
- fragment(String) - Method in interface io.helidon.webclient.WebClientServiceRequest
-
Set the new fragment of the request.
G
- get() - Method in interface io.helidon.webclient.WebClient
-
Create a request builder for a get method.
H
- handler(URI) - Method in class io.helidon.webclient.Proxy
-
Creates new proxy channel handler.
- hashCode() - Method in class io.helidon.webclient.Proxy
- hashCode() - Method in class io.helidon.webclient.WebClientTls
- head() - Method in interface io.helidon.webclient.WebClient
-
Create a request builder for a head method.
- headers() - Method in interface io.helidon.webclient.WebClientRequestBuilder.ClientRequest
-
Headers which are used in current request.
- headers() - Method in interface io.helidon.webclient.WebClientRequestBuilder
-
Get a (mutable) instance of outgoing headers.
- headers() - Method in interface io.helidon.webclient.WebClientResponse
-
Headers of the HTTP response.
- headers() - Method in interface io.helidon.webclient.WebClientServiceRequest
-
Configured request headers.
- headers() - Method in interface io.helidon.webclient.WebClientServiceResponse
-
Received response headers.
- headers(Headers) - Method in interface io.helidon.webclient.WebClientRequestBuilder
-
Configure headers.
- headers(Function<WebClientRequestHeaders, Headers>) - Method in interface io.helidon.webclient.WebClientRequestBuilder
-
Function from parameter is executed on top of stored headers.
- host() - Method in interface io.helidon.webclient.WebClientServiceRequest
-
Host of the request uri.
- host(String) - Method in class io.helidon.webclient.Proxy.Builder
-
Sets a new host value.
- host(String) - Method in interface io.helidon.webclient.WebClientServiceRequest
-
Set new host of the request.
- HTTP - Enum constant in enum class io.helidon.webclient.Proxy.ProxyType
-
HTTP proxy.
- httpVersion(Http.Version) - Method in interface io.helidon.webclient.WebClientRequestBuilder
-
Sets http version.
I
- ifMatch() - Method in interface io.helidon.webclient.WebClientRequestHeaders
-
Returns value of header "If-Match".
- ifMatch(String...) - Method in interface io.helidon.webclient.WebClientRequestHeaders
-
Sets
Http.Header.IF_MATCHheader to specific etags. - ifModifiedSince() - Method in interface io.helidon.webclient.WebClientRequestHeaders
-
Returns value of header "If-Modified-Since".
- ifModifiedSince(ZonedDateTime) - Method in interface io.helidon.webclient.WebClientRequestHeaders
-
Sets
Http.Header.IF_MODIFIED_SINCEheader to specific time. - ifNoneMatch() - Method in interface io.helidon.webclient.WebClientRequestHeaders
-
Returns value of header "If-None-Match".
- ifNoneMatch(String...) - Method in interface io.helidon.webclient.WebClientRequestHeaders
-
Sets
Http.Header.IF_NONE_MATCHheader to specific etags. - ifRange(String) - Method in interface io.helidon.webclient.WebClientRequestHeaders
-
Sets
Http.Header.IF_RANGEheader to specific etag. - ifRange(ZonedDateTime) - Method in interface io.helidon.webclient.WebClientRequestHeaders
-
Sets
Http.Header.IF_RANGEheader to specific time. - ifRangeDate() - Method in interface io.helidon.webclient.WebClientRequestHeaders
-
Returns value of header "If-Range" as a
ZonedDateTime. - ifRangeString() - Method in interface io.helidon.webclient.WebClientRequestHeaders
-
Returns value of header "If-Range" as a
String. - ifUnmodifiedSince() - Method in interface io.helidon.webclient.WebClientRequestHeaders
-
Returns value of header "If-Unmodified-Since".
- ifUnmodifiedSince(ZonedDateTime) - Method in interface io.helidon.webclient.WebClientRequestHeaders
-
Sets
Http.Header.IF_UNMODIFIED_SINCEheader to specific time. - io.helidon.webclient - module io.helidon.webclient
-
Helidon WebClient.
- io.helidon.webclient - package io.helidon.webclient
-
A reactive client for rest calls.
- io.helidon.webclient.spi - package io.helidon.webclient.spi
-
This package provides extensibility for the
WebClient.
K
- keepAlive(boolean) - Method in class io.helidon.webclient.WebClient.Builder
-
Set whether connection to server should be kept alive after request.
- keepAlive(boolean) - Method in interface io.helidon.webclient.WebClientRequestBuilder
-
Whether connection should be kept alive after request.
L
- lastEndpointURI() - Method in interface io.helidon.webclient.WebClientResponse
-
URI of the last request.
- lastModified() - Method in interface io.helidon.webclient.WebClientResponseHeaders
-
Returns value of header "Last-Modified" of the response.
- location() - Method in interface io.helidon.webclient.WebClientResponseHeaders
-
Returns
URIrepresentation of "Location" header from the response.
M
- mediaContext(MediaContext) - Method in class io.helidon.webclient.WebClient.Builder
- method(Http.RequestMethod) - Method in interface io.helidon.webclient.WebClient
-
Create a request builder for a method based on method parameter.
- method(String) - Method in interface io.helidon.webclient.WebClient
-
Create a request builder for a method based on method parameter.
N
- NONE - Enum constant in enum class io.helidon.webclient.Proxy.ProxyType
-
No proxy.
- noProxy() - Static method in class io.helidon.webclient.Proxy
-
A Proxy instance that does not proxy requests.
O
- onComplete() - Method in class io.helidon.webclient.FileSubscriber
-
Deprecated.
- onError(Throwable) - Method in class io.helidon.webclient.FileSubscriber
-
Deprecated.
- onNext(DataChunk) - Method in class io.helidon.webclient.FileSubscriber
-
Deprecated.
- onSubscribe(Flow.Subscription) - Method in class io.helidon.webclient.FileSubscriber
-
Deprecated.
- options() - Method in interface io.helidon.webclient.WebClient
-
Create a request builder for a options method.
P
- password(char[]) - Method in class io.helidon.webclient.Proxy.Builder
-
Sets a new password for the proxy.
- path(HttpRequest.Path) - Method in interface io.helidon.webclient.WebClientRequestBuilder
-
Path of the request.
- path(String) - Method in interface io.helidon.webclient.WebClientRequestBuilder
-
Path of the request.
- path(String) - Method in interface io.helidon.webclient.WebClientServiceRequest
-
Set the new path of the request.
- port() - Method in interface io.helidon.webclient.WebClientServiceRequest
-
Port of the request uri.
- port(int) - Method in class io.helidon.webclient.Proxy.Builder
-
Sets a port value.
- port(int) - Method in interface io.helidon.webclient.WebClientServiceRequest
-
Set new port of the request.
- post() - Method in interface io.helidon.webclient.WebClient
-
Create a request builder for a post method.
- properties() - Method in interface io.helidon.webclient.WebClientRequestBuilder.ClientRequest
-
Request immutable list of properties.
- properties() - Method in interface io.helidon.webclient.WebClientServiceRequest
-
Properties configured by user when creating this client request.
- property(String, String) - Method in interface io.helidon.webclient.WebClientRequestBuilder
-
Add a property to be used by a
WebClientService. - proxy() - Method in interface io.helidon.webclient.WebClientRequestBuilder.ClientRequest
-
Proxy used by current request.
- proxy(Proxy) - Method in class io.helidon.webclient.WebClient.Builder
-
Sets new proxy which will used for the requests.
- proxy(Proxy) - Method in interface io.helidon.webclient.WebClientRequestBuilder
-
Override client proxy configuration.
- Proxy - Class in io.helidon.webclient
-
A definition of a proxy server to use for outgoing requests.
- Proxy.Builder - Class in io.helidon.webclient
-
Fluent API builder for
Proxy. - Proxy.ProxyType - Enum Class in io.helidon.webclient
-
Type of the proxy.
- put() - Method in interface io.helidon.webclient.WebClient
-
Create a request builder for a put method.
- putAll(Parameters) - Method in interface io.helidon.webclient.WebClientRequestHeaders
Q
- queryParam(String, String...) - Method in interface io.helidon.webclient.WebClientRequestBuilder
-
Add a query parameter.
- queryParams(Parameters) - Method in interface io.helidon.webclient.WebClientRequestBuilder
-
Configure query parameters.
R
- readerContext() - Method in interface io.helidon.webclient.WebClientRequestBuilder
-
Returns reader context of the request builder.
- readTimeout(long, TimeUnit) - Method in class io.helidon.webclient.WebClient.Builder
-
Sets new read timeout.
- readTimeout(long, TimeUnit) - Method in interface io.helidon.webclient.WebClientRequestBuilder
-
Sets new read timeout for this request.
- redirectionCount() - Method in interface io.helidon.webclient.WebClientRequestBuilder.ClientRequest
-
Returns how many times our request has been redirected.
- request() - Method in interface io.helidon.webclient.WebClientRequestBuilder
-
Performs prepared request without expecting to receive any specific type.
- request(GenericType<T>) - Method in interface io.helidon.webclient.WebClientRequestBuilder
-
Performs prepared request and transforms response to requested type.
- request(WebClientServiceRequest) - Method in interface io.helidon.webclient.spi.WebClientService
-
Method which is called before send actual request.
- request(Class<T>) - Method in interface io.helidon.webclient.WebClientRequestBuilder
-
Performs prepared request and transforms response to requested type.
- requestId() - Method in interface io.helidon.webclient.WebClientServiceRequest
-
Request id which will be used in logging messages.
- requestId(long) - Method in interface io.helidon.webclient.WebClientRequestBuilder
-
Set new request id.
- requestId(long) - Method in interface io.helidon.webclient.WebClientServiceRequest
-
Set new request id.
- response() - Method in exception io.helidon.webclient.WebClientException
-
WebClientResponsethat caused this exception if caused by response from server. - response(WebClientRequestBuilder.ClientRequest, WebClientServiceResponse) - Method in interface io.helidon.webclient.spi.WebClientService
-
Method which is called when the last byte of the response is processed.
S
- schema() - Method in interface io.helidon.webclient.WebClientServiceRequest
-
Schema of the request uri.
- schema(String) - Method in interface io.helidon.webclient.WebClientServiceRequest
-
Set new schema of the request.
- setCookies() - Method in interface io.helidon.webclient.WebClientResponseHeaders
-
Returns
SetCookieheader of the response. - skipUriEncoding() - Method in interface io.helidon.webclient.WebClientRequestBuilder
-
Disables final uri encoding.
- SOCKS_4 - Enum constant in enum class io.helidon.webclient.Proxy.ProxyType
-
SOCKS V4 proxy.
- SOCKS_5 - Enum constant in enum class io.helidon.webclient.Proxy.ProxyType
-
SOCKS V5 proxy.
- sslContext(SSLContext) - Method in class io.helidon.webclient.WebClientTls.Builder
-
Sets new
SSLContextwhich will be used as base forSslContext. - status() - Method in interface io.helidon.webclient.WebClientResponse
-
Status of this response.
- status() - Method in interface io.helidon.webclient.WebClientServiceResponse
-
Status of the response.
- submit() - Method in interface io.helidon.webclient.WebClientRequestBuilder
-
Performs prepared request.
- submit(Object) - Method in interface io.helidon.webclient.WebClientRequestBuilder
-
Performs prepared request and submitting request entity.
- submit(Object, Class<T>) - Method in interface io.helidon.webclient.WebClientRequestBuilder
-
Performs prepared request and submitting request entity.
- submit(Flow.Publisher<DataChunk>) - Method in interface io.helidon.webclient.WebClientRequestBuilder
-
Performs prepared request and submitting request entity using
Flow.Publisher. - submit(Flow.Publisher<DataChunk>, Class<T>) - Method in interface io.helidon.webclient.WebClientRequestBuilder
-
Performs prepared request and submitting request entity using
Flow.Publisher. - submit(Function<MessageBodyWriterContext, Flow.Publisher<DataChunk>>) - Method in interface io.helidon.webclient.WebClientRequestBuilder
-
Performs prepared request and submitting request entity using a marshalling function.
- subscribeTo(Flow.Publisher<DataChunk>) - Method in class io.helidon.webclient.FileSubscriber
-
Deprecated.Subscribes this instance to the obtained publisher.
- SYSTEM - Enum constant in enum class io.helidon.webclient.Proxy.ProxyType
-
Proxy obtained from system.
T
- tls(WebClientTls) - Method in class io.helidon.webclient.WebClient.Builder
-
Sets new
WebClientTlsinstance which contains ssl configuration. - trace() - Method in interface io.helidon.webclient.WebClient
-
Create a request builder for a trace method.
- transferEncoding() - Method in interface io.helidon.webclient.WebClientResponseHeaders
-
Transfer encoding of the response.
- trustAll(boolean) - Method in class io.helidon.webclient.WebClientTls.Builder
-
Sets if all certificates should be trusted to.
- type(Proxy.ProxyType) - Method in class io.helidon.webclient.Proxy.Builder
-
Sets a new proxy type.
U
- unsetHeader(String) - Method in interface io.helidon.webclient.WebClientRequestHeaders
-
Remove a header if set.
- uri(String) - Method in interface io.helidon.webclient.WebClientRequestBuilder
-
String representation of request uri.
- uri(URI) - Method in interface io.helidon.webclient.WebClientRequestBuilder
-
Request
URI. - uri(URL) - Method in interface io.helidon.webclient.WebClientRequestBuilder
-
Request
URL. - userAgent(String) - Method in class io.helidon.webclient.WebClient.Builder
-
Sets user agent name.
- username(String) - Method in class io.helidon.webclient.Proxy.Builder
-
Sets a new username for the proxy.
- useSystemSelector(boolean) - Method in class io.helidon.webclient.Proxy.Builder
-
Configure proxy from environment variables and system properties.
- useSystemServiceLoader(boolean) - Method in class io.helidon.webclient.WebClient.Builder
-
Sets if Java Service loader should be used to load all
WebClientServiceProvider.
V
- validateHeaders(boolean) - Method in class io.helidon.webclient.WebClient.Builder
-
Whether to validate header names.
- valueOf(String) - Static method in enum class io.helidon.webclient.Proxy.ProxyType
-
Returns the enum constant of this class with the specified name.
- values() - Static method in enum class io.helidon.webclient.Proxy.ProxyType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- version() - Method in interface io.helidon.webclient.WebClientResponse
-
Http version of this response.
W
- WebClient - Interface in io.helidon.webclient
-
Base client which is used to perform requests.
- WebClient.Builder - Class in io.helidon.webclient
-
Fluent API builder for
WebClient. - WebClientException - Exception in io.helidon.webclient
-
An exception that caused this client request to fail.
- WebClientException(String) - Constructor for exception io.helidon.webclient.WebClientException
-
Creates new instance of web client exception.
- WebClientRequestBuilder - Interface in io.helidon.webclient
-
Fluent API builder that is used by
WebClientto create an outgoing request. - WebClientRequestBuilder.ClientRequest - Interface in io.helidon.webclient
-
Request to a server.
- WebClientRequestHeaders - Interface in io.helidon.webclient
-
Headers that can be modified (until request is sent) for outbound request.
- WebClientResponse - Interface in io.helidon.webclient
-
Response from a server that was created for our request.
- WebClientResponseHeaders - Interface in io.helidon.webclient
-
Headers that may be available on response from server.
- WebClientService - Interface in io.helidon.webclient.spi
-
Extension that can modify outgoing request.
- WebClientServiceProvider - Interface in io.helidon.webclient.spi
-
Java service loader interface.
- WebClientServiceRequest - Interface in io.helidon.webclient
-
Request to SPI
WebClientServicethat supports modification of the outgoing request. - WebClientServiceResponse - Interface in io.helidon.webclient
-
Response which is created upon receiving of server response.
- WebClientTls - Class in io.helidon.webclient
-
Configuration of TLS requests.
- WebClientTls.Builder - Class in io.helidon.webclient
-
Fluent API builder for
WebClientTlsinstance. - whenComplete() - Method in interface io.helidon.webclient.WebClientServiceRequest
-
Completes when the full processing of this request is done (e.g.
- whenResponseReceived() - Method in interface io.helidon.webclient.WebClientServiceRequest
-
Completes when the response headers has been received, but entity has not been processed yet.
- whenSent() - Method in interface io.helidon.webclient.WebClientServiceRequest
-
Completes when the request part of this request is done (e.g.
- writerContext() - Method in interface io.helidon.webclient.WebClientRequestBuilder
-
Returns writer context of the request builder.
All Classes and Interfaces|All Packages|Serialized Form
IoMulti.writeToFile(java.nio.file.Path)instead