Package org.eclipse.jetty.ee10.websocket.server.internal

Class DelegatedServerUpgradeResponse

java.lang.Object

org.eclipse.jetty.ee10.websocket.server.internal.DelegatedServerUpgradeResponse

All Implemented Interfaces:

JettyServerUpgradeResponse, UpgradeResponse

public class DelegatedServerUpgradeResponse
extends Object
implements JettyServerUpgradeResponse

Constructor Summary

Constructors

Constructor	Description
DelegatedServerUpgradeResponse(ServerUpgradeResponse response)

Method Summary

Modifier and Type	Method	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
boolean	isCommitted()	Returns a boolean indicating if the response has been committed.
void	sendError(int statusCode, String message)	Sends an error response to the client using the specified status.
void	sendForbidden(String message)	Issue a forbidden upgrade response.
void	setAcceptedSubProtocol(String protocol)	Set the accepted WebSocket Protocol.
void	setExtensions(List<ExtensionConfig> configs)	Set the list of extensions that are approved for use with this websocket.
void	setHeader(String name, String value)	Set a header
void	setHeader(String name, List<String> values)	Set a header
void	setStatusCode(int statusCode)	Set the HTTP Response status code

Methods inherited from class java.lang.Object

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

Constructor Details

DelegatedServerUpgradeResponse

public DelegatedServerUpgradeResponse(ServerUpgradeResponse response)

Method Details

addHeader

public void addHeader(String name,
 String value)

Description copied from interface: JettyServerUpgradeResponse

Add a header value to the response.

Specified by:

addHeader in interface JettyServerUpgradeResponse

Parameters:

name - the header name

value - the header value

setHeader

public void setHeader(String name,
 String value)

Description copied from interface: JettyServerUpgradeResponse

Set a header

Overrides previous value of header (if set)

Specified by:

setHeader in interface JettyServerUpgradeResponse

Parameters:

name - the header name

value - the header value

setHeader

public void setHeader(String name,
 List<String> values)

Description copied from interface: JettyServerUpgradeResponse

Set a header

Overrides previous value of header (if set)

Specified by:

setHeader in interface JettyServerUpgradeResponse

Parameters:

name - the header name

values - the header values

getAcceptedSubProtocol

public String getAcceptedSubProtocol()

Description copied from interface: UpgradeResponse

Get the accepted WebSocket protocol.

Specified by:

getAcceptedSubProtocol in interface UpgradeResponse

Returns:

the accepted WebSocket protocol.

getExtensions

public List<ExtensionConfig> getExtensions()

Description copied from interface: UpgradeResponse

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

sendForbidden

public void sendForbidden(String message)
                   throws IOException

Description copied from interface: JettyServerUpgradeResponse

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 JettyServerUpgradeResponse

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)

Description copied from interface: JettyServerUpgradeResponse

Set the accepted WebSocket Protocol.

Specified by:

setAcceptedSubProtocol in interface JettyServerUpgradeResponse

Parameters:

protocol - the protocol to list as accepted

setExtensions

public void setExtensions(List<ExtensionConfig> configs)

Description copied from interface: JettyServerUpgradeResponse

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 JettyServerUpgradeResponse

Parameters:

configs - the list of extensions to use.

setStatusCode

public void setStatusCode(int statusCode)

Description copied from interface: JettyServerUpgradeResponse

Set the HTTP Response status code

Specified by:

setStatusCode in interface JettyServerUpgradeResponse

Parameters:

statusCode - the status code

isCommitted

public boolean isCommitted()

Description copied from interface: JettyServerUpgradeResponse

Returns a boolean indicating if the response has been committed. A committed response has already had its status code and headers written.

Specified by:

isCommitted in interface JettyServerUpgradeResponse

Returns:

a boolean indicating if the response has been committed.

sendError

public void sendError(int statusCode,
 String message)
               throws IOException

Description copied from interface: JettyServerUpgradeResponse

Sends an error response to the client using the specified status.

Specified by:

sendError in interface JettyServerUpgradeResponse

Parameters:

statusCode - the error status code

message - the descriptive message

Throws:

IOException - If an input or output exception occurs