public class WebSocketConnectOptions extends RequestOptions
HttpClient connect a WebSocket.| Modifier and Type | Field and Description |
|---|---|
static boolean |
DEFAULT_ALLOW_ORIGIN_HEADER
The default WebSocket allow origin header =
true |
static ProxyOptions |
DEFAULT_PROXY_OPTIONS
The default value for proxy options =
null |
static List<String> |
DEFAULT_SUB_PROTOCOLS
The default WebSocket sub protocols =
null |
static WebsocketVersion |
DEFAULT_VERSION
The default WebSocket version =
WebsocketVersion.V13 |
DEFAULT_FOLLOW_REDIRECTS, DEFAULT_HOST, DEFAULT_HTTP_METHOD, DEFAULT_PORT, DEFAULT_SERVER, DEFAULT_SSL, DEFAULT_TIMEOUT, DEFAULT_URI| Constructor and Description |
|---|
WebSocketConnectOptions() |
WebSocketConnectOptions(JsonObject json) |
WebSocketConnectOptions(WebSocketConnectOptions other) |
getFollowRedirects, getHeaders, getHost, getMethod, getPort, getServer, getTimeout, getTraceOperation, getURI, isSsl, removeHeader, removeHeader, setAbsoluteURI, setAbsoluteURI, setFollowRedirects, setMethod, setServer, setTimeout, setTraceOperationpublic static final ProxyOptions DEFAULT_PROXY_OPTIONS
nullpublic static final WebsocketVersion DEFAULT_VERSION
WebsocketVersion.V13public static final List<String> DEFAULT_SUB_PROTOCOLS
nullpublic static final boolean DEFAULT_ALLOW_ORIGIN_HEADER
truepublic WebSocketConnectOptions()
public WebSocketConnectOptions(WebSocketConnectOptions other)
public WebSocketConnectOptions(JsonObject json)
public WebsocketVersion getVersion()
public WebSocketConnectOptions setVersion(WebsocketVersion version)
public List<String> getSubProtocols()
null if there are nonepublic WebSocketConnectOptions setSubProtocols(List<String> subProtocols)
public WebSocketConnectOptions addSubProtocol(String subprotocol)
public ProxyOptions getProxyOptions()
getProxyOptions in class RequestOptionspublic RequestOptions setProxyOptions(ProxyOptions proxyOptions)
HttpClientOptions.setProxyOptions(ProxyOptions) proxy options
for connections.setProxyOptions in class RequestOptionsproxyOptions - proxy options override objectpublic boolean getAllowOriginHeader()
origin header to the WebSocket handshake requestpublic WebSocketConnectOptions setAllowOriginHeader(boolean allowOriginHeader)
origin header to the WebSocket handshake request, enabled by default.
Set to false when a server does not accept WebSocket with an origin header.
allowOriginHeader - whether to add the origin header to the WebSocket handshake requestpublic WebSocketConnectOptions setHost(String host)
RequestOptionssetHost in class RequestOptionspublic WebSocketConnectOptions setPort(Integer port)
RequestOptionssetPort in class RequestOptionspublic WebSocketConnectOptions setSsl(Boolean ssl)
RequestOptionssetSsl in class RequestOptionsssl - true if enabledpublic WebSocketConnectOptions setURI(String uri)
RequestOptionssetURI in class RequestOptionsuri - the relative uripublic WebSocketConnectOptions addHeader(String key, String value)
RequestOptionsaddHeader in class RequestOptionskey - the header keyvalue - the header valuepublic WebSocketConnectOptions addHeader(CharSequence key, CharSequence value)
RequestOptionsaddHeader in class RequestOptionskey - the header keyvalue - the header valuepublic WebSocketConnectOptions addHeader(CharSequence key, Iterable<CharSequence> values)
addHeader in class RequestOptionspublic WebSocketConnectOptions putHeader(String key, String value)
RequestOptionsputHeader in class RequestOptionskey - the header keyvalue - the header valuepublic WebSocketConnectOptions putHeader(CharSequence key, CharSequence value)
RequestOptionsputHeader in class RequestOptionskey - the header keyvalue - the header valuepublic WebSocketConnectOptions putHeader(CharSequence key, Iterable<CharSequence> values)
putHeader in class RequestOptionspublic WebSocketConnectOptions setHeaders(MultiMap headers)
RequestOptionssetHeaders in class RequestOptionsheaders - the headerspublic JsonObject toJson()
toJson in class RequestOptionsCopyright © 2022 Eclipse. All rights reserved.