<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>ListenWebSocket</title><link rel="stylesheet" href="../../../../../css/component-usage.css" type="text/css"></link></head><script type="text/javascript">window.onload = function(){if(self==top) { document.getElementById('nameHeader').style.display = "inherit"; } }</script><body><h1 id="nameHeader" style="display: none;">ListenWebSocket</h1><h2>Description: </h2><p>Acts as a WebSocket server endpoint to accept client connections. FlowFiles are transferred to downstream relationships according to received message types as the WebSocket server configured with this processor receives client requests</p><h3>Tags: </h3><p>subscribe, WebSocket, consume, listen</p><h3>Properties: </h3><p>In the list below, the names of required properties appear in <strong>bold</strong>. Any other properties (not in bold) are considered optional. The table also indicates any default values.</p><table id="properties"><tr><th>Display Name</th><th>API Name</th><th>Default Value</th><th>Allowable Values</th><th>Description</th></tr><tr><td id="name"><strong>WebSocket Server ControllerService</strong></td><td>websocket-server-controller-service</td><td></td><td id="allowable-values"><strong>Controller Service API: </strong><br/>WebSocketServerService<br/><strong>Implementation: </strong><a href="../../../nifi-websocket-services-jetty-nar/1.19.1/org.apache.nifi.websocket.jetty.JettyWebSocketServer/index.html">JettyWebSocketServer</a></td><td id="description">A WebSocket SERVER Controller Service which can accept WebSocket requests.</td></tr><tr><td id="name"><strong>Server URL Path</strong></td><td>server-url-path</td><td></td><td id="allowable-values"></td><td id="description">The WetSocket URL Path on which this processor listens to. Must starts with '/', e.g. '/example'.</td></tr></table><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>text message</td><td>The WebSocket text message output</td></tr><tr><td>binary message</td><td>The WebSocket binary message output</td></tr><tr><td>connected</td><td>The WebSocket session is established</td></tr></table><h3>Reads Attributes: </h3>None specified.<h3>Writes Attributes: </h3><table id="writes-attributes"><tr><th>Name</th><th>Description</th></tr><tr><td>websocket.controller.service.id</td><td>WebSocket Controller Service id.</td></tr><tr><td>websocket.session.id</td><td>Established WebSocket session id.</td></tr><tr><td>websocket.endpoint.id</td><td>WebSocket endpoint id.</td></tr><tr><td>websocket.local.address</td><td>WebSocket server address.</td></tr><tr><td>websocket.remote.address</td><td>WebSocket client address.</td></tr><tr><td>websocket.message.type</td><td>TEXT or BINARY.</td></tr></table><h3>State management: </h3>This component does not store state.<h3>Restricted: </h3>This component is not restricted.<h3>Input requirement: </h3>This component does not allow an incoming relationship.<h3>System Resource Considerations:</h3>None specified.</body></html>