Acts as a WebSocket server endpoint to accept client connections. FlowFiles are transferred to downstream relationships according to received message types as the WebSocket server configured with this processor receives client requests
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 Server ControllerService | websocket-server-controller-service | Controller Service API: WebSocketServerService Implementation: JettyWebSocketServer | A WebSocket SERVER Controller Service which can accept WebSocket requests. | |
| Server URL Path | server-url-path | The WetSocket URL Path on which this processor listens to. Must starts with '/', e.g. '/example'. |
| Name | Description |
|---|---|
| text message | The WebSocket text message output |
| binary message | The WebSocket binary message output |
| 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 server address. |
| websocket.remote.address | WebSocket client address. |
| websocket.message.type | TEXT or BINARY. |