Package org.eclipse.jetty.websocket.client

Class WebSocketUpgradeRequest

java.lang.Object

org.eclipse.jetty.client.HttpRequest

org.eclipse.jetty.websocket.client.WebSocketUpgradeRequest

All Implemented Interfaces:

java.util.EventListener, Request, Response.CompleteListener, Response.ResponseListener, HttpConnectionUpgrader

public class WebSocketUpgradeRequest
extends HttpRequest
implements Response.CompleteListener, HttpConnectionUpgrader

Nested Class Summary

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

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

Constructor Summary

Constructors

Modifier	Constructor	Description
	WebSocketUpgradeRequest(WebSocketClient wsClient, HttpClient httpClient, java.net.URI wsURI, java.lang.Object localEndpoint)	Initiating a WebSocket Upgrade using HTTP/1.1
protected	WebSocketUpgradeRequest(WebSocketClient wsClient, HttpClient httpClient, ClientUpgradeRequest request)	Exists for internal use of HttpClient by WebSocketClient.

Method Summary

Modifier and Type	Method	Description
void	onComplete(Result result)	Callback method invoked when the request and the response have been processed, either successfully or not.
ContentResponse	send()	Sends this request and returns the response.
void	send(Response.CompleteListener listener)	Sends this request and asynchronously notifies the given listener for response events.
java.util.concurrent.CompletableFuture<Session>	sendAsync()
void	setUpgradeListener(UpgradeListener upgradeListener)
void	upgrade(HttpResponse response, HttpConnectionOverHTTP oldConn)

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

WebSocketUpgradeRequest

protected WebSocketUpgradeRequest(WebSocketClient wsClient,
                                  HttpClient httpClient,
                                  ClientUpgradeRequest request)

Exists for internal use of HttpClient by WebSocketClient.

Maintained for Backward compatibility and also for JSR356 WebSocket ClientContainer use.

Parameters:

wsClient - the WebSocketClient that this request uses

httpClient - the HttpClient that this request uses

request - the ClientUpgradeRequest (backward compat) to base this request from

WebSocketUpgradeRequest

public WebSocketUpgradeRequest(WebSocketClient wsClient,
                               HttpClient httpClient,
                               java.net.URI wsURI,
                               java.lang.Object localEndpoint)

Initiating a WebSocket Upgrade using HTTP/1.1

Parameters:

wsClient - the WebSocketClient that this request uses

httpClient - the HttpClient that this request uses

localEndpoint - the local endpoint (following Jetty WebSocket Client API rules) to use for incoming WebSocket events

wsURI - the WebSocket URI to connect to

Method Detail

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

send

public ContentResponse send()
                     throws java.lang.InterruptedException,
                            java.util.concurrent.TimeoutException,
                            java.util.concurrent.ExecutionException

Description copied from interface: Request

Sends this request and returns the response.

This method should be used when a simple blocking semantic is needed, and when it is known that the response content can be buffered without exceeding memory constraints.

For example, this method is not appropriate to download big files from a server; consider using Request.send(Response.CompleteListener) instead, passing your own Response.Listener or a utility listener such as InputStreamResponseListener.

The method returns when the complete event is fired.

Specified by:

send in interface Request

Overrides:

send in class HttpRequest

Returns:

a ContentResponse for this request

Throws:

java.lang.InterruptedException - if send thread is interrupted

java.util.concurrent.TimeoutException - if send times out

java.util.concurrent.ExecutionException - if execution fails

See Also:

Response.CompleteListener.onComplete(Result)

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 java.util.concurrent.CompletableFuture<Session> sendAsync()

upgrade

public void upgrade(HttpResponse response,
                    HttpConnectionOverHTTP oldConn)

Specified by:

upgrade in interface HttpConnectionUpgrader

setUpgradeListener

public void setUpgradeListener(UpgradeListener upgradeListener)