| <!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>JettyWebSocketServer</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;">JettyWebSocketServer</h1><h2>Description: </h2><p>Implementation of WebSocketServerService. This service uses Jetty WebSocket server module to provide WebSocket session management throughout the application.</p><h3>Tags: </h3><p>WebSocket, Jetty, server</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>Listen Port</strong></td><td>listen-port</td><td></td><td id="allowable-values"></td><td id="description">The port number on which this WebSocketServer listens to.<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</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>SSL Client Authentication</strong></td><td>client-authentication</td><td id="default-value">No Authentication</td><td id="allowable-values"><ul><li>No Authentication <img src="../../../../../html/images/iconInfo.png" alt="Processor will not authenticate clients. Anyone can communicate with this Processor anonymously" title="Processor will not authenticate clients. Anyone can communicate with this Processor anonymously"></img></li><li>Want Authentication <img src="../../../../../html/images/iconInfo.png" alt="Processor will try to verify the client but if unable to verify will allow the client to communicate anonymously" title="Processor will try to verify the client but if unable to verify will allow the client to communicate anonymously"></img></li><li>Need Authentication <img src="../../../../../html/images/iconInfo.png" alt="Processor will reject communications from any client unless the client provides a certificate that is trusted by the TrustStore specified in the SSL Context Service" title="Processor will reject communications from any client unless the client provides a certificate that is trusted by the TrustStore specified in the SSL Context Service"></img></li></ul></td><td id="description">Specifies whether or not the Processor should authenticate client by its certificate. This value is ignored if the <SSL Context Service> Property is not specified or the SSL Context provided uses only a KeyStore and not a TrustStore.</td></tr><tr><td id="name"><strong>Enable Basic Authentication</strong></td><td>basic-auth</td><td id="default-value">false</td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">If enabled, client connection requests are authenticated with Basic authentication using the specified Login Provider.</td></tr><tr><td id="name">Basic Authentication Path Spec</td><td>auth-path-spec</td><td id="default-value">/*</td><td id="allowable-values"></td><td id="description">Specify a Path Spec to apply Basic Authentication.<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name">Basic Authentication Roles</td><td>auth-roles</td><td id="default-value">**</td><td id="allowable-values"></td><td id="description">The authenticated user must have one of specified role. Multiple roles can be set as comma separated string. '*' represents any role and so does '**' any role including no role.<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name">Login Service</td><td>login-service</td><td id="default-value">HashLoginService</td><td id="allowable-values"><ul><li>HashLoginService <img src="../../../../../html/images/iconInfo.png" alt="See http://www.eclipse.org/jetty/javadoc/current/org/eclipse/jetty/security/HashLoginService.html for detail." title="See http://www.eclipse.org/jetty/javadoc/current/org/eclipse/jetty/security/HashLoginService.html for detail."></img></li></ul></td><td id="description">Specify which Login Service to use for Basic Authentication.</td></tr><tr><td id="name">Users Properties File</td><td>users-properties-file</td><td></td><td id="allowable-values"></td><td id="description">Specify a property file containing users for Basic Authentication using HashLoginService. See http://www.eclipse.org/jetty/documentation/current/configuring-security.html for detail.<br/><br/><strong>This property requires exactly one file to be provided..</strong><br/><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> |