JettyWebSocketClient

文档中心 › 组件索引 › JettyWebSocketClient

JettyWebSocketClient Controller Service

类型全限定名:cn.org.acal.lynxus.websocket.jetty.JettyWebSocketClient

所属 Bundle:cn.org.acal.lynxus:lynxus-websocket-services-jetty-nar:2.11.8

描述

WebSocketClientService 的实现。 该服务使用 Jetty WebSocket 客户端模块在整个应用程序中提供 WebSocket 会话管理。

标签

WebSocketJettyclient

属性

下表中,加粗的属性为必填项;其余为可选项。表格同时标注默认值、是否支持表达式语言,以及是否为敏感属性(值会被加密)。

名称默认值可选值描述
Input Buffer Size4 kb输入(从网络层读取)缓冲区大小的大小。
Max Text Message Size64 kb解析/生成期间文本消息的最大大小。
Max Binary Message Size64 kb解析/生成期间二进制消息的最大大小。
Idle Timeout0 secWebSocket 连接在关闭前可以保持空闲状态的最大时间。设置为 0 秒将禁用超时。
WebSocket URI此客户端连接到的 WebSocket URI。
支持表达式语言:是(使用 FlowFile 属性与环境/系统变量求值)
SSL Context Service控制器服务 API:
SSLContextProvider
cn.org.acal.lynxus-lynxus-standard-services-api-nar-2.11.8
用于保护服务器的 SSL 上下文服务。如果指定,服务器将仅接受 HTTPS 请求;否则,服务器将仅接受 HTTP 请求
Connection Timeout3 sec连接 WebSocket URI 的超时。
支持表达式语言:是(仅使用环境/系统变量求值)
Connection Attempt Count3尝试建立连接的次数。
支持表达式语言:是(仅使用环境/系统变量求值)
会话维护间隔10 sec会话维护活动之间的间隔。与 WebSocket 服务器建立的 WebSocket 会话可能因不同原因而终止,包括重启 WebSocket 服务器或超时不活动的会话。此会话维护活动定期执行以重新连接那些丢失的会话,以便 WebSocket 客户端在成功重新连接后可以透明地重用相同的会话 ID。维护活动将一直执行,直到相应的处理器或此控制器服务停止。
支持表达式语言:是(仅使用环境/系统变量求值)
Username基本身份验证的用户名。
支持表达式语言:是(仅使用环境/系统变量求值)
Password基本身份验证的用户密码。
敏感属性:是
支持表达式语言:是(仅使用环境/系统变量求值)
Authentication Header CharsetUS-ASCII基本身份验证标头 base64 字符串的字符集。
支持表达式语言:是(仅使用环境/系统变量求值)
Custom Authorization配置自定义 HTTP 授权标头,如 RFC 7235 第 4.2 节所述。设置自定义授权标头会排除配置用户名和密码属性进行基本身份验证。
敏感属性:是
支持表达式语言:是(仅使用环境/系统变量求值)
HTTP Proxy HostHTTP 代理的主机名。
支持表达式语言:是(仅使用环境/系统变量求值)
HTTP Proxy PortHTTP 代理的端口号。
支持表达式语言:是(仅使用环境/系统变量求值)

状态管理

该组件不存储状态。

受限 (Restricted)

该组件不受限。

提供的 Service API

  • WebSocketService (cn.org.acal.lynxus-lynxus-websocket-services-api-nar-2.11.8)
  • WebSocketClientService (cn.org.acal.lynxus-lynxus-websocket-services-api-nar-2.11.8)