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 NameAPI NameDefault ValueAllowable ValuesDescription
WebSocket Server ControllerServicewebsocket-server-controller-serviceController Service API:
Implementation: JettyWebSocketServer
A WebSocket SERVER Controller Service which can accept WebSocket requests.
Server URL Pathserver-url-pathThe WetSocket URL Path on which this processor listens to. Must starts with '/', e.g. '/example'.


text messageThe WebSocket text message output
binary messageThe WebSocket binary message output
connectedThe WebSocket session is established

Reads Attributes:

None specified.

Writes Attributes:

websocket.controller.service.idWebSocket Controller Service id.
websocket.session.idEstablished WebSocket session id.
websocket.endpoint.idWebSocket endpoint id.
websocket.local.addressWebSocket server address.
websocket.remote.addressWebSocket client address.
websocket.message.typeTEXT or BINARY.

State management:

This component does not store state.


This component is not restricted.

Input requirement:

This component does not allow an incoming relationship.

System Resource Considerations:

None specified.