Package io.vertx.rxjava3.ext.web.client
Class WebClientSession
- java.lang.Object
-
- io.vertx.rxjava3.ext.web.client.WebClient
-
- io.vertx.rxjava3.ext.web.client.WebClientSession
-
- All Implemented Interfaces:
io.vertx.lang.rx.RxDelegate
public class WebClientSession extends WebClient implements io.vertx.lang.rx.RxDelegate
An asynchronous sessions aware HTTP / HTTP/2 client calledWebClientSession.This client wraps a
WebClientand makes it session aware adding features to it:- Per client headers, to be send with every request
- Per client cookies, to be send with every request
- Automatic storage and sending of cookies received from the server(s)
The client honors the cookies attributes:
- domain
- path
- secure
- max-age and expires
NOTE: This class has been automatically generated from the
originalnon RX-ified interface using Vert.x codegen.
-
-
Field Summary
Fields Modifier and Type Field Description static io.vertx.lang.rx.TypeArg<WebClientSession>__TYPE_ARG
-
Constructor Summary
Constructors Constructor Description WebClientSession(WebClientSession delegate)WebClientSession(Object delegate)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description WebClientSessionaddHeader(CharSequence name, CharSequence value)Configure the client to add an HTTP header to every request.WebClientSessionaddHeader(CharSequence name, Iterable<CharSequence> values)Configure the client to add an HTTP header to every request.WebClientSessionaddHeader(String name, Iterable<String> values)Configure the client to add an HTTP header to every request.WebClientSessionaddHeader(String name, String value)Configure the client to add an HTTP header to every request.CookieStorecookieStore()Returns this client'sCookieStorestatic WebClientSessioncreate(WebClient webClient)Create a session aware web client using the providedwebClientinstance.static WebClientSessioncreate(WebClient webClient, CookieStore cookieStore)Create a session aware web client using the providedwebClientinstance.booleanequals(Object o)WebClientSessiongetDelegate()inthashCode()static WebClientSessionnewInstance(WebClientSession arg)WebClientSessionremoveHeader(CharSequence name)Removes a previously added header.WebClientSessionremoveHeader(String name)Removes a previously added header.StringtoString()-
Methods inherited from class io.vertx.rxjava3.ext.web.client.WebClient
close, create, create, create, delete, delete, delete, delete, delete, delete, deleteAbs, deleteAbs, get, get, get, get, get, get, getAbs, getAbs, head, head, head, head, head, head, headAbs, headAbs, newInstance, patch, patch, patch, patch, patch, patch, patchAbs, patchAbs, post, post, post, post, post, post, postAbs, postAbs, put, put, put, put, put, put, putAbs, putAbs, request, request, request, request, request, request, request, request, request, request, request, request, request, request, requestAbs, requestAbs, requestAbs, requestAbs, rxUpdateSSLOptions, rxUpdateSSLOptions, updateSSLOptions, updateSSLOptions, wrap, wrap
-
-
-
-
Field Detail
-
__TYPE_ARG
public static final io.vertx.lang.rx.TypeArg<WebClientSession> __TYPE_ARG
-
-
Constructor Detail
-
WebClientSession
public WebClientSession(WebClientSession delegate)
-
WebClientSession
public WebClientSession(Object delegate)
-
-
Method Detail
-
getDelegate
public WebClientSession getDelegate()
- Specified by:
getDelegatein interfaceio.vertx.lang.rx.RxDelegate- Overrides:
getDelegatein classWebClient
-
create
public static WebClientSession create(WebClient webClient)
Create a session aware web client using the providedwebClientinstance.- Parameters:
webClient- the web client instance- Returns:
- the created client
-
addHeader
public WebClientSession addHeader(String name, String value)
Configure the client to add an HTTP header to every request.- Parameters:
name- the header namevalue- the header value- Returns:
- a reference to this, so the API can be used fluently
-
removeHeader
public WebClientSession removeHeader(String name)
Removes a previously added header.- Parameters:
name- the header name- Returns:
- a reference to this, so the API can be used fluently
-
create
public static WebClientSession create(WebClient webClient, CookieStore cookieStore)
Create a session aware web client using the providedwebClientinstance.- Parameters:
webClient- the web client instancecookieStore-- Returns:
- the created client
-
addHeader
public WebClientSession addHeader(CharSequence name, CharSequence value)
Configure the client to add an HTTP header to every request.- Parameters:
name- the header namevalue- the header value- Returns:
- a reference to this, so the API can be used fluently
-
addHeader
public WebClientSession addHeader(CharSequence name, Iterable<CharSequence> values)
Configure the client to add an HTTP header to every request.- Parameters:
name- the header namevalues- the header value- Returns:
- a reference to this, so the API can be used fluently
-
addHeader
public WebClientSession addHeader(String name, Iterable<String> values)
Configure the client to add an HTTP header to every request.- Parameters:
name- the header namevalues- the header value- Returns:
- a reference to this, so the API can be used fluently
-
removeHeader
public WebClientSession removeHeader(CharSequence name)
Removes a previously added header.- Parameters:
name- the header name- Returns:
- a reference to this, so the API can be used fluently
-
cookieStore
public CookieStore cookieStore()
Returns this client'sCookieStoreAll cookies added to this store will be sent with every request. The CookieStore honors the domain, path, secure and max-age properties of received cookies and is automatically updated with cookies present in responses received by this client.
- Returns:
- this client's cookie store
-
newInstance
public static WebClientSession newInstance(WebClientSession arg)
-
-