public interface UpgradeResponse
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()
Deprecated.
this has no replacement, will be removed in Jetty 10
|
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)
Deprecated.
this has no replacement, will be removed in Jetty 10
|
void addHeader(String name, String value)
name
- the header namevalue
- the header valueString getAcceptedSubProtocol()
List<ExtensionConfig> getExtensions()
String getHeader(String name)
name
- the header nameList<String> getHeaders(String name)
name
- the header nameint getStatusCode()
String getStatusReason()
@Deprecated boolean isSuccess()
Merely notes if the response was sent as a WebSocket Upgrade, or was failed (resulting in no upgrade handshake)
void sendForbidden(String message) throws IOException
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.
message
- the short 1 line detail message about the forbidden responseIOException
- if unable to send the forbiddenvoid setAcceptedSubProtocol(String protocol)
protocol
- the protocol to list as acceptedvoid setExtensions(List<ExtensionConfig> extensions)
Notes:
UpgradeRequest
, just remove
entries you don't want to useextensions
- the list of extensions to use.void setHeader(String name, String value)
Overrides previous value of header (if set)
name
- the header namevalue
- the header valuevoid setStatusCode(int statusCode)
statusCode
- the status codevoid setStatusReason(String statusReason)
Note, not all implementation of UpgradeResponse can support this feature
statusReason
- the status reason phrase@Deprecated void setSuccess(boolean success)
success
- true to indicate a response to the upgrade handshake was sent, false to indicate no upgrade
response was sentCopyright © 2010 - 2020 Adobe. All Rights Reserved