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

Class CoreClientUpgradeRequest

java.lang.Object

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

All Implemented Interfaces:

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

Direct Known Subclasses:

JakartaClientUpgradeRequest, JettyClientUpgradeRequest

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

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<HttpCookie>	getCookies()
List<ExtensionConfig>	getExtensions()
abstract FrameHandler	getFrameHandler()
HttpFields	getHeaders()
String	getMethod()
List<String>	getSubProtocols()
URI	getURI()
HttpVersion	getVersion()
protected void	handleException(Throwable failure)
void	headers(Consumer<HttpFields.Mutable> consumer)
void	listener(Request.Listener listener)
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)
CompletableFuture<CoreSession>	sendAsync()
void	setConfiguration(Configuration.ConfigurationCustomizer config)
void	setExtensions(List<ExtensionConfig> configs)
void	setSubProtocols(String... protocols)
void	setSubProtocols(List<String> protocols)
void	timeout(long value, TimeUnit unit)
void	upgrade(Response response, EndPoint endPoint)

Methods inherited from class java.lang.Object

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

Constructor Details

CoreClientUpgradeRequest

public CoreClientUpgradeRequest(WebSocketCoreClient webSocketClient,
 URI requestURI)

Method Details

from

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

getMethod

public String getMethod()

getURI

public URI getURI()

getVersion

public HttpVersion getVersion()

listener

public void listener(Request.Listener listener)

headers

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

getHeaders

public HttpFields getHeaders()

getCookies

public List<HttpCookie> getCookies()

timeout

public void timeout(long value,
 TimeUnit unit)

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)

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(Response response,
 EndPoint endPoint)