org.glassfish.tyrus.spi

Class UpgradeResponse

java.lang.Object

org.glassfish.tyrus.spi.UpgradeResponse

All Implemented Interfaces:

javax.websocket.HandshakeResponse

public abstract class UpgradeResponse
extends Object
implements javax.websocket.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 (pavel.bucek at oracle.com)

Field Summary

Fields inherited from interface javax.websocket.HandshakeResponse

SEC_WEBSOCKET_ACCEPT

Constructor Summary

Constructors

Constructor and Description
UpgradeResponse()

Method Summary

Methods

Modifier and Type	Method and Description
String	getFirstHeaderValue(String name) Gets the value of the response header with the given name.
abstract int	getStatus() Gets the current HTTP status code of this response.
abstract void	setHeader(String name, String value) Sets a response header with the given name and value.
abstract void	setReasonPhrase(String reason) Get HTTP reason phrase.
abstract void	setStatus(int status) Sets 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 javax.websocket.HandshakeResponse

getHeaders

Constructor Detail

UpgradeResponse

public UpgradeResponse()

Method Detail

getStatus

public abstract int getStatus()

Gets the current HTTP status code of this response.

Returns:

the current HTTP status code.

setStatus

public abstract void setStatus(int status)

Sets HTTP status code for this response.

Parameters:

status - HTTP status code for this response.

setReasonPhrase

public abstract void setReasonPhrase(String reason)

Get HTTP reason phrase. TODO remove ?? we are using only for "Switching Protocols" and that is TODO standard status code 101

setHeader

public abstract void setHeader(String name,
             String value)

Sets a response header with the given name and value. If the header had already been set, the new value overwrites the previous one.

Parameters:

name - the name of the header.

value - the header value If it contains octet string, it should be encoded according to RFC 2047 (http://www.ietf.org/rfc/rfc2047.txt).

getFirstHeaderValue

public String getFirstHeaderValue(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)