Package org.eclipse.jetty.websocket.core.client

Class CoreClientUpgradeRequest

java.lang.Object

org.eclipse.jetty.client.HttpRequest

org.eclipse.jetty.websocket.core.client.CoreClientUpgradeRequest

All Implemented Interfaces:

EventListener, Request, Response.CompleteListener, Response.ResponseListener, HttpUpgrader.Factory

Direct Known Subclasses:

JakartaClientUpgradeRequest, JettyClientUpgradeRequest

public abstract class CoreClientUpgradeRequest
extends HttpRequest
implements Response.CompleteListener, HttpUpgrader.Factory

Nested Class Summary

Nested classes/interfaces inherited from interface org.eclipse.jetty.client.api.Request

Request.BeginListener, Request.CommitListener, Request.Content, Request.ContentListener, Request.FailureListener, Request.HeadersListener, Request.Listener, Request.QueuedListener, Request.RequestListener, Request.SuccessListener

Field Summary

Fields

Modifier and Type	Field	Description
protected final CompletableFuture<CoreSession>	futureCoreSession

Constructor Summary

Constructors

Constructor	Description
CoreClientUpgradeRequest(WebSocketCoreClient webSocketClient, URI requestURI)

Method Summary

Modifier and Type	Method	Description
void	addExtensions(String... configs)
void	addExtensions(ExtensionConfig... configs)
void	addListener(UpgradeListener listener)
protected void	customize(EndPoint endPoint)	Allow for overridden customization of endpoint (such as special transport level properties: e.g.
static CoreClientUpgradeRequest	from(WebSocketCoreClient webSocketClient, URI requestURI, FrameHandler frameHandler)
List<ExtensionConfig>	getExtensions()
abstract FrameHandler	getFrameHandler()
List<String>	getSubProtocols()
protected void	handleException(Throwable failure)
HttpUpgrader	newHttpUpgrader(HttpVersion version)
void	onComplete(Result result)	Callback method invoked when the request and the response have been processed, either successfully or not.
void	requestComplete()
void	send(Response.CompleteListener listener)	Sends this request and asynchronously notifies the given listener for response events.
CompletableFuture<CoreSession>	sendAsync()
void	setConfiguration(Configuration.ConfigurationCustomizer config)
void	setExtensions(List<ExtensionConfig> configs)
void	setSubProtocols(String... protocols)
void	setSubProtocols(List<String> protocols)
void	upgrade(HttpResponse response, EndPoint endPoint)

Methods inherited from class org.eclipse.jetty.client.HttpRequest

abort, accept, addHeader, agent, attribute, body, content, content, cookie, file, file, followRedirects, getAbortCause, getAgent, getAttributes, getBody, getConnection, getContent, getConversation, getCookies, getHeaders, getHost, getIdleTimeout, getMethod, getParams, getPath, getPort, getPushListener, getQuery, getRequestListeners, getResponseListeners, getScheme, getTag, getTimeout, getTrailers, getUpgradeProtocol, getURI, getVersion, header, header, headers, host, idleTimeout, isFollowRedirects, isVersionExplicit, listener, method, method, onComplete, onRequestBegin, onRequestCommit, onRequestContent, onRequestFailure, onRequestHeaders, onRequestQueued, onRequestSuccess, onResponseBegin, onResponseContent, onResponseContentAsync, onResponseContentDemanded, onResponseFailure, onResponseHeader, onResponseHeaders, onResponseSuccess, param, path, port, pushListener, scheme, send, tag, timeout, toString, trailers, upgradeProtocol, version

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

futureCoreSession

protected final CompletableFuture<CoreSession> futureCoreSession

Constructor Details

CoreClientUpgradeRequest

public CoreClientUpgradeRequest(WebSocketCoreClient webSocketClient,
 URI requestURI)

Method Details

from

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

setConfiguration

public void setConfiguration(Configuration.ConfigurationCustomizer config)

addListener

public void addListener(UpgradeListener listener)

addExtensions

public void addExtensions(ExtensionConfig... configs)

addExtensions

public void addExtensions(String... configs)

getExtensions

public List<ExtensionConfig> getExtensions()

setExtensions

public void setExtensions(List<ExtensionConfig> configs)

getSubProtocols

public List<String> getSubProtocols()

setSubProtocols

public void setSubProtocols(String... protocols)

setSubProtocols

public void setSubProtocols(List<String> protocols)

send

public void send(Response.CompleteListener listener)

Description copied from interface: Request

Sends this request and asynchronously notifies the given listener for response events.

This method should be used when the application needs to be notified of the various response events as they happen, or when the application needs to efficiently manage the response content.

The listener passed to this method may implement not only Response.CompleteListener but also other response listener interfaces, and all the events implemented will be notified. This allows application code to write a single listener class to handle all relevant events.

Specified by:

send in interface Request

Overrides:

send in class HttpRequest

Parameters:

listener - the listener that receives response events

sendAsync

public CompletableFuture<CoreSession> sendAsync()

onComplete

public void onComplete(Result result)

Description copied from interface: Response.CompleteListener

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 Response.SuccessListener.onSuccess(Response) or Response.FailureListener.onFailure(Response, Throwable), and only when request indicates that it is completed.

Specified by:

onComplete in interface Response.CompleteListener

Parameters:

result - the result of the request / response exchange

handleException

protected void handleException(Throwable failure)

newHttpUpgrader

public HttpUpgrader newHttpUpgrader(HttpVersion version)

Specified by:

newHttpUpgrader in interface HttpUpgrader.Factory

customize

protected void customize(EndPoint endPoint)

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

getFrameHandler

public abstract FrameHandler getFrameHandler()

requestComplete

public void requestComplete()

upgrade

public void upgrade(HttpResponse response,
 EndPoint endPoint)