Package org.apache.camel.builder.component.dsl

Interface Dhis2ComponentBuilderFactory.Dhis2ComponentBuilder

All Superinterfaces:
ComponentBuilder<org.apache.camel.component.dhis2.Dhis2Component>
All Known Implementing Classes:
Dhis2ComponentBuilderFactory.Dhis2ComponentBuilderImpl
Enclosing interface:
Dhis2ComponentBuilderFactory
public static interface Dhis2ComponentBuilderFactory.Dhis2ComponentBuilder extends ComponentBuilder<org.apache.camel.component.dhis2.Dhis2Component>
Builder for the DHIS2 component.

  • Method Details

    • baseApiUrl

      default Dhis2ComponentBuilderFactory.Dhis2ComponentBuilder baseApiUrl(String baseApiUrl)
      DHIS2 server base API URL (e.g., https://play.dhis2.org/2.39.1.1/api). The option is a: <code>java.lang.String</code> type. Group: common
      Parameters:
      baseApiUrl - the value to set
      Returns:
      the dsl builder

    • bridgeErrorHandler

      default Dhis2ComponentBuilderFactory.Dhis2ComponentBuilder bridgeErrorHandler(boolean bridgeErrorHandler)
      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. The option is a: <code>boolean</code> type. Default: false Group: consumer
      Parameters:
      bridgeErrorHandler - the value to set
      Returns:
      the dsl builder

    • lazyStartProducer

      default Dhis2ComponentBuilderFactory.Dhis2ComponentBuilder lazyStartProducer(boolean 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. The option is a: <code>boolean</code> type. Default: false Group: producer
      Parameters:
      lazyStartProducer - the value to set
      Returns:
      the dsl builder

    • autowiredEnabled

      default Dhis2ComponentBuilderFactory.Dhis2ComponentBuilder autowiredEnabled(boolean autowiredEnabled)
      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. The option is a: <code>boolean</code> type. Default: true Group: advanced
      Parameters:
      autowiredEnabled - the value to set
      Returns:
      the dsl builder

    • client

      default Dhis2ComponentBuilderFactory.Dhis2ComponentBuilder client(org.hisp.dhis.integration.sdk.api.Dhis2Client client)
      References a user-defined org.hisp.dhis.integration.sdk.api.Dhis2Client. The option is a: <code>org.hisp.dhis.integration.sdk.api.Dhis2Client</code> type. Group: advanced
      Parameters:
      client - the value to set
      Returns:
      the dsl builder

    • configuration

      default Dhis2ComponentBuilderFactory.Dhis2ComponentBuilder configuration(org.apache.camel.component.dhis2.Dhis2Configuration configuration)
      To use the shared configuration. The option is a: <code>org.apache.camel.component.dhis2.Dhis2Configuration</code> type. Group: advanced
      Parameters:
      configuration - the value to set
      Returns:
      the dsl builder

    • password

      default Dhis2ComponentBuilderFactory.Dhis2ComponentBuilder password(String password)
      DHIS2 account password for accessing the DHIS2 API. The option is a: <code>java.lang.String</code> type. Group: security
      Parameters:
      password - the value to set
      Returns:
      the dsl builder

    • username

      default Dhis2ComponentBuilderFactory.Dhis2ComponentBuilder username(String username)
      DHIS2 account username for accessing the DHIS2 API. The option is a: <code>java.lang.String</code> type. Group: security
      Parameters:
      username - the value to set
      Returns:
      the dsl builder