ListenWebSocket 2025.10.9.21

Bundle

org.apache.nifi | nifi-websocket-processors-nar

Description

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

Tags

WebSocket, consume, listen, subscribe

Input Requirement

FORBIDDEN

Supports Sensitive Dynamic Properties

false

Properties

PropertyDescription
server-url-pathThe WetSocket URL Path on which this processor listens to. Must starts with ‘/’, e.g. ‘/example’.
websocket-server-controller-serviceA WebSocket SERVER Controller Service which can accept WebSocket requests.

Relationships

NameDescription
binary messageThe WebSocket binary message output
connectedThe WebSocket session is established
disconnectedThe WebSocket session is disconnected
text messageThe WebSocket text message output

Writes attributes

NameDescription
websocket.controller.service.idWebSocket Controller Service id.
websocket.session.idEstablished WebSocket session id.
websocket.endpoint.idWebSocket endpoint id.
websocket.local.addressWebSocket server address.
websocket.remote.addressWebSocket client address.
websocket.message.typeTEXT or BINARY.