camel-cxf-kafka-connector sink configuration

Connector Description: Expose SOAP WebServices using Apache CXF or connect to external WebServices using CXF WS client.

When using camel-cxf-kafka-connector as sink make sure to use the following Maven dependency to have support for the connector:

<dependency>
  <groupId>org.apache.camel.kafkaconnector</groupId>
  <artifactId>camel-cxf-kafka-connector</artifactId>
  <version>x.x.x</version>
  <!-- use the same version as your Camel Kafka connector version -->
</dependency>

To use this sink connector in Kafka connect you’ll need to set the following connector.class

connector.class=org.apache.camel.kafkaconnector.cxf.CamelCxfSinkConnector

The camel-cxf sink connector supports 39 options, which are listed below.

Name Description Default Priority

camel.sink.path.beanId

To lookup an existing configured CxfEndpoint. Must used bean: as prefix.

MEDIUM

camel.sink.path.address

The service publish address.

MEDIUM

camel.sink.endpoint.dataFormat

The data type messages supported by the CXF endpoint. One of: [PAYLOAD] [RAW] [MESSAGE] [CXF_MESSAGE] [POJO].

Enum values:

  • PAYLOAD

  • RAW

  • MESSAGE

  • CXF_MESSAGE

  • POJO

"POJO"

MEDIUM

camel.sink.endpoint.wrappedStyle

The WSDL style that describes how parameters are represented in the SOAP body. If the value is false, CXF will chose the document-literal unwrapped style, If the value is true, CXF will chose the document-literal wrapped style.

MEDIUM

camel.sink.endpoint.cookieHandler

Configure a cookie handler to maintain a HTTP session.

MEDIUM

camel.sink.endpoint.defaultOperationName

This option will set the default operationName that will be used by the CxfProducer which invokes the remote service.

MEDIUM

camel.sink.endpoint.defaultOperationNamespace

This option will set the default operationNamespace that will be used by the CxfProducer which invokes the remote service.

MEDIUM

camel.sink.endpoint.hostnameVerifier

The hostname verifier to be used. Use the # notation to reference a HostnameVerifier from the registry.

MEDIUM

camel.sink.endpoint.sslContextParameters

The Camel SSL setting reference. Use the # notation to reference the SSL Context.

MEDIUM

camel.sink.endpoint.wrapped

Which kind of operation that CXF endpoint producer will invoke.

false

MEDIUM

camel.sink.endpoint.lazyStartProducer

Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel’s routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing.

false

MEDIUM

camel.sink.endpoint.synchronous

Sets whether synchronous processing should be strictly used.

false

MEDIUM

camel.sink.endpoint.allowStreaming

This option controls whether the CXF component, when running in PAYLOAD mode, will DOM parse the incoming messages into DOM Elements or keep the payload as a javax.xml.transform.Source object that would allow streaming in some cases.

MEDIUM

camel.sink.endpoint.bus

To use a custom configured CXF Bus.

MEDIUM

camel.sink.endpoint.continuationTimeout

This option is used to set the CXF continuation timeout which could be used in CxfConsumer by default when the CXF server is using Jetty or Servlet transport.

30000L

MEDIUM

camel.sink.endpoint.cxfBinding

To use a custom CxfBinding to control the binding between Camel Message and CXF Message.

MEDIUM

camel.sink.endpoint.cxfConfigurer

This option could apply the implementation of org.apache.camel.component.cxf.CxfEndpointConfigurer which supports to configure the CXF endpoint in programmatic way. User can configure the CXF server and client by implementing configure{ServerClient} method of CxfEndpointConfigurer.

MEDIUM

camel.sink.endpoint.defaultBus

Will set the default bus when CXF endpoint create a bus by itself.

false

MEDIUM

camel.sink.endpoint.headerFilterStrategy

To use a custom HeaderFilterStrategy to filter header to and from Camel message.

MEDIUM

camel.sink.endpoint.mergeProtocolHeaders

Whether to merge protocol headers. If enabled then propagating headers between Camel and CXF becomes more consistent and similar. For more details see CAMEL-6393.

false

MEDIUM

camel.sink.endpoint.mtomEnabled

To enable MTOM (attachments). This requires to use POJO or PAYLOAD data format mode.

false

MEDIUM

camel.sink.endpoint.properties

To set additional CXF options using the key/value pairs from the Map. For example to turn on stacktraces in SOAP faults, properties.faultStackTraceEnabled=true.

MEDIUM

camel.sink.endpoint.skipPayloadMessagePartCheck

Sets whether SOAP message validation should be disabled.

false

MEDIUM

camel.sink.endpoint.loggingFeatureEnabled

This option enables CXF Logging Feature which writes inbound and outbound SOAP messages to log.

false

MEDIUM

camel.sink.endpoint.loggingSizeLimit

To limit the total size of number of bytes the logger will output when logging feature has been enabled and -1 for no limit.

49152

MEDIUM

camel.sink.endpoint.skipFaultLogging

This option controls whether the PhaseInterceptorChain skips logging the Fault that it catches.

false

MEDIUM

camel.sink.endpoint.password

This option is used to set the basic authentication information of password for the CXF client.

MEDIUM

camel.sink.endpoint.username

This option is used to set the basic authentication information of username for the CXF client.

MEDIUM

camel.sink.endpoint.bindingId

The bindingId for the service model to use.

MEDIUM

camel.sink.endpoint.portName

The endpoint name this service is implementing, it maps to the wsdl:portname. In the format of ns:PORT_NAME where ns is a namespace prefix valid at this scope.

MEDIUM

camel.sink.endpoint.publishedEndpointUrl

This option can override the endpointUrl that published from the WSDL which can be accessed with service address url plus wsd.

MEDIUM

camel.sink.endpoint.serviceClass

The class name of the SEI (Service Endpoint Interface) class which could have JSR181 annotation or not.

MEDIUM

camel.sink.endpoint.serviceName

The service name this service is implementing, it maps to the wsdl:servicename.

MEDIUM

camel.sink.endpoint.wsdlURL

The location of the WSDL. Can be on the classpath, file system, or be hosted remotely.

MEDIUM

camel.component.cxf.lazyStartProducer

Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel’s routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing.

false

MEDIUM

camel.component.cxf.allowStreaming

This option controls whether the CXF component, when running in PAYLOAD mode, will DOM parse the incoming messages into DOM Elements or keep the payload as a javax.xml.transform.Source object that would allow streaming in some cases.

MEDIUM

camel.component.cxf.autowiredEnabled

Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching type, which then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc.

true

MEDIUM

camel.component.cxf.headerFilterStrategy

To use a custom org.apache.camel.spi.HeaderFilterStrategy to filter header to and from Camel message.

MEDIUM

camel.component.cxf.useGlobalSslContextParameters

Enable usage of global SSL context parameters.

false

MEDIUM

The camel-cxf sink connector has no converters out of the box.

The camel-cxf sink connector has no transforms out of the box.

The camel-cxf sink connector has no aggregation strategies out of the box.