Return-Path: X-Original-To: apmail-camel-commits-archive@www.apache.org Delivered-To: apmail-camel-commits-archive@www.apache.org Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by minotaur.apache.org (Postfix) with SMTP id 624781050E for ; Tue, 18 Feb 2014 07:21:47 +0000 (UTC) Received: (qmail 29203 invoked by uid 500); 18 Feb 2014 07:21:46 -0000 Delivered-To: apmail-camel-commits-archive@camel.apache.org Received: (qmail 29115 invoked by uid 500); 18 Feb 2014 07:21:45 -0000 Mailing-List: contact commits-help@camel.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: dev@camel.apache.org Delivered-To: mailing list commits@camel.apache.org Received: (qmail 29017 invoked by uid 99); 18 Feb 2014 07:21:44 -0000 Received: from nike.apache.org (HELO nike.apache.org) (192.87.106.230) by apache.org (qpsmtpd/0.29) with ESMTP; Tue, 18 Feb 2014 07:21:44 +0000 X-ASF-Spam-Status: No, hits=-2000.0 required=5.0 tests=ALL_TRUSTED X-Spam-Check-By: apache.org Received: from [140.211.11.4] (HELO eris.apache.org) (140.211.11.4) by apache.org (qpsmtpd/0.29) with ESMTP; Tue, 18 Feb 2014 07:21:29 +0000 Received: from eris.apache.org (localhost [127.0.0.1]) by eris.apache.org (Postfix) with ESMTP id B698723889E2 for ; Tue, 18 Feb 2014 07:21:06 +0000 (UTC) Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit Subject: svn commit: r898366 [2/8] - in /websites/production/camel/content: ./ cache/ Date: Tue, 18 Feb 2014 07:21:05 -0000 To: commits@camel.apache.org From: buildbot@apache.org X-Mailer: svnmailer-1.0.9 Message-Id: <20140218072106.B698723889E2@eris.apache.org> X-Virus-Checked: Checked by ClamAV on apache.org Modified: websites/production/camel/content/book-component-appendix.html ============================================================================== --- websites/production/camel/content/book-component-appendix.html (original) +++ websites/production/camel/content/book-component-appendix.html Tue Feb 18 07:21:04 2014 @@ -410,7 +410,7 @@ amqp:[queue:|topic:]destinationName[?opt

URI Format

-

The queue will be created if they don't already exists.
You can append query options to the URI in the following format, ?options=value&option2=value&...

URI Options

Name

Default Value

Context

Description

amazonSQSClient

null

Shared

Reference to a com.amazonaws.services.sqs.AmazonSQS in the Registry.

accessKey

null

Shared

Amazon AWS Access Key

secretKey

null

Shared

Amazon AWS Secret Key

amazonSQSEndpoint

null

Shared

The region with which the AWS-SQS client wants to work wi th. Only works if Camel creates the AWS-SQS client, i.e., if you explicitly set amazonSQSClient, then this setting will have no effect. You would have to set it on the client you create directly

attributeNames

null

Consumer

A list of attributes to set in the com.amazonaws.services.sqs.model.ReceiveMessageRequest.

defaultVisibilityTimeout

null

Shared

The visibility timeout (in seconds) to set in the com.amazonaws.services.sqs.model.Creat eQueueRequest.

deleteAfterRead

true

Consumer

Delete message from SQS after it has been read

deleteIfFiltered

true

Consumer

Camel 2.12.2,2.13.0 Whether or not to send the DeleteMessage to the SQS queue if an exchange fails to get through a filter. If 'false' and exchange does not make it through a Camel filter upstream in the route, then don't send DeleteMessage.

maxMessagesPerPoll

null

Consumer

The maximum number of messages which can be received in one poll to set in the com.amazonaws.services.sqs.model.ReceiveMessageRequest.

visibilityTimeout

null

Shared

The duration (in seconds) that the received messages are hidden from subsequent retrieve requests after being retrieved by a ReceiveMessage request to set in the com.amazonaws.services.sqs.model.SetQueueAttributesRequest. This only make sense if its different from defaultVisibilityTimeout. It changes the queue visibility timeout attribute permanently.

messageVisibilityTimeout

null

Consumer

Camel 2.8: The duration (in seconds) that the received messages are hidden from subsequent retrieve requests after being retrieved by a ReceiveMessage request to set in the com.amazonaws.services.sqs.model.ReceiveMessageRequest. It does NOT change the queue visibility timeout attribute permanently.

extendMessageVisibility

false

Consumer

Camel 2.10: If enabled then a scheduled background task will keep extending the message visibility on SQS. This is needed if it taks a long time to process the message. If set to true defaultVisibilityTimeout must be set. See details at Amazon docs.

maximumMessageSize

null

Shared

Camel 2.8: The maximumMessageSize (in bytes) an SQS message can contain for this queue, to set in the com.amazonaws.services.sqs.model.SetQueueAttributesRequest.

messageRetentionPeriod

null

Shared

Camel 2.8: The messageRetentionPeriod (in seconds) a message will be retained by SQS for this queue, to set in the com.amazonaws.services.sqs.model.SetQueueAttributesRequest.

policy

null

Shared

Camel 2.8: The policy for this queue to set in the com.amazonaws.services.sqs.model.SetQueueAttributesRequest.

delay Seconds

null

Producer

Camel 2.9.3: Delay sending messages for a number of seconds.

waitTimeSeconds

0

Producer

Camel 2.11: Duration in seconds (0 to 20) that the ReceiveMessage action call will wait until a message is in the queue to include in the response.

receiveMessageWaitTimeSeconds

0

Shared

Camel 2.11: If you do not specify WaitTimeSeconds in the request, the queue attribute ReceiveMessageWaitTimeSeconds is used to determine how long to wait.

queueOwnerAWSAccountId

null

Shared

Camel 2.12: Specify the queue owner aws account id when you need to connect the queue with different account owner.

region

null

Shared

Camel 2.12.3: Specify the queue region which could be used with queueOwnerAWSAccountId to build the service URL.

+

The queue will be created if they don't already exists.
You can append query options to the URI in the following format, ?options=value&option2=value&...

URI Options

Name

Default Value

Context

Description

amazonSQSClient

null

Shared

Reference to a com.amazonaws.services.sqs.AmazonSQS in the Registry.

accessKey

null

Shared

Amazon AWS Access Key

secretKey

null

Shared

Amazon AWS Secret Key

amazonSQSEndpoint

null

Shared

The region with which the AWS-SQS client wants to work with. Only works if Camel creates the AWS-SQS client, i.e., if you explicitly set amazonSQSClient, then this setting will have no effect. You would have to set it on the client you create directly

attributeNames

null

Consumer

A list of attributes to set in the com.amazonaws.services.sqs.model.ReceiveMessageRequest.

defaultVisibilityTimeout

null

Shared

The visibility timeout (in seconds) to set in the com.amazonaws.services.sqs.mode l.CreateQueueRequest.

deleteAfterRead

true

Consumer

Delete message from SQS after it has been read

deleteIfFiltered

true

Consumer

Camel 2.12.2,2.13.0 Whether or not to send the DeleteMessage to the SQS queue if an exchange fails to get through a filter. If 'false' and exchange does not make it through a Camel filter upstream in the route, then don't send DeleteMessage.

maxMessagesPerPoll

null

Consumer

The maximum number of messages which can be received in one poll to set in the com.amazonaws.services.sqs.model.ReceiveMessageRequest.

visibilityTimeout

null

Shared

The duration (in seconds) that the received messages are hidden from subsequent retrieve requests after being retrieved by a ReceiveMessage request to set in the com.amazonaws.services.sqs.model.SetQueueAttributesRequest. This only make sense if its different from defaultVisibilityTimeout. It changes the queue visibility timeout attribute permanently.

messageVisibilityTimeout

null

Consumer

Camel 2.8: The duration (in seconds) that the received messages are hidden from subsequent retrieve requests after being retrieved by a ReceiveMessage request to set in the com.amazonaws.services.sqs.model.ReceiveMessageRequest. It does NOT change the queue visibility timeout attribute permanently.

extendMessageVisibility

false

Consumer

Camel 2.10: If enabled then a scheduled background task will keep extending the message visibility on SQS. This is needed if it taks a long time to process the message. If set to true defaultVisibilityTimeout must be set. See details at Amazon docs.

maximumMessageSize

null

Shared

Camel 2.8: The maximumMessageSize (in bytes) an SQS message can contain for this queue, to set in the com.amazonaws.services.sqs.model.SetQueueAttributesRequest.

messageRetentionPeriod

null

Shared

Camel 2.8: The messageRetentionPeriod (in seconds) a message will be retained by SQS for this queue, to set in the com.amazonaws.services.sqs.model.SetQueueAttributesRequest.

policy

null

Shared

Camel 2.8: The policy for this queue to set in the com.amazonaws.services.sqs.model.SetQueueAttributesRequest.

< p>delaySeconds

null

Producer

Camel 2.9.3: Delay sending messages for a number of seconds.

waitTimeSeconds

0

Producer

Camel 2.11: Duration in seconds (0 to 20) that the ReceiveMessage action call will wait until a message is in the queue to include in the response.

receiveMessageWaitTimeSeconds

0

Shared

Camel 2.11: If you do not specify WaitTimeSeconds in the request, the queue attribute ReceiveMessageWaitTimeSeconds is used to determine how long to wait.

queueOwnerAWSAccountId

null

Shared

Camel 2.12: Specify the queue owner aws account id when you need to connect the queue with different account owner.

region

null

Shared

Camel 2.12.3: Specify the queue region which could be used with queueOwnerAWSAccountId to build the service URL.

Required SQS component options

Icon @@ -418,8 +418,8 @@ amqp:[queue:|topic:]destinationName[?opt

You have to provide the amazonSQSClient in the Registry or your accessKey and secretKey to access the Amazon's SQS.

-

Batch Consumer

This component implements the Batch Consumer.

This allows you for instance to know how many messages exists in this batch and for instance let the Aggregator aggregate this number of messages.

Usage

Message headers set by the SQS producer

Header

Type

Description

CamelAwsSqsMD5OfBody

String

The MD5 checksum of the Amazon SQS message.

CamelAwsSqsMessageId

String

The Amazon SQS message ID.

CamelAwsSqsDelaySeconds

Integer

Since Camel 2.11, the delay seconds that the Amazon SQS message can be see by others.

-

Message headers set by the SQS consumer

Header

Type

Description

CamelAwsSqsMD5OfBody

String

The MD5 checksum of the Amazon SQS message.

CamelAwsSqsMessageId

String

The Amazon SQS message ID.

CamelAwsSqsReceiptHandle

String

The Amazon SQS message receipt handle.

CamelAwsSqsAttributes

Map<String, String>

The Amazon SQS message attributes.

+

Batch Consumer

This component implements the Batch Consumer.

This allows you for instance to know how many messages exists in this batch and for instance let the Aggregator aggregate this number of messages.

Usage

Message headers set by the SQS producer

Header

Type

Description

CamelAwsSqsMD5OfBody

String

The MD5 checksum of the Amazon SQS message.

CamelAwsSqsMessageId

String

The Amazon SQS message ID.

CamelAwsSqsDelaySeconds

Integer

Since Camel 2.11, the delay seconds that the Amazon SQS message can be see by others.

+

Message headers set by the SQS consumer

Header

Type

Description

CamelAwsSqsMD5OfBody

String

The MD5 checksum of the Amazon SQS message.

CamelAwsSqsMessageId

String

The Amazon SQS message ID.

CamelAwsSqsReceiptHandle

String

The Amazon SQS message receipt handle.

CamelAwsSqsAttributes

Map<String, String>

The Amazon SQS message attributes.

Advanced AmazonSQS configuration

If your Camel Application is running behind a firewall or if you need to have more control over the AmazonSQS instance configuration, you can create your own instance:

-

You can append query options to the URI in the following format, ?option=value&option=#beanRef&...

Options

Name

Default Value

Description

maxElementsInMemory

1000

The number of elements that may be stored in the defined cache

memoryStoreEvictionPolicy

MemoryStoreEvictionPolicy.LFU

The number of elements that may be stored in the defined cache. Options include

-
  • MemoryStoreEvictionPolicy.LFU - Least frequently used
  • MemoryStoreEvictionPolicy.LRU - Least recently used
  • MemoryStoreEvictionPolicy.FIFO - first in first out, the oldest element by creation time
+

You can append query options to the URI in the following format, ?option=value&option=#beanRef&...

Options

Name

Default Value

Description

maxElementsInMemory

1000

The number of elements that may be stored in the defined cache

memoryStoreEvictionPolicy

MemoryStoreEvictionPolicy.LFU

The number of elements that may be stored in the defined cache. Options include

+
  • MemoryStoreEvictionPolicy.LFU - Least frequently used
  • MemoryStoreEvictionPolicy.LRU - Least recently used
  • MemoryStoreEvictionPolicy.FIFO - first in first out, the oldest element by creation time

overflowToDisk

true

Specifies whether cache may overflow to disk

eternal

false

Sets whether elements are eternal. If eternal, timeouts are ignored and the
element never expires.

timeToLiveSeconds

300

The maximum time between creation time and when an element expires.
- Is used only if the element is not eternal

timeToIdleSeconds

300

The maximum amount of time between accesses before an element expires

diskPersistent

false

Whether the disk store persists between restarts of the Virtual Machine.

diskExpiryThreadIntervalSeconds

120

The number of seconds between runs of the disk expiry thread.

cacheManagerFactory

null

Camel 2.8: If you want to use a custom factory which instantiates and creates the EHCache net.sf.ehcache.CacheManager.

Type: abstract org.apache.camel.component.cache.CacheManagerFactory

eventListenerRegistry

null

Camel 2.8: Sets a list of EHCache net.sf.ehcache.event.CacheEventListener for all new caches- no need to define it per cache in EHCache xml config anymore.

Type: org.apache.camel.component.cache.CacheEventListenerRegistry

cacheLoaderRegistry

null

Camel 2.8: Sets a list of org.apache.camel.component.cache.CacheLoaderWrapper that extends EHCache net.sf.ehcache.loader.CacheLoader for all new caches- no need to define it per cache in EHCache xml config anymore.

Type: org.apache.camel.component.cache.CacheLoaderRegistry

key

null

Camel 2.10: To configure using a cache key by default. If a key is provided in the message header, then the key from the header takes precedence.

operation

null

Camel 2.10: To configure using an cache operation by default. If an operation in the message header, then the operation from the header takes precedence.

-

Cache Component options

Name

Default Value

Description

configuration

 

To use a custom org.apache.camel.component.cache.CacheConfiguration configuration.

cacheManagerFactory

 

To use a custom org.apache.camel.component.cache.CacheManagerFactory.

configurationFile

 

Camel 2.13/2.12.3: To configure the location of the ehcache.xml file to use, such as classpath:com/foo/mycache.xml to load from classpath. By default the configuration is loaded from classpath:ehcache.xml.

+ Is used only if the element is not eternal

timeToIdleSeconds

300

The maximum amount of time between accesses before an element expires

diskPersistent

false

Whether the disk store persists between restarts of the Virtual Machine.

diskExpiryThreadIntervalSeconds

120

The number of seconds between runs of the disk expiry thread.

cacheManagerFactory

null

Camel 2.8: If you want to use a custom factory which instantiates and creates the EHCache net.sf.ehcache.CacheManager.

Type: abstract org.apache.camel.component.cache.CacheManagerFactory

eventListenerRegistry

null

Camel 2.8: Sets a list of EHCache net.sf.ehcache.event.CacheEventListener for all new caches- no need to define it per cache in EHCache xml config anymore.

Type: org.apache.camel.component.cache.CacheEventListenerRegistry

cacheLoaderRegistry

null

Camel 2.8: Sets a list of org.apache.camel.component.cache.CacheLoaderWrapper that extends EHCache net.sf.ehcache.loader.CacheLoader for all new caches- no need to define it per cache in EHCache xml config anymore.

Type: org.apache.camel.component.cache.CacheLoaderRegistry

key

null

Camel 2.10: To configure using a cache key by default. If a key is provided in the message header, then the key from the header takes precedence.

operation

null

Camel 2.10: To configure using an cache operation by default. If an operation in the message header, then the operation from the header takes precedence.

+

Cache Component options

Name

Default Value

Description

configuration

 

To use a custom org.apache.camel.component.cache.CacheConfiguration configuration.

cacheManagerFactory

 

To use a custom org.apache.camel.component.cache.CacheManagerFactory.

configurationFile

 

Camel 2.13/2.12.3: To configure the location of the ehcache.xml file to use, such as classpath:com/foo/mycache.xml to load from classpath. If no configuration is given, then the default settings from EHCache is used.

Sending/Receiving Messages to/from the cache

Message Headers up to Camel 2.7

Header

Description

CACHE_OPERATION

The operation to be performed on the cache. Valid options are

  • GET
  • CHECK
  • ADD
  • UPDATE
  • DELETE
  • DELETEALL
    @@ -1659,11 +1659,11 @@ template.send("direct:alias-verify&

    The cxf: component provides integration with Apache CXF for connecting to JAX-WS services hosted in CXF.

    +/*]]>*/

    Where someAddress specifies the CXF endpoint's address. With this URI format, most of the endpoint details are specified using options.

    For either style above, you can append options to the URI as follows:

    -

    Options

    Name

    Required

    Description

    wsdlURL

    No

    The location of the WSDL. It is obtained from endpoint address by default.

    Example: file://local/wsdl/hello.wsdl or wsdl/hello.wsdl

    serviceClass

    Yes

    The name of the SEI (Service Endpoint Interface) class. This class can have, but does not require, JSR181 annotations.
    This option is only required by POJO mode. If the wsdlURL option is provided, serviceClass is not required for PAYLOAD and MESSAGE mode. When wsdlURL option is used without serviceClass, the serviceName and portName (endpointName for Spring configuration) options MUST be provided. It is possible to use # notation to reference a serviceClass object instance from the registry. E.g. serviceClass=#beanName. The serviceClass for a CXF producer (that is, the to endpoint) should be a Java interface.
    Since 2.8, it is possible to omit both wsdlURL and serviceClass options for PAYLOAD and MESSAGE mo de. When they are omitted, arbitrary XML elements can be put in CxfPayload's body in PAYLOAD mode to facilitate CXF Dispatch Mode.

    Please be advised that the referenced object cannot be a Proxy (Spring AOP Proxy is OK) as it relies on Object.getClass().getName() method for non Spring AOP Proxy.

    Example: org.apache.camel.Hello

    serviceName

    No

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

    Required for camel-cxf consumer since camel-2.2.0 or if more than one serviceName is present in WSDL.

    Example: {http:­//org.apache.camel}ServiceName

    portName

    No

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

    Required for camel-cxf consumer since camel-2.2.0 or if more than one portName is present under serviceName.

    Example: {http:­//org.apache.camel}PortName

    dataFormat

    No

    The data type messages supported by the CXF endpoint.

    Default: POJO
    Example: POJO, PAYLOAD, MESSAGE

    relayHeaders

    No

    Please see the Description of relayHeaders option section for this option. Should a CXF endpoint relay headers along the route. Currently only available when dataFormat=POJO

    Default: true
    Example: true, false

    wrapped

    No

    Which kind of operation that CXF endpoint producer will invoke

    Default: false
    Example: true, false

    wrappedStyle

    No

    New in 2.5.0 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

    Default: Null
    Example: true, false

    setDefaultBus

    No

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

    Default: false
    Example: true, false

    bus

    No

    A default bus created by CXF Bus Factory. Use # notation to reference a bus object from the registry. The referenced object must be an instance of org.apache.cxf.Bus.

    Example: bus=#busName

    cxfBinding

    No

    Use # notation to reference a CXF binding object from the registry. The referenced object must be an instance of org.apache.camel.component.cxf.CxfBinding (use an instance of org.apache.camel.component.cxf.DefaultCxfBinding).

    Example: cxfBinding=#bindingName

    headerFilterStrategy

    No

    Use # notation to reference a header filter strategy object from the registry. The referenced object must be an instance of org.apache.camel.spi.HeaderFilterStrategy (use an instance of org.apache.camel.component.cxf.CxfHeaderFilterStrategy).

    Example: headerFilterStrategy=#strategyName

    loggingFeatureEnabled

    No

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

    Default: false
    Example: loggingFeatureEnabled=true

    defaultOperationName

    No

    New in 2.4, this option will set the default operationName that will be used by the CxfProducer which invokes the remote service.

    Default: null
    Example: defaultOperationName=greetMe

    defaultOperationNamespace

    No

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

    Default: null
    Example: defaultOperationNamespace=http://apache.org/hello_world_soap_http

    synchronous

    No

    New in 2.5. This option will let cxf endpoint decide to use sync or async API to do the underlying work. The default value is false which means camel-cxf endpoint will try to use async API by default.

    Default: false
    Example: synchronous=true

    publishedEndpointUrl

    No

    New in 2.5. This option can override the endpointUrl that published from the WSDL which can be accessed with service address url plus ?wsdl.

    Default: null
    Example: publshedEndpointUrl=http://example.com/service

    properties.XXX

    No

    Camel 2.8: Allows to set custom properties to CXF in the endpoint uri. For example setting properties.mtom-enabled=true to enable MTOM.

    allowStreaming

    No

    New in 2.8.2. This option controls whether the CXF component, when running in PAYLOAD mode (see below), 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.

    skipFaultLogging

    No

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

    username

    No

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

    password

    No

    New in Camel 2.12.3 This option is used to set the basic authentication info rmation of password for the CXF client.

    +

    Options

    < td colspan="1" rowspan="1" class="confluenceTd">

    Yes

    Name

    Required

    Description

    wsdlURL

    No

    The location of the WSDL. It is obtained from endpoint address by default.

    Example: file://local/wsdl/hello.wsdl or wsdl/hello.wsdl

    serviceClass

    The name of the SEI (Service Endpoint Interface) class. This class can have, but does not require, JSR181 annotations.
    This option is only required by POJO mode. If the wsdlURL option is provided, serviceClass is not required for PAYLOAD and MESSAGE mode. When wsdlURL option is used without serviceClass, the serviceName and portName (endpointName for Spring configuration) options MUST be provided. It is possible to use # notation to reference a serviceClass object instance from the registry. E.g. serviceClass=#beanName. The serviceClass for a CXF producer (that is, the to endpoint) should be a Java interface.
    Since 2.8, it is possible to omit both wsdlURL and serviceClass options fo r PAYLOAD and MESSAGE mode. When they are omitted, arbitrary XML elements can be put in CxfPayload's body in PAYLOAD mode to facilitate CXF Dispatch Mode.

    Please be advised that the referenced object cannot be a Proxy (Spring AOP Proxy is OK) as it relies on Object.getClass().getName() method for non Spring AOP Proxy.

    Example: org.apache.camel.Hello

    serviceName

    No

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

    Required for camel-cxf consumer since camel-2.2.0 or if more than one serviceName is present in WSDL.

    Example: {http:­//org.apache.camel}ServiceName

    portName

    No

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

    Required for camel-cxf consumer since camel-2.2.0 or if more than one portName is present under serviceName.

    Example: {http:­//org.apache.camel}PortName

    dataFormat

    No

    The data type messages supported by the CXF endpoint.

    Default: POJO
    Example: POJO, PAYLOAD, MESSAGE

    relayHeaders

    No

    Please see the Description of relayHeaders option section for this option. Should a CXF endpoint relay headers along the route. Currently only available when dataFormat=POJO

    Default: true
    Example: true, false

    wrapped

    No

    Which kind of operation that CXF endpoint producer will invoke

    Default: false
    Example: true, false

    wrappedStyle

    No

    New in 2.5.0 The WSDL style that d escribes 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

    Default: Null
    Example: true, false

    setDefaultBus

    No

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

    Default: false
    Example: true, false

    bus

    No

    A default bus created by CXF Bus Factory. Use # notation to reference a bus object from the registry. The referenced object must be an instance of org.apache.cxf.Bus.

    Example: bus=#busName

    cxfBinding

    No

    Use # notation to reference a CXF binding object from the registry. The referenced object must be an instance of org.apache.camel.component.cxf.CxfBinding (use an instance of org.apache.camel.component.cxf.DefaultCxfBinding).

    Example: cxfBinding=#bindingName

    headerFilterStrategy

    No

    Use # notation to reference a header filter strategy object from the registry. The referenced object must be an instance of org.apache.camel.spi.HeaderFilterStrategy (use an instance of org.apache.camel.component.cxf.CxfHeaderFilterStrategy).

    Example: headerFilterStrategy=#strategyName

    loggingFeatureEnabled

    No

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

    Default: false
    Example: loggingFeatureEnabled=true

    defaultOperationName

    No

    New in 2.4, this option will set the default operationName that will be used by the CxfProducer which invokes the remote service.

    Default: null
    Example: defaul tOperationName=greetMe

    defaultOperationNamespace

    No

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

    Default: null
    Example: defaultOperationNamespace=http://apache.org/hello_world_soap_http

    synchronous

    No

    New in 2.5. This option will let cxf endpoint decide to use sync or async API to do the underlying work. The default value is false which means camel-cxf endpoint will try to use async API by default.

    Default: false
    Example: synchronous=true

    publishedEndpointUrl

    No

    New in 2.5. This option can override the endpointUrl that published from the WSDL which can be accessed with service address url plus ?wsdl.

    Default: null
    Example: pub lshedEndpointUrl=http://example.com/service

    properties.XXX

    No

    Camel 2.8: Allows to set custom properties to CXF in the endpoint uri. For example setting properties.mtom-enabled=true to enable MTOM.

    allowStreaming

    No

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

    skipFaultLogging

    No

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

    username

    No

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

    password

    No

    New in Camel 2.12.3 This option is used to set the b asic authentication information of password for the CXF client.

    The serviceName and portName are QNames, so if you provide them be sure to prefix them with their {namespace} as shown in the examples above.

    -

    The descriptions of the dataformats

    +

    The descriptions of the dataformats

    -

    DataFormat

    Description

    POJO

    POJOs (Plain old Java objects) are the Java parameters to the method being invoked on the target server. Both Protocol and Logical JAX-WS handlers are supported.

    PAYLOAD

    PAYLOAD is the message payload (the contents of the soap:body) after message configuration in the CXF endpoint is applied. Only Protocol JAX-WS handler is supported. Logical JAX-WS handler is not supported.

    MESSAGE

    MESSAGE is the raw message that is received from the transport layer. It is not suppose to touch or change Stream, some of the CXF interceptor will be removed if you are using this kind of DataFormat so you can't see any soap headers after the camel-cxf consumer and JAX-WS handler is not supported.

    CXF_MESSAGE

    New in Camel 2.8.2, CXF_MESSAGE allows for invoking the full capabilities of CXF interceptors by converting the message from the transport layer into a raw SOAP message

    +

    DataFormat

    Description

    POJO

    POJOs (Plain old Java objects) are the Java parameters to the method being invoked on the target server. Both Protocol and Logical JAX-WS handlers are supported.

    PAYLOAD

    PAYLOAD is the message payload (the contents of the soap:body) after message configuration in the CXF endpoint is applied. Only Protocol JAX-WS handler is supported. Logical JAX-WS handler is not supported.

    MESSAGE

    MESSAGE is the raw message that is received from the transport layer. It is not suppose to touch or change Stream, some of the CXF interceptor will be removed if you are using this kind of DataFormat so you can't see any soap headers after the camel-cxf consumer and JAX-WS handler is not supported.

    CXF_MESSAGE

    New in Camel 2.8.2, CXF_MESSAGE allows for invoking the full capabilities of CXF interceptors by converting the message from the transport layer into a raw SOAP message

    You can determine the data format mode of an exchange by retrieving the exchange property, CamelCXFDataFormat. The exchange key constant is defined in org.apache.camel.component.cxf.CxfConstants.DATA_FORMAT_PROPERTY.

    How to enable CXF's LoggingOutInterceptor in MESSAGE mode

    CXF's LoggingOutInterceptor outputs outbound message that goes on the wire to logging system (Java Util Logging). Since the LoggingOutInterceptor is in PRE_STREAM phase (but PRE_STREAM phase is removed in MESSAGE mode), you have to configure LoggingOutInterceptor to be run during the WRITE phase. The following is an example.

    @@ -1767,10 +1767,10 @@ div.rbtoc1392103247397 li {margin-left: </property> </bean> ]]> -
  • Other than relayHeaders, there are new properties that can be configured in CxfHeaderFilterStrategy.

    Name

    Required

    Description

    relayHeaders

    No

    All message headers will be processed by Message Header Filters

    Type: boolean
    Default: true

    relayAllMessageHeaders

    No

    All message headers will be propagated (without processing by Message Header Filters)

    Type: boolean
    Default: false

    allowFilterNamespaceClash

    No

    If two filters overlap in activation namespace, the property control how it should be handled. If the value is true, last one wins. If the value is false, it will throw an exception

    Type: boolean
    Default: false

    +
  • Other than relayHeaders, there are new properties that can be configured in CxfHeaderFilterStrategy.

    Name

    Required

    Description

    relayHeaders

    No

    All message headers will be processed by Message Header Filters

    Type: boolean
    Default: true

    re layAllMessageHeaders

    No

    All message headers will be propagated (without processing by Message Header Filters)

    Type: boolean
    Default: false

    allowFilterNamespaceClash

    No

    If two filters overlap in activation namespace, the property control how it should be handled. If the value is true, last one wins. If the value is false, it will throw an exception

    Type: boolean
    Default: false

    -

    Configure the CXF endpoints with Spring

    +

    Configure the CXF endpoints with Spring

    You can configure the CXF endpoint with the Spring configuration file shown below, and you can also embed the endpoint into the camelContext tags. When you are invoking the service endpoint, you can set the operationName and operationNamespace headers to explicitly state which operation you are calling.

    @@ -1804,11 +1804,11 @@ div.rbtoc1392103247397 li {margin-left:

    The cxf:cxfEndpoint element supports many additional attributes:

    -

    Name

    Value

    PortName

    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.

    serviceName

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

    wsdlURL

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

    bindingId

    The bindingId for the service model to use.

    address

    The service publish address.

    bus

    The bus name that will be used in the JAX-WS endpoint.

    serviceClass

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

    +

    Name

    Value

    PortName

    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.

    serviceName

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

    wsdlURL

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

    bindingId

    The bindingId for the service model to use.

    address

    The service publish address.

    bus

    The bus name that will be used in the JAX-WS endpoint.

    serviceClass

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

    It also supports many child elements:

    [... 415 lines stripped ...]