CXF

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

Metadata

Property	Value
Scheme	`cxf`
Support Level	Stable
Labels	http,webservice
Version	4.10.2

Maven Dependency

<dependency>
    <groupId>org.apache.camel</groupId>
    <artifactId>camel-cxf-soap</artifactId>
    <version>4.10.2</version>
</dependency>

Endpoint Properties

Name	Type	Default	Description
`beanId`	string		To lookup an existing configured CxfEndpoint. Must used bean: as prefix.
`address`	string		The service publish address.
`dataFormat`	object	`POJO`	The data type messages supported by the CXF endpoint.
`wrappedStyle`	boolean		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
`bridgeErrorHandler`	boolean	`false`	Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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.
`exceptionHandler`	object		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.
`exchangePattern`	object		Sets the exchange pattern when the consumer creates an exchange.
`cookieHandler`	object		Configure a cookie handler to maintain a HTTP session
`defaultOperationName`	string		This option will set the default operationName that will be used by the CxfProducer which invokes the remote service.
`defaultOperationNamespace`	string		This option will set the default operationNamespace that will be used by the CxfProducer which invokes the remote service.
`hostnameVerifier`	object		The hostname verifier to be used. Use the # notation to reference a HostnameVerifier from the registry.
`sslContextParameters`	object		The Camel SSL setting reference. Use the # notation to reference the SSL Context.
`wrapped`	boolean	`false`	Which kind of operation that CXF endpoint producer will invoke
`lazyStartProducer`	boolean	`false`	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.
`synchronous`	boolean	`false`	Sets whether synchronous processing should be strictly used
`allowStreaming`	boolean		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.
`bus`	object		To use a custom configured CXF Bus.
`continuationTimeout`	duration	`30000`	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.
`cxfBinding`	object		To use a custom CxfBinding to control the binding between Camel Message and CXF Message.
`cxfConfigurer`	object		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.
`defaultBus`	boolean	`false`	Will set the default bus when CXF endpoint create a bus by itself
`headerFilterStrategy`	object		To use a custom HeaderFilterStrategy to filter header to and from Camel message.
`mergeProtocolHeaders`	boolean	`false`	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.
`mtomEnabled`	boolean	`false`	To enable MTOM (attachments). This requires to use POJO or PAYLOAD data format mode.
`properties`	object		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
`schemaValidationEnabled`	boolean	`false`	Enable schema validation for request and response. Disabled by default for performance reason
`skipPayloadMessagePartCheck`	boolean	`false`	Sets whether SOAP message validation should be disabled.
`loggingFeatureEnabled`	boolean	`false`	This option enables CXF Logging Feature which writes inbound and outbound SOAP messages to log.
`loggingSizeLimit`	integer	`49152`	To limit the total size of number of bytes the logger will output when logging feature has been enabled and -1 for no limit.
`skipFaultLogging`	boolean	`false`	This option controls whether the PhaseInterceptorChain skips logging the Fault that it catches.
`password`	string		This option is used to set the basic authentication information of password for the CXF client.
`username`	string		This option is used to set the basic authentication information of username for the CXF client.
`bindingId`	string		The bindingId for the service model to use.
`portName`	string		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.
`publishedEndpointUrl`	string		This option can override the endpointUrl that published from the WSDL which can be accessed with service address url plus wsd
`serviceClass`	string		The class name of the SEI (Service Endpoint Interface) class which could have JSR181 annotation or not.
`serviceName`	string		The service name this service is implementing, it maps to the wsdl:servicename.
`wsdlURL`	string		The location of the WSDL. Can be on the classpath, file system, or be hosted remotely.