generated from camel.apache.org/component
489 lines
16 KiB
JSON
489 lines
16 KiB
JSON
{
|
|
"component": {
|
|
"kind": "component",
|
|
"name": "iec60870-server",
|
|
"title": "IEC 60870 Server",
|
|
"description": "IEC 60870 supervisory control and data acquisition (SCADA) server using NeoSCADA implementation.",
|
|
"deprecated": false,
|
|
"firstVersion": "2.20.0",
|
|
"label": "iot",
|
|
"javaType": "org.apache.camel.component.iec60870.server.ServerComponent",
|
|
"supportLevel": "Stable",
|
|
"groupId": "org.apache.camel",
|
|
"artifactId": "camel-iec60870",
|
|
"version": "4.10.2",
|
|
"scheme": "iec60870-server",
|
|
"extendsScheme": "",
|
|
"syntax": "iec60870-server:uriPath",
|
|
"async": false,
|
|
"api": false,
|
|
"consumerOnly": false,
|
|
"producerOnly": false,
|
|
"lenientProperties": false,
|
|
"browsable": false,
|
|
"remote": true
|
|
},
|
|
"headers": {
|
|
"address": {
|
|
"index": 0,
|
|
"kind": "header",
|
|
"displayName": "",
|
|
"group": "consumer",
|
|
"label": "consumer",
|
|
"required": false,
|
|
"javaType": "org.apache.camel.component.iec60870.ObjectAddress",
|
|
"deprecated": false,
|
|
"deprecationNote": "",
|
|
"autowired": false,
|
|
"secret": false,
|
|
"description": "The address as ObjectAddress",
|
|
"constantName": "org.apache.camel.component.iec60870.Constants#ADDRESS"
|
|
},
|
|
"value": {
|
|
"index": 1,
|
|
"kind": "header",
|
|
"displayName": "",
|
|
"group": "consumer",
|
|
"label": "consumer",
|
|
"required": false,
|
|
"javaType": "Object",
|
|
"deprecated": false,
|
|
"deprecationNote": "",
|
|
"autowired": false,
|
|
"secret": false,
|
|
"description": "The value",
|
|
"constantName": "org.apache.camel.component.iec60870.Constants#VALUE"
|
|
},
|
|
"informationObjectAddress": {
|
|
"index": 2,
|
|
"kind": "header",
|
|
"displayName": "",
|
|
"group": "consumer",
|
|
"label": "consumer",
|
|
"required": false,
|
|
"javaType": "org.eclipse.neoscada.protocol.iec60870.asdu.types.InformationObjectAddress",
|
|
"deprecated": false,
|
|
"deprecationNote": "",
|
|
"autowired": false,
|
|
"secret": false,
|
|
"description": "The address as InformationObjectAddress",
|
|
"constantName": "org.apache.camel.component.iec60870.Constants#INFORMATION_OBJECT_ADDRESS"
|
|
},
|
|
"asduHeader": {
|
|
"index": 3,
|
|
"kind": "header",
|
|
"displayName": "",
|
|
"group": "consumer",
|
|
"label": "consumer",
|
|
"required": false,
|
|
"javaType": "org.eclipse.neoscada.protocol.iec60870.asdu.ASDUHeader",
|
|
"deprecated": false,
|
|
"deprecationNote": "",
|
|
"autowired": false,
|
|
"secret": false,
|
|
"description": "The ASDU header",
|
|
"constantName": "org.apache.camel.component.iec60870.Constants#ASDU_HEADER"
|
|
},
|
|
"type": {
|
|
"index": 4,
|
|
"kind": "header",
|
|
"displayName": "",
|
|
"group": "consumer",
|
|
"label": "consumer",
|
|
"required": false,
|
|
"javaType": "byte",
|
|
"deprecated": false,
|
|
"deprecationNote": "",
|
|
"autowired": false,
|
|
"secret": false,
|
|
"description": "The type",
|
|
"constantName": "org.apache.camel.component.iec60870.Constants#TYPE"
|
|
},
|
|
"execute": {
|
|
"index": 5,
|
|
"kind": "header",
|
|
"displayName": "",
|
|
"group": "consumer",
|
|
"label": "consumer",
|
|
"required": false,
|
|
"javaType": "boolean",
|
|
"deprecated": false,
|
|
"deprecationNote": "",
|
|
"autowired": false,
|
|
"secret": false,
|
|
"description": "Is execute",
|
|
"constantName": "org.apache.camel.component.iec60870.Constants#EXECUTE"
|
|
}
|
|
},
|
|
"properties": {
|
|
"uriPath": {
|
|
"index": 0,
|
|
"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": {
|
|
"index": 1,
|
|
"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"
|
|
},
|
|
"filterNonExecute": {
|
|
"index": 2,
|
|
"kind": "parameter",
|
|
"displayName": "Filter Non Execute",
|
|
"group": "common",
|
|
"label": "",
|
|
"required": false,
|
|
"type": "boolean",
|
|
"javaType": "boolean",
|
|
"deprecated": false,
|
|
"autowired": false,
|
|
"secret": false,
|
|
"defaultValue": true,
|
|
"description": "Filter out all requests which don't have the execute bit set"
|
|
},
|
|
"protocolOptions": {
|
|
"index": 3,
|
|
"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": {
|
|
"index": 4,
|
|
"kind": "parameter",
|
|
"displayName": "Bridge Error Handler",
|
|
"group": "consumer (advanced)",
|
|
"label": "consumer,advanced",
|
|
"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 (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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": {
|
|
"index": 5,
|
|
"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": {
|
|
"index": 6,
|
|
"kind": "parameter",
|
|
"displayName": "Exchange Pattern",
|
|
"group": "consumer (advanced)",
|
|
"label": "consumer,advanced",
|
|
"required": false,
|
|
"type": "object",
|
|
"javaType": "org.apache.camel.ExchangePattern",
|
|
"enum": [
|
|
"InOnly",
|
|
"InOut"
|
|
],
|
|
"deprecated": false,
|
|
"autowired": false,
|
|
"secret": false,
|
|
"description": "Sets the exchange pattern when the consumer creates an exchange."
|
|
},
|
|
"lazyStartProducer": {
|
|
"index": 7,
|
|
"kind": "parameter",
|
|
"displayName": "Lazy Start Producer",
|
|
"group": "producer (advanced)",
|
|
"label": "producer,advanced",
|
|
"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": {
|
|
"index": 8,
|
|
"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": {
|
|
"index": 9,
|
|
"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": {
|
|
"index": 10,
|
|
"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": {
|
|
"index": 11,
|
|
"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": {
|
|
"index": 12,
|
|
"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": {
|
|
"index": 13,
|
|
"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": {
|
|
"index": 14,
|
|
"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": {
|
|
"index": 15,
|
|
"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": {
|
|
"index": 16,
|
|
"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": {
|
|
"index": 17,
|
|
"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": {
|
|
"index": 18,
|
|
"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": {
|
|
"index": 19,
|
|
"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": {
|
|
"index": 20,
|
|
"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": {
|
|
"index": 21,
|
|
"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"
|
|
}
|
|
}
|
|
} |