Class ClientUpgradeResponse

java.lang.Object

org.eclipse.jetty.websocket.common.UpgradeResponseAdapter

org.eclipse.jetty.websocket.client.ClientUpgradeResponse

All Implemented Interfaces:

UpgradeResponse

public class ClientUpgradeResponse
extends UpgradeResponseAdapter

Field Summary

Fields

Modifier and Type	Field	Description
private List<ExtensionConfig>	extensions

Fields inherited from class UpgradeResponseAdapter

SEC_WEBSOCKET_PROTOCOL

Constructor Summary

Constructors

Constructor	Description
ClientUpgradeResponse()
ClientUpgradeResponse(org.eclipse.jetty.client.HttpResponse response)

Method Summary

Modifier and Type	Method	Description
List<ExtensionConfig>	getExtensions()	Get the list of extensions that should be used for the websocket.
boolean	isSuccess()	Test if upgrade response is successful.
void	sendForbidden(String message)	Issue a forbidden upgrade response.

Methods inherited from class UpgradeResponseAdapter

addHeader, getAcceptedSubProtocol, getHeader, getHeaderNames, getHeaders, getHeaders, getStatusCode, getStatusReason, setAcceptedSubProtocol, setExtensions, setHeader, setStatusCode, setStatusReason, setSuccess

Methods inherited from class Object

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

Field Details

extensions

private List<ExtensionConfig> extensions

Constructor Details

ClientUpgradeResponse

public ClientUpgradeResponse()

ClientUpgradeResponse

public ClientUpgradeResponse(org.eclipse.jetty.client.HttpResponse response)

Method Details

isSuccess

public boolean isSuccess()

Description copied from interface: UpgradeResponse

Test if upgrade response is successful.

Merely notes if the response was sent as a WebSocket Upgrade, or was failed (resulting in no upgrade handshake)

Specified by:

isSuccess in interface UpgradeResponse

Overrides:

isSuccess in class UpgradeResponseAdapter

Returns:

true if upgrade response was generated, false if no upgrade response was generated

getExtensions

public List<ExtensionConfig> getExtensions()

Description copied from class: UpgradeResponseAdapter

Get the list of extensions that should be used for the websocket.

Specified by:

getExtensions in interface UpgradeResponse

Overrides:

getExtensions in class UpgradeResponseAdapter

Returns:

the list of negotiated extensions to use.

sendForbidden

public void sendForbidden(String message)
                   throws IOException

Description copied from class: UpgradeResponseAdapter

Issue a forbidden upgrade response.

This means that the websocket endpoint was valid, but the conditions to use a WebSocket resulted in a forbidden access.

Use this when the origin or authentication is invalid.

Specified by:

sendForbidden in interface UpgradeResponse

Overrides:

sendForbidden in class UpgradeResponseAdapter

Parameters:

message - the short 1 line detail message about the forbidden response

Throws:

IOException - if unable to send the forbidden