http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-couchdb/src/main/docs/couchdb-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-couchdb/src/main/docs/couchdb-component.adoc b/components/camel-couchdb/src/main/docs/couchdb-component.adoc index 143184f..c118b76 100644 --- a/components/camel-couchdb/src/main/docs/couchdb-component.adoc +++ b/components/camel-couchdb/src/main/docs/couchdb-component.adoc @@ -56,44 +56,32 @@ with the following path and query parameters: #### Path Parameters (4 parameters): -[width="100%",cols="2,1,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |======================================================================= -| Name | Default | Java Type | Description -| protocol | | String | *Required* The protocol to use for communicating with the database. -| hostname | | String | *Required* Hostname of the running couchdb instance -| port | 5984 | int | Port number for the running couchdb instance -| database | | String | *Required* Name of the database to use +| Name | Description | Default | Type +| **protocol** | *Required* The protocol to use for communicating with the database. | | String +| **hostname** | *Required* Hostname of the running couchdb instance | | String +| **port** | Port number for the running couchdb instance | 5984 | int +| **database** | *Required* Name of the database to use | | String |======================================================================= #### Query Parameters (12 parameters): -[width="100%",cols="2,1m,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |======================================================================= -| Name | Default | Java Type | Description - -| createDatabase | false | boolean | Creates the database if it does not already exist - 4+^s| consumer -| bridgeErrorHandler | false | 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 or ERROR level and ignored. - -| deletes | true | boolean | Document deletes are published as events - -| heartbeat | 30000 | long | How often to send an empty message to keep socket alive in millis - -| since | | String | Start tracking changes immediately after the given update sequence. The default null will start monitoring from the latest sequence. - -| style | main_only | String | Specifies how many revisions are returned in the changes array. The default main_only will only return the current winning revision; all_docs will return all leaf revisions (including conflicts and deleted former conflicts.) - -| updates | true | boolean | Document inserts/updates are published as events - 4+^s| consumer (advanced) -| exceptionHandler | | 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 or ERROR level and ignored. - -| exchangePattern | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange. - 4+^s| advanced -| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). - 4+^s| security -| password | | String | Password for authenticated databases - -| username | | String | Username in case of authenticated databases +| Name | Description | Default | Type +| **createDatabase** (common) | Creates the database if it does not already exist | false | boolean +| **bridgeErrorHandler** (consumer) | 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 | boolean +| **deletes** (consumer) | Document deletes are published as events | true | boolean +| **heartbeat** (consumer) | How often to send an empty message to keep socket alive in millis | 30000 | long +| **since** (consumer) | Start tracking changes immediately after the given update sequence. The default null will start monitoring from the latest sequence. | | String +| **style** (consumer) | Specifies how many revisions are returned in the changes array. The default main_only will only return the current winning revision; all_docs will return all leaf revisions (including conflicts and deleted former conflicts.) | main_only | String +| **updates** (consumer) | Document inserts/updates are published as events | true | boolean +| **exceptionHandler** (consumer) | 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 or ERROR level and ignored. | | ExceptionHandler +| **exchangePattern** (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern +| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean +| **password** (security) | Password for authenticated databases | | String +| **username** (security) | Username in case of authenticated databases | | String |======================================================================= // endpoint options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-crypto/src/main/docs/crypto-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-crypto/src/main/docs/crypto-component.adoc b/components/camel-crypto/src/main/docs/crypto-component.adoc index 0123592..140b685 100644 --- a/components/camel-crypto/src/main/docs/crypto-component.adoc +++ b/components/camel-crypto/src/main/docs/crypto-component.adoc @@ -84,13 +84,11 @@ The Crypto (JCE) component supports 2 options which are listed below. -[width="100%",cols="2,1m,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |======================================================================= -| Name | Default | Java Type | Description - 4+^s| advanced -| configuration | | DigitalSignatureConfiguration | To use the shared DigitalSignatureConfiguration as configuration - -| resolvePropertyPlaceholders | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. +| Name | Description | Default | Type +| **configuration** (advanced) | To use the shared DigitalSignatureConfiguration as configuration | | DigitalSignature Configuration +| **resolveProperty Placeholders** (advanced) | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | boolean |======================================================================= // component options: END @@ -103,56 +101,37 @@ with the following path and query parameters: #### Path Parameters (2 parameters): -[width="100%",cols="2,1,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |======================================================================= -| Name | Default | Java Type | Description -| cryptoOperation | | CryptoOperation | *Required* Set the Crypto operation from that supplied after the crypto scheme in the endpoint uri e.g. crypto:sign sets sign as the operation. -| name | | String | *Required* The logical name of this operation. +| Name | Description | Default | Type +| **cryptoOperation** | *Required* Set the Crypto operation from that supplied after the crypto scheme in the endpoint uri e.g. crypto:sign sets sign as the operation. | | CryptoOperation +| **name** | *Required* The logical name of this operation. | | String |======================================================================= #### Query Parameters (19 parameters): -[width="100%",cols="2,1m,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |======================================================================= -| Name | Default | Java Type | Description - -| algorithm | SHA1WithDSA | String | Sets the JCE name of the Algorithm that should be used for the signer. - -| alias | | String | Sets the alias used to query the KeyStore for keys and link java.security.cert.Certificate Certificates to be used in signing and verifying exchanges. This value can be provided at runtime via the message header link org.apache.camel.component.crypto.DigitalSignatureConstantsKEYSTORE_ALIAS - -| certificateName | | String | Sets the reference name for a PrivateKey that can be fond in the registry. - -| keystore | | KeyStore | Sets the KeyStore that can contain keys and Certficates for use in signing and verifying exchanges. A KeyStore is typically used with an alias either one supplied in the Route definition or dynamically via the message header CamelSignatureKeyStoreAlias. If no alias is supplied and there is only a single entry in the Keystore then this single entry will be used. - -| keystoreName | | String | Sets the reference name for a Keystore that can be fond in the registry. - -| privateKey | | PrivateKey | Set the PrivateKey that should be used to sign the exchange - -| privateKeyName | | String | Sets the reference name for a PrivateKey that can be fond in the registry. - -| provider | | String | Set the id of the security provider that provides the configured Signature algorithm. - -| publicKeyName | | String | references that should be resolved when the context changes - -| secureRandomName | | String | Sets the reference name for a SecureRandom that can be fond in the registry. - -| signatureHeaderName | | String | Set the name of the message header that should be used to store the base64 encoded signature. This defaults to 'CamelDigitalSignature' - 4+^s| advanced -| bufferSize | 2048 | Integer | Set the size of the buffer used to read in the Exchange payload data. - -| certificate | | Certificate | Set the Certificate that should be used to verify the signature in the exchange based on its payload. - -| clearHeaders | true | boolean | Determines if the Signature specific headers be cleared after signing and verification. Defaults to true and should only be made otherwise at your extreme peril as vital private information such as Keys and passwords may escape if unset. - -| keyStoreParameters | | KeyStoreParameters | Sets the KeyStore that can contain keys and Certficates for use in signing and verifying exchanges based on the given KeyStoreParameters. A KeyStore is typically used with an alias either one supplied in the Route definition or dynamically via the message header CamelSignatureKeyStoreAlias. If no alias is supplied and there is only a single entry in the Keystore then this single entry will be used. - -| publicKey | | PublicKey | Set the PublicKey that should be used to verify the signature in the exchange. - -| secureRandom | | SecureRandom | Set the SecureRandom used to initialize the Signature service - -| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). - 4+^s| security -| password | | String | Sets the password used to access an aliased PrivateKey in the KeyStore. +| Name | Description | Default | Type +| **algorithm** (producer) | Sets the JCE name of the Algorithm that should be used for the signer. | SHA1WithDSA | String +| **alias** (producer) | Sets the alias used to query the KeyStore for keys and link java.security.cert.Certificate Certificates to be used in signing and verifying exchanges. This value can be provided at runtime via the message header link org.apache.camel.component.crypto.DigitalSignatureConstantsKEYSTORE_ALIAS | | String +| **certificateName** (producer) | Sets the reference name for a PrivateKey that can be fond in the registry. | | String +| **keystore** (producer) | Sets the KeyStore that can contain keys and Certficates for use in signing and verifying exchanges. A KeyStore is typically used with an alias either one supplied in the Route definition or dynamically via the message header CamelSignatureKeyStoreAlias. If no alias is supplied and there is only a single entry in the Keystore then this single entry will be used. | | KeyStore +| **keystoreName** (producer) | Sets the reference name for a Keystore that can be fond in the registry. | | String +| **privateKey** (producer) | Set the PrivateKey that should be used to sign the exchange | | PrivateKey +| **privateKeyName** (producer) | Sets the reference name for a PrivateKey that can be fond in the registry. | | String +| **provider** (producer) | Set the id of the security provider that provides the configured Signature algorithm. | | String +| **publicKeyName** (producer) | references that should be resolved when the context changes | | String +| **secureRandomName** (producer) | Sets the reference name for a SecureRandom that can be fond in the registry. | | String +| **signatureHeaderName** (producer) | Set the name of the message header that should be used to store the base64 encoded signature. This defaults to 'CamelDigitalSignature' | | String +| **bufferSize** (advanced) | Set the size of the buffer used to read in the Exchange payload data. | 2048 | Integer +| **certificate** (advanced) | Set the Certificate that should be used to verify the signature in the exchange based on its payload. | | Certificate +| **clearHeaders** (advanced) | Determines if the Signature specific headers be cleared after signing and verification. Defaults to true and should only be made otherwise at your extreme peril as vital private information such as Keys and passwords may escape if unset. | true | boolean +| **keyStoreParameters** (advanced) | Sets the KeyStore that can contain keys and Certficates for use in signing and verifying exchanges based on the given KeyStoreParameters. A KeyStore is typically used with an alias either one supplied in the Route definition or dynamically via the message header CamelSignatureKeyStoreAlias. If no alias is supplied and there is only a single entry in the Keystore then this single entry will be used. | | KeyStoreParameters +| **publicKey** (advanced) | Set the PublicKey that should be used to verify the signature in the exchange. | | PublicKey +| **secureRandom** (advanced) | Set the SecureRandom used to initialize the Signature service | | SecureRandom +| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean +| **password** (security) | Sets the password used to access an aliased PrivateKey in the KeyStore. | | String |======================================================================= // endpoint options: END http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-cxf/src/main/docs/cxf-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-cxf/src/main/docs/cxf-component.adoc b/components/camel-cxf/src/main/docs/cxf-component.adoc index 95fbc89..2479464 100644 --- a/components/camel-cxf/src/main/docs/cxf-component.adoc +++ b/components/camel-cxf/src/main/docs/cxf-component.adoc @@ -116,15 +116,12 @@ The CXF component supports 3 options which are listed below. -[width="100%",cols="2,1m,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |======================================================================= -| Name | Default | Java Type | Description - 4+^s| advanced -| 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. - 4+^s| filter -| headerFilterStrategy | | HeaderFilterStrategy | To use a custom org.apache.camel.spi.HeaderFilterStrategy to filter header to and from Camel message. - 4+^s| advanced -| resolvePropertyPlaceholders | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. +| Name | Description | Default | Type +| **allowStreaming** (advanced) | 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. | | Boolean +| **headerFilterStrategy** (filter) | To use a custom org.apache.camel.spi.HeaderFilterStrategy to filter header to and from Camel message. | | HeaderFilterStrategy +| **resolveProperty Placeholders** (advanced) | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | boolean |======================================================================= // component options: END @@ -141,86 +138,52 @@ with the following path and query parameters: #### Path Parameters (2 parameters): -[width="100%",cols="2,1,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |======================================================================= -| Name | Default | Java Type | Description -| beanId | | String | To lookup an existing configured CxfEndpoint. Must used bean: as prefix. -| address | | String | The service publish address. +| Name | Description | Default | Type +| **beanId** | To lookup an existing configured CxfEndpoint. Must used bean: as prefix. | | String +| **address** | The service publish address. | | String |======================================================================= #### Query Parameters (34 parameters): -[width="100%",cols="2,1m,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |======================================================================= -| Name | Default | Java Type | Description - 4+^s| common -| dataFormat | POJO | DataFormat | 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 - 4+^s| consumer -| bridgeErrorHandler | false | 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 or ERROR level and ignored. - 4+^s| consumer (advanced) -| exceptionHandler | | 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 or ERROR level and ignored. - -| exchangePattern | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange. - 4+^s| producer -| cookieHandler | | CookieHandler | 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 | | HostnameVerifier | The hostname verifier to be used. Use the notation to reference a HostnameVerifier from the registry. - -| sslContextParameters | | SSLContextParameters | The Camel SSL setting reference. Use the notation to reference the SSL Context. - -| wrapped | false | boolean | Which kind of operation that CXF endpoint producer will invoke - 4+^s| advanced -| 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 | | Bus | To use a custom configured CXF Bus. - -| continuationTimeout | 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 | | CxfBinding | To use a custom CxfBinding to control the binding between Camel Message and CXF Message. - -| cxfEndpointConfigurer | | 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 configureServerClient method of CxfEndpointConfigurer. - -| defaultBus | false | boolean | Will set the default bus when CXF endpoint create a bus by itself - -| headerFilterStrategy | | HeaderFilterStrategy | To use a custom HeaderFilterStrategy to filter header to and from Camel message. - -| mergeProtocolHeaders | false | 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 | false | boolean | To enable MTOM (attachments). This requires to use POJO or PAYLOAD data format mode. - -| properties | | 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 | false | boolean | Sets whether SOAP message validation should be disabled. - -| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). - 4+^s| logging -| loggingFeatureEnabled | false | boolean | This option enables CXF Logging Feature which writes inbound and outbound SOAP messages to log. - -| loggingSizeLimit | 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 | false | boolean | This option controls whether the PhaseInterceptorChain skips logging the Fault that it catches. - 4+^s| security -| 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. - 4+^s| service -| 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 | | Class<?> | 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. +| Name | Description | Default | Type +| **dataFormat** (common) | The data type messages supported by the CXF endpoint. | POJO | DataFormat +| **wrappedStyle** (common) | 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 | | Boolean +| **bridgeErrorHandler** (consumer) | 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 | boolean +| **exceptionHandler** (consumer) | 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 or ERROR level and ignored. | | ExceptionHandler +| **exchangePattern** (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern +| **cookieHandler** (producer) | Configure a cookie handler to maintain a HTTP session | | CookieHandler +| **defaultOperationName** (producer) | This option will set the default operationName that will be used by the CxfProducer which invokes the remote service. | | String +| **defaultOperationNamespace** (producer) | This option will set the default operationNamespace that will be used by the CxfProducer which invokes the remote service. | | String +| **hostnameVerifier** (producer) | The hostname verifier to be used. Use the notation to reference a HostnameVerifier from the registry. | | HostnameVerifier +| **sslContextParameters** (producer) | The Camel SSL setting reference. Use the notation to reference the SSL Context. | | SSLContextParameters +| **wrapped** (producer) | Which kind of operation that CXF endpoint producer will invoke | false | boolean +| **allowStreaming** (advanced) | 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. | | Boolean +| **bus** (advanced) | To use a custom configured CXF Bus. | | Bus +| **continuationTimeout** (advanced) | 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. | 30000 | long +| **cxfBinding** (advanced) | To use a custom CxfBinding to control the binding between Camel Message and CXF Message. | | CxfBinding +| **cxfEndpointConfigurer** (advanced) | 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 configureServerClient method of CxfEndpointConfigurer. | | CxfEndpointConfigurer +| **defaultBus** (advanced) | Will set the default bus when CXF endpoint create a bus by itself | false | boolean +| **headerFilterStrategy** (advanced) | To use a custom HeaderFilterStrategy to filter header to and from Camel message. | | HeaderFilterStrategy +| **mergeProtocolHeaders** (advanced) | 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 | boolean +| **mtomEnabled** (advanced) | To enable MTOM (attachments). This requires to use POJO or PAYLOAD data format mode. | false | boolean +| **properties** (advanced) | 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 | | Map +| **skipPayloadMessagePart Check** (advanced) | Sets whether SOAP message validation should be disabled. | false | boolean +| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean +| **loggingFeatureEnabled** (logging) | This option enables CXF Logging Feature which writes inbound and outbound SOAP messages to log. | false | boolean +| **loggingSizeLimit** (logging) | 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 | int +| **skipFaultLogging** (logging) | This option controls whether the PhaseInterceptorChain skips logging the Fault that it catches. | false | boolean +| **password** (security) | This option is used to set the basic authentication information of password for the CXF client. | | String +| **username** (security) | This option is used to set the basic authentication information of username for the CXF client. | | String +| **bindingId** (service) | The bindingId for the service model to use. | | String +| **portName** (service) | 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. | | String +| **publishedEndpointUrl** (service) | This option can override the endpointUrl that published from the WSDL which can be accessed with service address url plus wsd | | String +| **serviceClass** (service) | The class name of the SEI (Service Endpoint Interface) class which could have JSR181 annotation or not. | | Class<?> +| **serviceName** (service) | The service name this service is implementing it maps to the wsdl:servicename. | | String +| **wsdlURL** (service) | The location of the WSDL. Can be on the classpath file system or be hosted remotely. | | String |======================================================================= // endpoint options: END http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-cxf/src/main/docs/cxfrs-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-cxf/src/main/docs/cxfrs-component.adoc b/components/camel-cxf/src/main/docs/cxfrs-component.adoc index f69f77d..2cd74dd 100644 --- a/components/camel-cxf/src/main/docs/cxfrs-component.adoc +++ b/components/camel-cxf/src/main/docs/cxfrs-component.adoc @@ -58,13 +58,11 @@ The CXF-RS component supports 2 options which are listed below. -[width="100%",cols="2,1m,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |======================================================================= -| Name | Default | Java Type | Description - 4+^s| filter -| headerFilterStrategy | | HeaderFilterStrategy | To use a custom org.apache.camel.spi.HeaderFilterStrategy to filter header to and from Camel message. - 4+^s| advanced -| resolvePropertyPlaceholders | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. +| Name | Description | Default | Type +| **headerFilterStrategy** (filter) | To use a custom org.apache.camel.spi.HeaderFilterStrategy to filter header to and from Camel message. | | HeaderFilterStrategy +| **resolveProperty Placeholders** (advanced) | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | boolean |======================================================================= // component options: END @@ -80,76 +78,47 @@ with the following path and query parameters: #### Path Parameters (2 parameters): -[width="100%",cols="2,1,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |======================================================================= -| Name | Default | Java Type | Description -| beanId | | String | To lookup an existing configured CxfRsEndpoint. Must used bean: as prefix. -| address | | String | The service publish address. +| Name | Description | Default | Type +| **beanId** | To lookup an existing configured CxfRsEndpoint. Must used bean: as prefix. | | String +| **address** | The service publish address. | | String |======================================================================= #### Query Parameters (29 parameters): -[width="100%",cols="2,1m,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |======================================================================= -| Name | Default | Java Type | Description - -| features | | List | Set the feature list to the CxfRs endpoint. - -| loggingFeatureEnabled | false | boolean | This option enables CXF Logging Feature which writes inbound and outbound REST messages to log. - -| loggingSizeLimit | | int | To limit the total size of number of bytes the logger will output when logging feature has been enabled. - -| modelRef | | String | This option is used to specify the model file which is useful for the resource class without annotation. When using this option then the service class can be omitted to emulate document-only endpoints - -| providers | | String | Set custom JAX-RS provider(s) list to the CxfRs endpoint. You can specify a string with a list of providers to lookup in the registy separated by comma. - -| resourceClasses | | List | The resource classes which you want to export as REST service. Multiple classes can be separated by comma. - -| schemaLocations | | List | Sets the locations of the schema(s) which can be used to validate the incoming XML or JAXB-driven JSON. - -| skipFaultLogging | false | boolean | This option controls whether the PhaseInterceptorChain skips logging the Fault that it catches. - 4+^s| consumer -| bindingStyle | Default | BindingStyle | Sets how requests and responses will be mapped to/from Camel. Two values are possible: SimpleConsumer: This binding style processes request parameters multiparts etc. and maps them to IN headers IN attachments and to the message body. It aims to eliminate low-level processing of org.apache.cxf.message.MessageContentsList. It also also adds more flexibility and simplicity to the response mapping. Only available for consumers. Default: The default style. For consumers this passes on a MessageContentsList to the route requiring low-level processing in the route. This is the traditional binding style which simply dumps the org.apache.cxf.message.MessageContentsList coming in from the CXF stack onto the IN message body. The user is then responsible for processing it according to the contract defined by the JAX-RS method signature. Custom: allows you to specify a custom binding through the binding option. - -| bridgeErrorHandler | false | 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 or ERROR level and ignored. - -| publishedEndpointUrl | | String | This option can override the endpointUrl that published from the WADL which can be accessed with resource address url plus _wadl - 4+^s| consumer (advanced) -| exceptionHandler | | 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 or ERROR level and ignored. - -| exchangePattern | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange. - 4+^s| producer -| cookieHandler | | CookieHandler | Configure a cookie handler to maintain a HTTP session - -| hostnameVerifier | | HostnameVerifier | The hostname verifier to be used. Use the notation to reference a HostnameVerifier from the registry. - -| sslContextParameters | | SSLContextParameters | The Camel SSL setting reference. Use the notation to reference the SSL Context. - -| throwExceptionOnFailure | true | boolean | This option tells the CxfRsProducer to inspect return codes and will generate an Exception if the return code is larger than 207. - 4+^s| producer (advanced) -| httpClientAPI | true | boolean | If it is true the CxfRsProducer will use the HttpClientAPI to invoke the service. If it is false the CxfRsProducer will use the ProxyClientAPI to invoke the service - -| ignoreDeleteMethodMessageBody | false | boolean | This option is used to tell CxfRsProducer to ignore the message body of the DELETE method when using HTTP API. - -| maxClientCacheSize | 10 | int | This option allows you to configure the maximum size of the cache. The implementation caches CXF clients or ClientFactoryBean in CxfProvider and CxfRsProvider. - 4+^s| advanced -| binding | | CxfRsBinding | To use a custom CxfBinding to control the binding between Camel Message and CXF Message. - -| bus | | Bus | To use a custom configured CXF Bus. - -| continuationTimeout | 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. - -| cxfRsEndpointConfigurer | | CxfRsEndpointConfigurer | This option could apply the implementation of org.apache.camel.component.cxf.jaxrs.CxfRsEndpointConfigurer which supports to configure the CXF endpoint in programmatic way. User can configure the CXF server and client by implementing configureServer/Client method of CxfEndpointConfigurer. - -| defaultBus | false | boolean | Will set the default bus when CXF endpoint create a bus by itself - -| headerFilterStrategy | | HeaderFilterStrategy | To use a custom HeaderFilterStrategy to filter header to and from Camel message. - -| performInvocation | false | boolean | When the option is true Camel will perform the invocation of the resource class instance and put the response object into the exchange for further processing. - -| propagateContexts | false | boolean | When the option is true JAXRS UriInfo HttpHeaders Request and SecurityContext contexts will be available to custom CXFRS processors as typed Camel exchange properties. These contexts can be used to analyze the current requests using JAX-RS API. - -| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). +| Name | Description | Default | Type +| **features** (common) | Set the feature list to the CxfRs endpoint. | | List +| **loggingFeatureEnabled** (common) | This option enables CXF Logging Feature which writes inbound and outbound REST messages to log. | false | boolean +| **loggingSizeLimit** (common) | To limit the total size of number of bytes the logger will output when logging feature has been enabled. | | int +| **modelRef** (common) | This option is used to specify the model file which is useful for the resource class without annotation. When using this option then the service class can be omitted to emulate document-only endpoints | | String +| **providers** (common) | Set custom JAX-RS provider(s) list to the CxfRs endpoint. You can specify a string with a list of providers to lookup in the registy separated by comma. | | String +| **resourceClasses** (common) | The resource classes which you want to export as REST service. Multiple classes can be separated by comma. | | List +| **schemaLocations** (common) | Sets the locations of the schema(s) which can be used to validate the incoming XML or JAXB-driven JSON. | | List +| **skipFaultLogging** (common) | This option controls whether the PhaseInterceptorChain skips logging the Fault that it catches. | false | boolean +| **bindingStyle** (consumer) | Sets how requests and responses will be mapped to/from Camel. Two values are possible: SimpleConsumer: This binding style processes request parameters multiparts etc. and maps them to IN headers IN attachments and to the message body. It aims to eliminate low-level processing of org.apache.cxf.message.MessageContentsList. It also also adds more flexibility and simplicity to the response mapping. Only available for consumers. Default: The default style. For consumers this passes on a MessageContentsList to the route requiring low-level processing in the route. This is the traditional binding style which simply dumps the org.apache.cxf.message.MessageContentsList coming in from the CXF stack onto the IN message body. The user is then responsible for processing it according to the contract defined by the JAX-RS method signature. Custom: allows you to specify a custom binding through the binding option. | Default | BindingStyle +| **bridgeErrorHandler** (consumer) | 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 | boolean +| **publishedEndpointUrl** (consumer) | This option can override the endpointUrl that published from the WADL which can be accessed with resource address url plus _wadl | | String +| **exceptionHandler** (consumer) | 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 or ERROR level and ignored. | | ExceptionHandler +| **exchangePattern** (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern +| **cookieHandler** (producer) | Configure a cookie handler to maintain a HTTP session | | CookieHandler +| **hostnameVerifier** (producer) | The hostname verifier to be used. Use the notation to reference a HostnameVerifier from the registry. | | HostnameVerifier +| **sslContextParameters** (producer) | The Camel SSL setting reference. Use the notation to reference the SSL Context. | | SSLContextParameters +| **throwExceptionOnFailure** (producer) | This option tells the CxfRsProducer to inspect return codes and will generate an Exception if the return code is larger than 207. | true | boolean +| **httpClientAPI** (producer) | If it is true the CxfRsProducer will use the HttpClientAPI to invoke the service. If it is false the CxfRsProducer will use the ProxyClientAPI to invoke the service | true | boolean +| **ignoreDeleteMethodMessage Body** (producer) | This option is used to tell CxfRsProducer to ignore the message body of the DELETE method when using HTTP API. | false | boolean +| **maxClientCacheSize** (producer) | This option allows you to configure the maximum size of the cache. The implementation caches CXF clients or ClientFactoryBean in CxfProvider and CxfRsProvider. | 10 | int +| **binding** (advanced) | To use a custom CxfBinding to control the binding between Camel Message and CXF Message. | | CxfRsBinding +| **bus** (advanced) | To use a custom configured CXF Bus. | | Bus +| **continuationTimeout** (advanced) | 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. | 30000 | long +| **cxfRsEndpointConfigurer** (advanced) | This option could apply the implementation of org.apache.camel.component.cxf.jaxrs.CxfRsEndpointConfigurer which supports to configure the CXF endpoint in programmatic way. User can configure the CXF server and client by implementing configureServer/Client method of CxfEndpointConfigurer. | | CxfRsEndpoint Configurer +| **defaultBus** (advanced) | Will set the default bus when CXF endpoint create a bus by itself | false | boolean +| **headerFilterStrategy** (advanced) | To use a custom HeaderFilterStrategy to filter header to and from Camel message. | | HeaderFilterStrategy +| **performInvocation** (advanced) | When the option is true Camel will perform the invocation of the resource class instance and put the response object into the exchange for further processing. | false | boolean +| **propagateContexts** (advanced) | When the option is true JAXRS UriInfo HttpHeaders Request and SecurityContext contexts will be available to custom CXFRS processors as typed Camel exchange properties. These contexts can be used to analyze the current requests using JAX-RS API. | false | boolean +| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean |======================================================================= // endpoint options: END http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-disruptor/src/main/docs/disruptor-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-disruptor/src/main/docs/disruptor-component.adoc b/components/camel-disruptor/src/main/docs/disruptor-component.adoc index d54487a..0c8e2d0 100644 --- a/components/camel-disruptor/src/main/docs/disruptor-component.adoc +++ b/components/camel-disruptor/src/main/docs/disruptor-component.adoc @@ -98,25 +98,17 @@ The Disruptor component supports 8 options which are listed below. -[width="100%",cols="2,1m,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |======================================================================= -| Name | Default | Java Type | Description - 4+^s| consumer -| defaultConcurrentConsumers | 1 | int | To configure the default number of concurrent consumers - -| defaultMultipleConsumers | false | boolean | To configure the default value for multiple consumers - 4+^s| producer -| defaultProducerType | Multi | DisruptorProducerType | To configure the default value for DisruptorProducerType The default value is Multi. - 4+^s| consumer -| defaultWaitStrategy | Blocking | DisruptorWaitStrategy | To configure the default value for DisruptorWaitStrategy The default value is Blocking. - 4+^s| producer -| defaultBlockWhenFull | true | boolean | To configure the default value for block when full The default value is true. - 4+^s| common -| queueSize | | int | To configure the ring buffer size - -| bufferSize | 1024 | int | To configure the ring buffer size - 4+^s| advanced -| resolvePropertyPlaceholders | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. +| Name | Description | Default | Type +| **defaultConcurrent Consumers** (consumer) | To configure the default number of concurrent consumers | 1 | int +| **defaultMultiple Consumers** (consumer) | To configure the default value for multiple consumers | false | boolean +| **defaultProducerType** (producer) | To configure the default value for DisruptorProducerType The default value is Multi. | Multi | DisruptorProducerType +| **defaultWaitStrategy** (consumer) | To configure the default value for DisruptorWaitStrategy The default value is Blocking. | Blocking | DisruptorWaitStrategy +| **defaultBlockWhenFull** (producer) | To configure the default value for block when full The default value is true. | true | boolean +| **queueSize** (common) | To configure the ring buffer size | | int +| **bufferSize** (common) | To configure the ring buffer size | 1024 | int +| **resolveProperty Placeholders** (advanced) | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | boolean |======================================================================= // component options: END @@ -132,41 +124,29 @@ with the following path and query parameters: #### Path Parameters (1 parameters): -[width="100%",cols="2,1,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |======================================================================= -| Name | Default | Java Type | Description -| name | | String | *Required* Name of queue +| Name | Description | Default | Type +| **name** | *Required* Name of queue | | String |======================================================================= #### Query Parameters (12 parameters): -[width="100%",cols="2,1m,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |======================================================================= -| Name | Default | Java Type | Description - -| size | 1024 | int | The maximum capacity of the Disruptors ringbuffer Will be effectively increased to the nearest power of two. Notice: Mind if you use this option then its the first endpoint being created with the queue name that determines the size. To make sure all endpoints use same size then configure the size option on all of them or the first endpoint being created. - 4+^s| consumer -| bridgeErrorHandler | false | 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 or ERROR level and ignored. - -| concurrentConsumers | 1 | int | Number of concurrent threads processing exchanges. - -| multipleConsumers | false | boolean | Specifies whether multiple consumers are allowed. If enabled you can use Disruptor for Publish-Subscribe messaging. That is you can send a message to the queue and have each consumer receive a copy of the message. When enabled this option should be specified on every consumer endpoint. - -| waitStrategy | Blocking | DisruptorWaitStrategy | Defines the strategy used by consumer threads to wait on new exchanges to be published. The options allowed are:Blocking Sleeping BusySpin and Yielding. - 4+^s| consumer (advanced) -| exceptionHandler | | 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 or ERROR level and ignored. - -| exchangePattern | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange. - 4+^s| producer -| blockWhenFull | false | boolean | Whether a thread that sends messages to a full Disruptor will block until the ringbuffer's capacity is no longer exhausted. By default the calling thread will block and wait until the message can be accepted. By disabling this option an exception will be thrown stating that the queue is full. - -| producerType | Multi | DisruptorProducerType | Defines the producers allowed on the Disruptor. The options allowed are: Multi to allow multiple producers and Single to enable certain optimizations only allowed when one concurrent producer (on one thread or otherwise synchronized) is active. - -| timeout | 30000 | long | Timeout (in milliseconds) before a producer will stop waiting for an asynchronous task to complete. You can disable timeout by using 0 or a negative value. - -| waitForTaskToComplete | IfReplyExpected | WaitForTaskToComplete | Option to specify whether the caller should wait for the async task to complete or not before continuing. The following three options are supported: Always Never or IfReplyExpected. The first two values are self-explanatory. The last value IfReplyExpected will only wait if the message is Request Reply based. - 4+^s| advanced -| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). +| Name | Description | Default | Type +| **size** (common) | The maximum capacity of the Disruptors ringbuffer Will be effectively increased to the nearest power of two. Notice: Mind if you use this option then its the first endpoint being created with the queue name that determines the size. To make sure all endpoints use same size then configure the size option on all of them or the first endpoint being created. | 1024 | int +| **bridgeErrorHandler** (consumer) | 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 | boolean +| **concurrentConsumers** (consumer) | Number of concurrent threads processing exchanges. | 1 | int +| **multipleConsumers** (consumer) | Specifies whether multiple consumers are allowed. If enabled you can use Disruptor for Publish-Subscribe messaging. That is you can send a message to the queue and have each consumer receive a copy of the message. When enabled this option should be specified on every consumer endpoint. | false | boolean +| **waitStrategy** (consumer) | Defines the strategy used by consumer threads to wait on new exchanges to be published. The options allowed are:Blocking Sleeping BusySpin and Yielding. | Blocking | DisruptorWaitStrategy +| **exceptionHandler** (consumer) | 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 or ERROR level and ignored. | | ExceptionHandler +| **exchangePattern** (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern +| **blockWhenFull** (producer) | Whether a thread that sends messages to a full Disruptor will block until the ringbuffer's capacity is no longer exhausted. By default the calling thread will block and wait until the message can be accepted. By disabling this option an exception will be thrown stating that the queue is full. | false | boolean +| **producerType** (producer) | Defines the producers allowed on the Disruptor. The options allowed are: Multi to allow multiple producers and Single to enable certain optimizations only allowed when one concurrent producer (on one thread or otherwise synchronized) is active. | Multi | DisruptorProducerType +| **timeout** (producer) | Timeout (in milliseconds) before a producer will stop waiting for an asynchronous task to complete. You can disable timeout by using 0 or a negative value. | 30000 | long +| **waitForTaskToComplete** (producer) | Option to specify whether the caller should wait for the async task to complete or not before continuing. The following three options are supported: Always Never or IfReplyExpected. The first two values are self-explanatory. The last value IfReplyExpected will only wait if the message is Request Reply based. | IfReplyExpected | WaitForTaskToComplete +| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean |======================================================================= // endpoint options: END http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-dns/src/main/docs/dns-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-dns/src/main/docs/dns-component.adoc b/components/camel-dns/src/main/docs/dns-component.adoc index 6a25b3c..2e25c4c 100644 --- a/components/camel-dns/src/main/docs/dns-component.adoc +++ b/components/camel-dns/src/main/docs/dns-component.adoc @@ -60,19 +60,18 @@ with the following path and query parameters: #### Path Parameters (1 parameters): -[width="100%",cols="2,1,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |======================================================================= -| Name | Default | Java Type | Description -| dnsType | | DnsType | *Required* The type of the lookup. +| Name | Description | Default | Type +| **dnsType** | *Required* The type of the lookup. | | DnsType |======================================================================= #### Query Parameters (1 parameters): -[width="100%",cols="2,1m,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |======================================================================= -| Name | Default | Java Type | Description - 4+^s| advanced -| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). +| Name | Description | Default | Type +| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean |======================================================================= // endpoint options: END http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-docker/src/main/docs/docker-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-docker/src/main/docs/docker-component.adoc b/components/camel-docker/src/main/docs/docker-component.adoc index fa18edf..3a59a9d 100644 --- a/components/camel-docker/src/main/docs/docker-component.adoc +++ b/components/camel-docker/src/main/docs/docker-component.adoc @@ -26,13 +26,11 @@ The Docker component supports 2 options which are listed below. -[width="100%",cols="2,1m,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |======================================================================= -| Name | Default | Java Type | Description - 4+^s| advanced -| configuration | | DockerConfiguration | To use the shared docker configuration - -| resolvePropertyPlaceholders | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. +| Name | Description | Default | Type +| **configuration** (advanced) | To use the shared docker configuration | | DockerConfiguration +| **resolveProperty Placeholders** (advanced) | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | boolean |======================================================================= // component options: END @@ -46,57 +44,37 @@ with the following path and query parameters: #### Path Parameters (1 parameters): -[width="100%",cols="2,1,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |======================================================================= -| Name | Default | Java Type | Description -| operation | | DockerOperation | *Required* Which operation to use +| Name | Description | Default | Type +| **operation** | *Required* Which operation to use | | DockerOperation |======================================================================= #### Query Parameters (20 parameters): -[width="100%",cols="2,1m,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |======================================================================= -| Name | Default | Java Type | Description - -| email | | String | Email address associated with the user - -| host | localhost | String | *Required* Docker host - -| port | 2375 | Integer | *Required* Docker port - -| requestTimeout | | Integer | Request timeout for response (in seconds) - 4+^s| consumer -| bridgeErrorHandler | false | 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 or ERROR level and ignored. - 4+^s| consumer (advanced) -| exceptionHandler | | 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 or ERROR level and ignored. - -| exchangePattern | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange. - 4+^s| advanced -| cmdExecFactory | com.github.dockerjava.jaxrs.JerseyDockerCmdExecFactory | String | The fully qualified class name of the DockerCmdExecFactory implementation to use - -| followRedirectFilter | false | boolean | Whether to follow redirect filter - -| loggingFilter | false | boolean | Whether to use logging filter - -| maxPerRouteConnections | 100 | Integer | Maximum route connections - -| maxTotalConnections | 100 | Integer | Maximum total connections - -| serverAddress | https://index.docker.io/v1/ | String | Server address for docker registry. - -| socket | true | boolean | Socket connection mode - -| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). - 4+^s| security -| certPath | | String | Location containing the SSL certificate chain - -| password | | String | Password to authenticate with - -| secure | false | boolean | Use HTTPS communication - -| tlsVerify | false | boolean | Check TLS - -| username | | String | User name to authenticate with +| Name | Description | Default | Type +| **email** (common) | Email address associated with the user | | String +| **host** (common) | *Required* Docker host | localhost | String +| **port** (common) | *Required* Docker port | 2375 | Integer +| **requestTimeout** (common) | Request timeout for response (in seconds) | | Integer +| **bridgeErrorHandler** (consumer) | 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 | boolean +| **exceptionHandler** (consumer) | 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 or ERROR level and ignored. | | ExceptionHandler +| **exchangePattern** (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern +| **cmdExecFactory** (advanced) | The fully qualified class name of the DockerCmdExecFactory implementation to use | com.github.dockerjava.jaxrs.JerseyDockerCmdExecFactory | String +| **followRedirectFilter** (advanced) | Whether to follow redirect filter | false | boolean +| **loggingFilter** (advanced) | Whether to use logging filter | false | boolean +| **maxPerRouteConnections** (advanced) | Maximum route connections | 100 | Integer +| **maxTotalConnections** (advanced) | Maximum total connections | 100 | Integer +| **serverAddress** (advanced) | Server address for docker registry. | https://index.docker.io/v1/ | String +| **socket** (advanced) | Socket connection mode | true | boolean +| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean +| **certPath** (security) | Location containing the SSL certificate chain | | String +| **password** (security) | Password to authenticate with | | String +| **secure** (security) | Use HTTPS communication | false | boolean +| **tlsVerify** (security) | Check TLS | false | boolean +| **username** (security) | User name to authenticate with | | String |======================================================================= // endpoint options: END http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-dozer/src/main/docs/dozer-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-dozer/src/main/docs/dozer-component.adoc b/components/camel-dozer/src/main/docs/dozer-component.adoc index 0ce9604..e46f818 100644 --- a/components/camel-dozer/src/main/docs/dozer-component.adoc +++ b/components/camel-dozer/src/main/docs/dozer-component.adoc @@ -68,31 +68,24 @@ with the following path and query parameters: #### Path Parameters (1 parameters): -[width="100%",cols="2,1,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |======================================================================= -| Name | Default | Java Type | Description -| name | | String | *Required* A human readable name of the mapping. +| Name | Description | Default | Type +| **name** | *Required* A human readable name of the mapping. | | String |======================================================================= #### Query Parameters (7 parameters): -[width="100%",cols="2,1m,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |======================================================================= -| Name | Default | Java Type | Description - -| mappingConfiguration | | DozerBeanMapperConfiguration | The name of a DozerBeanMapperConfiguration bean in the Camel registry which should be used for configuring the Dozer mapping. This is an alternative to the mappingFile option that can be used for fine-grained control over how Dozer is configured. Remember to use a prefix in the value to indicate that the bean is in the Camel registry (e.g. myDozerConfig). - -| mappingFile | dozerBeanMapping.xml | String | The location of a Dozer configuration file. The file is loaded from the classpath by default but you can use file: classpath: or http: to load the configuration from a specific location. - -| marshalId | | String | The id of a dataFormat defined within the Camel Context to use for marshalling the mapping output to a non-Java type. - -| sourceModel | | String | Fully-qualified class name for the source type used in the mapping. If specified the input to the mapping is converted to the specified type before being mapped with Dozer. - -| targetModel | | String | *Required* Fully-qualified class name for the target type used in the mapping. - -| unmarshalId | | String | The id of a dataFormat defined within the Camel Context to use for unmarshalling the mapping input from a non-Java type. - 4+^s| advanced -| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). +| Name | Description | Default | Type +| **mappingConfiguration** (producer) | The name of a DozerBeanMapperConfiguration bean in the Camel registry which should be used for configuring the Dozer mapping. This is an alternative to the mappingFile option that can be used for fine-grained control over how Dozer is configured. Remember to use a prefix in the value to indicate that the bean is in the Camel registry (e.g. myDozerConfig). | | DozerBeanMapper Configuration +| **mappingFile** (producer) | The location of a Dozer configuration file. The file is loaded from the classpath by default but you can use file: classpath: or http: to load the configuration from a specific location. | dozerBeanMapping.xml | String +| **marshalId** (producer) | The id of a dataFormat defined within the Camel Context to use for marshalling the mapping output to a non-Java type. | | String +| **sourceModel** (producer) | Fully-qualified class name for the source type used in the mapping. If specified the input to the mapping is converted to the specified type before being mapped with Dozer. | | String +| **targetModel** (producer) | *Required* Fully-qualified class name for the target type used in the mapping. | | String +| **unmarshalId** (producer) | The id of a dataFormat defined within the Camel Context to use for unmarshalling the mapping input from a non-Java type. | | String +| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean |======================================================================= // endpoint options: END http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-drill/src/main/docs/drill-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-drill/src/main/docs/drill-component.adoc b/components/camel-drill/src/main/docs/drill-component.adoc index a714b34..d2e41c2 100644 --- a/components/camel-drill/src/main/docs/drill-component.adoc +++ b/components/camel-drill/src/main/docs/drill-component.adoc @@ -50,27 +50,22 @@ with the following path and query parameters: #### Path Parameters (1 parameters): -[width="100%",cols="2,1,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |======================================================================= -| Name | Default | Java Type | Description -| host | | String | *Required* ZooKeeper host name or IP address. Use local instead of a host name or IP address to connect to the local Drillbit +| Name | Description | Default | Type +| **host** | *Required* ZooKeeper host name or IP address. Use local instead of a host name or IP address to connect to the local Drillbit | | String |======================================================================= #### Query Parameters (5 parameters): -[width="100%",cols="2,1m,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |======================================================================= -| Name | Default | Java Type | Description - -| clusterId | | String | Cluster ID https://drill.apache.org/docs/using-the-jdbc-driver/determining-the-cluster-id - -| directory | | String | Drill directory in ZooKeeper - -| mode | ZK | DrillConnectionMode | Connection mode: zk: Zookeeper drillbit: Drillbit direct connection https://drill.apache.org/docs/using-the-jdbc-driver/ - -| port | | Integer | ZooKeeper port number - 4+^s| advanced -| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). +| Name | Description | Default | Type +| **clusterId** (producer) | Cluster ID https://drill.apache.org/docs/using-the-jdbc-driver/determining-the-cluster-id | | String +| **directory** (producer) | Drill directory in ZooKeeper | | String +| **mode** (producer) | Connection mode: zk: Zookeeper drillbit: Drillbit direct connection https://drill.apache.org/docs/using-the-jdbc-driver/ | ZK | DrillConnectionMode +| **port** (producer) | ZooKeeper port number | | Integer +| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean |======================================================================= // endpoint options: END http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-dropbox/src/main/docs/dropbox-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-dropbox/src/main/docs/dropbox-component.adoc b/components/camel-dropbox/src/main/docs/dropbox-component.adoc index 7da17a4..3281c55 100644 --- a/components/camel-dropbox/src/main/docs/dropbox-component.adoc +++ b/components/camel-dropbox/src/main/docs/dropbox-component.adoc @@ -77,41 +77,29 @@ with the following path and query parameters: #### Path Parameters (1 parameters): -[width="100%",cols="2,1,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |======================================================================= -| Name | Default | Java Type | Description -| operation | | DropboxOperation | *Required* The specific action (typically is a CRUD action) to perform on Dropbox remote folder. +| Name | Description | Default | Type +| **operation** | *Required* The specific action (typically is a CRUD action) to perform on Dropbox remote folder. | | DropboxOperation |======================================================================= #### Query Parameters (12 parameters): -[width="100%",cols="2,1m,1m,6",options="header"] -|======================================================================= -| Name | Default | Java Type | Description - -| accessToken | | String | *Required* The access token to make API requests for a specific Dropbox user - -| client | | DbxClient | To use an existing DbxClient instance as DropBox client. - -| clientIdentifier | | String | *Required* Name of the app registered to make API requests - -| localPath | | String | Folder or file to upload on Dropbox from the local filesystem. - -| newRemotePath | | String | Destination file or folder - -| query | | String | A space-separated list of sub-strings to search for. A file matches only if it contains all the sub-strings. If this option is not set all files will be matched. - -| remotePath | | String | Original file or folder to move - -| uploadMode | | DropboxUploadMode | Which mode to upload. in case of add the new file will be renamed if a file with the same name already exists on dropbox. in case of force if a file with the same name already exists on dropbox this will be overwritten. - 4+^s| consumer -| bridgeErrorHandler | false | 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 or ERROR level and ignored. - 4+^s| consumer (advanced) -| exceptionHandler | | 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 or ERROR level and ignored. - -| exchangePattern | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange. - 4+^s| advanced -| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). +[width="100%",cols="2,5,^1,2",options="header"] +|======================================================================= +| Name | Description | Default | Type +| **accessToken** (common) | *Required* The access token to make API requests for a specific Dropbox user | | String +| **client** (common) | To use an existing DbxClient instance as DropBox client. | | DbxClient +| **clientIdentifier** (common) | *Required* Name of the app registered to make API requests | | String +| **localPath** (common) | Folder or file to upload on Dropbox from the local filesystem. | | String +| **newRemotePath** (common) | Destination file or folder | | String +| **query** (common) | A space-separated list of sub-strings to search for. A file matches only if it contains all the sub-strings. If this option is not set all files will be matched. | | String +| **remotePath** (common) | Original file or folder to move | | String +| **uploadMode** (common) | Which mode to upload. in case of add the new file will be renamed if a file with the same name already exists on dropbox. in case of force if a file with the same name already exists on dropbox this will be overwritten. | | DropboxUploadMode +| **bridgeErrorHandler** (consumer) | 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 | boolean +| **exceptionHandler** (consumer) | 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 or ERROR level and ignored. | | ExceptionHandler +| **exchangePattern** (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern +| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean |======================================================================= // endpoint options: END http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-ehcache/src/main/docs/ehcache-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-ehcache/src/main/docs/ehcache-component.adoc b/components/camel-ehcache/src/main/docs/ehcache-component.adoc index aa41c03..09f7b82 100644 --- a/components/camel-ehcache/src/main/docs/ehcache-component.adoc +++ b/components/camel-ehcache/src/main/docs/ehcache-component.adoc @@ -51,47 +51,32 @@ with the following path and query parameters: #### Path Parameters (1 parameters): -[width="100%",cols="2,1,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |======================================================================= -| Name | Default | Java Type | Description -| cacheName | | String | *Required* the cache name +| Name | Description | Default | Type +| **cacheName** | *Required* the cache name | | String |======================================================================= #### Query Parameters (15 parameters): -[width="100%",cols="2,1m,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |======================================================================= -| Name | Default | Java Type | Description - -| cacheManager | | CacheManager | The cache manager - -| configUri | | String | URI pointing to the Ehcache XML configuration file's location - -| createCacheIfNotExist | true | boolean | Configure if a cache need to be created if it does exist or can't be pre-configured. - 4+^s| consumer -| bridgeErrorHandler | false | 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 or ERROR level and ignored. - -| eventFiring | ASYNCHRONOUS | EventFiring | Set the the delivery mode (synchronous asynchronous) - -| eventOrdering | ORDERED | EventOrdering | Set the the delivery mode (ordered unordered) - -| eventTypes | EVICTED,EXPIRED,REMOVED,CREATED,UPDATED | Set | Set the type of events to listen for - 4+^s| consumer (advanced) -| exceptionHandler | | 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 or ERROR level and ignored. - -| exchangePattern | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange. - 4+^s| producer -| action | | String | To configure the default cache action. If an action is set in the message header then the operation from the header takes precedence. - -| key | | Object | To configure the default action key. If a key is set in the message header then the key from the header takes precedence. - 4+^s| advanced -| configuration | | CacheConfiguration<?,?> | The default cache configuration to be used to create caches. - -| keyType | java.lang.Object | String | The cache key type default Object.class - -| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). - -| valueType | java.lang.Object | String | The cache value type default Object.class +| Name | Description | Default | Type +| **cacheManager** (common) | The cache manager | | CacheManager +| **configUri** (common) | URI pointing to the Ehcache XML configuration file's location | | String +| **createCacheIfNotExist** (common) | Configure if a cache need to be created if it does exist or can't be pre-configured. | true | boolean +| **bridgeErrorHandler** (consumer) | 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 | boolean +| **eventFiring** (consumer) | Set the the delivery mode (synchronous asynchronous) | ASYNCHRONOUS | EventFiring +| **eventOrdering** (consumer) | Set the the delivery mode (ordered unordered) | ORDERED | EventOrdering +| **eventTypes** (consumer) | Set the type of events to listen for | EVICTED,EXPIRED,REMOVED,CREATED,UPDATED | Set +| **exceptionHandler** (consumer) | 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 or ERROR level and ignored. | | ExceptionHandler +| **exchangePattern** (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern +| **action** (producer) | To configure the default cache action. If an action is set in the message header then the operation from the header takes precedence. | | String +| **key** (producer) | To configure the default action key. If a key is set in the message header then the key from the header takes precedence. | | Object +| **configuration** (advanced) | The default cache configuration to be used to create caches. | | CacheConfiguration<?,?> +| **keyType** (advanced) | The cache key type default Object.class | java.lang.Object | String +| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean +| **valueType** (advanced) | The cache value type default Object.class | java.lang.Object | String |======================================================================= // endpoint options: END http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-ejb/src/main/docs/ejb-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-ejb/src/main/docs/ejb-component.adoc b/components/camel-ejb/src/main/docs/ejb-component.adoc index bfc1395..bd0a44d 100644 --- a/components/camel-ejb/src/main/docs/ejb-component.adoc +++ b/components/camel-ejb/src/main/docs/ejb-component.adoc @@ -36,15 +36,12 @@ The EJB component supports 3 options which are listed below. -[width="100%",cols="2,1m,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |======================================================================= -| Name | Default | Java Type | Description - 4+^s| producer -| context | | Context | The Context to use for looking up the EJBs - -| properties | | Properties | Properties for creating javax.naming.Context if a context has not been configured. - 4+^s| advanced -| resolvePropertyPlaceholders | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. +| Name | Description | Default | Type +| **context** (producer) | The Context to use for looking up the EJBs | | Context +| **properties** (producer) | Properties for creating javax.naming.Context if a context has not been configured. | | Properties +| **resolveProperty Placeholders** (advanced) | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | boolean |======================================================================= // component options: END @@ -60,27 +57,22 @@ with the following path and query parameters: #### Path Parameters (1 parameters): -[width="100%",cols="2,1,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |======================================================================= -| Name | Default | Java Type | Description -| beanName | | String | *Required* Sets the name of the bean to invoke +| Name | Description | Default | Type +| **beanName** | *Required* Sets the name of the bean to invoke | | String |======================================================================= #### Query Parameters (5 parameters): -[width="100%",cols="2,1m,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |======================================================================= -| Name | Default | Java Type | Description - -| method | | String | Sets the name of the method to invoke on the bean - 4+^s| advanced -| cache | false | boolean | If enabled Camel will cache the result of the first Registry look-up. Cache can be enabled if the bean in the Registry is defined as a singleton scope. - -| multiParameterArray | false | boolean | How to treat the parameters which are passed from the message body.true means the message body should be an array of parameters. Note: This option is used internally by Camel and is not intended for end users to use. - -| parameters | | Map | Used for configuring additional properties on the bean - -| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). +| Name | Description | Default | Type +| **method** (producer) | Sets the name of the method to invoke on the bean | | String +| **cache** (advanced) | If enabled Camel will cache the result of the first Registry look-up. Cache can be enabled if the bean in the Registry is defined as a singleton scope. | false | boolean +| **multiParameterArray** (advanced) | How to treat the parameters which are passed from the message body.true means the message body should be an array of parameters. Note: This option is used internally by Camel and is not intended for end users to use. | false | boolean +| **parameters** (advanced) | Used for configuring additional properties on the bean | | Map +| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean |======================================================================= // endpoint options: END
