http://git-wip-us.apache.org/repos/asf/camel/blob/4f4f2e45/components/camel-smpp/src/main/docs/smpp-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-smpp/src/main/docs/smpp-component.adoc b/components/camel-smpp/src/main/docs/smpp-component.adoc index bc166a7..1441a0e 100644 --- a/components/camel-smpp/src/main/docs/smpp-component.adoc +++ b/components/camel-smpp/src/main/docs/smpp-component.adoc @@ -1,4 +1,4 @@ -## SMPP Component +== SMPP Component *Available as of Camel version 2.2* @@ -172,11 +172,11 @@ The SMPP component supports 2 options which are listed below. [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **configuration** (advanced) | To use the shared SmppConfiguration as configuration. | | SmppConfiguration -| **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 -|======================================================================= +| *configuration* (advanced) | To use the shared SmppConfiguration as configuration. | | SmppConfiguration +| *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 @@ -187,63 +187,65 @@ The SMPP component supports 2 options which are listed below. // endpoint options: START The SMPP endpoint is configured using URI syntax: - smpp:host:port +---- +smpp:host:port +---- with the following path and query parameters: -#### Path Parameters (2 parameters): +==== Path Parameters (2 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **host** | Hostname for the SMSC server to use. | localhost | String -| **port** | Port number for the SMSC server to use. | 2775 | Integer -|======================================================================= +| *host* | Hostname for the SMSC server to use. | localhost | String +| *port* | Port number for the SMSC server to use. | 2775 | Integer +|=== -#### Query Parameters (38 parameters): +==== Query Parameters (38 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **initialReconnectDelay** (common) | Defines the initial delay in milliseconds after the consumer/producer tries to reconnect to the SMSC after the connection was lost. | 5000 | long -| **maxReconnect** (common) | Defines the maximum number of attempts to reconnect to the SMSC if SMSC returns a negative bind response | 2147483647 | int -| **reconnectDelay** (common) | Defines the interval in milliseconds between the reconnect attempts if the connection to the SMSC was lost and the previous was not succeed. | 5000 | long -| **splittingPolicy** (common) | You can specify a policy for handling long messages: ALLOW - the default long messages are split to 140 bytes per message TRUNCATE - long messages are split and only the first fragment will be sent to the SMSC. Some carriers drop subsequent fragments so this reduces load on the SMPP connection sending parts of a message that will never be delivered. REJECT - if a message would need to be split it is rejected with an SMPP NegativeResponseException and the reason code signifying the message is too long. | ALLOW | SmppSplittingPolicy -| **systemType** (common) | This parameter is used to categorize the type of ESME (External Short Message Entity) that is binding to the SMSC (max. 13 characters). | cp | String -| **addressRange** (consumer) | You can specify the address range for the SmppConsumer as defined in section 5.2.7 of the SMPP 3.4 specification. The SmppConsumer will receive messages only from SMSC's which target an address (MSISDN or IP address) within this range. | | String -| **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 -| **destAddr** (producer) | Defines the destination SME address. For mobile terminated messages this is the directory number of the recipient MS. Only for SubmitSm SubmitMulti CancelSm and DataSm. | 1717 | String -| **destAddrNpi** (producer) | Defines the type of number (TON) to be used in the SME destination address parameters. Only for SubmitSm SubmitMulti CancelSm and DataSm. The following NPI values are defined: 0: Unknown 1: ISDN (E163/E164) 2: Data (X.121) 3: Telex (F.69) 6: Land Mobile (E.212) 8: National 9: Private 10: ERMES 13: Internet (IP) 18: WAP Client Id (to be defined by WAP Forum) | | byte -| **destAddrTon** (producer) | Defines the type of number (TON) to be used in the SME destination address parameters. Only for SubmitSm SubmitMulti CancelSm and DataSm. The following TON values are defined: 0: Unknown 1: International 2: National 3: Network Specific 4: Subscriber Number 5: Alphanumeric 6: Abbreviated | | byte -| **lazySessionCreation** (producer) | Sessions can be lazily created to avoid exceptions if the SMSC is not available when the Camel producer is started. Camel will check the in message headers 'CamelSmppSystemId' and 'CamelSmppPassword' of the first exchange. If they are present Camel will use these data to connect to the SMSC. | false | boolean -| **numberingPlanIndicator** (producer) | Defines the numeric plan indicator (NPI) to be used in the SME. The following NPI values are defined: 0: Unknown 1: ISDN (E163/E164) 2: Data (X.121) 3: Telex (F.69) 6: Land Mobile (E.212) 8: National 9: Private 10: ERMES 13: Internet (IP) 18: WAP Client Id (to be defined by WAP Forum) | | byte -| **priorityFlag** (producer) | Allows the originating SME to assign a priority level to the short message. Only for SubmitSm and SubmitMulti. Four Priority Levels are supported: 0: Level 0 (lowest) priority 1: Level 1 priority 2: Level 2 priority 3: Level 3 (highest) priority | | byte -| **protocolId** (producer) | The protocol id | | byte -| **registeredDelivery** (producer) | Is used to request an SMSC delivery receipt and/or SME originated acknowledgements. The following values are defined: 0: No SMSC delivery receipt requested. 1: SMSC delivery receipt requested where final delivery outcome is success or failure. 2: SMSC delivery receipt requested where the final delivery outcome is delivery failure. | | byte -| **replaceIfPresentFlag** (producer) | Used to request the SMSC to replace a previously submitted message that is still pending delivery. The SMSC will replace an existing message provided that the source address destination address and service type match the same fields in the new message. The following replace if present flag values are defined: 0: Don't replace 1: Replace | | byte -| **serviceType** (producer) | The service type parameter can be used to indicate the SMS Application service associated with the message. The following generic service_types are defined: CMT: Cellular Messaging CPT: Cellular Paging VMN: Voice Mail Notification VMA: Voice Mail Alerting WAP: Wireless Application Protocol USSD: Unstructured Supplementary Services Data | CMT | String -| **sourceAddr** (producer) | Defines the address of SME (Short Message Entity) which originated this message. | 1616 | String -| **sourceAddrNpi** (producer) | Defines the numeric plan indicator (NPI) to be used in the SME originator address parameters. The following NPI values are defined: 0: Unknown 1: ISDN (E163/E164) 2: Data (X.121) 3: Telex (F.69) 6: Land Mobile (E.212) 8: National 9: Private 10: ERMES 13: Internet (IP) 18: WAP Client Id (to be defined by WAP Forum) | | byte -| **sourceAddrTon** (producer) | Defines the type of number (TON) to be used in the SME originator address parameters. The following TON values are defined: 0: Unknown 1: International 2: National 3: Network Specific 4: Subscriber Number 5: Alphanumeric 6: Abbreviated | | byte -| **typeOfNumber** (producer) | Defines the type of number (TON) to be used in the SME. The following TON values are defined: 0: Unknown 1: International 2: National 3: Network Specific 4: Subscriber Number 5: Alphanumeric 6: Abbreviated | | byte -| **enquireLinkTimer** (advanced) | Defines the interval in milliseconds between the confidence checks. The confidence check is used to test the communication path between an ESME and an SMSC. | 5000 | Integer -| **sessionStateListener** (advanced) | You can refer to a org.jsmpp.session.SessionStateListener in the Registry to receive callbacks when the session state changed. | | SessionStateListener -| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean -| **transactionTimer** (advanced) | Defines the maximum period of inactivity allowed after a transaction after which an SMPP entity may assume that the session is no longer active. This timer may be active on either communicating SMPP entity (i.e. SMSC or ESME). | 10000 | Integer -| **alphabet** (codec) | Defines encoding of data according the SMPP 3.4 specification section 5.2.19. 0: SMSC Default Alphabet 4: 8 bit Alphabet 8: UCS2 Alphabet | | byte -| **dataCoding** (codec) | Defines the data coding according the SMPP 3.4 specification section 5.2.19. Example data encodings are: 0: SMSC Default Alphabet 3: Latin 1 (ISO-8859-1) 4: Octet unspecified (8-bit binary) 8: UCS2 (ISO/IEC-10646) 13: Extended Kanji JIS(X 0212-1990) | | byte -| **encoding** (codec) | Defines the encoding scheme of the short message user data. Only for SubmitSm ReplaceSm and SubmitMulti. | ISO-8859-1 | String -| **httpProxyHost** (proxy) | If you need to tunnel SMPP through a HTTP proxy set this attribute to the hostname or ip address of your HTTP proxy. | | String -| **httpProxyPassword** (proxy) | If your HTTP proxy requires basic authentication set this attribute to the password required for your HTTP proxy. | | String -| **httpProxyPort** (proxy) | If you need to tunnel SMPP through a HTTP proxy set this attribute to the port of your HTTP proxy. | 3128 | Integer -| **httpProxyUsername** (proxy) | If your HTTP proxy requires basic authentication set this attribute to the username required for your HTTP proxy. | | String -| **proxyHeaders** (proxy) | These headers will be passed to the proxy server while establishing the connection. | | Map -| **password** (security) | The password for connecting to SMSC server. | | String -| **systemId** (security) | The system id (username) for connecting to SMSC server. | smppclient | String -| **usingSSL** (security) | Whether using SSL with the smpps protocol | false | boolean -|======================================================================= +| *initialReconnectDelay* (common) | Defines the initial delay in milliseconds after the consumer/producer tries to reconnect to the SMSC after the connection was lost. | 5000 | long +| *maxReconnect* (common) | Defines the maximum number of attempts to reconnect to the SMSC if SMSC returns a negative bind response | 2147483647 | int +| *reconnectDelay* (common) | Defines the interval in milliseconds between the reconnect attempts if the connection to the SMSC was lost and the previous was not succeed. | 5000 | long +| *splittingPolicy* (common) | You can specify a policy for handling long messages: ALLOW - the default long messages are split to 140 bytes per message TRUNCATE - long messages are split and only the first fragment will be sent to the SMSC. Some carriers drop subsequent fragments so this reduces load on the SMPP connection sending parts of a message that will never be delivered. REJECT - if a message would need to be split it is rejected with an SMPP NegativeResponseException and the reason code signifying the message is too long. | ALLOW | SmppSplittingPolicy +| *systemType* (common) | This parameter is used to categorize the type of ESME (External Short Message Entity) that is binding to the SMSC (max. 13 characters). | cp | String +| *addressRange* (consumer) | You can specify the address range for the SmppConsumer as defined in section 5.2.7 of the SMPP 3.4 specification. The SmppConsumer will receive messages only from SMSC's which target an address (MSISDN or IP address) within this range. | | String +| *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 +| *destAddr* (producer) | Defines the destination SME address. For mobile terminated messages this is the directory number of the recipient MS. Only for SubmitSm SubmitMulti CancelSm and DataSm. | 1717 | String +| *destAddrNpi* (producer) | Defines the type of number (TON) to be used in the SME destination address parameters. Only for SubmitSm SubmitMulti CancelSm and DataSm. The following NPI values are defined: 0: Unknown 1: ISDN (E163/E164) 2: Data (X.121) 3: Telex (F.69) 6: Land Mobile (E.212) 8: National 9: Private 10: ERMES 13: Internet (IP) 18: WAP Client Id (to be defined by WAP Forum) | | byte +| *destAddrTon* (producer) | Defines the type of number (TON) to be used in the SME destination address parameters. Only for SubmitSm SubmitMulti CancelSm and DataSm. The following TON values are defined: 0: Unknown 1: International 2: National 3: Network Specific 4: Subscriber Number 5: Alphanumeric 6: Abbreviated | | byte +| *lazySessionCreation* (producer) | Sessions can be lazily created to avoid exceptions if the SMSC is not available when the Camel producer is started. Camel will check the in message headers 'CamelSmppSystemId' and 'CamelSmppPassword' of the first exchange. If they are present Camel will use these data to connect to the SMSC. | false | boolean +| *numberingPlanIndicator* (producer) | Defines the numeric plan indicator (NPI) to be used in the SME. The following NPI values are defined: 0: Unknown 1: ISDN (E163/E164) 2: Data (X.121) 3: Telex (F.69) 6: Land Mobile (E.212) 8: National 9: Private 10: ERMES 13: Internet (IP) 18: WAP Client Id (to be defined by WAP Forum) | | byte +| *priorityFlag* (producer) | Allows the originating SME to assign a priority level to the short message. Only for SubmitSm and SubmitMulti. Four Priority Levels are supported: 0: Level 0 (lowest) priority 1: Level 1 priority 2: Level 2 priority 3: Level 3 (highest) priority | | byte +| *protocolId* (producer) | The protocol id | | byte +| *registeredDelivery* (producer) | Is used to request an SMSC delivery receipt and/or SME originated acknowledgements. The following values are defined: 0: No SMSC delivery receipt requested. 1: SMSC delivery receipt requested where final delivery outcome is success or failure. 2: SMSC delivery receipt requested where the final delivery outcome is delivery failure. | | byte +| *replaceIfPresentFlag* (producer) | Used to request the SMSC to replace a previously submitted message that is still pending delivery. The SMSC will replace an existing message provided that the source address destination address and service type match the same fields in the new message. The following replace if present flag values are defined: 0: Don't replace 1: Replace | | byte +| *serviceType* (producer) | The service type parameter can be used to indicate the SMS Application service associated with the message. The following generic service_types are defined: CMT: Cellular Messaging CPT: Cellular Paging VMN: Voice Mail Notification VMA: Voice Mail Alerting WAP: Wireless Application Protocol USSD: Unstructured Supplementary Services Data | CMT | String +| *sourceAddr* (producer) | Defines the address of SME (Short Message Entity) which originated this message. | 1616 | String +| *sourceAddrNpi* (producer) | Defines the numeric plan indicator (NPI) to be used in the SME originator address parameters. The following NPI values are defined: 0: Unknown 1: ISDN (E163/E164) 2: Data (X.121) 3: Telex (F.69) 6: Land Mobile (E.212) 8: National 9: Private 10: ERMES 13: Internet (IP) 18: WAP Client Id (to be defined by WAP Forum) | | byte +| *sourceAddrTon* (producer) | Defines the type of number (TON) to be used in the SME originator address parameters. The following TON values are defined: 0: Unknown 1: International 2: National 3: Network Specific 4: Subscriber Number 5: Alphanumeric 6: Abbreviated | | byte +| *typeOfNumber* (producer) | Defines the type of number (TON) to be used in the SME. The following TON values are defined: 0: Unknown 1: International 2: National 3: Network Specific 4: Subscriber Number 5: Alphanumeric 6: Abbreviated | | byte +| *enquireLinkTimer* (advanced) | Defines the interval in milliseconds between the confidence checks. The confidence check is used to test the communication path between an ESME and an SMSC. | 5000 | Integer +| *sessionStateListener* (advanced) | You can refer to a org.jsmpp.session.SessionStateListener in the Registry to receive callbacks when the session state changed. | | SessionStateListener +| *synchronous* (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean +| *transactionTimer* (advanced) | Defines the maximum period of inactivity allowed after a transaction after which an SMPP entity may assume that the session is no longer active. This timer may be active on either communicating SMPP entity (i.e. SMSC or ESME). | 10000 | Integer +| *alphabet* (codec) | Defines encoding of data according the SMPP 3.4 specification section 5.2.19. 0: SMSC Default Alphabet 4: 8 bit Alphabet 8: UCS2 Alphabet | | byte +| *dataCoding* (codec) | Defines the data coding according the SMPP 3.4 specification section 5.2.19. Example data encodings are: 0: SMSC Default Alphabet 3: Latin 1 (ISO-8859-1) 4: Octet unspecified (8-bit binary) 8: UCS2 (ISO/IEC-10646) 13: Extended Kanji JIS(X 0212-1990) | | byte +| *encoding* (codec) | Defines the encoding scheme of the short message user data. Only for SubmitSm ReplaceSm and SubmitMulti. | ISO-8859-1 | String +| *httpProxyHost* (proxy) | If you need to tunnel SMPP through a HTTP proxy set this attribute to the hostname or ip address of your HTTP proxy. | | String +| *httpProxyPassword* (proxy) | If your HTTP proxy requires basic authentication set this attribute to the password required for your HTTP proxy. | | String +| *httpProxyPort* (proxy) | If you need to tunnel SMPP through a HTTP proxy set this attribute to the port of your HTTP proxy. | 3128 | Integer +| *httpProxyUsername* (proxy) | If your HTTP proxy requires basic authentication set this attribute to the username required for your HTTP proxy. | | String +| *proxyHeaders* (proxy) | These headers will be passed to the proxy server while establishing the connection. | | Map +| *password* (security) | The password for connecting to SMSC server. | | String +| *systemId* (security) | The system id (username) for connecting to SMSC server. | smppclient | String +| *usingSSL* (security) | Whether using SSL with the smpps protocol | false | boolean +|=== // endpoint options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/4f4f2e45/components/camel-snakeyaml/src/main/docs/yaml-snakeyaml-dataformat.adoc ---------------------------------------------------------------------- diff --git a/components/camel-snakeyaml/src/main/docs/yaml-snakeyaml-dataformat.adoc b/components/camel-snakeyaml/src/main/docs/yaml-snakeyaml-dataformat.adoc index 15b5691..92cbe18 100644 --- a/components/camel-snakeyaml/src/main/docs/yaml-snakeyaml-dataformat.adoc +++ b/components/camel-snakeyaml/src/main/docs/yaml-snakeyaml-dataformat.adoc @@ -1,4 +1,4 @@ -## YAML SnakeYAML DataFormat +== YAML SnakeYAML DataFormat *Available as of Camel version 2.17* @@ -22,7 +22,7 @@ The YAML SnakeYAML dataformat supports 11 options which are listed below. [width="100%",cols="2s,1m,1m,6",options="header"] -|======================================================================= +|=== | Name | Default | Java Type | Description | library | SnakeYAML | YAMLLibrary | Which yaml library to use. By default it is SnakeYAML | unmarshalTypeName | | String | Class name of the java type to use when unarmshalling @@ -35,7 +35,7 @@ The YAML SnakeYAML dataformat supports 11 options which are listed below. | allowAnyType | false | Boolean | Allow any class to be un-marshaled | typeFilter | | List | Set the types SnakeYAML is allowed to un-marshall | contentTypeHeader | false | Boolean | Whether the data format should set the Content-Type header with the type from the data format if the data format is capable of doing so. For example application/xml for data formats marshalling to XML or application/json for data formats marshalling to JSon etc. -|======================================================================= +|=== // dataformat options: END WARNING: SnakeYAML can load any class from YAML definition which may lead to security breach so by default, SnakeYAML DataForma restrict the object it can load to standard Java objects like List or Long. If you want to load custom POJOs you need to add theirs type to SnakeYAML DataFormat type filter list. If your source is trusted, you can set the property allowAnyType to true so SnakeYAML DataForma won't perform any filter on the types. http://git-wip-us.apache.org/repos/asf/camel/blob/4f4f2e45/components/camel-snmp/src/main/docs/snmp-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-snmp/src/main/docs/snmp-component.adoc b/components/camel-snmp/src/main/docs/snmp-component.adoc index 100b522..cc90bca 100644 --- a/components/camel-snmp/src/main/docs/snmp-component.adoc +++ b/components/camel-snmp/src/main/docs/snmp-component.adoc @@ -1,4 +1,4 @@ -## SNMP Component +== SNMP Component *Available as of Camel version 2.1* @@ -51,59 +51,61 @@ The SNMP component has no options. // endpoint options: START The SNMP endpoint is configured using URI syntax: - snmp:host:port +---- +snmp:host:port +---- with the following path and query parameters: -#### Path Parameters (2 parameters): +==== Path Parameters (2 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **host** | *Required* Hostname of the SNMP enabled device | | String -| **port** | *Required* Port number of the SNMP enabled device | | Integer -|======================================================================= +| *host* | *Required* Hostname of the SNMP enabled device | | String +| *port* | *Required* Port number of the SNMP enabled device | | Integer +|=== -#### Query Parameters (34 parameters): +==== Query Parameters (34 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **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 -| **delay** (consumer) | Sets update rate in seconds | 60000 | long -| **oids** (consumer) | Defines which values you are interested in. Please have a look at the Wikipedia to get a better understanding. You may provide a single OID or a coma separated list of OIDs. Example: oids=1.3.6.1.2.1.1.3.01.3.6.1.2.1.25.3.2.1.5.11.3.6.1.2.1.25.3.5.1.1.11.3.6.1.2.1.43.5.1.1.11.1 | | String -| **protocol** (consumer) | Here you can select which protocol to use. You can use either udp or tcp. | udp | String -| **retries** (consumer) | Defines how often a retry is made before canceling the request. | 2 | int -| **sendEmptyMessageWhenIdle** (consumer) | If the polling consumer did not poll any files you can enable this option to send an empty message (no body) instead. | false | boolean -| **snmpCommunity** (consumer) | Sets the community octet string for the snmp request. | public | String -| **snmpContextEngineId** (consumer) | Sets the context engine ID field of the scoped PDU. | | String -| **snmpContextName** (consumer) | Sets the context name field of this scoped PDU. | | String -| **snmpVersion** (consumer) | Sets the snmp version for the request. The value 0 means SNMPv1 1 means SNMPv2c and the value 3 means SNMPv3 | 0 | int -| **timeout** (consumer) | Sets the timeout value for the request in millis. | 1500 | int -| **type** (consumer) | Which operation to perform such as poll trap etc. | | SnmpActionType -| **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 -| **pollStrategy** (consumer) | A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel. | | PollingConsumerPoll Strategy -| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean -| **backoffErrorThreshold** (scheduler) | The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in. | | int -| **backoffIdleThreshold** (scheduler) | The number of subsequent idle polls that should happen before the backoffMultipler should kick-in. | | int -| **backoffMultiplier** (scheduler) | To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured. | | int -| **greedy** (scheduler) | If greedy is enabled then the ScheduledPollConsumer will run immediately again if the previous run polled 1 or more messages. | false | boolean -| **initialDelay** (scheduler) | Milliseconds before the first poll starts. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour). | 1000 | long -| **runLoggingLevel** (scheduler) | The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that. | TRACE | LoggingLevel -| **scheduledExecutorService** (scheduler) | Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool. | | ScheduledExecutor Service -| **scheduler** (scheduler) | To use a cron scheduler from either camel-spring or camel-quartz2 component | none | ScheduledPollConsumer Scheduler -| **schedulerProperties** (scheduler) | To configure additional properties when using a custom scheduler or any of the Quartz2 Spring based scheduler. | | Map -| **startScheduler** (scheduler) | Whether the scheduler should be auto started. | true | boolean -| **timeUnit** (scheduler) | Time unit for initialDelay and delay options. | MILLISECONDS | TimeUnit -| **useFixedDelay** (scheduler) | Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details. | true | boolean -| **authenticationPassphrase** (security) | The authentication passphrase. If not null authenticationProtocol must also be not null. RFC3414 11.2 requires passphrases to have a minimum length of 8 bytes. If the length of authenticationPassphrase is less than 8 bytes an IllegalArgumentException is thrown. | | String -| **authenticationProtocol** (security) | Authentication protocol to use if security level is set to enable authentication The possible values are: MD5 SHA1 | | String -| **privacyPassphrase** (security) | The privacy passphrase. If not null privacyProtocol must also be not null. RFC3414 11.2 requires passphrases to have a minimum length of 8 bytes. If the length of authenticationPassphrase is less than 8 bytes an IllegalArgumentException is thrown. | | String -| **privacyProtocol** (security) | The privacy protocol ID to be associated with this user. If set to null this user only supports unencrypted messages. | | String -| **securityLevel** (security) | Sets the security level for this target. The supplied security level must be supported by the security model dependent information associated with the security name set for this target. The value 1 means: No authentication and no encryption. Anyone can create and read messages with this security level The value 2 means: Authentication and no encryption. Only the one with the right authentication key can create messages with this security level but anyone can read the contents of the message. The value 3 means: Authentication and encryption. Only the one with the right authentication key can create messages with this security level and only the one with the right encryption/decryption key can read the contents of the message. | 3 | int -| **securityName** (security) | Sets the security name to be used with this target. | | String -|======================================================================= +| *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 +| *delay* (consumer) | Sets update rate in seconds | 60000 | long +| *oids* (consumer) | Defines which values you are interested in. Please have a look at the Wikipedia to get a better understanding. You may provide a single OID or a coma separated list of OIDs. Example: oids=1.3.6.1.2.1.1.3.01.3.6.1.2.1.25.3.2.1.5.11.3.6.1.2.1.25.3.5.1.1.11.3.6.1.2.1.43.5.1.1.11.1 | | String +| *protocol* (consumer) | Here you can select which protocol to use. You can use either udp or tcp. | udp | String +| *retries* (consumer) | Defines how often a retry is made before canceling the request. | 2 | int +| *sendEmptyMessageWhenIdle* (consumer) | If the polling consumer did not poll any files you can enable this option to send an empty message (no body) instead. | false | boolean +| *snmpCommunity* (consumer) | Sets the community octet string for the snmp request. | public | String +| *snmpContextEngineId* (consumer) | Sets the context engine ID field of the scoped PDU. | | String +| *snmpContextName* (consumer) | Sets the context name field of this scoped PDU. | | String +| *snmpVersion* (consumer) | Sets the snmp version for the request. The value 0 means SNMPv1 1 means SNMPv2c and the value 3 means SNMPv3 | 0 | int +| *timeout* (consumer) | Sets the timeout value for the request in millis. | 1500 | int +| *type* (consumer) | Which operation to perform such as poll trap etc. | | SnmpActionType +| *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 +| *pollStrategy* (consumer) | A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel. | | PollingConsumerPoll Strategy +| *synchronous* (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean +| *backoffErrorThreshold* (scheduler) | The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in. | | int +| *backoffIdleThreshold* (scheduler) | The number of subsequent idle polls that should happen before the backoffMultipler should kick-in. | | int +| *backoffMultiplier* (scheduler) | To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured. | | int +| *greedy* (scheduler) | If greedy is enabled then the ScheduledPollConsumer will run immediately again if the previous run polled 1 or more messages. | false | boolean +| *initialDelay* (scheduler) | Milliseconds before the first poll starts. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour). | 1000 | long +| *runLoggingLevel* (scheduler) | The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that. | TRACE | LoggingLevel +| *scheduledExecutorService* (scheduler) | Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool. | | ScheduledExecutor Service +| *scheduler* (scheduler) | To use a cron scheduler from either camel-spring or camel-quartz2 component | none | ScheduledPollConsumer Scheduler +| *schedulerProperties* (scheduler) | To configure additional properties when using a custom scheduler or any of the Quartz2 Spring based scheduler. | | Map +| *startScheduler* (scheduler) | Whether the scheduler should be auto started. | true | boolean +| *timeUnit* (scheduler) | Time unit for initialDelay and delay options. | MILLISECONDS | TimeUnit +| *useFixedDelay* (scheduler) | Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details. | true | boolean +| *authenticationPassphrase* (security) | The authentication passphrase. If not null authenticationProtocol must also be not null. RFC3414 11.2 requires passphrases to have a minimum length of 8 bytes. If the length of authenticationPassphrase is less than 8 bytes an IllegalArgumentException is thrown. | | String +| *authenticationProtocol* (security) | Authentication protocol to use if security level is set to enable authentication The possible values are: MD5 SHA1 | | String +| *privacyPassphrase* (security) | The privacy passphrase. If not null privacyProtocol must also be not null. RFC3414 11.2 requires passphrases to have a minimum length of 8 bytes. If the length of authenticationPassphrase is less than 8 bytes an IllegalArgumentException is thrown. | | String +| *privacyProtocol* (security) | The privacy protocol ID to be associated with this user. If set to null this user only supports unencrypted messages. | | String +| *securityLevel* (security) | Sets the security level for this target. The supplied security level must be supported by the security model dependent information associated with the security name set for this target. The value 1 means: No authentication and no encryption. Anyone can create and read messages with this security level The value 2 means: Authentication and no encryption. Only the one with the right authentication key can create messages with this security level but anyone can read the contents of the message. The value 3 means: Authentication and encryption. Only the one with the right authentication key can create messages with this security level and only the one with the right encryption/decryption key can read the contents of the message. | 3 | int +| *securityName* (security) | Sets the security name to be used with this target. | | String +|=== // endpoint options: END ### The result of a poll http://git-wip-us.apache.org/repos/asf/camel/blob/4f4f2e45/components/camel-soap/src/main/docs/soapjaxb-dataformat.adoc ---------------------------------------------------------------------- diff --git a/components/camel-soap/src/main/docs/soapjaxb-dataformat.adoc b/components/camel-soap/src/main/docs/soapjaxb-dataformat.adoc index c2e488b..190815f 100644 --- a/components/camel-soap/src/main/docs/soapjaxb-dataformat.adoc +++ b/components/camel-soap/src/main/docs/soapjaxb-dataformat.adoc @@ -1,4 +1,4 @@ -## SOAP DataFormat +== SOAP DataFormat *Available as of Camel version 2.3* @@ -25,7 +25,7 @@ The SOAP dataformat supports 7 options which are listed below. [width="100%",cols="2s,1m,1m,6",options="header"] -|======================================================================= +|=== | Name | Default | Java Type | Description | contextPath | | String | Package name where your JAXB classes are located. | encoding | | String | To overrule and use a specific encoding @@ -34,7 +34,7 @@ The SOAP dataformat supports 7 options which are listed below. | namespacePrefixRef | | String | When marshalling using JAXB or SOAP then the JAXB implementation will automatic assign namespace prefixes such as ns2 ns3 ns4 etc. To control this mapping Camel allows you to refer to a map which contains the desired mapping. | schema | | String | To validate against an existing schema. Your can use the prefix classpath: file: or http: to specify how the resource should by resolved. You can separate multiple schema files by using the '' character. | contentTypeHeader | false | Boolean | Whether the data format should set the Content-Type header with the type from the data format if the data format is capable of doing so. For example application/xml for data formats marshalling to XML or application/json for data formats marshalling to JSon etc. -|======================================================================= +|=== // dataformat options: END http://git-wip-us.apache.org/repos/asf/camel/blob/4f4f2e45/components/camel-solr/src/main/docs/solr-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-solr/src/main/docs/solr-component.adoc b/components/camel-solr/src/main/docs/solr-component.adoc index 63da91e..130d7c9 100644 --- a/components/camel-solr/src/main/docs/solr-component.adoc +++ b/components/camel-solr/src/main/docs/solr-component.adoc @@ -1,4 +1,4 @@ -## Solr Component +== Solr Component *Available as of Camel version 2.9* @@ -42,37 +42,39 @@ The Solr component has no options. // endpoint options: START The Solr endpoint is configured using URI syntax: - solr:url +---- +solr:url +---- with the following path and query parameters: -#### Path Parameters (1 parameters): +==== Path Parameters (1 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **url** | *Required* Hostname and port for the solr server | | String -|======================================================================= +| *url* | *Required* Hostname and port for the solr server | | String +|=== -#### Query Parameters (13 parameters): +==== Query Parameters (13 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **allowCompression** (producer) | Server side must support gzip or deflate for this to have any effect | | Boolean -| **connectionTimeout** (producer) | connectionTimeout on the underlying HttpConnectionManager | | Integer -| **defaultMaxConnectionsPer Host** (producer) | maxConnectionsPerHost on the underlying HttpConnectionManager | | Integer -| **followRedirects** (producer) | indicates whether redirects are used to get to the Solr server | | Boolean -| **maxRetries** (producer) | Maximum number of retries to attempt in the event of transient errors | | Integer -| **maxTotalConnections** (producer) | maxTotalConnection on the underlying HttpConnectionManager | | Integer -| **requestHandler** (producer) | Set the request handler to be used | | String -| **soTimeout** (producer) | Read timeout on the underlying HttpConnectionManager. This is desirable for queries but probably not for indexing | | Integer -| **streamingQueueSize** (producer) | Set the queue size for the StreamingUpdateSolrServer | 10 | int -| **streamingThreadCount** (producer) | Set the number of threads for the StreamingUpdateSolrServer | 2 | int -| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean -| **collection** (solrCloud) | Set the collection name which the solrCloud server could use | | String -| **zkHost** (solrCloud) | Set the ZooKeeper host information which the solrCloud could use such as zkhost=localhost:8123. | | String -|======================================================================= +| *allowCompression* (producer) | Server side must support gzip or deflate for this to have any effect | | Boolean +| *connectionTimeout* (producer) | connectionTimeout on the underlying HttpConnectionManager | | Integer +| *defaultMaxConnectionsPer Host* (producer) | maxConnectionsPerHost on the underlying HttpConnectionManager | | Integer +| *followRedirects* (producer) | indicates whether redirects are used to get to the Solr server | | Boolean +| *maxRetries* (producer) | Maximum number of retries to attempt in the event of transient errors | | Integer +| *maxTotalConnections* (producer) | maxTotalConnection on the underlying HttpConnectionManager | | Integer +| *requestHandler* (producer) | Set the request handler to be used | | String +| *soTimeout* (producer) | Read timeout on the underlying HttpConnectionManager. This is desirable for queries but probably not for indexing | | Integer +| *streamingQueueSize* (producer) | Set the queue size for the StreamingUpdateSolrServer | 10 | int +| *streamingThreadCount* (producer) | Set the number of threads for the StreamingUpdateSolrServer | 2 | int +| *synchronous* (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean +| *collection* (solrCloud) | Set the collection name which the solrCloud server could use | | String +| *zkHost* (solrCloud) | Set the ZooKeeper host information which the solrCloud could use such as zkhost=localhost:8123. | | String +|=== // endpoint options: END http://git-wip-us.apache.org/repos/asf/camel/blob/4f4f2e45/components/camel-spark-rest/src/main/docs/spark-rest-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-spark-rest/src/main/docs/spark-rest-component.adoc b/components/camel-spark-rest/src/main/docs/spark-rest-component.adoc index c3f04d8..abdc11d 100644 --- a/components/camel-spark-rest/src/main/docs/spark-rest-component.adoc +++ b/components/camel-spark-rest/src/main/docs/spark-rest-component.adoc @@ -1,4 +1,4 @@ -## Spark Rest Component +== Spark Rest Component *Available as of Camel version 2.14* @@ -37,21 +37,21 @@ The Spark Rest component supports 12 options which are listed below. [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **port** (consumer) | Port number. Will by default use 4567 | 4567 | int -| **ipAddress** (consumer) | Set the IP address that Spark should listen on. If not called the default address is '0.0.0.0'. | 0.0.0.0 | String -| **minThreads** (advanced) | Minimum number of threads in Spark thread-pool (shared globally) | | int -| **maxThreads** (advanced) | Maximum number of threads in Spark thread-pool (shared globally) | | int -| **timeOutMillis** (advanced) | Thread idle timeout in millis where threads that has been idle for a longer period will be terminated from the thread pool | | int -| **keystoreFile** (security) | Configures connection to be secure to use the keystore file | | String -| **keystorePassword** (security) | Configures connection to be secure to use the keystore password | | String -| **truststoreFile** (security) | Configures connection to be secure to use the truststore file | | String -| **truststorePassword** (security) | Configures connection to be secure to use the truststore password | | String -| **sparkConfiguration** (advanced) | To use the shared SparkConfiguration | | SparkConfiguration -| **sparkBinding** (advanced) | To use a custom SparkBinding to map to/from Camel message. | | SparkBinding -| **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 -|======================================================================= +| *port* (consumer) | Port number. Will by default use 4567 | 4567 | int +| *ipAddress* (consumer) | Set the IP address that Spark should listen on. If not called the default address is '0.0.0.0'. | 0.0.0.0 | String +| *minThreads* (advanced) | Minimum number of threads in Spark thread-pool (shared globally) | | int +| *maxThreads* (advanced) | Maximum number of threads in Spark thread-pool (shared globally) | | int +| *timeOutMillis* (advanced) | Thread idle timeout in millis where threads that has been idle for a longer period will be terminated from the thread pool | | int +| *keystoreFile* (security) | Configures connection to be secure to use the keystore file | | String +| *keystorePassword* (security) | Configures connection to be secure to use the keystore password | | String +| *truststoreFile* (security) | Configures connection to be secure to use the truststore file | | String +| *truststorePassword* (security) | Configures connection to be secure to use the truststore password | | String +| *sparkConfiguration* (advanced) | To use the shared SparkConfiguration | | SparkConfiguration +| *sparkBinding* (advanced) | To use a custom SparkBinding to map to/from Camel message. | | SparkBinding +| *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,36 +60,38 @@ The Spark Rest component supports 12 options which are listed below. // endpoint options: START The Spark Rest endpoint is configured using URI syntax: - spark-rest:verb:path +---- +spark-rest:verb:path +---- with the following path and query parameters: -#### Path Parameters (2 parameters): +==== Path Parameters (2 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **verb** | *Required* get post put patch delete head trace connect or options. | | String -| **path** | *Required* The content path which support Spark syntax. | | String -|======================================================================= +| *verb* | *Required* get post put patch delete head trace connect or options. | | String +| *path* | *Required* The content path which support Spark syntax. | | String +|=== -#### Query Parameters (11 parameters): +==== Query Parameters (11 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **accept** (consumer) | Accept type such as: 'text/xml' or 'application/json'. By default we accept all kinds of types. | | String -| **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 -| **disableStreamCache** (consumer) | Determines whether or not the raw input stream from Spark HttpRequestgetContent() is cached or not (Camel will read the stream into a in light-weight memory based Stream caching) cache. By default Camel will cache the Netty input stream to support reading it multiple times to ensure Camel can retrieve all data from the stream. However you can set this option to true when you for example need to access the raw stream such as streaming it directly to a file or other persistent store. Mind that if you enable this option then you cannot read the Netty stream multiple times out of the box and you would need manually to reset the reader index on the Spark raw stream. | false | boolean -| **mapHeaders** (consumer) | If this option is enabled then during binding from Spark to Camel Message then the headers will be mapped as well (eg added as header to the Camel Message as well). You can turn off this option to disable this. The headers can still be accessed from the org.apache.camel.component.sparkrest.SparkMessage message with the method getRequest() that returns the Spark HTTP request instance. | true | boolean -| **transferException** (consumer) | If enabled and an Exchange failed processing on the consumer side and if the caused Exception was send back serialized in the response as a application/x-java-serialized-object content type. This is by default turned off. If you enable this then be aware that Java will deserialize the incoming data from the request to Java and that can be a potential security risk. | false | boolean -| **urlDecodeHeaders** (consumer) | If this option is enabled then during binding from Spark to Camel Message then the header values will be URL decoded (eg 20 will be a space character.) | 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 -| **matchOnUriPrefix** (advanced) | Whether or not the consumer should try to find a target consumer by matching the URI prefix if no exact match is found. | false | boolean -| **sparkBinding** (advanced) | To use a custom SparkBinding to map to/from Camel message. | | SparkBinding -| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean -|======================================================================= +| *accept* (consumer) | Accept type such as: 'text/xml' or 'application/json'. By default we accept all kinds of types. | | String +| *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 +| *disableStreamCache* (consumer) | Determines whether or not the raw input stream from Spark HttpRequestgetContent() is cached or not (Camel will read the stream into a in light-weight memory based Stream caching) cache. By default Camel will cache the Netty input stream to support reading it multiple times to ensure Camel can retrieve all data from the stream. However you can set this option to true when you for example need to access the raw stream such as streaming it directly to a file or other persistent store. Mind that if you enable this option then you cannot read the Netty stream multiple times out of the box and you would need manually to reset the reader index on the Spark raw stream. | false | boolean +| *mapHeaders* (consumer) | If this option is enabled then during binding from Spark to Camel Message then the headers will be mapped as well (eg added as header to the Camel Message as well). You can turn off this option to disable this. The headers can still be accessed from the org.apache.camel.component.sparkrest.SparkMessage message with the method getRequest() that returns the Spark HTTP request instance. | true | boolean +| *transferException* (consumer) | If enabled and an Exchange failed processing on the consumer side and if the caused Exception was send back serialized in the response as a application/x-java-serialized-object content type. This is by default turned off. If you enable this then be aware that Java will deserialize the incoming data from the request to Java and that can be a potential security risk. | false | boolean +| *urlDecodeHeaders* (consumer) | If this option is enabled then during binding from Spark to Camel Message then the header values will be URL decoded (eg 20 will be a space character.) | 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 +| *matchOnUriPrefix* (advanced) | Whether or not the consumer should try to find a target consumer by matching the URI prefix if no exact match is found. | false | boolean +| *sparkBinding* (advanced) | To use a custom SparkBinding to map to/from Camel message. | | SparkBinding +| *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/4f4f2e45/components/camel-spark/src/main/docs/spark-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-spark/src/main/docs/spark-component.adoc b/components/camel-spark/src/main/docs/spark-component.adoc index 1213150..80e062b 100644 --- a/components/camel-spark/src/main/docs/spark-component.adoc +++ b/components/camel-spark/src/main/docs/spark-component.adoc @@ -1,4 +1,4 @@ -## Apache Spark Component +== Apache Spark Component *Available as of Camel version 2.17* @@ -56,12 +56,12 @@ The Apache Spark component supports 3 options which are listed below. [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **rdd** (producer) | RDD to compute against. | | JavaRDDLike -| **rddCallback** (producer) | Function performing action against an RDD. | | RddCallback -| **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 -|======================================================================= +| *rdd* (producer) | RDD to compute against. | | JavaRDDLike +| *rddCallback* (producer) | Function performing action against an RDD. | | RddCallback +| *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 @@ -70,30 +70,32 @@ The Apache Spark component supports 3 options which are listed below. // endpoint options: START The Apache Spark endpoint is configured using URI syntax: - spark:endpointType +---- +spark:endpointType +---- with the following path and query parameters: -#### Path Parameters (1 parameters): +==== Path Parameters (1 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **endpointType** | *Required* Type of the endpoint (rdd dataframe hive). | | EndpointType -|======================================================================= +| *endpointType* | *Required* Type of the endpoint (rdd dataframe hive). | | EndpointType +|=== -#### Query Parameters (6 parameters): +==== Query Parameters (6 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **collect** (producer) | Indicates if results should be collected or counted. | true | boolean -| **dataFrame** (producer) | DataFrame to compute against. | | DataFrame -| **dataFrameCallback** (producer) | Function performing action against an DataFrame. | | DataFrameCallback -| **rdd** (producer) | RDD to compute against. | | JavaRDDLike -| **rddCallback** (producer) | Function performing action against an RDD. | | RddCallback -| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean -|======================================================================= +| *collect* (producer) | Indicates if results should be collected or counted. | true | boolean +| *dataFrame* (producer) | DataFrame to compute against. | | DataFrame +| *dataFrameCallback* (producer) | Function performing action against an DataFrame. | | DataFrameCallback +| *rdd* (producer) | RDD to compute against. | | JavaRDDLike +| *rddCallback* (producer) | Function performing action against an RDD. | | RddCallback +| *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/4f4f2e45/components/camel-splunk/src/main/docs/splunk-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-splunk/src/main/docs/splunk-component.adoc b/components/camel-splunk/src/main/docs/splunk-component.adoc index 7eac5bd..12f8c27 100644 --- a/components/camel-splunk/src/main/docs/splunk-component.adoc +++ b/components/camel-splunk/src/main/docs/splunk-component.adoc @@ -1,4 +1,4 @@ -## Splunk Component +== Splunk Component *Available as of Camel version 2.13* @@ -91,11 +91,11 @@ The Splunk component supports 2 options which are listed below. [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **splunkConfiguration Factory** (advanced) | To use the SplunkConfigurationFactory | | SplunkConfiguration Factory -| **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 -|======================================================================= +| *splunkConfiguration Factory* (advanced) | To use the SplunkConfigurationFactory | | SplunkConfiguration Factory +| *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 @@ -104,66 +104,68 @@ The Splunk component supports 2 options which are listed below. // endpoint options: START The Splunk endpoint is configured using URI syntax: - splunk:name +---- +splunk:name +---- with the following path and query parameters: -#### Path Parameters (1 parameters): +==== Path Parameters (1 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **name** | *Required* Name has no purpose | | String -|======================================================================= +| *name* | *Required* Name has no purpose | | String +|=== -#### Query Parameters (42 parameters): +==== Query Parameters (42 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **app** (common) | Splunk app | | String -| **connectionTimeout** (common) | Timeout in MS when connecting to Splunk server | 5000 | int -| **host** (common) | Splunk host. | localhost | String -| **owner** (common) | Splunk owner | | String -| **port** (common) | Splunk port | 8089 | int -| **scheme** (common) | Splunk scheme | https | String -| **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 -| **count** (consumer) | A number that indicates the maximum number of entities to return. | | int -| **earliestTime** (consumer) | Earliest time of the search time window. | | String -| **initEarliestTime** (consumer) | Initial start offset of the first search | | String -| **latestTime** (consumer) | Latest time of the search time window. | | String -| **savedSearch** (consumer) | The name of the query saved in Splunk to run | | String -| **search** (consumer) | The Splunk query to run | | String -| **sendEmptyMessageWhenIdle** (consumer) | If the polling consumer did not poll any files you can enable this option to send an empty message (no body) instead. | false | boolean -| **streaming** (consumer) | Sets streaming mode. Streaming mode sends exchanges as they are received rather than in a batch. | | 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 -| **pollStrategy** (consumer) | A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel. | | PollingConsumerPoll Strategy -| **eventHost** (producer) | Override the default Splunk event host field | | String -| **index** (producer) | Splunk index to write to | | String -| **raw** (producer) | Should the payload be inserted raw | false | boolean -| **source** (producer) | Splunk source argument | | String -| **sourceType** (producer) | Splunk sourcetype argument | | String -| **tcpReceiverPort** (producer) | Splunk tcp receiver port | | int -| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean -| **backoffErrorThreshold** (scheduler) | The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in. | | int -| **backoffIdleThreshold** (scheduler) | The number of subsequent idle polls that should happen before the backoffMultipler should kick-in. | | int -| **backoffMultiplier** (scheduler) | To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured. | | int -| **delay** (scheduler) | Milliseconds before the next poll. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour). | 500 | long -| **greedy** (scheduler) | If greedy is enabled then the ScheduledPollConsumer will run immediately again if the previous run polled 1 or more messages. | false | boolean -| **initialDelay** (scheduler) | Milliseconds before the first poll starts. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour). | 1000 | long -| **runLoggingLevel** (scheduler) | The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that. | TRACE | LoggingLevel -| **scheduledExecutorService** (scheduler) | Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool. | | ScheduledExecutor Service -| **scheduler** (scheduler) | To use a cron scheduler from either camel-spring or camel-quartz2 component | none | ScheduledPollConsumer Scheduler -| **schedulerProperties** (scheduler) | To configure additional properties when using a custom scheduler or any of the Quartz2 Spring based scheduler. | | Map -| **startScheduler** (scheduler) | Whether the scheduler should be auto started. | true | boolean -| **timeUnit** (scheduler) | Time unit for initialDelay and delay options. | MILLISECONDS | TimeUnit -| **useFixedDelay** (scheduler) | Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details. | true | boolean -| **password** (security) | Password for Splunk | | String -| **sslProtocol** (security) | Set the ssl protocol to use | TLSv1.2 | SSLSecurityProtocol -| **username** (security) | Username for Splunk | | String -| **useSunHttpsHandler** (security) | Use sun.net.www.protocol.https.Handler Https handler to establish the Splunk Connection. Can be useful when running in application servers to avoid app. server https handling. | false | boolean -|======================================================================= +| *app* (common) | Splunk app | | String +| *connectionTimeout* (common) | Timeout in MS when connecting to Splunk server | 5000 | int +| *host* (common) | Splunk host. | localhost | String +| *owner* (common) | Splunk owner | | String +| *port* (common) | Splunk port | 8089 | int +| *scheme* (common) | Splunk scheme | https | String +| *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 +| *count* (consumer) | A number that indicates the maximum number of entities to return. | | int +| *earliestTime* (consumer) | Earliest time of the search time window. | | String +| *initEarliestTime* (consumer) | Initial start offset of the first search | | String +| *latestTime* (consumer) | Latest time of the search time window. | | String +| *savedSearch* (consumer) | The name of the query saved in Splunk to run | | String +| *search* (consumer) | The Splunk query to run | | String +| *sendEmptyMessageWhenIdle* (consumer) | If the polling consumer did not poll any files you can enable this option to send an empty message (no body) instead. | false | boolean +| *streaming* (consumer) | Sets streaming mode. Streaming mode sends exchanges as they are received rather than in a batch. | | 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 +| *pollStrategy* (consumer) | A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel. | | PollingConsumerPoll Strategy +| *eventHost* (producer) | Override the default Splunk event host field | | String +| *index* (producer) | Splunk index to write to | | String +| *raw* (producer) | Should the payload be inserted raw | false | boolean +| *source* (producer) | Splunk source argument | | String +| *sourceType* (producer) | Splunk sourcetype argument | | String +| *tcpReceiverPort* (producer) | Splunk tcp receiver port | | int +| *synchronous* (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean +| *backoffErrorThreshold* (scheduler) | The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in. | | int +| *backoffIdleThreshold* (scheduler) | The number of subsequent idle polls that should happen before the backoffMultipler should kick-in. | | int +| *backoffMultiplier* (scheduler) | To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured. | | int +| *delay* (scheduler) | Milliseconds before the next poll. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour). | 500 | long +| *greedy* (scheduler) | If greedy is enabled then the ScheduledPollConsumer will run immediately again if the previous run polled 1 or more messages. | false | boolean +| *initialDelay* (scheduler) | Milliseconds before the first poll starts. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour). | 1000 | long +| *runLoggingLevel* (scheduler) | The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that. | TRACE | LoggingLevel +| *scheduledExecutorService* (scheduler) | Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool. | | ScheduledExecutor Service +| *scheduler* (scheduler) | To use a cron scheduler from either camel-spring or camel-quartz2 component | none | ScheduledPollConsumer Scheduler +| *schedulerProperties* (scheduler) | To configure additional properties when using a custom scheduler or any of the Quartz2 Spring based scheduler. | | Map +| *startScheduler* (scheduler) | Whether the scheduler should be auto started. | true | boolean +| *timeUnit* (scheduler) | Time unit for initialDelay and delay options. | MILLISECONDS | TimeUnit +| *useFixedDelay* (scheduler) | Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details. | true | boolean +| *password* (security) | Password for Splunk | | String +| *sslProtocol* (security) | Set the ssl protocol to use | TLSv1.2 | SSLSecurityProtocol +| *username* (security) | Username for Splunk | | String +| *useSunHttpsHandler* (security) | Use sun.net.www.protocol.https.Handler Https handler to establish the Splunk Connection. Can be useful when running in application servers to avoid app. server https handling. | false | boolean +|=== // endpoint options: END http://git-wip-us.apache.org/repos/asf/camel/blob/4f4f2e45/components/camel-spring-batch/src/main/docs/spring-batch-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-spring-batch/src/main/docs/spring-batch-component.adoc b/components/camel-spring-batch/src/main/docs/spring-batch-component.adoc index e996f8c..219a746 100644 --- a/components/camel-spring-batch/src/main/docs/spring-batch-component.adoc +++ b/components/camel-spring-batch/src/main/docs/spring-batch-component.adoc @@ -1,4 +1,4 @@ -## Spring Batch Component +== Spring Batch Component *Available as of Camel version 2.10* @@ -45,12 +45,12 @@ The Spring Batch component supports 3 options which are listed below. [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **jobLauncher** (producer) | Explicitly specifies a JobLauncher to be used. | | JobLauncher -| **jobRegistry** (producer) | Explicitly specifies a JobRegistry to be used. | | JobRegistry -| **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 -|======================================================================= +| *jobLauncher* (producer) | Explicitly specifies a JobLauncher to be used. | | JobLauncher +| *jobRegistry* (producer) | Explicitly specifies a JobRegistry to be used. | | JobRegistry +| *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 @@ -63,28 +63,30 @@ The Spring Batch component supports 3 options which are listed below. // endpoint options: START The Spring Batch endpoint is configured using URI syntax: - spring-batch:jobName +---- +spring-batch:jobName +---- with the following path and query parameters: -#### Path Parameters (1 parameters): +==== Path Parameters (1 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **jobName** | *Required* The name of the Spring Batch job located in the registry. | | String -|======================================================================= +| *jobName* | *Required* The name of the Spring Batch job located in the registry. | | String +|=== -#### Query Parameters (4 parameters): +==== Query Parameters (4 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **jobFromHeader** (producer) | Explicitly defines if the jobName should be taken from the headers instead of the URI. | false | boolean -| **jobLauncher** (producer) | Explicitly specifies a JobLauncher to be used. | | JobLauncher -| **jobRegistry** (producer) | Explicitly specifies a JobRegistry to be used. | | JobRegistry -| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean -|======================================================================= +| *jobFromHeader* (producer) | Explicitly defines if the jobName should be taken from the headers instead of the URI. | false | boolean +| *jobLauncher* (producer) | Explicitly specifies a JobLauncher to be used. | | JobLauncher +| *jobRegistry* (producer) | Explicitly specifies a JobRegistry to be used. | | JobRegistry +| *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/4f4f2e45/components/camel-spring-integration/src/main/docs/spring-integration-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-spring-integration/src/main/docs/spring-integration-component.adoc b/components/camel-spring-integration/src/main/docs/spring-integration-component.adoc index ab76f1c..adc509e 100644 --- a/components/camel-spring-integration/src/main/docs/spring-integration-component.adoc +++ b/components/camel-spring-integration/src/main/docs/spring-integration-component.adoc @@ -1,4 +1,4 @@ -## Spring Integration Component +== Spring Integration Component *Available as of Camel version 1.4* @@ -47,31 +47,33 @@ The Spring Integration component has no options. // endpoint options: START The Spring Integration endpoint is configured using URI syntax: - spring-integration:defaultChannel +---- +spring-integration:defaultChannel +---- with the following path and query parameters: -#### Path Parameters (1 parameters): +==== Path Parameters (1 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **defaultChannel** | *Required* The default channel name which is used by the Spring Integration Spring context. It will equal to the inputChannel name for the Spring Integration consumer and the outputChannel name for the Spring Integration provider. | | String -|======================================================================= +| *defaultChannel* | *Required* The default channel name which is used by the Spring Integration Spring context. It will equal to the inputChannel name for the Spring Integration consumer and the outputChannel name for the Spring Integration provider. | | String +|=== -#### Query Parameters (7 parameters): +==== Query Parameters (7 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **inOut** (common) | The exchange pattern that the Spring integration endpoint should use. If inOut=true then a reply channel is expected either from the Spring Integration Message header or configured on the endpoint. | 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 -| **inputChannel** (consumer) | The Spring integration input channel name that this endpoint wants to consume from Spring integration. | | 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 -| **outputChannel** (producer) | The Spring integration output channel name that is used to send messages to Spring integration. | | String -| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean -|======================================================================= +| *inOut* (common) | The exchange pattern that the Spring integration endpoint should use. If inOut=true then a reply channel is expected either from the Spring Integration Message header or configured on the endpoint. | 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 +| *inputChannel* (consumer) | The Spring integration input channel name that this endpoint wants to consume from Spring integration. | | 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 +| *outputChannel* (producer) | The Spring integration output channel name that is used to send messages to Spring integration. | | 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/4f4f2e45/components/camel-spring-ldap/src/main/docs/spring-ldap-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-spring-ldap/src/main/docs/spring-ldap-component.adoc b/components/camel-spring-ldap/src/main/docs/spring-ldap-component.adoc index dd73c70..94dc31f 100644 --- a/components/camel-spring-ldap/src/main/docs/spring-ldap-component.adoc +++ b/components/camel-spring-ldap/src/main/docs/spring-ldap-component.adoc @@ -1,4 +1,4 @@ -## Spring LDAP Component +== Spring LDAP Component *Available as of Camel version 2.11* @@ -42,27 +42,29 @@ The Spring LDAP component has no options. // endpoint options: START The Spring LDAP endpoint is configured using URI syntax: - spring-ldap:templateName +---- +spring-ldap:templateName +---- with the following path and query parameters: -#### Path Parameters (1 parameters): +==== Path Parameters (1 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **templateName** | *Required* Name of the Spring LDAP Template bean | | String -|======================================================================= +| *templateName* | *Required* Name of the Spring LDAP Template bean | | String +|=== -#### Query Parameters (3 parameters): +==== Query Parameters (3 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **operation** (producer) | *Required* The LDAP operation to be performed. | | LdapOperation -| **scope** (producer) | The scope of the search operation. | subtree | String -| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean -|======================================================================= +| *operation* (producer) | *Required* The LDAP operation to be performed. | | LdapOperation +| *scope* (producer) | The scope of the search operation. | subtree | 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
