IEC 60870 Server

URI format

The URI syntax of the endpoint is:

iec60870-server:host:port/00-01-02-03-04

The information object address is encoded in the path in the syntax shows above. Please note that always the full, 5 octet address format is being used. Unused octets have to be filled with zero.

Configuring Options

Camel components are configured on two separate levels:

component level
endpoint level

Configuring Component Options

The component level is the highest level which holds general and common configurations that are inherited by the endpoints. For example a component may have security settings, credentials for authentication, urls for network connection and so forth.

Some components only have a few options, and others may have many. Because components typically have pre configured defaults that are commonly used, then you may often only need to configure a few options on a component; or none at all.

Configuring components can be done with the Component DSL, in a configuration file (application.properties|yaml), or directly with Java code.

Configuring Endpoint Options

Where you find yourself configuring the most is on endpoints, as endpoints often have many options, which allows you to configure what you need the endpoint to do. The options are also categorized into whether the endpoint is used as consumer (from) or as a producer (to), or used for both.

Configuring endpoints is most often done directly in the endpoint URI as path and query parameters. You can also use the Endpoint DSL and DataFormat DSL as a type safe way of configuring endpoints and data formats in Java.

A good practice when configuring options is to use Property Placeholders, which allows to not hardcode urls, port numbers, sensitive information, and other settings. In other words placeholders allows to externalize the configuration from your code, and gives more flexibility and reuse.

The following two sections lists all the options, firstly for the component followed by the endpoint.

Component Options

The IEC 60870 Server component supports 4 options, which are listed below.

Name	Description	Default	Type
defaultConnectionOptions (common)	Default connection options.		ServerOptions
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
lazyStartProducer (producer)	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	boolean
autowiredEnabled (advanced)	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.	true	boolean

Name

Description

Default

Type

defaultConnectionOptions (common)

Default connection options.

ServerOptions

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

lazyStartProducer (producer)

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

boolean

autowiredEnabled (advanced)

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.

true

boolean

Endpoint Options

The IEC 60870 Server endpoint is configured using URI syntax:

iec60870-server:uriPath

with the following path and query parameters:

Path Parameters (1 parameters)

Name	Description	Default	Type
uriPath (common)	Required The object information address.		ObjectAddress

Name

Description

Default

Type

uriPath (common)

Required The object information address.

ObjectAddress

Query Parameters (21 parameters)

Name	Description	Default	Type
dataModuleOptions (common)	Data module options.		DataModuleOptions
filterNonExecute (common)	Filter out all requests which don’t have the execute bit set.	true	boolean
protocolOptions (common)	Protocol options.		ProtocolOptions
bridgeErrorHandler (consumer (advanced))	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 (advanced))	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.		ExceptionHandler
exchangePattern (consumer (advanced))	Sets the exchange pattern when the consumer creates an exchange. Enum values: InOnly InOut		ExchangePattern
lazyStartProducer (producer (advanced))	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	boolean
acknowledgeWindow (connection)	Parameter W - Acknowledgment window.	10	short
adsuAddressType (connection)	The common ASDU address size. May be either SIZE_1 or SIZE_2. Enum values: SIZE_1 SIZE_2		ASDUAddressType
causeOfTransmissionType (connection)	The cause of transmission type. May be either SIZE_1 or SIZE_2. Enum values: SIZE_1 SIZE_2		CauseOfTransmissionType
informationObjectAddressType (connection)	The information address size. May be either SIZE_1, SIZE_2 or SIZE_3. Enum values: SIZE_1 SIZE_2 SIZE_3		InformationObjectAddressType
maxUnacknowledged (connection)	Parameter K - Maximum number of un-acknowledged messages.	15	short
timeout1 (connection)	Timeout T1 in milliseconds.	15000	int
timeout2 (connection)	Timeout T2 in milliseconds.	10000	int
timeout3 (connection)	Timeout T3 in milliseconds.	20000	int
causeSourceAddress (data)	Whether to include the source address.		byte
connectionTimeout (data)	Timeout in millis to wait for client to establish a connected connection.	10000	int
ignoreBackgroundScan (data)	Whether background scan transmissions should be ignored.	true	boolean
ignoreDaylightSavingTime (data)	Whether to ignore or respect DST.	false	boolean
timeZone (data)	The timezone to use. May be any Java time zone string.	UTC	TimeZone
connectionId (id)	An identifier grouping connection instances.		String

Name

Description

Default

Type

dataModuleOptions (common)

Data module options.

DataModuleOptions

filterNonExecute (common)

Filter out all requests which don’t have the execute bit set.

true

boolean

protocolOptions (common)

Protocol options.

ProtocolOptions

bridgeErrorHandler (consumer (advanced))

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 (advanced))

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.

ExceptionHandler

exchangePattern (consumer (advanced))

Sets the exchange pattern when the consumer creates an exchange.

Enum values:

InOnly
InOut

ExchangePattern

lazyStartProducer (producer (advanced))

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

boolean

acknowledgeWindow (connection)

Parameter W - Acknowledgment window.

10

short

