30.5. 端点选项
CXF-RS 端点使用 URI 语法进行配置:
cxfrs:beanId:address
cxfrs:beanId:address
使用以下 路径和 查询参数 :
30.5.1. 路径参数(2 参数) 复制链接链接已复制到粘贴板!
| Name | 描述 | 默认值 | 类型 |
|---|---|---|---|
| beanId (common) |
要查找现有配置的 CxfRsEndpoint。必须使用 | 字符串 | |
| address (common) | 服务发布地址。 | 字符串 |
30.5.2. 查询参数(31 参数) 复制链接链接已复制到粘贴板!
| Name | 描述 | 默认值 | 类型 |
|---|---|---|---|
| features (common) | 将功能列表设置为 CxfRs 端点。 | list | |
| loggingFeatureEnabled (common) | 这个选项启用 CXF Logging 功能,将入站和出站 REST 消息写入日志。 | false | 布尔值 |
| loggingSizeLimit (common) | 为限制启用日志记录功能时,日志记录器将输出的字节数。 | int | |
| modelRef (common) | 此选项用于指定对没有注解的资源类有用的模型文件。使用这个选项时,可以省略服务类,以模拟仅文档的端点。 | 字符串 | |
| providers (common) | 设置自定义 JAX-RS 提供程序列表到 CxfRs 端点。您可以在以逗号分开的 registy 中指定要查询的供应商列表指定字符串。 | 字符串 | |
| resourceClasses (common) | 要导出为 REST 服务的资源类。可以使用逗号分隔多个类。 | list | |
| schemaLocations (common) | 设置架构的位置,可用于验证传入的 XML 或 JAXB 驱动的 JSON。 | list | |
| skipFaultLogging (common) | 这个选项控制 PhaseInterceptorChain 是否跳过记录它捕获的 Fault。 | false | 布尔值 |
| bindingStyle (consumer) | 设置请求和响应如何映射到/来自 Camel。可能有两个值: SimpleConsumer:此绑定样式处理请求参数、多部分等,并将它们映射到 IN 标头、IN附件和消息正文。它旨在消除 org.apache.cxf.message.MessageContentsList 的低级别处理。它还为响应映射增加了更大的灵活性和简洁性。仅适用于消费者。Default :默认风格。对于消费者,这会将 MessageContentsList 传递给路由,需要在路由中处理低级处理。这是传统的绑定样式,只需要将 org.apache.cxf.message.MessageContentsList 转储到 IN 消息正文。然后,用户负责根据 JAX-RS 方法签名所定义的合同进行处理。custom :允许您通过 binding 选项指定自定义绑定。 Enum 值:
| default | BindingStyle |
| publishedEndpointUrl (consumer) | 这个选项可以覆盖从 WADL 发布的 endpointUrl,该端点可通过资源地址 url 和 _wadl 访问。 | 字符串 | |
| bridgeErrorHandler (consumer (advanced)) | 允许将消费者桥接到 Camel 路由错误处理程序,这意味着当 Camel 使用者试图提取传入的信息时(如果可能)将作为消息处理并由路由 Error Handler 处理。重要:只有在第三方组件允许在抛出异常时警报 Camel 时,才能实现。有些组件只在内部处理,因此 bridgeErrorHandler 无法进行。在其他情况下,我们可以将 Camel 组件改进为 hook 到第三方组件,并使它成为将来的版本。默认情况下,使用者将使用 org.apache.camel.spi.ExceptionHandler 来处理例外情况,该处理程序将被记录在 WARN 或 ERROR 级别,并忽略。 | false | 布尔值 |
| exceptionHandler (consumer (advanced)) | 要让使用者使用自定义例外处理程序:请注意,如果启用了 bridgeErrorHandler 选项,则此选项不使用。默认情况下,消费者将处理异常,其记录在 WARN 或 ERROR 级别中,并忽略。 | ExceptionHandler | |
| exchangePattern (consumer (advanced)) | 在消费者创建交换时设置交换模式。 Enum 值:
| ExchangePattern | |
| serviceBeans (consumer (advanced)) | 您要导出为 REST 服务的 Service Bean (要在 registry 中查找的 bean id)。可以使用逗号分隔多个 Bean。 | 字符串 | |
| cookieHandler (producer) | 配置 Cookie 处理程序,以维护 HTTP 会话。 | CookieHandler | |
| hostnameVerifier (producer) | 要使用的主机名验证器。使用 # 表示法引用 registry 中的 HostnameVerifier。 | HostnameVerifier | |
| sslContextParameters (producer) | Camel SSL 设置参考。使用 # 表示法引用 SSL 上下文。 | SSLContextParameters | |
| throwExceptionOnFailure (producer) | 此选项告知 CxfRsProducer 检查返回代码,并在返回码大于 207 时生成一个例外。 | true | 布尔值 |
| httpClientAPI (producer (advanced)) | 如果为 true,CxfRsProducer 将使用 HttpClientAPI 调用该服务。如果是 false,CxfRsProducer 将使用 ProxyClientAPI 调用该服务。 | true | 布尔值 |
| ignoreDeleteMethodMessageBody (producer (advanced)) | 此选项用于告知 CxfRsProducer 在使用 HTTP API 时忽略 DELETE 方法的消息正文。 | false | 布尔值 |
| lazyStartProducer (producer (advanced)) | 生成者是否应懒惰启动 (在第一个消息中)。通过懒惰启动,您可以使用此选项来允许 CamelContext 和路由在生成者启动期间启动,并导致路由启动失败。通过懒惰启动,启动失败可以在路由信息时通过 Camel 的路由错误处理程序进行处理。请注意,在处理第一个消息时,创建并启动生成者可能需要稍等时间,并延长处理的总处理时间。 | false | 布尔值 |
| maxClientCacheSize (producer (advanced)) | 这个选项允许您配置缓存的最大大小。实现在 CxfProvider 和 CxfRsProvider 中缓存 CXF 客户端或 ClientFactoryBean。 | 10 | int |
| 同步 (producer (advanced)) | 设置是否应严格使用同步处理。 | false | 布尔值 |
| 绑定 (advanced) | 使用自定义 CxfBinding 控制 Camel 消息和 CXF 消息之间的绑定。 | CxfRsBinding | |
| 总线 (advanced) | 使用自定义配置的 CXF 总线。 | Bus | |
| continuationTimeout (advanced) | 这个选项用于设置 CXF continuation 超时,当 CXF 服务器使用 Jetty 或 Servlet 传输时,默认可在 CxfConsumer 中使用它。 | 30000 | long |
| cxfRsConfigurer (advanced) | 这个选项可以应用 org.apache.camel.component.cxf.jaxrs.CxfRsEndpointConfigurer 的实现,它支持以编程方式配置 CXF 端点。用户可以通过实施 CxfEndpointConfigurer 的 configure\\{Server/Client} 方法来配置 CXF 服务器和客户端。 | CxfRsConfigurer | |
| defaultBus (advanced) | 当 CXF 端点自行创建总线时,将设置默认总线。 | false | 布尔值 |
| headerFilterStrategy (advanced) | 使用自定义 HeaderFilterStrategy 过滤到 Camel 消息的标头。 | HeaderFilterStrategy | |
| performInvocation (advanced) | 当选项为 true 时,Camel 将执行资源类实例的调用,并将响应对象放入交换中以进一步处理。 | false | 布尔值 |
| propagateContexts (advanced) | 当选项为 true 时,JAXRS UriInfo, HttpHeaders, Request 和 SecurityContext 上下文将可用于自定义 CXFRS 处理器,作为类型的 Camel Exchange 属性。这些上下文可用于利用 JAX-RS API 分析当前请求。 | false | 布尔值 |