UpgradeResponse
public class UpgradeResponseAdapter extends java.lang.Object implements UpgradeResponse
Modifier and Type | Field | Description |
---|---|---|
static java.lang.String |
SEC_WEBSOCKET_PROTOCOL |
Constructor | Description |
---|---|
UpgradeResponseAdapter() |
Modifier and Type | Method | Description |
---|---|---|
void |
addHeader(java.lang.String name,
java.lang.String value) |
|
java.lang.String |
getAcceptedSubProtocol() |
Get the accepted WebSocket protocol.
|
java.util.List<ExtensionConfig> |
getExtensions() |
Get the list of extensions that should be used for the websocket.
|
java.lang.String |
getHeader(java.lang.String name) |
|
java.util.Set<java.lang.String> |
getHeaderNames() |
|
java.util.Map<java.lang.String,java.util.List<java.lang.String>> |
getHeaders() |
|
java.util.List<java.lang.String> |
getHeaders(java.lang.String name) |
|
int |
getStatusCode() |
|
java.lang.String |
getStatusReason() |
|
boolean |
isSuccess() |
|
void |
sendForbidden(java.lang.String message) |
Issue a forbidden upgrade response.
|
void |
setAcceptedSubProtocol(java.lang.String protocol) |
Set the accepted WebSocket Protocol.
|
void |
setExtensions(java.util.List<ExtensionConfig> extensions) |
Set the list of extensions that are approved for use with this websocket.
|
void |
setHeader(java.lang.String name,
java.lang.String value) |
|
void |
setStatusCode(int statusCode) |
|
void |
setStatusReason(java.lang.String statusReason) |
|
void |
setSuccess(boolean success) |
public static final java.lang.String SEC_WEBSOCKET_PROTOCOL
public void addHeader(java.lang.String name, java.lang.String value)
addHeader
in interface UpgradeResponse
public java.lang.String getAcceptedSubProtocol()
getAcceptedSubProtocol
in interface UpgradeResponse
public java.util.List<ExtensionConfig> getExtensions()
getExtensions
in interface UpgradeResponse
public java.lang.String getHeader(java.lang.String name)
getHeader
in interface UpgradeResponse
public java.util.Set<java.lang.String> getHeaderNames()
getHeaderNames
in interface UpgradeResponse
public java.util.Map<java.lang.String,java.util.List<java.lang.String>> getHeaders()
getHeaders
in interface UpgradeResponse
public java.util.List<java.lang.String> getHeaders(java.lang.String name)
getHeaders
in interface UpgradeResponse
public int getStatusCode()
getStatusCode
in interface UpgradeResponse
public java.lang.String getStatusReason()
getStatusReason
in interface UpgradeResponse
public boolean isSuccess()
isSuccess
in interface UpgradeResponse
public void sendForbidden(java.lang.String message) throws java.io.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.
sendForbidden
in interface UpgradeResponse
message
- the short 1 line detail message about the forbidden responsejava.io.IOException
- if unable to send the forbiddenpublic void setAcceptedSubProtocol(java.lang.String protocol)
setAcceptedSubProtocol
in interface UpgradeResponse
protocol
- the protocol to list as acceptedpublic void setExtensions(java.util.List<ExtensionConfig> extensions)
Notes:
UpgradeRequest
, just remove entries you don't want to usesetExtensions
in interface UpgradeResponse
extensions
- the list of extensions to use.public void setHeader(java.lang.String name, java.lang.String value)
setHeader
in interface UpgradeResponse
public void setStatusCode(int statusCode)
setStatusCode
in interface UpgradeResponse
public void setStatusReason(java.lang.String statusReason)
setStatusReason
in interface UpgradeResponse
public void setSuccess(boolean success)
setSuccess
in interface UpgradeResponse
Copyright © 1995–2018 Webtide. All rights reserved.