Class UpgradeResponseAdapter
- java.lang.Object
-
- org.eclipse.jetty.websocket.common.UpgradeResponseAdapter
-
- All Implemented Interfaces:
UpgradeResponse
public class UpgradeResponseAdapter extends java.lang.Object implements UpgradeResponse
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
SEC_WEBSOCKET_PROTOCOL
-
Constructor Summary
Constructors Constructor Description UpgradeResponseAdapter()
-
Method Summary
All Methods Instance Methods Concrete Methods 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)
-
-
-
Field Detail
-
SEC_WEBSOCKET_PROTOCOL
public static final java.lang.String SEC_WEBSOCKET_PROTOCOL
- See Also:
- Constant Field Values
-
-
Method Detail
-
addHeader
public void addHeader(java.lang.String name, java.lang.String value)
- Specified by:
addHeader
in interfaceUpgradeResponse
-
getAcceptedSubProtocol
public java.lang.String getAcceptedSubProtocol()
Get the accepted WebSocket protocol.- Specified by:
getAcceptedSubProtocol
in interfaceUpgradeResponse
- Returns:
- the accepted WebSocket protocol.
-
getExtensions
public java.util.List<ExtensionConfig> 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
public java.lang.String getHeader(java.lang.String name)
- Specified by:
getHeader
in interfaceUpgradeResponse
-
getHeaderNames
public java.util.Set<java.lang.String> getHeaderNames()
- Specified by:
getHeaderNames
in interfaceUpgradeResponse
-
getHeaders
public java.util.Map<java.lang.String,java.util.List<java.lang.String>> getHeaders()
- Specified by:
getHeaders
in interfaceUpgradeResponse
-
getHeaders
public java.util.List<java.lang.String> getHeaders(java.lang.String name)
- Specified by:
getHeaders
in interfaceUpgradeResponse
-
getStatusCode
public int getStatusCode()
- Specified by:
getStatusCode
in interfaceUpgradeResponse
-
getStatusReason
public java.lang.String getStatusReason()
- Specified by:
getStatusReason
in interfaceUpgradeResponse
-
isSuccess
public boolean isSuccess()
- Specified by:
isSuccess
in interfaceUpgradeResponse
-
sendForbidden
public void sendForbidden(java.lang.String message) throws java.io.IOException
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:
java.io.IOException
- if unable to send the forbidden
-
setAcceptedSubProtocol
public void setAcceptedSubProtocol(java.lang.String protocol)
Set the accepted WebSocket Protocol.- Specified by:
setAcceptedSubProtocol
in interfaceUpgradeResponse
- Parameters:
protocol
- the protocol to list as accepted
-
setExtensions
public void setExtensions(java.util.List<ExtensionConfig> extensions)
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
public void setHeader(java.lang.String name, java.lang.String value)
- Specified by:
setHeader
in interfaceUpgradeResponse
-
setStatusCode
public void setStatusCode(int statusCode)
- Specified by:
setStatusCode
in interfaceUpgradeResponse
-
setStatusReason
public void setStatusReason(java.lang.String statusReason)
- Specified by:
setStatusReason
in interfaceUpgradeResponse
-
setSuccess
public void setSuccess(boolean success)
- Specified by:
setSuccess
in interfaceUpgradeResponse
-
-