79.2. 选项
CXF-RS 组件支持 3 个选项,如下所列。
名称 | 描述 | 默认值 | 类型 |
---|---|---|---|
useGlobalSslContext Parameters (security) | 启用使用全局 SSL 上下文参数。 | false | 布尔值 |
headerFilterStrategy (filter) | 使用自定义 org.apache.camel.spi.HeaderFilterStrategy 过滤标头到 Camel 消息。 | HeaderFilterStrategy | |
resolveProperty Placeholders (advanced) | 启动时组件是否应解析自身上的属性占位符。只有属于 String 类型的属性才能使用属性占位符。 | true | 布尔值 |
CXF-RS 端点使用 URI 语法进行配置:
cxfrs:beanId:address
使用以下路径和查询参数:
79.2.1. 路径参数(2 参数):
名称 | 描述 | 默认值 | 类型 |
---|---|---|---|
beanId | 查找现有的已配置的 CxfRsEndpoint。必须使用 bean: 作为前缀。 | 字符串 | |
address | 服务发布地址。 | 字符串 |
79.2.2. 查询参数(30 参数):
名称 | 描述 | 默认值 | 类型 |
---|---|---|---|
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 attachments 和消息正文。它旨在消除 org.apache.cxf.message.MessageContentsList 的低级别处理。它还为响应映射增加了更大的灵活性和简单性。仅适用于消费者。默认:默认样式。对于消费者,这会将 MessageContentsList 传递给路由,这需要路由中的低级处理。这是传统的绑定风格,只是将来自 CXF 堆栈的 org.apache.cxf.message.MessageContentsList 转储到 IN 消息正文。然后,用户负责根据 JAX-RS 方法签名定义的合同进行处理。custom :允许您通过 binding 选项指定自定义绑定。 | default | BindingStyle |
bridgeErrorHandler (consumer) | 允许将消费者桥接到 Camel 路由错误处理程序,这意味着当消费者试图选择传入消息或类似信息时发生异常,现在将作为消息处理并由路由 Error Handler 处理。默认情况下,使用者将使用 org.apache.camel.spi.ExceptionHandler 来处理例外情况,该处理程序将被记录在 WARN 或 ERROR 级别,并忽略。 | false | 布尔值 |
publishedEndpointUrl (consumer) | 这个选项可以覆盖从 WADL 发布的 endpointUrl,它可以通过资源地址 url 和 _wadl 访问 | 字符串 | |
exceptionHandler (consumer) | 要让使用者使用自定义例外处理程序:请注意,如果启用了 bridgeErrorHandler 选项,则此选项不使用。默认情况下,消费者将处理异常,其记录在 WARN 或 ERROR 级别中,并忽略。 | ExceptionHandler | |
exchangePattern (consumer) | 在消费者创建交换时设置交换模式。 | ExchangePattern | |
serviceBeans (consumer) | 要导出为 REST 服务的服务 Bean。可以使用逗号分隔多个 Bean。 | list | |
cookieHandler (producer) | 配置 Cookie 处理程序来维护 HTTP 会话 | CookieHandler | |
hostnameVerifier (producer) | 要使用的主机名验证器。使用 # 表示法引用 registry 中的 HostnameVerifier。 | HostnameVerifier | |
sslContextParameters (producer) | Camel SSL 设置参考。使用 # 表示法引用 SSL 上下文。 | SSLContextParameters | |
throwExceptionOnFailure (producer) | 此选项告知 CxfRsProducer 检查返回代码,如果返回代码大于 207,将生成一个例外。 | true | 布尔值 |
httpClientAPI (producer) | 如果为 true,则 CxfRsProducer 将使用 HttpClientAPI 调用该服务。如果是 false,则 CxfRsProducer 将使用 ProxyClientAPI 调用服务 | true | 布尔值 |
ignoreDeleteMethodMessage Body (producer) | 此选项用于告知 CxfRsProducer,在使用 HTTP API 时忽略 DELETE 方法的消息正文。 | false | 布尔值 |
maxClientCacheSize (producer) | 这个选项允许您配置缓存的最大大小。实施在 CxfProvider 和 CxfRsProvider 中缓存 CXF 客户端或 ClientFactoryBean。 | 10 | int |
绑定 (advanced) | 使用自定义 CxfBinding 控制 Camel 消息和 CXF 消息之间的绑定。 | CxfRsBinding | |
Bus (advanced) | 使用自定义配置的 CXF 总线。 | bus | |
continuationTimeout (advanced) | 这个选项用于设置 CXF 持续超时,在 CXF 服务器使用 Jetty 或 Servlet 传输时,默认可在 CxfConsumer 中使用。 | 30000 | long |
cxfRsEndpointConfigurer (advanced) | 这个选项可以应用 org.apache.camel.component.cxf.jaxrs.CxfRsEndpointConfigurer 的实现,它支持以编程方式配置 CXF 端点。用户可以通过实施 CxfEndpointConfigurer 的 configureServer/Client 方法来配置 CXF 服务器和客户端。 | CxfRsEndpoint Configurer | |
defaultBus (advanced) | 当 CXF 端点本身创建总线时,将设置默认总线 | false | 布尔值 |
headerFilterStrategy (advanced) | 使用自定义 HeaderFilterStrategy 过滤标头到 Camel 消息。 | HeaderFilterStrategy | |
performInvocation (advanced) | 当选项为 true 时,Camel 将执行资源类实例的调用,并将响应对象放入交换中,以进行进一步处理。 | false | 布尔值 |
propagateContexts (advanced) | 当选项为 true 时,JAXRS UriInfo、HttpHeaders、Request 和 SecurityContext 上下文将作为类型 Camel Exchange 属性提供给自定义 CXFRS 处理器。这些上下文可用于使用 JAX-RS API 分析当前的请求。 | false | 布尔值 |
同步 (advanced) | 设置是否应严格使用同步处理,或者 Camel 允许使用异步处理(如果受支持)。 | false | 布尔值 |