org.glassfish.tyrus.spi

Class UpgradeResponse

java.lang.Object

org.glassfish.tyrus.spi.UpgradeResponse

All Implemented Interfaces:

HandshakeResponse

Direct Known Subclasses:

TyrusUpgradeResponse

public abstract class UpgradeResponse
extends java.lang.Object
implements HandshakeResponse

Abstraction for a HTTP upgrade response. A transport creates an implementation for this and uses WebSocketEngine.upgrade(org.glassfish.tyrus.spi.UpgradeRequest, org.glassfish.tyrus.spi.UpgradeResponse) method to upgrade the request.

Author:

Pavel Bucek

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	LOCATION Header containing a new URI when getStatus() .
static java.lang.String	RETRY_AFTER Header containing delay or date in which client can try to reconnect to the server.
static java.lang.String	TRACING_HEADER_PREFIX Prefix of headers used for including tracing information into handshake response.
static java.lang.String	WWW_AUTHENTICATE Header containing challenge with authentication scheme and parameters.

Fields inherited from interface jakarta.websocket.HandshakeResponse

SEC_WEBSOCKET_ACCEPT

Constructor Summary

Constructors

Constructor and Description
UpgradeResponse()

Method Summary

Modifier and Type	Method and Description
java.lang.String	getFirstHeaderValue(java.lang.String name) Gets the value of the response header with the given name.
abstract java.lang.String	getReasonPhrase() Get HTTP reason phrase.
abstract int	getStatus() Get the current HTTP status code of this response.
abstract void	setReasonPhrase(java.lang.String reason) Set HTTP reason phrase.
abstract void	setStatus(int status) Set HTTP status code for this response.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface jakarta.websocket.HandshakeResponse

getHeaders

Field Detail

WWW_AUTHENTICATE

public static final java.lang.String WWW_AUTHENTICATE

Header containing challenge with authentication scheme and parameters.

See Also:

Constant Field Values

LOCATION

public static final java.lang.String LOCATION

Header containing a new URI when getStatus() .

See Also:

Constant Field Values

RETRY_AFTER

public static final java.lang.String RETRY_AFTER

Header containing delay or date in which client can try to reconnect to the server.

See Also:

Constant Field Values

TRACING_HEADER_PREFIX

public static final java.lang.String TRACING_HEADER_PREFIX

Prefix of headers used for including tracing information into handshake response.

See Also:

Constant Field Values

Constructor Detail

UpgradeResponse

public UpgradeResponse()

Method Detail

getStatus

public abstract int getStatus()

Get the current HTTP status code of this response.

Returns:

the current HTTP status code.

setStatus

public abstract void setStatus(int status)

Set HTTP status code for this response.

Parameters:

status - HTTP status code for this response.

setReasonPhrase

public abstract void setReasonPhrase(java.lang.String reason)

Set HTTP reason phrase.

Warning: The Reason Phrase is removed from HTTP/2 and from Servlet 6.

Parameters:

reason - reason phrase to be set.

getReasonPhrase

public abstract java.lang.String getReasonPhrase()

Get HTTP reason phrase.

Warning: The Reason Phrase is removed from HTTP/2 and from Servlet 6.

getFirstHeaderValue

public final java.lang.String getFirstHeaderValue(java.lang.String name)

Gets the value of the response header with the given name.

If a response header with the given name exists and contains multiple values, the value that was added first will be returned.

Parameters:

name - header name.

Returns:

the value of the response header with the given name, null if no header with the given name has been set on this response. TODO rename to getHeader(String name) ?? similar to TODO HttpServletResponse#getHeader(String)