Top Fields Constructors Methods
org.eclipse.jetty.websocket.core.client

public abstract Class CoreClientUpgradeRequest

extends Object
implements CompleteListener, Factory
Class Inheritance
All Implemented Interfaces
org.eclipse.jetty.client.HttpUpgrader.Factory, org.eclipse.jetty.client.Response.CompleteListener, org.eclipse.jetty.client.Response.ResponseListener, java.util.EventListener
Imports
java.io.IOException, java.net.URI, java.util.ArrayList, .Arrays, .Iterator, .List, .Map, java.util.concurrent.CompletableFuture, .TimeUnit, java.util.function.Consumer, java.util.stream.Collectors, org.eclipse.jetty.client.HttpClient, .HttpUpgrader, .Request, .Response, .Result, org.eclipse.jetty.http.HttpCookie, .HttpField, .HttpFields, .HttpHeader, .HttpScheme, .HttpStatus, .HttpVersion, org.eclipse.jetty.io.ByteBufferPool, .EndPoint, org.eclipse.jetty.util.Callback, .ExceptionUtil, .QuotedStringTokenizer, .StringUtil, org.eclipse.jetty.websocket.core.Behavior, .Configuration, .CoreSession, .ExtensionConfig, .ExtensionStack, .FrameHandler, .Negotiated, .WebSocketConnection, .WebSocketConstants, .WebSocketCoreSession, org.eclipse.jetty.websocket.core.client.internal.HttpUpgraderOverHTTP, .HttpUpgraderOverHTTP2, org.eclipse.jetty.websocket.core.exception.UpgradeException, .WebSocketException, org.slf4j.Logger, .LoggerFactory

Field Summary

Modifier and TypeField and Description
private final Configuration.ConfigurationCustomizer
customizer

private FrameHandler
frameHandler

private final CompletableFuture<CoreSession>
futureCoreSession

private static final Logger
LOG

private final Request
request

private List<ExtensionConfig>
requestedExtensions

private boolean
upgraded

private final List<UpgradeListener>
upgradeListeners

private final WebSocketCoreClient
wsClient

Constructor Summary

AccessConstructor and Description
public
CoreClientUpgradeRequest(WebSocketCoreClient webSocketClient, URI requestURI)

Method Summary

Modifier and TypeMethod and Description
public void
addExtensions(ExtensionConfig... configs)

public void
addExtensions(String... configs)

public void
addListener(UpgradeListener listener)

protected void
customize(EndPoint endPoint)

Allow for overridden customization of endpoint (such as special transport level properties: e.g. TCP keepAlive)

public static CoreClientUpgradeRequest
from(WebSocketCoreClient webSocketClient, URI requestURI, FrameHandler frameHandler)

public List<HttpCookie>
getCookies()

public List<ExtensionConfig>
getExtensions()

public abstract FrameHandler
getFrameHandler()

public HttpFields
getHeaders()

public String
getMethod()

public List<String>
getSubProtocols()

public URI
getURI()

public HttpVersion
getVersion()

protected void
handleException(Throwable failure)

public void
headers(Consumer<HttpFields.Mutable> consumer)

public void
listener(Request.Listener listener)

public HttpUpgrader
newHttpUpgrader(HttpVersion version)

Implements org.eclipse.jetty.client.HttpUpgrader.Factory.newHttpUpgrader.

private Throwable
notifyUpgradeListeners(Consumer<UpgradeListener> action)

public void
onComplete(Result
the result of the request / response exchange
result)

Implements org.eclipse.jetty.client.Response.CompleteListener.onComplete.

Callback method invoked when the request and the response have been processed, either successfully or not.

public void
requestComplete()

public void
send(Response.CompleteListener listener)

public CompletableFuture<CoreSession>
sendAsync()

public void
setConfiguration(Configuration.ConfigurationCustomizer config)

public void
setExtensions(List<ExtensionConfig> configs)

