Package org.eclipse.jetty.websocket.common

Class UpgradeResponseAdapter

java.lang.Object

org.eclipse.jetty.websocket.common.UpgradeResponseAdapter

All Implemented Interfaces:

UpgradeResponse

public class UpgradeResponseAdapter
extends Object
implements UpgradeResponse

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SEC_WEBSOCKET_PROTOCOL

Constructor Summary

Constructors

Constructor	Description
UpgradeResponseAdapter()

Method Summary

Modifier and Type	Method	Description
void	addHeader(String name, String value)
String	getAcceptedSubProtocol()	Get the accepted WebSocket protocol.
List<ExtensionConfig>	getExtensions()	Get the list of extensions that should be used for the websocket.
String	getHeader(String name)
Set<String>	getHeaderNames()
Map<String,List<String>>	getHeaders()
List<String>	getHeaders(String name)
int	getStatusCode()
String	getStatusReason()
boolean	isSuccess()
void	sendForbidden(String message)	Issue a forbidden upgrade response.
void	setAcceptedSubProtocol(String protocol)	Set the accepted WebSocket Protocol.
void	setExtensions(List<ExtensionConfig> extensions)	Set the list of extensions that are approved for use with this websocket.
void	setHeader(String name, String value)
void	setStatusCode(int statusCode)
void	setStatusReason(String statusReason)
void	setSuccess(boolean success)

Methods inherited from class java.lang.Object

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

Field Details

SEC_WEBSOCKET_PROTOCOL

public static final String SEC_WEBSOCKET_PROTOCOL

See Also:

• Constant Field Values

Constructor Details

UpgradeResponseAdapter

public UpgradeResponseAdapter()

Method Details

addHeader

public void addHeader(String name,
 String value)

Specified by:

addHeader in interface UpgradeResponse

getAcceptedSubProtocol

public String getAcceptedSubProtocol()

Get the accepted WebSocket protocol.

Specified by:

getAcceptedSubProtocol in interface UpgradeResponse

Returns:

the accepted WebSocket protocol.

getExtensions

public List<ExtensionConfig> getExtensions()

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

Specified by:

getExtensions in interface UpgradeResponse

Returns:

the list of negotiated extensions to use.

getHeader

public String getHeader(String name)

Specified by:

getHeader in interface UpgradeResponse

getHeaderNames

public Set<String> getHeaderNames()

Specified by:

getHeaderNames in interface UpgradeResponse

getHeaders

public Map<String,List<String>> getHeaders()

Specified by:

getHeaders in interface UpgradeResponse

getHeaders

public List<String> getHeaders(String name)

Specified by:

getHeaders in interface UpgradeResponse

getStatusCode

public int getStatusCode()

Specified by:

getStatusCode in interface UpgradeResponse

getStatusReason

public String getStatusReason()

Specified by:

getStatusReason in interface UpgradeResponse

isSuccess

public boolean isSuccess()

Specified by:

isSuccess in interface UpgradeResponse

sendForbidden

public void sendForbidden(String message)
                   throws IOException

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

Parameters:

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

Throws:

IOException - if unable to send the forbidden

setAcceptedSubProtocol

public void setAcceptedSubProtocol(String protocol)

Set the accepted WebSocket Protocol.

Specified by:

setAcceptedSubProtocol in interface UpgradeResponse

Parameters:

protocol - the protocol to list as accepted

setExtensions

public void setExtensions(List<ExtensionConfig> extensions)

Set the list of extensions that are approved for use with this websocket.

Notes:

• Per the spec you cannot add extensions that have not been seen in the UpgradeRequest, just remove entries you don't want to use
• If this is unused, or a null is passed, then the list negotiation will follow default behavior and use the complete list of extensions that are available in this WebSocket server implementation.

Specified by:

setExtensions in interface UpgradeResponse

Parameters:

extensions - the list of extensions to use.

setHeader

public void setHeader(String name,
 String value)

Specified by:

setHeader in interface UpgradeResponse

setStatusCode

public void setStatusCode(int statusCode)

Specified by:

setStatusCode in interface UpgradeResponse

setStatusReason

public void setStatusReason(String statusReason)

Specified by:

setStatusReason in interface UpgradeResponse

setSuccess

public void setSuccess(boolean success)

Specified by:

setSuccess in interface UpgradeResponse