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.
subscribe, WebSocket, consume, listen
In the list below, the names of required properties appear in bold. Any other properties (not in bold) are considered optional. The table also indicates any default values.
| Display Name | API Name | Default Value | Allowable Values | Description |
|---|---|---|---|---|
| WebSocket Client ControllerService | websocket-client-controller-service | Controller Service API: WebSocketClientService Implementation: 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. |
| 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 |
| 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. |