blob: eb9e133ebdbe777d693e7a3da46f4d1b3d511672 [file] [log] [blame]
// kafka-connector options: START
[[camel-iec60870-server-kafka-connector-sink]]
= camel-iec60870-server-kafka-connector sink configuration
When using camel-iec60870-server-kafka-connector as sink make sure to use the following Maven dependency to have support for the connector:
[source,xml]
----
<dependency>
<groupId>org.apache.camel.kafkaconnector</groupId>
<artifactId>camel-iec60870-server-kafka-connector</artifactId>
<version>x.x.x</version>
<!-- use the same version as your Camel Kafka connector version -->
</dependency>
----
The camel-iec60870-server sink connector supports 24 options, which are listed below.
[width="100%",cols="2,5,^1,2",options="header"]
|===
| Name | Description | Default | Priority
| *camel.sink.path.uriPath* | The object information address | null | HIGH
| *camel.sink.endpoint.dataModuleOptions* | Data module options | null | MEDIUM
| *camel.sink.endpoint.filterNonExecute* | Filter out all requests which don't have the execute bit set | true | MEDIUM
| *camel.sink.endpoint.protocolOptions* | Protocol options | null | MEDIUM
| *camel.sink.endpoint.lazyStartProducer* | Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel's routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing. | false | MEDIUM
| *camel.sink.endpoint.basicPropertyBinding* | Whether the endpoint should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities | false | MEDIUM
| *camel.sink.endpoint.synchronous* | Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported). | false | MEDIUM
| *camel.sink.endpoint.acknowledgeWindow* | Parameter W - Acknowledgment window. | 10 | MEDIUM
| *camel.sink.endpoint.adsuAddressType* | The common ASDU address size. May be either SIZE_1 or SIZE_2. One of: [SIZE_1] [SIZE_2] | null | MEDIUM
| *camel.sink.endpoint.causeOfTransmissionType* | The cause of transmission type. May be either SIZE_1 or SIZE_2. One of: [SIZE_1] [SIZE_2] | null | MEDIUM
| *camel.sink.endpoint.informationObjectAddressType* | The information address size. May be either SIZE_1, SIZE_2 or SIZE_3. One of: [SIZE_1] [SIZE_2] [SIZE_3] | null | MEDIUM
| *camel.sink.endpoint.maxUnacknowledged* | Parameter K - Maximum number of un-acknowledged messages. | 15 | MEDIUM
| *camel.sink.endpoint.timeout1* | Timeout T1 in milliseconds. | 15000 | MEDIUM
| *camel.sink.endpoint.timeout2* | Timeout T2 in milliseconds. | 10000 | MEDIUM
| *camel.sink.endpoint.timeout3* | Timeout T3 in milliseconds. | 20000 | MEDIUM
| *camel.sink.endpoint.causeSourceAddress* | Whether to include the source address | null | MEDIUM
| *camel.sink.endpoint.connectionTimeout* | Timeout in millis to wait for client to establish a connected connection. | 10000 | MEDIUM
| *camel.sink.endpoint.ignoreBackgroundScan* | Whether background scan transmissions should be ignored. | true | MEDIUM
| *camel.sink.endpoint.ignoreDaylightSavingTime* | Whether to ignore or respect DST | false | MEDIUM
| *camel.sink.endpoint.timeZone* | The timezone to use. May be any Java time zone string | "UTC" | MEDIUM
| *camel.sink.endpoint.connectionId* | An identifier grouping connection instances | null | MEDIUM
| *camel.component.iec60870-server.defaultConnection Options* | Default connection options | null | MEDIUM
| *camel.component.iec60870-server.lazyStartProducer* | Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel's routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing. | false | MEDIUM
| *camel.component.iec60870-server.basicProperty Binding* | Whether the component should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities | false | MEDIUM
|===
// kafka-connector options: END