org.eclipse.jetty.websocket.servlet

Class ServletUpgradeResponse

java.lang.Object

org.eclipse.jetty.websocket.api.UpgradeResponse

org.eclipse.jetty.websocket.servlet.ServletUpgradeResponse

Direct Known Subclasses:

ServletWebSocketResponse

public class ServletUpgradeResponse
extends UpgradeResponse

Servlet Specific UpgradeResponse implementation.

Field Summary

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

SEC_WEBSOCKET_PROTOCOL

Constructor Summary

Constructors

Constructor and Description
ServletUpgradeResponse(HttpServletResponse response)

Method Summary

Methods

Modifier and Type	Method and Description
void	complete()
int	getStatusCode()
String	getStatusReason()
boolean	isCommitted()
boolean	isExtensionsNegotiated()
boolean	isSubprotocolNegotiated()
void	sendError(int statusCode, String message)
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	setStatus(int status)

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

addHeader, getAcceptedSubProtocol, getExtensions, getHeader, getHeaderNames, getHeaders, getHeaders, isSuccess, setHeader, setStatusCode, setStatusReason, setSuccess

Methods inherited from class java.lang.Object

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

Constructor Detail

ServletUpgradeResponse

public ServletUpgradeResponse(HttpServletResponse response)

Method Detail

getStatusCode

public int getStatusCode()

Overrides:

getStatusCode in class UpgradeResponse

setStatus

public void setStatus(int status)

getStatusReason

public String getStatusReason()

Overrides:

getStatusReason in class UpgradeResponse

isCommitted

public boolean isCommitted()

isExtensionsNegotiated

public boolean isExtensionsNegotiated()

isSubprotocolNegotiated

public boolean isSubprotocolNegotiated()

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

setAcceptedSubProtocol

public void setAcceptedSubProtocol(String protocol)

Description copied from class: UpgradeResponse

Set the accepted WebSocket Protocol.

Overrides:

setAcceptedSubProtocol in class UpgradeResponse

Parameters:

protocol - the protocol to list as accepted

setExtensions

public void setExtensions(List<ExtensionConfig> extensions)

Description copied from class: UpgradeResponse

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

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.

Overrides:

setExtensions in class UpgradeResponse

Parameters:

extensions - the list of extensions to use.

complete

public void complete()