blob: 87cc4711f35cbf2d0e0fb272e289004ea534281b [file] [log] [blame]
// kafka-connector options: START
[[camel-cxf-kafka-connector-source]]
= camel-cxf-kafka-connector source configuration
When using camel-cxf-kafka-connector as source make sure to use the following Maven dependency to have support for the connector:
[source,xml]
----
<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>
----
The camel-cxf source connector supports 36 options, which are listed below.
[width="100%",cols="2,5,^1,2",options="header"]
|===
| Name | Description | Default | Priority
| *camel.source.path.beanId* | To lookup an existing configured CxfEndpoint. Must used bean: as prefix. | null | ConfigDef.Importance.MEDIUM
| *camel.source.path.address* | The service publish address. | null | ConfigDef.Importance.MEDIUM
| *camel.source.endpoint.data Format* | The data type messages supported by the CXF endpoint. One of: [PAYLOAD] [RAW] [MESSAGE] [CXF_MESSAGE] [POJO] | "POJO" | ConfigDef.Importance.MEDIUM
| *camel.source.endpoint.wrapped Style* | 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 | null | ConfigDef.Importance.MEDIUM
| *camel.source.endpoint.bridge ErrorHandler* | Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions occurred while the consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions, that will be logged at WARN or ERROR level and ignored. | false | ConfigDef.Importance.MEDIUM
| * camel.source.endpoint.exception Handler* | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this option is not in use. By default the consumer will deal with exceptions, that will be logged at WARN or ERROR level and ignored. | null | ConfigDef.Importance.MEDIUM
| *camel.source.endpoint.exchange Pattern* | Sets the exchange pattern when the consumer creates an exchange. One of: [InOnly] [InOut] [InOptionalOut] | null | ConfigDef.Importance.MEDIUM
| *camel.source.endpoint.allow Streaming* | 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. | null | ConfigDef.Importance.MEDIUM
| *camel.source.endpoint.basic PropertyBinding* | Whether the endpoint should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities | false | ConfigDef.Importance.MEDIUM
| *camel.source.endpoint.bus* | To use a custom configured CXF Bus. | null | ConfigDef.Importance.MEDIUM
| * camel.source.endpoint.continuation Timeout* | 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 | ConfigDef.Importance.MEDIUM
| *camel.source.endpoint.cxf Binding* | To use a custom CxfBinding to control the binding between Camel Message and CXF Message. | null | ConfigDef.Importance.MEDIUM
| *camel.source.endpoint.cxf Configurer* | 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. | null | ConfigDef.Importance.MEDIUM
| *camel.source.endpoint.default Bus* | Will set the default bus when CXF endpoint create a bus by itself | false | ConfigDef.Importance.MEDIUM
| *camel.source.endpoint.header FilterStrategy* | To use a custom HeaderFilterStrategy to filter header to and from Camel message. | null | ConfigDef.Importance.MEDIUM
| *camel.source.endpoint.merge ProtocolHeaders* | 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 | ConfigDef.Importance.MEDIUM
| *camel.source.endpoint.mtom Enabled* | To enable MTOM (attachments). This requires to use POJO or PAYLOAD data format mode. | false | ConfigDef.Importance.MEDIUM
| * camel.source.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 | null | ConfigDef.Importance.MEDIUM
| *camel.source.endpoint.skip PayloadMessagePartCheck* | Sets whether SOAP message validation should be disabled. | false | ConfigDef.Importance.MEDIUM
| * camel.source.endpoint.synchronous* | Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported). | false | ConfigDef.Importance.MEDIUM
| *camel.source.endpoint.logging FeatureEnabled* | This option enables CXF Logging Feature which writes inbound and outbound SOAP messages to log. | false | ConfigDef.Importance.MEDIUM
| *camel.source.endpoint.logging SizeLimit* | 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 | ConfigDef.Importance.MEDIUM
| *camel.source.endpoint.skip FaultLogging* | This option controls whether the PhaseInterceptorChain skips logging the Fault that it catches. | false | ConfigDef.Importance.MEDIUM
| *camel.source.endpoint.password* | This option is used to set the basic authentication information of password for the CXF client. | null | ConfigDef.Importance.MEDIUM
| *camel.source.endpoint.username* | This option is used to set the basic authentication information of username for the CXF client. | null | ConfigDef.Importance.MEDIUM
| *camel.source.endpoint.binding Id* | The bindingId for the service model to use. | null | ConfigDef.Importance.MEDIUM
| *camel.source.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. | null | ConfigDef.Importance.MEDIUM
| * camel.source.endpoint.published EndpointUrl* | This option can override the endpointUrl that published from the WSDL which can be accessed with service address url plus wsd | null | ConfigDef.Importance.MEDIUM
| *camel.source.endpoint.service Class* | The class name of the SEI (Service Endpoint Interface) class which could have JSR181 annotation or not. | null | ConfigDef.Importance.MEDIUM
| *camel.source.endpoint.service Name* | The service name this service is implementing, it maps to the wsdl:servicename. | null | ConfigDef.Importance.MEDIUM
| *camel.source.endpoint.wsdlURL* | The location of the WSDL. Can be on the classpath, file system, or be hosted remotely. | null | ConfigDef.Importance.MEDIUM
| *camel.component.cxf.bridge ErrorHandler* | Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions occurred while the consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions, that will be logged at WARN or ERROR level and ignored. | false | ConfigDef.Importance.MEDIUM
| *camel.component.cxf.allow Streaming* | 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. | null | ConfigDef.Importance.MEDIUM
| *camel.component.cxf.basic PropertyBinding* | Whether the component should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities | false | ConfigDef.Importance.MEDIUM
| *camel.component.cxf.header FilterStrategy* | To use a custom org.apache.camel.spi.HeaderFilterStrategy to filter header to and from Camel message. | null | ConfigDef.Importance.MEDIUM
| *camel.component.cxf.useGlobal SslContextParameters* | Enable usage of global SSL context parameters. | false | ConfigDef.Importance.MEDIUM
|===
// kafka-connector options: END