JettyWebSocketServer

文档中心 › 组件索引 › JettyWebSocketServer

JettyWebSocketServer Controller Service

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

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

描述

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

标签

WebSocketJettyserver

属性

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

名称默认值可选值描述
Input Buffer Size4 kb输入(从网络层读取)缓冲区大小的大小。
Max Text Message Size64 kb解析/生成期间文本消息的最大大小。
Max Binary Message Size64 kb解析/生成期间二进制消息的最大大小。
Idle Timeout0 secWebSocket 连接在关闭前可以保持空闲状态的最大时间。设置为 0 秒将禁用超时。
Port此 WebSocketServer 侦听的端口号。
支持表达式语言:是(仅使用环境/系统变量求值)
SSL Context Service控制器服务 API:
SSLContextProvider
cn.org.acal.lynxus-lynxus-standard-services-api-nar-2.11.8
用于保护服务器的 SSL 上下文服务。如果指定,服务器将仅接受 HTTPS 请求;否则,服务器将仅接受 HTTP 请求
Client Authenticationno
  • 无认证 — 处理器不会对客户端进行认证。任何人都可以匿名与此处理器通信
  • 需要认证(可选) — 处理器将尝试验证客户端,但如果无法验证则允许客户端匿名通信
  • 需要认证(必需) — 处理器将拒绝任何未提供由 TrustStore 信任的证书的客户端通信,该 TrustStore 在 SSL Context Service 中指定
指定处理器是否应通过客户端证书对其进行身份验证。如果未指定 <SSL Context Service> 属性或提供的 SSL 上下文仅使用密钥库而不使用信任库,则忽略此值。
Basic Authentication Enabledfalse
  • true
  • false
如果启用,将使用指定的登录提供者通过基本身份验证对客户端连接请求进行身份验证。
Basic Authentication Path Spec/*指定路径规范以应用基本身份验证。
支持表达式语言:是(仅使用环境/系统变量求值)
基本身份验证角色**认证用户必须拥有指定角色之一。多个角色可以用逗号分隔的字符串设置。'*' 表示任意角色,'**' 表示任意角色包括无角色。
支持表达式语言:是(仅使用环境/系统变量求值)
Login Servicehash
  • HashLoginService — See http://www.eclipse.org/jetty/javadoc/current/org/eclipse/jetty/security/HashLoginService.html for detail.
指定用于基本身份验证的登录服务。
用户属性文件指定包含基本身份验证用户信息的属性文件,使用 HashLoginService。详见 http://www.eclipse.org/jetty/documentation/current/configuring-security.html。
支持表达式语言:是(仅使用环境/系统变量求值)

状态管理

该组件不存储状态。

受限 (Restricted)

该组件不受限。

提供的 Service API

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