org.eclipse.jetty.websocket.common

Class UpgradeResponseAdapter

java.lang.Object

org.eclipse.jetty.websocket.common.UpgradeResponseAdapter

All Implemented Interfaces:

UpgradeResponse

Direct Known Subclasses:

ClientUpgradeResponse

public class UpgradeResponseAdapter
extends Object
implements UpgradeResponse

Field Summary

Fields

Modifier and Type	Field and Description
static String	SEC_WEBSOCKET_PROTOCOL

Constructor Summary

Constructors

Constructor and Description
UpgradeResponseAdapter()

Method Summary

Modifier and Type	Method and Description
void	addHeader(String name, String value) Add a header value to the response.
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) Get a header value
Set<String>	getHeaderNames() Get the header names
Map<String,List<String>>	getHeaders() Get the headers map
List<String>	getHeaders(String name) Get the multi-value header value
int	getStatusCode() Get the HTTP Response Status Code
String	getStatusReason() Get the HTTP Response Status Reason
boolean	isSuccess() Test if upgrade response is successful.
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) Set a header
void	setStatusCode(int statusCode) Set the HTTP Response status code
void	setStatusReason(String statusReason) Set the HTTP Response status reason phrase
void	setSuccess(boolean success) Set the success of the upgrade response.

Methods inherited from class java.lang.Object

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

Field Detail

SEC_WEBSOCKET_PROTOCOL

public static final String SEC_WEBSOCKET_PROTOCOL

See Also:

Constant Field Values

Constructor Detail

UpgradeResponseAdapter

public UpgradeResponseAdapter()

Method Detail

addHeader

public void addHeader(String name,
                      String value)

Description copied from interface: UpgradeResponse

Add a header value to the response.

Specified by:

addHeader in interface UpgradeResponse

Parameters:

name - the header name

value - the header value

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)

Description copied from interface: UpgradeResponse

Get a header value

Specified by:

getHeader in interface UpgradeResponse

Parameters:

name - the header name

Returns:

the value (null if header doesn't exist)

getHeaderNames

public Set<String> getHeaderNames()

Description copied from interface: UpgradeResponse

Get the header names

Specified by:

getHeaderNames in interface UpgradeResponse

Returns:

the set of header names

getHeaders

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

Description copied from interface: UpgradeResponse

Get the headers map

Specified by:

getHeaders in interface UpgradeResponse

Returns:

the map of headers

getHeaders

public List<String> getHeaders(String name)

Description copied from interface: UpgradeResponse

Get the multi-value header value

Specified by:

getHeaders in interface UpgradeResponse

Parameters:

name - the header name

Returns:

the list of values (null if header doesn't exist)

getStatusCode

public int getStatusCode()

Description copied from interface: UpgradeResponse

Get the HTTP Response Status Code

Specified by:

getStatusCode in interface UpgradeResponse

Returns:

the status code

getStatusReason

public String getStatusReason()

Description copied from interface: UpgradeResponse

Get the HTTP Response Status Reason

Specified by:

getStatusReason in interface UpgradeResponse

Returns:

the HTTP Response status reason

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

Returns:

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

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)

Description copied from interface: UpgradeResponse

Set a header

Overrides previous value of header (if set)

Specified by:

setHeader in interface UpgradeResponse

Parameters:

name - the header name

value - the header value

setStatusCode

public void setStatusCode(int statusCode)

Description copied from interface: UpgradeResponse

Set the HTTP Response status code

Specified by:

setStatusCode in interface UpgradeResponse

Parameters:

statusCode - the status code

setStatusReason

public void setStatusReason(String statusReason)

Description copied from interface: UpgradeResponse

Set the HTTP Response status reason phrase

Note, not all implementation of UpgradeResponse can support this feature

Specified by:

setStatusReason in interface UpgradeResponse

Parameters:

statusReason - the status reason phrase

setSuccess

public void setSuccess(boolean success)

Description copied from interface: UpgradeResponse

Set the success of the upgrade response.

Specified by:

setSuccess in interface UpgradeResponse

Parameters:

success - true to indicate a response to the upgrade handshake was sent, false to indicate no upgrade response was sent