org.eclipse.jetty.websocket.client

Class ClientUpgradeResponse

java.lang.Object

org.eclipse.jetty.websocket.api.UpgradeResponse

org.eclipse.jetty.websocket.client.ClientUpgradeResponse

All Implemented Interfaces:

HttpResponseHeaderParseListener

public class ClientUpgradeResponse
extends UpgradeResponse
implements HttpResponseHeaderParseListener

Field Summary

Fields inherited from class org.eclipse.jetty.websocket.api.UpgradeResponse

SEC_WEBSOCKET_PROTOCOL

Constructor Summary

Constructors

Constructor and Description
ClientUpgradeResponse()

Method Summary

Methods

Modifier and Type	Method and Description
ByteBuffer	getRemainingBuffer()
void	sendForbidden(String message) Issue a forbidden upgrade response.
void	setRemainingBuffer(ByteBuffer remainingBuffer)

Methods inherited from class org.eclipse.jetty.websocket.api.UpgradeResponse

addHeader, getAcceptedSubProtocol, getExtensions, getHeader, getHeaderNames, getHeaders, getHeaders, getStatusCode, getStatusReason, isSuccess, setAcceptedSubProtocol, setExtensions, setHeader, setStatusCode, setStatusReason, setSuccess

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.eclipse.jetty.websocket.common.io.http.HttpResponseHeaderParseListener

addHeader, setStatusCode, setStatusReason

Constructor Detail

ClientUpgradeResponse

public ClientUpgradeResponse()

Method Detail

getRemainingBuffer

public ByteBuffer getRemainingBuffer()

sendForbidden

public void sendForbidden(String message)
                   throws IOException

Description copied from class: UpgradeResponse

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.

Overrides:

sendForbidden in class UpgradeResponse

Parameters:

message - the short 1 line detail message about the forbidden response

Throws:

IOException

setRemainingBuffer

public void setRemainingBuffer(ByteBuffer remainingBuffer)

Specified by:

setRemainingBuffer in interface HttpResponseHeaderParseListener