368.2. Websocket 选项


Jetty Websocket 组件支持 14 个选项,如下所列。

Name描述默认值类型

staticResources (consumer)

为静态资源设置资源路径(如 .html 文件等)。如果使用 classpath: 前缀,则可以从 classpath: 加载资源,否则资源是从文件系统或 JAR 文件加载的。例如,若要从 root classpath 加载,请使用 classpath:., 或 classpath:WEB-INF/static if not configured (如 null),但没有使用静态资源。

 

字符串

host (common)

主机名。默认值为 0.0.0.0

0.0.0.0

字符串

port (common)

端口号。默认值为 9292

9292

整数

sslKeyPassword (security)

使用 SSL 时密钥存储的密码。

 

字符串

sslpassword (security)

使用 SSL 时的密码。

 

字符串

sslKeystore (security)

密钥存储的路径。

 

字符串

enableJmx (advanced)

如果这个选项为 true,则会为这个端点启用 Jetty JMX 支持。如需了解更多详细信息,请参阅 Jetty JMX 支持。

false

布尔值

MinThreads (advanced)

要为服务器线程池中最少的线程数设置值。由于切换到 Jetty9,需要 MaxThreads/minThreads 或 threadPool 字段。minThreads 的默认值为 1。

 

整数

maxThreads (advanced)

要为服务器线程池中最大线程数设置值。由于切换到 Jetty9,需要 MaxThreads/minThreads 或 threadPool 字段。maxThreads 的默认值为 1 2 noCores。

 

整数

threadPool (advanced)

为服务器使用自定义线程池。由于切换到 Jetty9,需要 MaxThreads/minThreads 或 threadPool 字段。

 

ThreadPool

sslContextParameters (security)

使用 SSLContextParameters 配置安全性

 

SSLContextParameters

useGlobalSslContext 参数 (security)

启用使用全局 SSL 上下文参数。

false

布尔值

socketFactory (common)

配置包含子协议的自定义 WebSocketFactory 的映射。映射中的键是子协议。默认键是为默认实现保留的。

 

Map

resolveProperty Placeholders (advanced)

组件是否应在启动时解析属性占位符。只有 String 类型的属性可以使用属性占位符。

true

布尔值

Jetty Websocket 端点使用 URI 语法进行配置:

websocket:host:port/resourceUri

使用以下路径和查询参数:

368.2.1. 路径参数(3 参数):

Name描述默认值类型

主机

主机名。默认值为 0.0.0.0。在组件上设置这个选项将使用组件配置的值作为默认值。

0.0.0.0

字符串

port

端口号。默认值为 9292。在组件上设置这个选项将使用组件配置的值作为默认值。

9292

整数

resourceUri

要使用的 websocket 频道的名称

 

字符串

368.2.2. 查询参数(18 参数):

Name描述默认值类型

maxBinaryMessageSize (common)

可用于设置 websocketServlet 创建的 websocket 在关闭前可以接受的大小(以字节为单位)。(默认为 -1 - 或无限)

-1

整数

bridgeErrorHandler (consumer)

允许将消费者桥接到 Camel 路由错误处理程序,这意味着当消费者试图选择传入消息或类似信息时发生异常,现在将作为消息处理并由路由 Error Handler 处理。默认情况下,使用者将使用 org.apache.camel.spi.ExceptionHandler 来处理例外情况,该处理程序将被记录在 WARN 或 ERROR 级别,并忽略。

false

布尔值

sessionSupport (consumer)

是否启用会话支持,为每个 http 请求启用 HttpSession。

false

布尔值

staticResources (consumer)

为静态资源设置资源路径(如 .html 文件等)。如果使用 classpath: 前缀,则可以从 classpath: 加载资源,否则资源是从文件系统或 JAR 文件加载的。例如,若要从 root classpath 加载,请使用 classpath:., 或 classpath:WEB-INF/static if not configured (如 null),但没有使用静态资源。

 

字符串

ExceptionHandler ( consumer)

要让使用者使用自定义例外处理程序:请注意,如果启用了 bridgeErrorHandler 选项,则此选项不使用。默认情况下,消费者将处理异常,其记录在 WARN 或 ERROR 级别中,并忽略。

 

ExceptionHandler

exchangePattern (consumer)

在消费者创建交换时设置交换模式。

 

ExchangePattern

sendTimeout (producer)

发送到 websocket 频道时的超时(以 millis 为单位)。默认超时为 30000 (30 秒)。

30000

整数

sendToAll (producer)

发送到所有 websocket 订阅者。可用于在端点级别上配置,而不必在消息上使用 WebsocketConstants.SEND_TO_ALL 标头。

 

布尔值

bufferSize (advanced)

设置 websocketServlet 的缓冲区大小,它也是最大帧字节大小(默认值 8192)

8192

整数

maxIdleTime (advanced)

设置 websocketServlet 创建的 websocket 在关闭前可能会闲置的时间(默认为 300000)

300000

整数

maxTextMessageSize (advanced)

可用于在关闭前接受 websocketServlet 创建的 websocket 的大小。

 

整数

minVersion (advanced)

可用于设置 websocketServlet 接受的最低协议版本。(默认为 13 - RFC6455 版本)

13

整数

同步 (高级)

设置是否应严格使用同步处理,还是允许 Camel 使用异步处理(如果支持)。

false

布尔值

allowedOrigins (cors)

CORS 允许的源。使用 允许所有.

 

字符串

crossOriginFilterOn (cors)

是否启用 CORS

false

布尔值

filterPath (cors)

过滤 CORS 的上下文路径

 

字符串

enableJmx (monitoring)

如果这个选项为 true,则会为这个端点启用 Jetty JMX 支持。如需了解更多详细信息,请参阅 Jetty JMX 支持。

false

布尔值

sslContextParameters (security)

使用 SSLContextParameters 配置安全性

 

SSLContextParameters

Red Hat logoGithubRedditYoutubeTwitter

学习

尝试、购买和销售

社区

关于红帽文档

通过我们的产品和服务,以及可以信赖的内容,帮助红帽用户创新并实现他们的目标。

让开源更具包容性

红帽致力于替换我们的代码、文档和 Web 属性中存在问题的语言。欲了解更多详情,请参阅红帽博客.

關於紅帽

我们提供强化的解决方案,使企业能够更轻松地跨平台和环境(从核心数据中心到网络边缘)工作。

© 2024 Red Hat, Inc.