Class UpgradeResponseAdapter
java.lang.Object
org.eclipse.jetty.websocket.common.UpgradeResponseAdapter
- All Implemented Interfaces:
UpgradeResponse
- Direct Known Subclasses:
ClientUpgradeResponse
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate List
<ExtensionConfig> static final String
private int
private String
private boolean
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
Add a header value to the response.Get the accepted WebSocket protocol.Get the list of extensions that should be used for the websocket.Get a header valueGet the header namesGet the headers mapgetHeaders
(String name) Get the multi-value header valueint
Get the HTTP Response Status CodeGet the HTTP Response Status Reasonboolean
Test if upgrade response is successful.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
Set a headervoid
setStatusCode
(int statusCode) Set the HTTP Response status codevoid
setStatusReason
(String statusReason) Set the HTTP Response status reason phrasevoid
setSuccess
(boolean success) Set the success of the upgrade response.
-
Field Details
-
SEC_WEBSOCKET_PROTOCOL
- See Also:
-
statusCode
private int statusCode -
statusReason
-
headers
-
extensions
-
success
private boolean success
-
-
Constructor Details
-
UpgradeResponseAdapter
public UpgradeResponseAdapter()
-
-
Method Details
-
addHeader
Description copied from interface:UpgradeResponse
Add a header value to the response.- Specified by:
addHeader
in interfaceUpgradeResponse
- Parameters:
name
- the header namevalue
- the header value
-
getAcceptedSubProtocol
Get the accepted WebSocket protocol.- Specified by:
getAcceptedSubProtocol
in interfaceUpgradeResponse
- Returns:
- the accepted WebSocket protocol.
-
getExtensions
Get the list of extensions that should be used for the websocket.- Specified by:
getExtensions
in interfaceUpgradeResponse
- Returns:
- the list of negotiated extensions to use.
-
getHeader
Description copied from interface:UpgradeResponse
Get a header value- Specified by:
getHeader
in interfaceUpgradeResponse
- Parameters:
name
- the header name- Returns:
- the value (null if header doesn't exist)
-
getHeaderNames
Description copied from interface:UpgradeResponse
Get the header names- Specified by:
getHeaderNames
in interfaceUpgradeResponse
- Returns:
- the set of header names
-
getHeaders
Description copied from interface:UpgradeResponse
Get the headers map- Specified by:
getHeaders
in interfaceUpgradeResponse
- Returns:
- the map of headers
-
getHeaders
Description copied from interface:UpgradeResponse
Get the multi-value header value- Specified by:
getHeaders
in interfaceUpgradeResponse
- 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 interfaceUpgradeResponse
- Returns:
- the status code
-
getStatusReason
Description copied from interface:UpgradeResponse
Get the HTTP Response Status Reason- Specified by:
getStatusReason
in interfaceUpgradeResponse
- Returns:
- the HTTP Response status reason
-
isSuccess
public boolean isSuccess()Description copied from interface:UpgradeResponse
Test if upgrade response is successful.Merely notes if the response was sent as a WebSocket Upgrade, or was failed (resulting in no upgrade handshake)
- Specified by:
isSuccess
in interfaceUpgradeResponse
- Returns:
- true if upgrade response was generated, false if no upgrade response was generated
-
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.
- Specified by:
sendForbidden
in interfaceUpgradeResponse
- Parameters:
message
- the short 1 line detail message about the forbidden response- Throws:
IOException
- if unable to send the forbidden
-
setAcceptedSubProtocol
Set the accepted WebSocket Protocol.- Specified by:
setAcceptedSubProtocol
in interfaceUpgradeResponse
- Parameters:
protocol
- the protocol to list as accepted
-
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.
- Specified by:
setExtensions
in interfaceUpgradeResponse
- Parameters:
extensions
- the list of extensions to use.
- Per the spec you cannot add extensions that have not been seen in the
-
setHeader
Description copied from interface:UpgradeResponse
Set a headerOverrides previous value of header (if set)
- Specified by:
setHeader
in interfaceUpgradeResponse
- Parameters:
name
- the header namevalue
- the header value
-
setStatusCode
public void setStatusCode(int statusCode) Description copied from interface:UpgradeResponse
Set the HTTP Response status code- Specified by:
setStatusCode
in interfaceUpgradeResponse
- Parameters:
statusCode
- the status code
-
setStatusReason
Description copied from interface:UpgradeResponse
Set the HTTP Response status reason phraseNote, not all implementation of UpgradeResponse can support this feature
- Specified by:
setStatusReason
in interfaceUpgradeResponse
- Parameters:
statusReason
- the status reason phrase
-
setSuccess
public void setSuccess(boolean success) Description copied from interface:UpgradeResponse
Set the success of the upgrade response.- Specified by:
setSuccess
in interfaceUpgradeResponse
- Parameters:
success
- true to indicate a response to the upgrade handshake was sent, false to indicate no upgrade response was sent
-