ConnectWebSocket
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
Properties
In the list below required Properties are shown with an asterisk (*). Other properties are considered optional. The table also indicates any default values, and whether a property supports the NiFi Expression Language.
| Display Name | API Name | Default Value | Allowable Values | Description |
|---|---|---|---|---|
| WebSocket Client ControllerService * | websocket-client-controller-service | Controller Service: WebSocketClientService Implementations: JettyWebSocketClient | A WebSocket CLIENT Controller Service which can connect to a WebSocket server. | |
| WebSocket Client Id * | websocket-client-id | The client ID to identify WebSocket session. It should be unique within the WebSocket Client Controller Service. Otherwise, it throws WebSocketConfigurationException when it gets started. |
Dynamic Properties
This component does not support dynamic properties.
Relationships
| Name | Description |
|---|---|
| binary message | The WebSocket binary message output |
| connected | The WebSocket session is established |
| failure | FlowFile holding connection configuration attributes (like URL or HTTP headers) in case of connection failure |
| success | FlowFile holding connection configuration attributes (like URL or HTTP headers) in case of successful connection |
| text message | The WebSocket text message output |
Reads Attributes
This processor does not read attributes.
Writes Attributes
| Name | Description |
|---|---|
| websocket.controller.service.id | WebSocket Controller Service id. |
| websocket.endpoint.id | WebSocket endpoint id. |
| websocket.local.address | WebSocket client address. |
| websocket.message.type | TEXT or BINARY. |
| websocket.remote.address | WebSocket server address. |
| websocket.session.id | Established WebSocket session id. |
State Management
This component does not store state.
Restricted
This component is not restricted.
Input Requirement
This component allows an incoming relationship.
System Resource Considerations
This component does not specify system resource considerations.