adsuAddressType (connection)

The common ASDU address size. May be either SIZE_1 or SIZE_2.

Enum values:

SIZE_1
SIZE_2

ASDUAddressType

causeOfTransmissionType (connection)

The cause of transmission type. May be either SIZE_1 or SIZE_2.

Enum values:

SIZE_1
SIZE_2

CauseOfTransmissionType

informationObjectAddressType (connection)

The information address size. May be either SIZE_1, SIZE_2 or SIZE_3.

Enum values:

SIZE_1
SIZE_2
SIZE_3

InformationObjectAddressType

maxUnacknowledged (connection)

Parameter K - Maximum number of un-acknowledged messages.

15

short

timeout1 (connection)

Timeout T1 in milliseconds.

15000

int

timeout2 (connection)

Timeout T2 in milliseconds.

10000

int

timeout3 (connection)

Timeout T3 in milliseconds.

20000

int

causeSourceAddress (data)

Whether to include the source address.

byte

connectionTimeout (data)

Timeout in millis to wait for client to establish a connected connection.

10000

int

ignoreBackgroundScan (data)

Whether background scan transmissions should be ignored.

true

boolean

ignoreDaylightSavingTime (data)

Whether to ignore or respect DST.

false

boolean

timeZone (data)

The timezone to use. May be any Java time zone string.

UTC

TimeZone

connectionId (id)

An identifier grouping connection instances.

String

Message Headers

The IEC 60870 Server component supports 6 message header(s), which is/are listed below:

Name Description Default Type

Name	Description	Type
address (consumer) Constant: `ADDRESS`	The address as ObjectAddress.	ObjectAddress
value (consumer) Constant: `VALUE`	The value.	Object
informationObjectAddress (consumer) Constant: `INFORMATION_OBJECT_ADDRESS`	The address as InformationObjectAddress.	InformationObjectAddress
asduHeader (consumer) Constant: `ASDU_HEADER`	The ASDU header.	ASDUHeader
type (consumer) Constant: `TYPE`	The type.	byte
execute (consumer) Constant: `EXECUTE`	Is execute.	boolean

address (consumer)

Constant: ADDRESS

The address as ObjectAddress.

ObjectAddress

value (consumer)

Constant: VALUE

The value.

Object

informationObjectAddress (consumer)

Constant: INFORMATION_OBJECT_ADDRESS

The address as InformationObjectAddress.

InformationObjectAddress

asduHeader (consumer)

Constant: ASDU_HEADER

The ASDU header.

ASDUHeader

type (consumer)

Constant: TYPE

The type.

byte

execute (consumer)

Constant: EXECUTE

Is execute.

boolean

Spring Boot Auto-Configuration

When using iec60870-server with Spring Boot make sure to use the following Maven dependency to have support for auto configuration:

<dependency>
  <groupId>org.apache.camel.springboot</groupId>
  <artifactId>camel-iec60870-starter</artifactId>
  <version>x.x.x</version>
  <!-- use the same version as your Camel core version -->
</dependency>

The component supports 10 options, which are listed below.

Name	Description	Default	Type
camel.component.iec60870-client.autowired-enabled	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.	true	Boolean
camel.component.iec60870-client.bridge-error-handler	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
camel.component.iec60870-client.default-connection-options	Default connection options. The option is a org.apache.camel.component.iec60870.client.ClientOptions type.		ClientOptions
camel.component.iec60870-client.enabled	Whether to enable auto configuration of the iec60870-client component. This is enabled by default.		Boolean
camel.component.iec60870-client.lazy-start-producer	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	Boolean
camel.component.iec60870-server.autowired-enabled	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.	true	Boolean
camel.component.iec60870-server.bridge-error-handler	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
camel.component.iec60870-server.default-connection-options	Default connection options. The option is a org.apache.camel.component.iec60870.server.ServerOptions type.		ServerOptions
camel.component.iec60870-server.enabled	Whether to enable auto configuration of the iec60870-server component. This is enabled by default.		Boolean
camel.component.iec60870-server.lazy-start-producer	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	Boolean

Name

Description

Default

Type

camel.component.iec60870-client.autowired-enabled

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.

true

Boolean

camel.component.iec60870-client.bridge-error-handler

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

camel.component.iec60870-client.default-connection-options

Default connection options. The option is a org.apache.camel.component.iec60870.client.ClientOptions type.

ClientOptions

camel.component.iec60870-client.enabled

Whether to enable auto configuration of the iec60870-client component. This is enabled by default.

Boolean

camel.component.iec60870-client.lazy-start-producer

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

Boolean

camel.component.iec60870-server.autowired-enabled

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.

true

Boolean

camel.component.iec60870-server.bridge-error-handler

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

camel.component.iec60870-server.default-connection-options

Default connection options. The option is a org.apache.camel.component.iec60870.server.ServerOptions type.

ServerOptions

camel.component.iec60870-server.enabled

Whether to enable auto configuration of the iec60870-server component. This is enabled by default.

Boolean

camel.component.iec60870-server.lazy-start-producer

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

Boolean