org.eclipse.jetty.websocket.api

Class UpgradeResponse

java.lang.Object

org.eclipse.jetty.websocket.api.UpgradeResponse

Direct Known Subclasses:

ClientUpgradeResponse, ServletUpgradeResponse

public class UpgradeResponse
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
static String	SEC_WEBSOCKET_PROTOCOL

Constructor Summary

Constructors

Constructor and Description
UpgradeResponse()

Method Summary

Methods

Modifier and Type	Method and 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 Detail

SEC_WEBSOCKET_PROTOCOL

public static final String SEC_WEBSOCKET_PROTOCOL

See Also:

Constant Field Values

Constructor Detail

UpgradeResponse

public UpgradeResponse()

Method Detail

addHeader

public void addHeader(String name,
             String value)

getAcceptedSubProtocol

public String getAcceptedSubProtocol()

Get the accepted WebSocket protocol.

Returns:

the accepted WebSocket protocol.

getExtensions

public List<ExtensionConfig> getExtensions()

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

Returns:

the list of negotiated extensions to use.

getHeader

public String getHeader(String name)

getHeaderNames

public Set<String> getHeaderNames()

getHeaders

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

getHeaders

public List<String> getHeaders(String name)

getStatusCode

public int getStatusCode()

getStatusReason

public String getStatusReason()

isSuccess

public boolean isSuccess()

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.

Parameters:

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

Throws:

IOException

setAcceptedSubProtocol

public void setAcceptedSubProtocol(String protocol)

Set the accepted WebSocket Protocol.

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.

Parameters:

extensions - the list of extensions to use.

setHeader

public void setHeader(String name,
             String value)

setStatusCode

public void setStatusCode(int statusCode)

setStatusReason

public void setStatusReason(String statusReason)

setSuccess

public void setSuccess(boolean success)