ListenWebSocket
Description
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
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 Server ControllerService * | websocket-server-controller-service | Controller Service: WebSocketServerService Implementations: 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'. |
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 |
| 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 server address. |
| websocket.message.type | TEXT or BINARY. |
| websocket.remote.address | WebSocket client 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 does not allow an incoming relationship.
System Resource Considerations
This component does not specify system resource considerations.