| <!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>JettyWebSocketClient</title><link rel="stylesheet" href="../../../../../css/component-usage.css" type="text/css"></link></head><script type="text/javascript">window.onload = function(){if(self==top) { document.getElementById('nameHeader').style.display = "inherit"; } }</script><body><h1 id="nameHeader" style="display: none;">JettyWebSocketClient</h1><h2>Description: </h2><p>Implementation of WebSocketClientService. This service uses Jetty WebSocket client module to provide WebSocket session management throughout the application.</p><h3>Tags: </h3><p>WebSocket, Jetty, client</p><h3>Properties: </h3><p>In the list below, the names of required properties appear in <strong>bold</strong>. Any other properties (not in bold) are considered optional. The table also indicates any default values, and whether a property supports the <a href="../../../../../html/expression-language-guide.html">NiFi Expression Language</a>.</p><table id="properties"><tr><th>Display Name</th><th>API Name</th><th>Default Value</th><th>Allowable Values</th><th>Description</th></tr><tr><td id="name"><strong>Input Buffer Size</strong></td><td>input-buffer-size</td><td id="default-value">4 kb</td><td id="allowable-values"></td><td id="description">The size of the input (read from network layer) buffer size.</td></tr><tr><td id="name"><strong>Max Text Message Size</strong></td><td>max-text-message-size</td><td id="default-value">64 kb</td><td id="allowable-values"></td><td id="description">The maximum size of a text message during parsing/generating.</td></tr><tr><td id="name"><strong>Max Binary Message Size</strong></td><td>max-binary-message-size</td><td id="default-value">64 kb</td><td id="allowable-values"></td><td id="description">The maximum size of a binary message during parsing/generating.</td></tr><tr><td id="name"><strong>WebSocket URI</strong></td><td>websocket-uri</td><td></td><td id="allowable-values"></td><td id="description">The WebSocket URI this client connects to.<br/><strong>Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)</strong></td></tr><tr><td id="name">SSL Context Service</td><td>ssl-context-service</td><td></td><td id="allowable-values"><strong>Controller Service API: </strong><br/>RestrictedSSLContextService<br/><strong>Implementation: </strong><a href="../../../nifi-ssl-context-service-nar/1.19.1/org.apache.nifi.ssl.StandardRestrictedSSLContextService/index.html">StandardRestrictedSSLContextService</a></td><td id="description">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</td></tr><tr><td id="name"><strong>Connection Timeout</strong></td><td>connection-timeout</td><td id="default-value">3 sec</td><td id="allowable-values"></td><td id="description">The timeout to connect the WebSocket URI.<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name"><strong>Connection Attempt Count</strong></td><td>connection-attempt-timeout</td><td id="default-value">3</td><td id="allowable-values"></td><td id="description">The number of times to try and establish a connection.<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name"><strong>Session Maintenance Interval</strong></td><td>session-maintenance-interval</td><td id="default-value">10 sec</td><td id="allowable-values"></td><td id="description">The 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.<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name">User Name</td><td>user-name</td><td></td><td id="allowable-values"></td><td id="description">The user name for Basic Authentication.<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name">User Password</td><td>user-password</td><td></td><td id="allowable-values"></td><td id="description">The user password for Basic Authentication.<br/><strong>Sensitive Property: true</strong><br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name"><strong>Authentication Header Charset</strong></td><td>authentication-charset</td><td id="default-value">US-ASCII</td><td id="allowable-values"></td><td id="description">The charset for Basic Authentication header base64 string.<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name">Custom Authorization</td><td>custom-authorization</td><td></td><td id="allowable-values"></td><td id="description">Configures a custom HTTP Authorization Header as described in RFC 7235 Section 4.2. Setting a custom Authorization Header excludes configuring the User Name and User Password properties for Basic Authentication.<br/><strong>Sensitive Property: true</strong><br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name">HTTP Proxy Host</td><td>proxy-host</td><td></td><td id="allowable-values"></td><td id="description">The host name of the HTTP Proxy.<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name">HTTP Proxy Port</td><td>proxy-port</td><td></td><td id="allowable-values"></td><td id="description">The port number of the HTTP Proxy.<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr></table><h3>State management: </h3>This component does not store state.<h3>Restricted: </h3>This component is not restricted.<h3>System Resource Considerations:</h3>None specified.</body></html> |