public void
setSubProtocols(String... protocols)

public void
setSubProtocols(List<String> protocols)

public void
timeout(long value, TimeUnit unit)

public void
upgrade(Response response, EndPoint endPoint)

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

customizerback to summary
private final Configuration.ConfigurationCustomizer customizer
frameHandlerback to summary
private FrameHandler frameHandler
futureCoreSessionback to summary
private final CompletableFuture<CoreSession> futureCoreSession
LOGback to summary
private static final Logger LOG
requestback to summary
private final Request request
requestedExtensionsback to summary
private List<ExtensionConfig> requestedExtensions
upgradedback to summary
private boolean upgraded
upgradeListenersback to summary
private final List<UpgradeListener> upgradeListeners
wsClientback to summary
private final WebSocketCoreClient wsClient

Constructor Detail

CoreClientUpgradeRequestback to summary
public CoreClientUpgradeRequest(WebSocketCoreClient webSocketClient, URI requestURI)

Method Detail

addExtensionsback to summary
public void addExtensions(ExtensionConfig... configs)
addExtensionsback to summary
public void addExtensions(String... configs)
addListenerback to summary
public void addListener(UpgradeListener listener)
customizeback to summary
protected void customize(EndPoint endPoint)

Allow for overridden customization of endpoint (such as special transport level properties: e.g. TCP keepAlive)

fromback to summary
public static CoreClientUpgradeRequest from(WebSocketCoreClient webSocketClient, URI requestURI, FrameHandler frameHandler)
getCookiesback to summary
public List<HttpCookie> getCookies()
getExtensionsback to summary
public List<ExtensionConfig> getExtensions()
getFrameHandlerback to summary
public abstract FrameHandler getFrameHandler()
getHeadersback to summary
public HttpFields getHeaders()
getMethodback to summary
public String getMethod()
getSubProtocolsback to summary
public List<String> getSubProtocols()
getURIback to summary
public URI getURI()
getVersionback to summary
public HttpVersion getVersion()
handleExceptionback to summary
protected void handleException(Throwable failure)
headersback to summary
public void headers(Consumer<HttpFields.Mutable> consumer)
listenerback to summary
public void listener(Request.Listener listener)
newHttpUpgraderback to summary
public HttpUpgrader newHttpUpgrader(HttpVersion version)

Implements org.eclipse.jetty.client.HttpUpgrader.Factory.newHttpUpgrader.

Annotations
@Override
notifyUpgradeListenersback to summary
private Throwable notifyUpgradeListeners(Consumer<UpgradeListener> action)
onCompleteback to summary
public void onComplete(Result result)

Implements org.eclipse.jetty.client.Response.CompleteListener.onComplete.

Doc from org.eclipse.jetty.client.Response.CompleteListener.onComplete.

Callback method invoked when the request and the response have been processed, either successfully or not.

The result parameter contains the request, the response, and eventual failures.

Requests may complete after response, for example in case of big uploads that are discarded or read asynchronously by the server. This method is always invoked after SuccessListener#onSuccess(Response) or FailureListener#onFailure(Response, Throwable), and only when request indicates that it is completed.

Parameters
result:Result

the result of the request / response exchange

Annotations
@Override
requestCompleteback to summary
public void requestComplete()
sendback to summary
public void send(Response.CompleteListener listener)
sendAsyncback to summary
public CompletableFuture<CoreSession> sendAsync()
setConfigurationback to summary
public void setConfiguration(Configuration.ConfigurationCustomizer config)
setExtensionsback to summary
public void setExtensions(List<ExtensionConfig> configs)
setSubProtocolsback to summary
public void setSubProtocols(String... protocols)
setSubProtocolsback to summary
public void setSubProtocols(List<String> protocols)
timeoutback to summary
public void timeout(long value, TimeUnit unit)
upgradeback to summary
public void upgrade(Response response, EndPoint endPoint)