public class ServletUpgradeResponse extends Object implements UpgradeResponse
Constructor and Description |
---|
ServletUpgradeResponse(HttpServletResponse response) |
Modifier and Type | Method and Description |
---|---|
void |
addHeader(String name,
String value)
Add a header value to the response.
|
void |
complete() |
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 |
isCommitted() |
boolean |
isExtensionsNegotiated() |
boolean |
isSubprotocolNegotiated() |
boolean |
isSuccess()
Test if upgrade response is successful.
|
void |
sendError(int statusCode,
String message) |
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 |
setStatusCode(int statusCode)
Set the HTTP Response status code
|
void |
setStatusReason(String statusReason)
Set the HTTP Response status reason phrase
|
void |
setSuccess(boolean success)
Set the success of the upgrade response.
|
String |
toString() |
public ServletUpgradeResponse(HttpServletResponse response)
public void addHeader(String name, String value)
UpgradeResponse
addHeader
in interface UpgradeResponse
name
- the header namevalue
- the header valuepublic void setHeader(String name, String value)
UpgradeResponse
Overrides previous value of header (if set)
setHeader
in interface UpgradeResponse
name
- the header namevalue
- the header valuepublic void complete()
public String getAcceptedSubProtocol()
UpgradeResponse
getAcceptedSubProtocol
in interface UpgradeResponse
public List<ExtensionConfig> getExtensions()
UpgradeResponse
getExtensions
in interface UpgradeResponse
public String getHeader(String name)
UpgradeResponse
getHeader
in interface UpgradeResponse
name
- the header namepublic Set<String> getHeaderNames()
UpgradeResponse
getHeaderNames
in interface UpgradeResponse
public Map<String,List<String>> getHeaders()
UpgradeResponse
getHeaders
in interface UpgradeResponse
public List<String> getHeaders(String name)
UpgradeResponse
getHeaders
in interface UpgradeResponse
name
- the header namepublic int getStatusCode()
UpgradeResponse
getStatusCode
in interface UpgradeResponse
public String getStatusReason()
UpgradeResponse
getStatusReason
in interface UpgradeResponse
public boolean isCommitted()
public boolean isExtensionsNegotiated()
public boolean isSubprotocolNegotiated()
public boolean isSuccess()
UpgradeResponse
Merely notes if the response was sent as a WebSocket Upgrade, or was failed (resulting in no upgrade handshake)
isSuccess
in interface UpgradeResponse
public void sendError(int statusCode, String message) throws IOException
IOException
public void sendForbidden(String message) throws IOException
UpgradeResponse
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 responseIOException
- if unable to send the forbiddenpublic void setAcceptedSubProtocol(String protocol)
UpgradeResponse
setAcceptedSubProtocol
in interface UpgradeResponse
protocol
- the protocol to list as acceptedpublic void setExtensions(List<ExtensionConfig> configs)
UpgradeResponse
Notes:
UpgradeRequest
, just remove
entries you don't want to usesetExtensions
in interface UpgradeResponse
configs
- the list of extensions to use.public void setStatusCode(int statusCode)
UpgradeResponse
setStatusCode
in interface UpgradeResponse
statusCode
- the status codepublic void setStatusReason(String statusReason)
UpgradeResponse
Note, not all implementation of UpgradeResponse can support this feature
setStatusReason
in interface UpgradeResponse
statusReason
- the status reason phrasepublic void setSuccess(boolean success)
UpgradeResponse
setSuccess
in interface UpgradeResponse
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