Top Fields Constructors Methods
org.eclipse.jetty.ee10.websocket.server.internal

public Class DelegatedServerUpgradeResponse

extends Object
implements JettyServerUpgradeResponse
Class Inheritance
All Implemented Interfaces
org.eclipse.jetty.ee10.websocket.server.JettyServerUpgradeResponse, org.eclipse.jetty.websocket.api.UpgradeResponse
Imports
java.io.IOException, java.util.ArrayList, .Collections, .List, .Map, .Set, java.util.stream.Collectors, jakarta.servlet.http.HttpServletResponse, org.eclipse.jetty.ee10.servlet.ServletContextResponse, org.eclipse.jetty.ee10.websocket.server.JettyServerUpgradeResponse, org.eclipse.jetty.http.HttpStatus, org.eclipse.jetty.server.Response, org.eclipse.jetty.websocket.api.ExtensionConfig, org.eclipse.jetty.websocket.common.JettyExtensionConfig, org.eclipse.jetty.websocket.core.WebSocketConstants, org.eclipse.jetty.websocket.core.server.ServerUpgradeResponse

Field Summary

Modifier and TypeField and Description
private final HttpServletResponse
httpServletResponse

private final ServerUpgradeResponse
upgradeResponse

Constructor Summary

AccessConstructor and Description
public
DelegatedServerUpgradeResponse(ServerUpgradeResponse response)

Method Summary

Modifier and TypeMethod and Description
public void
addHeader(String
the header name
name, String
the header value
value)

Implements org.eclipse.jetty.ee10.websocket.server.JettyServerUpgradeResponse.addHeader.

Add a header value to the response.

public String
getAcceptedSubProtocol()

Implements org.eclipse.jetty.websocket.api.UpgradeResponse.getAcceptedSubProtocol.

Get the accepted WebSocket protocol.

public List<ExtensionConfig>
getExtensions()

Implements org.eclipse.jetty.websocket.api.UpgradeResponse.getExtensions.

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

public String
getHeader(String
the header name
name)

Implements org.eclipse.jetty.websocket.api.UpgradeResponse.getHeader.

Get a header value

public Set<String>
getHeaderNames()

Implements org.eclipse.jetty.websocket.api.UpgradeResponse.getHeaderNames.

Get the header names

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

Implements org.eclipse.jetty.websocket.api.UpgradeResponse.getHeaders.

Get the headers map

public List<String>
getHeaders(String
the header name
name)

Implements org.eclipse.jetty.websocket.api.UpgradeResponse.getHeaders.

Get the multi-value header value

public int
getStatusCode()

Implements org.eclipse.jetty.websocket.api.UpgradeResponse.getStatusCode.

Get the HTTP Response Status Code

public boolean
isCommitted()

Implements org.eclipse.jetty.ee10.websocket.server.JettyServerUpgradeResponse.isCommitted.

Returns a boolean indicating if the response has been committed.

public void
sendError(int
the error status code
statusCode, String
the descriptive message
message)

Implements org.eclipse.jetty.ee10.websocket.server.JettyServerUpgradeResponse.sendError.

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

public void
sendForbidden(String
the short 1 line detail message about the forbidden response
message)

Implements org.eclipse.jetty.ee10.websocket.server.JettyServerUpgradeResponse.sendForbidden.

Issue a forbidden upgrade response.

public void
setAcceptedSubProtocol(String
the protocol to list as accepted
protocol)

Implements org.eclipse.jetty.ee10.websocket.server.JettyServerUpgradeResponse.setAcceptedSubProtocol.

Set the accepted WebSocket Protocol.

public void
setExtensions(List<ExtensionConfig>
the list of extensions to use.
configs)

Implements org.eclipse.jetty.ee10.websocket.server.JettyServerUpgradeResponse.setExtensions.

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

public void
setHeader(String
the header name
name, String
the header value
value)

Implements org.eclipse.jetty.ee10.websocket.server.JettyServerUpgradeResponse.setHeader.

Set a header

Overrides previous value of header (if set)

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

Implements org.eclipse.jetty.ee10.websocket.server.JettyServerUpgradeResponse.setHeader.

Set a header

Overrides previous value of header (if set)

public void
setStatusCode(int
the status code
statusCode)

Implements org.eclipse.jetty.ee10.websocket.server.JettyServerUpgradeResponse.setStatusCode.

Set the HTTP Response status code

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

httpServletResponseback to summary
private final HttpServletResponse httpServletResponse
upgradeResponseback to summary
private final ServerUpgradeResponse upgradeResponse

Constructor Detail

DelegatedServerUpgradeResponseback to summary
public DelegatedServerUpgradeResponse(ServerUpgradeResponse response)

Method Detail

addHeaderback to summary
public void addHeader(String name, String value)

Implements org.eclipse.jetty.ee10.websocket.server.JettyServerUpgradeResponse.addHeader.

Doc from org.eclipse.jetty.ee10.websocket.server.JettyServerUpgradeResponse.addHeader.

Add a header value to the response.

Parameters
name:String

the header name

value:String

the header value

Annotations
@Override
getAcceptedSubProtocolback to summary
public String getAcceptedSubProtocol()

Implements org.eclipse.jetty.websocket.api.UpgradeResponse.getAcceptedSubProtocol.

Doc from org.eclipse.jetty.websocket.api.UpgradeResponse.getAcceptedSubProtocol.

Get the accepted WebSocket protocol.

Returns:String

the accepted WebSocket protocol.

