PutWebSocket 2.3.0¶

BUNDLE¶

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

DESCRIPTION¶

Sends messages to a WebSocket remote endpoint using a WebSocket session that is established by either ListenWebSocket or ConnectWebSocket.

TAGS¶

WebSocket, publish, send

INPUT REQUIREMENT¶

REQUIRED

Supports Sensitive Dynamic Properties¶

false

PROPERTIES¶

Property

Description

websocket-controller-service-id

A NiFi Expression to retrieve the id of a WebSocket ControllerService.

websocket-endpoint-id

A NiFi Expression to retrieve the endpoint id of a WebSocket ControllerService.

websocket-message-type

The type of message content: TEXT or BINARY

websocket-session-id

A NiFi Expression to retrieve the session id. If not specified, a message will be sent to all connected WebSocket peers for the WebSocket controller service endpoint.

RELATIONSHIPS¶

NAME

DESCRIPTION

failure

FlowFiles that failed to send to the destination are transferred to this relationship.

success

FlowFiles that are sent successfully to the destination are transferred to this relationship.

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.message.type

TEXT or BINARY.

websocket.local.address

WebSocket server address.

websocket.remote.address

WebSocket client address.

websocket.failure.detail

Detail of the failure.