Package org.openhab.core.io.websocket.log

Class LogWebSocketAdapter

java.lang.Object

org.openhab.core.io.websocket.log.LogWebSocketAdapter

All Implemented Interfaces:

WebSocketAdapter

@NonNullByDefault
public class LogWebSocketAdapter
extends Object
implements WebSocketAdapter

The LogWebSocketAdapter allows subscription to log events over WebSocket

Author:

Jan N. Klug - Initial contribution

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ADAPTER_ID

Constructor Summary

Constructors

Constructor	Description
LogWebSocketAdapter(org.osgi.service.log.LogReaderService logReaderService)

Method Summary

Modifier and Type	Method	Description
Object	createWebSocket(org.eclipse.jetty.websocket.servlet.ServletUpgradeRequest servletUpgradeRequest, org.eclipse.jetty.websocket.servlet.ServletUpgradeResponse servletUpgradeResponse)	Creates a websocket instance.
void	deactivate()
String	getId()	The adapter id.
Enumeration<org.osgi.service.log.LogEntry>	getLog()
void	registerListener(LogWebSocket logWebSocket)
void	unregisterListener(LogWebSocket logWebSocket)

Methods inherited from class java.lang.Object

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

Field Details

ADAPTER_ID

public static final String ADAPTER_ID

See Also:

• Constant Field Values

Constructor Details

LogWebSocketAdapter

public LogWebSocketAdapter(org.osgi.service.log.LogReaderService logReaderService)

Method Details

deactivate

public void deactivate()

registerListener

public void registerListener(LogWebSocket logWebSocket)

unregisterListener

public void unregisterListener(LogWebSocket logWebSocket)

getId

public String getId()

Description copied from interface: WebSocketAdapter

The adapter id. In combination with the base path CommonWebSocketServlet.SERVLET_PATH defines the adapter path.

Specified by:

getId in interface WebSocketAdapter

Returns:

the adapter id.

createWebSocket

public Object createWebSocket(org.eclipse.jetty.websocket.servlet.ServletUpgradeRequest servletUpgradeRequest,
 org.eclipse.jetty.websocket.servlet.ServletUpgradeResponse servletUpgradeResponse)

Description copied from interface: WebSocketAdapter

Creates a websocket instance. It should use the org.eclipse.jetty.websocket.api.annotations or implement WebSocketListener.

Specified by:

createWebSocket in interface WebSocketAdapter

Returns:

a websocket instance.

getLog

public Enumeration<org.osgi.service.log.LogEntry> getLog()