org.eclipse.jetty.websocket.server

Class ServletWebSocketResponse

java.lang.Object

javax.servlet.ServletResponseWrapper

javax.servlet.http.HttpServletResponseWrapper

org.eclipse.jetty.websocket.server.ServletWebSocketResponse

All Implemented Interfaces:

HttpServletResponse, ServletResponse, UpgradeResponse

public class ServletWebSocketResponse
extends HttpServletResponseWrapper
implements UpgradeResponse

Field Summary

Fields inherited from interface javax.servlet.http.HttpServletResponse

SC_ACCEPTED, SC_BAD_GATEWAY, SC_BAD_REQUEST, SC_CONFLICT, SC_CONTINUE, SC_CREATED, SC_EXPECTATION_FAILED, SC_FORBIDDEN, SC_FOUND, SC_GATEWAY_TIMEOUT, SC_GONE, SC_HTTP_VERSION_NOT_SUPPORTED, SC_INTERNAL_SERVER_ERROR, SC_LENGTH_REQUIRED, SC_METHOD_NOT_ALLOWED, SC_MOVED_PERMANENTLY, SC_MOVED_TEMPORARILY, SC_MULTIPLE_CHOICES, SC_NO_CONTENT, SC_NON_AUTHORITATIVE_INFORMATION, SC_NOT_ACCEPTABLE, SC_NOT_FOUND, SC_NOT_IMPLEMENTED, SC_NOT_MODIFIED, SC_OK, SC_PARTIAL_CONTENT, SC_PAYMENT_REQUIRED, SC_PRECONDITION_FAILED, SC_PROXY_AUTHENTICATION_REQUIRED, SC_REQUEST_ENTITY_TOO_LARGE, SC_REQUEST_TIMEOUT, SC_REQUEST_URI_TOO_LONG, SC_REQUESTED_RANGE_NOT_SATISFIABLE, SC_RESET_CONTENT, SC_SEE_OTHER, SC_SERVICE_UNAVAILABLE, SC_SWITCHING_PROTOCOLS, SC_TEMPORARY_REDIRECT, SC_UNAUTHORIZED, SC_UNSUPPORTED_MEDIA_TYPE, SC_USE_PROXY

Constructor Summary

Constructors

Constructor and Description
ServletWebSocketResponse(HttpServletResponse resp)

Method Summary

Methods

Modifier and Type	Method and Description
void	addHeader(String name, String value)
String	getAcceptedSubProtocol() Get the accepted WebSocket protocol.
List<ExtensionConfig>	getExtensions() Get the list of extensions that should be used for the websocket.
Set<String>	getHeaderNamesSet()
String	getHeaderValue(String name)
Iterator<String>	getHeaderValues(String name)
int	getStatusCode()
String	getStatusReason()
boolean	isSuccess()
void	sendForbidden(String message) Issue a forbidden upgrade response.
void	setAcceptedSubProtocol(String protocol) Set the accepted WebSocket Protocol.
void	setExtensions(List<ExtensionConfig> extensions) Set the list of extensions that are approved for use with this websocket.
void	validateWebSocketHash(String expectedHash)

Methods inherited from class javax.servlet.http.HttpServletResponseWrapper

addCookie, addDateHeader, addIntHeader, containsHeader, encodeRedirectUrl, encodeRedirectURL, encodeUrl, encodeURL, getHeader, getHeaderNames, getHeaders, getStatus, sendError, sendError, sendRedirect, setDateHeader, setHeader, setIntHeader, setStatus, setStatus

Methods inherited from class javax.servlet.ServletResponseWrapper

flushBuffer, getBufferSize, getCharacterEncoding, getContentType, getLocale, getOutputStream, getResponse, getWriter, isCommitted, isWrapperFor, isWrapperFor, reset, resetBuffer, setBufferSize, setCharacterEncoding, setContentLength, setContentType, setLocale, setResponse

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.core.api.UpgradeResponse

setHeader

Methods inherited from interface javax.servlet.ServletResponse

flushBuffer, getBufferSize, getCharacterEncoding, getContentType, getLocale, getOutputStream, getWriter, isCommitted, reset, resetBuffer, setBufferSize, setCharacterEncoding, setContentLength, setContentType, setLocale

Constructor Detail

ServletWebSocketResponse

public ServletWebSocketResponse(HttpServletResponse resp)

Method Detail

addHeader

public void addHeader(String name,
             String value)

Specified by:

addHeader in interface HttpServletResponse

Specified by:

addHeader in interface UpgradeResponse

Overrides:

addHeader in class HttpServletResponseWrapper

getAcceptedSubProtocol

public String getAcceptedSubProtocol()

Description copied from interface: UpgradeResponse

Get the accepted WebSocket protocol.

Specified by:

getAcceptedSubProtocol in interface UpgradeResponse

Returns:

the accepted WebSocket protocol.

getExtensions

public List<ExtensionConfig> getExtensions()

Description copied from interface: UpgradeResponse

Get the list of extensions that should be used for the websocket.

Specified by:

getExtensions in interface UpgradeResponse

Returns:

the list of negotiated extensions to use.

getHeaderNamesSet

public Set<String> getHeaderNamesSet()

Specified by:

getHeaderNamesSet in interface UpgradeResponse

getHeaderValue

public String getHeaderValue(String name)

Specified by:

getHeaderValue in interface UpgradeResponse

getHeaderValues

public Iterator<String> getHeaderValues(String name)

Specified by:

getHeaderValues in interface UpgradeResponse

getStatusCode

public int getStatusCode()

Specified by:

getStatusCode in interface UpgradeResponse

getStatusReason

public String getStatusReason()

Specified by:

getStatusReason in interface UpgradeResponse

isSuccess

public boolean isSuccess()

Specified by:

isSuccess in interface UpgradeResponse

sendForbidden

public void sendForbidden(String message)
                   throws IOException

Description copied from interface: 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.

Specified by:

sendForbidden in interface UpgradeResponse

Parameters:

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

Throws:

IOException

setAcceptedSubProtocol

public void setAcceptedSubProtocol(String protocol)

Description copied from interface: UpgradeResponse

Set the accepted WebSocket Protocol.

Specified by:

setAcceptedSubProtocol in interface UpgradeResponse

Parameters:

protocol - the protocol to list as accepted

setExtensions

public void setExtensions(List<ExtensionConfig> extensions)

Description copied from interface: UpgradeResponse

Set the list of extensions that are approved for use with this websocket.

This is Advanced usage of the WebSocketCreator to allow for a custom set of negotiated extensions.

Notes:

• Per the spec you cannot add extensions that have not been seen in the UpgradeRequest, just remove entries you don't want to use
• If this is unused, or a null is passed, then the list negotiation will follow default behavior and use the complete list of extensions that are available in this WebSocket server implementation.

Specified by:

setExtensions in interface UpgradeResponse

Parameters:

extensions - the list of extensions to use.

validateWebSocketHash

public void validateWebSocketHash(String expectedHash)
                           throws UpgradeException

Specified by:

validateWebSocketHash in interface UpgradeResponse

Throws:

UpgradeException