public abstract class UpgradeRequest extends Object implements javax.websocket.server.HandshakeRequest
WebSocketEngine.upgrade(org.glassfish.tyrus.spi.UpgradeRequest, org.glassfish.tyrus.spi.UpgradeResponse)
method to upgrade the
request.Modifier and Type | Field and Description |
---|---|
static String |
AUTHORIZATION
HTTP "Authorization" header name.
|
static String |
CLUSTER_CONNECTION_ID_HEADER
Tyrus cluster connection ID header name.
|
static String |
CONNECTION
HTTP "Connection" header name.
|
static String |
ENABLE_TRACING_HEADER
If this header is present in the handshake request and the tracing type is configured to "ON_DEMAND", tracing
headers will be sent in the handshake response.
|
static String |
HOST
HTTP "Host" header name.
|
static String |
ORIGIN_HEADER
HTTP "Origin" header name.
|
static String |
RESPONSE_CODE_MESSAGE
HTTP reason phrase for successful handshake response.
|
static String |
SEC_WS_ORIGIN_HEADER
WebSocket origin header name from previous versions.
|
static String |
SERVER_KEY_HASH
Server key hash used to compute "Sec-WebSocket-Accept" header value.
|
static String |
TRACING_THRESHOLD
This header allows temporarily changing tracing threshold.
|
static String |
UPGRADE
HTTP "Upgrade" header name and "Connection" header expected value.
|
static String |
WEBSOCKET
Expected value in HTTP handshake "Upgrade" header.
|
Constructor and Description |
---|
UpgradeRequest() |
Modifier and Type | Method and Description |
---|---|
abstract String |
getHeader(String name)
Returns the value of the specified request header name.
|
abstract String |
getRequestUri()
Get the undecoded request uri (up to the query string) of underlying
HTTP handshake request.
|
abstract boolean |
isSecure()
Indicates whether this request was made using a secure channel
(such as HTTPS).
|
public static final String WEBSOCKET
public static final String RESPONSE_CODE_MESSAGE
public static final String UPGRADE
public static final String CONNECTION
public static final String HOST
public static final String SEC_WS_ORIGIN_HEADER
public static final String ORIGIN_HEADER
public static final String CLUSTER_CONNECTION_ID_HEADER
public static final String SERVER_KEY_HASH
public static final String AUTHORIZATION
public static final String ENABLE_TRACING_HEADER
public static final String TRACING_THRESHOLD
public abstract String getHeader(String name)
name
- a header name.public abstract String getRequestUri()
public abstract boolean isSecure()
Copyright © 2012-2015, Oracle and/or its affiliates. All Rights Reserved. Use is subject to license terms.