JettyWebSocketServer
Description
Implementation of WebSocketServerService. This service uses Jetty WebSocket server module to provide WebSocket session management throughout the application.
Tags
Jetty, WebSocket, server
Properties
In the list below required Properties are shown with an asterisk (*). Other properties are considered optional. The table also indicates any default values, and whether a property supports the NiFi Expression Language.
| Display Name | API Name | Default Value | Allowable Values | Description |
|---|---|---|---|---|
| Input Buffer Size * | input-buffer-size | 4 kb | The size of the input (read from network layer) buffer size. | |
| Max Text Message Size * | max-text-message-size | 64 kb | The maximum size of a text message during parsing/generating. | |
| Max Binary Message Size * | max-binary-message-size | 64 kb | The maximum size of a binary message during parsing/generating. | |
| Listen Port * | listen-port | The port number on which this WebSocketServer listens to. Supports Expression Language, using Environment variables. | ||
| SSL Context Service | ssl-context-service | Controller Service: RestrictedSSLContextService Implementations: 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 | |
| SSL Client Authentication * | client-authentication | No Authentication |
| 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. |
| Enable Basic Authentication * | basic-auth | false |
| If enabled, client connection requests are authenticated with Basic authentication using the specified Login Provider. |
| Basic Authentication Path Spec | auth-path-spec | /* | Specify a Path Spec to apply Basic Authentication. Supports Expression Language, using Environment variables. | |
| Basic Authentication Roles | auth-roles | ** | 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. Supports Expression Language, using Environment variables. | |
| Login Service | login-service | HashLoginService |
| Specify which Login Service to use for Basic Authentication. |
| Users Properties File | users-properties-file | Specify a property file containing users for Basic Authentication using HashLoginService. See http://www.eclipse.org/jetty/documentation/current/configuring-security.html for detail. Supports Expression Language, using Environment variables. |
State Management
This component does not store state.
Restricted
This component is not restricted.
System Resource Considerations
This component does not specify system resource considerations.