JettyWebSocketClient

Description:

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

Tags:

WebSocket, Jetty, client

Properties:

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, whether a property supports the NiFi Expression Language, and whether a property is considered "sensitive", meaning that its value will be encrypted. Before entering a value in a sensitive property, ensure that the nifi.properties file has an entry for the property nifi.sensitive.props.key.

NameDefault ValueAllowable ValuesDescription
Input Buffer Size4 kbThe size of the input (read from network layer) buffer size.
Max Text Message Size64 kbThe maximum size of a text message during parsing/generating.
Max Binary Message Size64 kbThe maximum size of a binary message during parsing/generating.
WebSocket URIThe WebSocket URI this client connects to.
Supports Expression Language: true (will be evaluated using variable registry only)
SSL Context ServiceController Service API:
RestrictedSSLContextService
Implementation: StandardRestrictedSSLContextService
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 Timeout3 secThe timeout to connect the WebSocket URI.
Supports Expression Language: true (will be evaluated using variable registry only)
Session Maintenance Interval10 secThe interval between session maintenance activities. A WebSocket session established with a WebSocket server can be terminated due to different reasons including restarting the WebSocket server or timing out inactive sessions. This session maintenance activity is periodically executed in order to reconnect those lost sessions, so that a WebSocket client can reuse the same session id transparently after it reconnects successfully. The maintenance activity is executed until corresponding processors or this controller service is stopped.
Supports Expression Language: true (will be evaluated using variable registry only)
User NameThe user name for Basic Authentication.
Supports Expression Language: true (will be evaluated using variable registry only)
User PasswordThe user password for Basic Authentication.
Sensitive Property: true
Supports Expression Language: true (will be evaluated using variable registry only)
Authentication Header CharsetUS-ASCIIThe charset for Basic Authentication header base64 string.
Supports Expression Language: true (will be evaluated using variable registry only)

State management:

This component does not store state.

Restricted:

This component is not restricted.

System Resource Considerations:

None specified.