PutWebSocket

PutWebSocket 2.1.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

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

Display Name

WebSocket ControllerService Id

Description

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

API Name

websocket-controller-service-id

Default Value

${websocket.controller.service.id}

Expression Language Scope

Environment variables and FlowFile Attributes

Sensitive

false

Required

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

Display Name

WebSocket Endpoint Id

Description

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

API Name

websocket-endpoint-id

Default Value

${websocket.endpoint.id}

Expression Language Scope

Environment variables and FlowFile Attributes

Sensitive

false

Required

true
WebSocket Message Type
The type of message content: TEXT or BINARY

Display Name

WebSocket Message Type

Description

The type of message content: TEXT or BINARY

API Name

websocket-message-type

Default Value

TEXT

Expression Language Scope

Environment variables and FlowFile Attributes

Sensitive

false

Required

true
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.

Display Name

WebSocket Session Id

Description

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.

API Name

websocket-session-id

Default Value

${websocket.session.id}

Expression Language Scope

Environment variables and FlowFile Attributes

Sensitive

false

Required

true

System Resource Considerations

Resource	Description
MEMORY	An instance of this component can cause high usage of this system resource. Multiple instances or high concurrency settings may result a degradation of performance.

Relationships

Name	Description
success	FlowFiles that are sent successfully to the destination are transferred to this relationship.
failure	FlowFiles that failed to send 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.