blob: 50faf0d6f395e84cefe0746d8d9eac5ddce71a66 [file] [log] [blame]
{
"component": {
"kind": "component",
"name": "iec60870-client",
"title": "IEC 60870 Client",
"description": "IEC 60870 supervisory control and data acquisition (SCADA) client using NeoSCADA implementation.",
"deprecated": false,
"firstVersion": "2.20.0",
"label": "iot",
"javaType": "org.apache.camel.component.iec60870.client.ClientComponent",
"supportLevel": "Stable",
"groupId": "org.apache.camel.springboot",
"artifactId": "camel-iec60870-starter",
"version": "3.11.1-SNAPSHOT",
"scheme": "iec60870-client",
"extendsScheme": "",
"syntax": "iec60870-client:uriPath",
"async": false,
"api": false,
"consumerOnly": false,
"producerOnly": false,
"lenientProperties": false
},
"componentProperties": {
"defaultConnectionOptions": { "kind": "property", "displayName": "Default Connection Options", "group": "common", "label": "", "required": false, "type": "object", "javaType": "org.apache.camel.component.iec60870.client.ClientOptions", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "Default connection options" },
"bridgeErrorHandler": { "kind": "property", "displayName": "Bridge Error Handler", "group": "consumer", "label": "consumer", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "description": "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." },
"lazyStartProducer": { "kind": "property", "displayName": "Lazy Start Producer", "group": "producer", "label": "producer", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "description": "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." },
"autowiredEnabled": { "kind": "property", "displayName": "Autowired Enabled", "group": "advanced", "label": "advanced", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": true, "description": "Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching type, which then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc." }
},
"properties": {
"uriPath": { "kind": "path", "displayName": "Uri Path", "group": "common", "label": "", "required": true, "type": "object", "javaType": "org.apache.camel.component.iec60870.ObjectAddress", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "The object information address" },
"dataModuleOptions": { "kind": "parameter", "displayName": "Data Module Options", "group": "common", "label": "", "required": false, "type": "object", "javaType": "org.eclipse.neoscada.protocol.iec60870.client.data.DataModuleOptions", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.iec60870.client.ClientOptions", "configurationField": "connectionOptions", "description": "Data module options" },
"protocolOptions": { "kind": "parameter", "displayName": "Protocol Options", "group": "common", "label": "", "required": false, "type": "object", "javaType": "org.eclipse.neoscada.protocol.iec60870.ProtocolOptions", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.iec60870.client.ClientOptions", "configurationField": "connectionOptions", "description": "Protocol options" },
"bridgeErrorHandler": { "kind": "parameter", "displayName": "Bridge Error Handler", "group": "consumer", "label": "consumer", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "description": "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." },
"exceptionHandler": { "kind": "parameter", "displayName": "Exception Handler", "group": "consumer (advanced)", "label": "consumer,advanced", "required": false, "type": "object", "javaType": "org.apache.camel.spi.ExceptionHandler", "optionalPrefix": "consumer.", "deprecated": false, "autowired": false, "secret": false, "description": "To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this option is not in use. By default the consumer will deal with exceptions, that will be logged at WARN or ERROR level and ignored." },
"exchangePattern": { "kind": "parameter", "displayName": "Exchange Pattern", "group": "consumer (advanced)", "label": "consumer,advanced", "required": false, "type": "object", "javaType": "org.apache.camel.ExchangePattern", "enum": [ "InOnly", "InOut", "InOptionalOut" ], "deprecated": false, "autowired": false, "secret": false, "description": "Sets the exchange pattern when the consumer creates an exchange." },
"lazyStartProducer": { "kind": "parameter", "displayName": "Lazy Start Producer", "group": "producer", "label": "producer", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "description": "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." },
"acknowledgeWindow": { "kind": "parameter", "displayName": "Acknowledge Window", "group": "connection", "label": "connection", "required": false, "type": "integer", "javaType": "short", "deprecated": false, "autowired": false, "secret": false, "defaultValue": "10", "configurationClass": "org.apache.camel.component.iec60870.client.ClientOptions", "configurationField": "connectionOptions", "description": "Parameter W - Acknowledgment window." },
"adsuAddressType": { "kind": "parameter", "displayName": "Adsu Address Type", "group": "connection", "label": "connection", "required": false, "type": "object", "javaType": "org.eclipse.neoscada.protocol.iec60870.ASDUAddressType", "enum": [ "SIZE_1", "SIZE_2" ], "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.iec60870.client.ClientOptions", "configurationField": "connectionOptions", "description": "The common ASDU address size. May be either SIZE_1 or SIZE_2." },
"causeOfTransmissionType": { "kind": "parameter", "displayName": "Cause Of Transmission Type", "group": "connection", "label": "connection", "required": false, "type": "object", "javaType": "org.eclipse.neoscada.protocol.iec60870.CauseOfTransmissionType", "enum": [ "SIZE_1", "SIZE_2" ], "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.iec60870.client.ClientOptions", "configurationField": "connectionOptions", "description": "The cause of transmission type. May be either SIZE_1 or SIZE_2." },
"informationObjectAddressType": { "kind": "parameter", "displayName": "Information Object Address Type", "group": "connection", "label": "connection", "required": false, "type": "object", "javaType": "org.eclipse.neoscada.protocol.iec60870.InformationObjectAddressType", "enum": [ "SIZE_1", "SIZE_2", "SIZE_3" ], "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.iec60870.client.ClientOptions", "configurationField": "connectionOptions", "description": "The information address size. May be either SIZE_1, SIZE_2 or SIZE_3." },
"maxUnacknowledged": { "kind": "parameter", "displayName": "Max Unacknowledged", "group": "connection", "label": "connection", "required": false, "type": "integer", "javaType": "short", "deprecated": false, "autowired": false, "secret": false, "defaultValue": "15", "configurationClass": "org.apache.camel.component.iec60870.client.ClientOptions", "configurationField": "connectionOptions", "description": "Parameter K - Maximum number of un-acknowledged messages." },
"timeout1": { "kind": "parameter", "displayName": "Timeout1", "group": "connection", "label": "connection", "required": false, "type": "integer", "javaType": "int", "deprecated": false, "autowired": false, "secret": false, "defaultValue": 15000, "configurationClass": "org.apache.camel.component.iec60870.client.ClientOptions", "configurationField": "connectionOptions", "description": "Timeout T1 in milliseconds." },
"timeout2": { "kind": "parameter", "displayName": "Timeout2", "group": "connection", "label": "connection", "required": false, "type": "integer", "javaType": "int", "deprecated": false, "autowired": false, "secret": false, "defaultValue": 10000, "configurationClass": "org.apache.camel.component.iec60870.client.ClientOptions", "configurationField": "connectionOptions", "description": "Timeout T2 in milliseconds." },
"timeout3": { "kind": "parameter", "displayName": "Timeout3", "group": "connection", "label": "connection", "required": false, "type": "integer", "javaType": "int", "deprecated": false, "autowired": false, "secret": false, "defaultValue": 20000, "configurationClass": "org.apache.camel.component.iec60870.client.ClientOptions", "configurationField": "connectionOptions", "description": "Timeout T3 in milliseconds." },
"causeSourceAddress": { "kind": "parameter", "displayName": "Cause Source Address", "group": "data", "label": "data", "required": false, "type": "integer", "javaType": "byte", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.iec60870.client.ClientOptions", "configurationField": "connectionOptions", "description": "Whether to include the source address" },
"connectionTimeout": { "kind": "parameter", "displayName": "Connection Timeout", "group": "data", "label": "data", "required": false, "type": "integer", "javaType": "int", "deprecated": false, "autowired": false, "secret": false, "defaultValue": 10000, "configurationClass": "org.apache.camel.component.iec60870.client.ClientOptions", "configurationField": "connectionOptions", "description": "Timeout in millis to wait for client to establish a connected connection." },
"ignoreBackgroundScan": { "kind": "parameter", "displayName": "Ignore Background Scan", "group": "data", "label": "data", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": true, "configurationClass": "org.apache.camel.component.iec60870.client.ClientOptions", "configurationField": "connectionOptions", "description": "Whether background scan transmissions should be ignored." },
"ignoreDaylightSavingTime": { "kind": "parameter", "displayName": "Ignore Daylight Saving Time", "group": "data", "label": "data", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "configurationClass": "org.apache.camel.component.iec60870.client.ClientOptions", "configurationField": "connectionOptions", "description": "Whether to ignore or respect DST" },
"timeZone": { "kind": "parameter", "displayName": "Time Zone", "group": "data", "label": "data", "required": false, "type": "object", "javaType": "java.util.TimeZone", "deprecated": false, "autowired": false, "secret": false, "defaultValue": "UTC", "configurationClass": "org.apache.camel.component.iec60870.client.ClientOptions", "configurationField": "connectionOptions", "description": "The timezone to use. May be any Java time zone string" },
"connectionId": { "kind": "parameter", "displayName": "Connection Id", "group": "id", "label": "id", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "description": "An identifier grouping connection instances" }
}
}