DHIS2

Leverages the DHIS2 Java SDK to integrate Apache Camel with the DHIS2 Web API.

What’s inside

DHIS2 component, URI syntax: dhis2:apiName/methodName

Please refer to the above links for usage and configuration details.

Maven coordinates

<dependency>
    <groupId>org.apache.camel.springboot</groupId>
    <artifactId>camel-dhis2-starter</artifactId>
</dependency>

Spring Boot Auto-Configuration

The starter supports 10 options, which are listed below.

Name	Description	Default	Type
camel.component.dhis2.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.dhis2.base-api-url	DHIS2 server base API URL (e.g., https://play.dhis2.org/2.39.1.1/api)		String
camel.component.dhis2.bridge-error-handler	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.	false	Boolean
camel.component.dhis2.client	References a user-defined org.hisp.dhis.integration.sdk.api.Dhis2Client. This option is mutually exclusive to the baseApiUrl, username, password, and personalAccessToken options. The option is a org.hisp.dhis.integration.sdk.api.Dhis2Client type.		Dhis2Client
camel.component.dhis2.configuration	To use the shared configuration. The option is a org.apache.camel.component.dhis2.Dhis2Configuration type.		Dhis2Configuration
camel.component.dhis2.enabled	Whether to enable auto configuration of the dhis2 component. This is enabled by default.		Boolean
camel.component.dhis2.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.dhis2.password	Password of the DHIS2 username		String
camel.component.dhis2.personal-access-token	Personal access token to authenticate with DHIS2. This option is mutually exclusive to username and password		String
camel.component.dhis2.username	Username of the DHIS2 user to operate as		String

Name

Description

Default

Type

camel.component.dhis2.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.dhis2.base-api-url

DHIS2 server base API URL (e.g., https://play.dhis2.org/2.39.1.1/api)

String

camel.component.dhis2.bridge-error-handler

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.

false

Boolean

camel.component.dhis2.client

References a user-defined org.hisp.dhis.integration.sdk.api.Dhis2Client. This option is mutually exclusive to the baseApiUrl, username, password, and personalAccessToken options. The option is a org.hisp.dhis.integration.sdk.api.Dhis2Client type.

Dhis2Client

camel.component.dhis2.configuration

To use the shared configuration. The option is a org.apache.camel.component.dhis2.Dhis2Configuration type.

Dhis2Configuration

camel.component.dhis2.enabled

Whether to enable auto configuration of the dhis2 component. This is enabled by default.

Boolean

camel.component.dhis2.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.dhis2.password

Password of the DHIS2 username

String

camel.component.dhis2.personal-access-token

Personal access token to authenticate with DHIS2. This option is mutually exclusive to username and password

String

camel.component.dhis2.username

Username of the DHIS2 user to operate as

String