The cxf component is used for SOAP WebServices using Apache CXF.
| Name | Kind | Group | Required | Default | Type | Enum | Description |
|---|---|---|---|---|---|---|---|
| beanId | path | common | java.lang.String | To lookup an existing configured CxfEndpoint. Must used bean: as prefix. | |||
| address | path | service | java.lang.String | The service publish address. | |||
| dataFormat | parameter | common | POJO | org.apache.camel.component.cxf.DataFormat | PAYLOAD RAW MESSAGE CXF_MESSAGE POJO |
The data type messages supported by the CXF endpoint. | |
| wrappedStyle | parameter | common | java.lang.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 | parameter | consumer | boolean | 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/ERROR level and ignored. | |||
| exceptionHandler | parameter | consumer (advanced) | org.apache.camel.spi.ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions, that will be logged at WARN/ERROR level and ignored. | |||
| exchangePattern | parameter | consumer (advanced) | org.apache.camel.ExchangePattern | InOnly RobustInOnly InOut InOptionalOut OutOnly RobustOutOnly OutIn OutOptionalIn |
Sets the exchange pattern when the consumer creates an exchange. | ||
| defaultOperationName | parameter | producer | java.lang.String | This option will set the default operationName that will be used by the CxfProducer which invokes the remote service. | |||
| defaultOperationNamespace | parameter | producer | java.lang.String | This option will set the default operationNamespace that will be used by the CxfProducer which invokes the remote service. | |||
| hostnameVerifier | parameter | producer | javax.net.ssl.HostnameVerifier | The hostname verifier to be used. Use the # notation to reference a HostnameVerifier from the registry. | |||
| sslContextParameters | parameter | producer | org.apache.camel.util.jsse.SSLContextParameters | The Camel SSL setting reference. Use the # notation to reference the SSL Context. | |||
| wrapped | parameter | producer | boolean | Which kind of operation that CXF endpoint producer will invoke | |||
| allowStreaming | parameter | advanced | java.lang.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 | parameter | advanced | org.apache.cxf.Bus | To use a custom configured CXF Bus. | |||
| continuationTimeout | parameter | advanced | 30000 | long | 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 | parameter | advanced | org.apache.camel.component.cxf.CxfBinding | To use a custom CxfBinding to control the binding between Camel Message and CXF Message. | |||
| cxfEndpointConfigurer | parameter | advanced | org.apache.camel.component.cxf.CxfEndpointConfigurer | 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{Server|Client} method of CxfEndpointConfigurer. | |||
| defaultBus | parameter | advanced | boolean | Will set the default bus when CXF endpoint create a bus by itself | |||
| headerFilterStrategy | parameter | advanced | org.apache.camel.spi.HeaderFilterStrategy | To use a custom HeaderFilterStrategy to filter header to and from Camel message. | |||
| mergeProtocolHeaders | parameter | advanced | boolean | 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 | parameter | advanced | boolean | To enable MTOM (attachments). This requires to use POJO or PAYLOAD data format mode. | |||
| properties | parameter | advanced | java.util.Map |
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 | |||
| skipPayloadMessagePartCheck | parameter | advanced | boolean | Sets whether SOAP message validation should be disabled. | |||
| synchronous | parameter | advanced | false | boolean | Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported). | ||
| loggingFeatureEnabled | parameter | logging | boolean | This option enables CXF Logging Feature which writes inbound and outbound SOAP messages to log. | |||
| loggingSizeLimit | parameter | logging | 49152 | int | 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 | parameter | logging | boolean | This option controls whether the PhaseInterceptorChain skips logging the Fault that it catches. | |||
| password | parameter | security | java.lang.String | This option is used to set the basic authentication information of password for the CXF client. | |||
| username | parameter | security | java.lang.String | This option is used to set the basic authentication information of username for the CXF client. | |||
| bindingId | parameter | service | java.lang.String | The bindingId for the service model to use. | |||
| portName | parameter | service | java.lang.String | The endpoint name this service is implementing, it maps to the wsdl:port@name. In the format of ns:PORT_NAME where ns is a namespace prefix valid at this scope. | |||
| publishedEndpointUrl | parameter | service | java.lang.String | This option can override the endpointUrl that published from the WSDL which can be accessed with service address url plus ?wsd | |||
| serviceClass | parameter | service | java.lang.Class | The class name of the SEI (Service Endpoint Interface) class which could have JSR181 annotation or not. | |||
| serviceName | parameter | service | java.lang.String | The service name this service is implementing, it maps to the wsdl:service@name. | |||
| wsdlURL | parameter | service | java.lang.String | The location of the WSDL. Can be on the classpath, file system, or be hosted remotely. |
A Consumer of exchanges for a service in CXF. CxfConsumer acts a CXF service to receive requests, convert them, and forward them to Camel route for processing. It is also responsible for converting and sending back responses to CXF client.