ConnectWebSocket 2.0.0

Bundle
org.apache.nifi | nifi-websocket-processors-nar
Description
Acts as a WebSocket client endpoint to interact with a remote WebSocket server. FlowFiles are transferred to downstream relationships according to received message types as WebSocket client configured with this processor receives messages from remote WebSocket server. If a new flowfile is passed to the processor, the previous sessions will be closed and any data being sent will be aborted.
Tags
WebSocket, consume, listen, subscribe
Input Requirement
ALLOWED
Supports Sensitive Dynamic Properties
false
  • Additional Details for ConnectWebSocket 2.0.0

    ConnectWebSocket

    Summary

    This processor acts as a WebSocket client endpoint to interact with a remote WebSocket server. It is capable of receiving messages from a websocket server and it transfers them to downstream relationships according to the received message types.

    The processor may have an incoming relationship, in which case flowfile attributes are passed down to its WebSocket Client Service. This can be used to fine-tune the connection configuration (url and headers for example). For example " dynamic.url = currentValue" flowfile attribute can be referenced in the WebSocket Client Service with the ${dynamic.url} expression.

    You can define custom websocket headers in the incoming flowfile as additional attributes. The attribute key shall start with “header.” and continue with they header key. For example: “header.Authorization”. The attribute value will be the corresponding header value. If a new flowfile is passed to the processor, the previous sessions will be closed, and any data being sent will be aborted.

    1. header.Autorization | Basic base64UserNamePassWord
    2. header.Content-Type | application, audio, example

    For multiple header values provide a comma separated list.

Properties
Relationships
Name Description
success FlowFile holding connection configuration attributes (like URL or HTTP headers) in case of successful connection
text message The WebSocket text message output
binary message The WebSocket binary message output
failure FlowFile holding connection configuration attributes (like URL or HTTP headers) in case of connection failure
connected The WebSocket session is established
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 client address.
websocket.remote.address WebSocket server address.
websocket.message.type TEXT or BINARY.