ListenWebSocket 2.3.0¶

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¶

Property

Description

server-url-path

The WetSocket URL Path on which this processor listens to. Must starts with ‘/’, e.g. ‘/example’.

websocket-server-controller-service

A WebSocket SERVER Controller Service which can accept WebSocket requests.

RELATIONSHIPS¶

NAME

DESCRIPTION

binary message

The WebSocket binary message output

connected

The WebSocket session is established

disconnected

The WebSocket session is disconnected

text message

The WebSocket text message output

WRITES ATTRIBUTES¶

NAME

DESCRIPTION

websocket.controller.service.id

WebSocket Controller Service id.

websocket.session.id

Established WebSocket session id.

websocket.endpoint.id

WebSocket endpoint id.

websocket.local.address

WebSocket server address.

websocket.remote.address

WebSocket client address.

websocket.message.type

TEXT or BINARY.