Annotations
@Override
getExtensionsback to summary
public List<ExtensionConfig> getExtensions()

Implements org.eclipse.jetty.websocket.api.UpgradeResponse.getExtensions.

Doc from org.eclipse.jetty.websocket.api.UpgradeResponse.getExtensions.

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

Returns:List<ExtensionConfig>

the list of negotiated extensions to use.

Annotations
@Override
getHeaderback to summary
public String getHeader(String name)

Implements org.eclipse.jetty.websocket.api.UpgradeResponse.getHeader.

Doc from org.eclipse.jetty.websocket.api.UpgradeResponse.getHeader.

Get a header value

Parameters
name:String

the header name

Returns:String

the value (null if header doesn't exist)

Annotations
@Override
getHeaderNamesback to summary
public Set<String> getHeaderNames()

Implements org.eclipse.jetty.websocket.api.UpgradeResponse.getHeaderNames.

Doc from org.eclipse.jetty.websocket.api.UpgradeResponse.getHeaderNames.

Get the header names

Returns:Set<String>

the set of header names

Annotations
@Override
getHeadersback to summary
public Map<String, List<String>> getHeaders()

Implements org.eclipse.jetty.websocket.api.UpgradeResponse.getHeaders.

Doc from org.eclipse.jetty.websocket.api.UpgradeResponse.getHeaders.

Get the headers map

Returns:Map<String, List<String>>

the map of headers

Annotations
@Override
getHeadersback to summary
public List<String> getHeaders(String name)

Implements org.eclipse.jetty.websocket.api.UpgradeResponse.getHeaders.

Doc from org.eclipse.jetty.websocket.api.UpgradeResponse.getHeaders.

Get the multi-value header value

Parameters
name:String

the header name

Returns:List<String>

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

Annotations
@Override
getStatusCodeback to summary
public int getStatusCode()

Implements org.eclipse.jetty.websocket.api.UpgradeResponse.getStatusCode.

Doc from org.eclipse.jetty.websocket.api.UpgradeResponse.getStatusCode.

Get the HTTP Response Status Code

Returns:int

the status code

Annotations
@Override
isCommittedback to summary
public boolean isCommitted()

Implements org.eclipse.jetty.ee10.websocket.server.JettyServerUpgradeResponse.isCommitted.

Doc from org.eclipse.jetty.ee10.websocket.server.JettyServerUpgradeResponse.isCommitted.

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

Returns:boolean

a boolean indicating if the response has been committed.

Annotations
@Override
sendErrorback to summary
public void sendError(int statusCode, String message) throws IOException

Implements org.eclipse.jetty.ee10.websocket.server.JettyServerUpgradeResponse.sendError.

Doc from org.eclipse.jetty.ee10.websocket.server.JettyServerUpgradeResponse.sendError.

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

Parameters
statusCode:int

the error status code

message:String

the descriptive message

Annotations
@Override
Exceptions
IOException:
If an input or output exception occurs
sendForbiddenback to summary
public void sendForbidden(String message) throws IOException

Implements org.eclipse.jetty.ee10.websocket.server.JettyServerUpgradeResponse.sendForbidden.

Doc from org.eclipse.jetty.ee10.websocket.server.JettyServerUpgradeResponse.sendForbidden.

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:String

the short 1 line detail message about the forbidden response

Annotations
@Override
Exceptions
IOException:
if unable to send the forbidden
setAcceptedSubProtocolback to summary
public void setAcceptedSubProtocol(String protocol)

Implements org.eclipse.jetty.ee10.websocket.server.JettyServerUpgradeResponse.setAcceptedSubProtocol.

Doc from org.eclipse.jetty.ee10.websocket.server.JettyServerUpgradeResponse.setAcceptedSubProtocol.

Set the accepted WebSocket Protocol.

Parameters
protocol:String

the protocol to list as accepted

Annotations
@Override
setExtensionsback to summary
public void setExtensions(List<ExtensionConfig> configs)

Implements org.eclipse.jetty.ee10.websocket.server.JettyServerUpgradeResponse.setExtensions.

Doc from org.eclipse.jetty.ee10.websocket.server.JettyServerUpgradeResponse.setExtensions.

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
configs:List<ExtensionConfig>

the list of extensions to use.

Annotations
@Override
setHeaderback to summary
public void setHeader(String name, String value)

Implements org.eclipse.jetty.ee10.websocket.server.JettyServerUpgradeResponse.setHeader.

Doc from org.eclipse.jetty.ee10.websocket.server.JettyServerUpgradeResponse.setHeader.

Set a header

Overrides previous value of header (if set)

Parameters
name:String

the header name

value:String

the header value

Annotations
@Override
setHeaderback to summary
public void setHeader(String name, List<String> values)

Implements org.eclipse.jetty.ee10.websocket.server.JettyServerUpgradeResponse.setHeader.

Doc from org.eclipse.jetty.ee10.websocket.server.JettyServerUpgradeResponse.setHeader.

Set a header

Overrides previous value of header (if set)

Parameters
name:String

the header name

values:List<String>

the header values

Annotations
@Override
setStatusCodeback to summary
public void setStatusCode(int statusCode)

Implements org.eclipse.jetty.ee10.websocket.server.JettyServerUpgradeResponse.setStatusCode.

Doc from org.eclipse.jetty.ee10.websocket.server.JettyServerUpgradeResponse.setStatusCode.

Set the HTTP Response status code

Parameters
statusCode:int

the status code

Annotations
@Override