org.eclipse.jetty.websocket.server

Class ServletWebSocketResponse

java.lang.Object

org.eclipse.jetty.websocket.api.UpgradeResponse

org.eclipse.jetty.websocket.server.ServletWebSocketResponse

public class ServletWebSocketResponse
extends UpgradeResponse

Field Summary

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

SEC_WEBSOCKET_PROTOCOL

Constructor Summary

Constructors

Constructor and Description
ServletWebSocketResponse(javax.servlet.http.HttpServletResponse resp)

Method Summary

Methods

Modifier and Type	Method and Description
void	addHeader(String name, String value)
int	getStatusCode()
String	getStatusReason()
boolean	isCommitted()
void	sendError(int statusCode, String message)
void	sendForbidden(String message) Issue a forbidden upgrade response.
void	setHeader(String name, String value)
void	setStatus(int status)

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

getAcceptedSubProtocol, getExtensions, getHeader, getHeaderNames, getHeaders, getHeaders, isSuccess, setAcceptedSubProtocol, setExtensions, setStatusCode, setStatusReason, setSuccess

Methods inherited from class java.lang.Object

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

Constructor Detail

ServletWebSocketResponse

public ServletWebSocketResponse(javax.servlet.http.HttpServletResponse resp)

Method Detail

addHeader

public void addHeader(String name,
             String value)

Overrides:

addHeader in class UpgradeResponse

getStatusCode

public int getStatusCode()

Overrides:

getStatusCode in class UpgradeResponse

getStatusReason

public String getStatusReason()

Overrides:

getStatusReason in class UpgradeResponse

isCommitted

public boolean isCommitted()

sendError

public void sendError(int statusCode,
             String message)
               throws IOException

Throws:

IOException

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

setHeader

public void setHeader(String name,
             String value)

Overrides:

setHeader in class UpgradeResponse

setStatus

public void setStatus(int status)