Package org.openhab.core.io.websocket

Class CommonWebSocketServlet

java.lang.Object

javax.servlet.GenericServlet

javax.servlet.http.HttpServlet

org.eclipse.jetty.websocket.servlet.WebSocketServlet

org.openhab.core.io.websocket.CommonWebSocketServlet

All Implemented Interfaces:

Serializable, javax.servlet.Servlet, javax.servlet.ServletConfig

@NonNullByDefault
public class CommonWebSocketServlet
extends org.eclipse.jetty.websocket.servlet.WebSocketServlet

The CommonWebSocketServlet provides the servlet for WebSocket connections.

Clients can authorize in two ways:

• By setting org.openhab.ws.accessToken.base64. + base64-encoded access token and the WEBSOCKET_PROTOCOL_DEFAULT in the Sec-WebSocket-Protocol header.
• By providing the access token as query parameter accessToken.

Author:

Jan N. Klug - Initial contribution, Miguel Álvarez Díez - Refactor into a common servlet, Florian Hotze - Support passing access token through Sec-WebSocket-Protocol header

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_ADAPTER_ID
static final String	SEC_WEBSOCKET_PROTOCOL_HEADER
static final String	SERVLET_PATH
static final String	WEBSOCKET_PROTOCOL_DEFAULT

Constructor Summary

Constructors

Constructor	Description
CommonWebSocketServlet(AuthFilter authFilter)

Method Summary

Modifier and Type	Method	Description
protected void	addWebSocketAdapter(WebSocketAdapter wsAdapter)
void	configure(org.eclipse.jetty.websocket.servlet.WebSocketServletFactory webSocketServletFactory)
protected void	removeWebSocketAdapter(WebSocketAdapter wsAdapter)

Methods inherited from class org.eclipse.jetty.websocket.servlet.WebSocketServlet

destroy, init, service

Methods inherited from class javax.servlet.http.HttpServlet

doDelete, doGet, doHead, doOptions, doPost, doPut, doTrace, getLastModified, service

Methods inherited from class javax.servlet.GenericServlet

getInitParameter, getInitParameterNames, getServletConfig, getServletContext, getServletInfo, getServletName, init, log, log

Methods inherited from class java.lang.Object

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

Field Details

SEC_WEBSOCKET_PROTOCOL_HEADER

public static final String SEC_WEBSOCKET_PROTOCOL_HEADER

See Also:

• Constant Field Values

WEBSOCKET_PROTOCOL_DEFAULT

public static final String WEBSOCKET_PROTOCOL_DEFAULT

See Also:

• Constant Field Values

SERVLET_PATH

public static final String SERVLET_PATH

See Also:

• Constant Field Values

DEFAULT_ADAPTER_ID

public static final String DEFAULT_ADAPTER_ID

See Also:

• Constant Field Values

Constructor Details

CommonWebSocketServlet

public CommonWebSocketServlet(AuthFilter authFilter)
                       throws javax.servlet.ServletException,
org.osgi.service.http.NamespaceException

Throws:

javax.servlet.ServletException

org.osgi.service.http.NamespaceException

Method Details

configure

public void configure(@NonNullByDefault({})
 org.eclipse.jetty.websocket.servlet.WebSocketServletFactory webSocketServletFactory)

Specified by:

configure in class org.eclipse.jetty.websocket.servlet.WebSocketServlet

addWebSocketAdapter

protected void addWebSocketAdapter(WebSocketAdapter wsAdapter)

removeWebSocketAdapter

protected void removeWebSocketAdapter(WebSocketAdapter wsAdapter)