Implementation of WebSocketClientService. This service uses Jetty WebSocket client module to provide WebSocket session management throughout the application.


WebSocket, Jetty, client


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, and whether a property supports the NiFi Expression Language.


Default Value

Allowable Values


Input Buffer Size

4 kb The size of the input (read from network layer) buffer size.

Max Text Message Size

64 kb The maximum size of a text message during parsing/generating.

Max Binary Message Size

64 kb The maximum size of a binary message during parsing/generating.

WebSocket URI

The WebSocket URI this client connects to.

Supports Expression Language: true

SSL Context Service

Controller Service API: 




The SSL Context Service to use in order to secure the server. If specified, the server will accept only WSS requests; otherwise, the server will accept only WS requests

Connection Timeout

3 sec The timeout to connect the WebSocket URI.

Supports Expression Language: true