Package org.apache.camel.component.dhis2

Class Dhis2Endpoint

java.lang.Object
org.apache.camel.support.service.BaseService
org.apache.camel.support.service.ServiceSupport
org.apache.camel.support.DefaultEndpoint
org.apache.camel.support.ScheduledPollEndpoint
org.apache.camel.support.component.AbstractApiEndpoint<Dhis2ApiName,Dhis2Configuration>
org.apache.camel.component.dhis2.Dhis2Endpoint
All Implemented Interfaces:
AutoCloseable, org.apache.camel.ApiEndpoint, org.apache.camel.CamelContextAware, org.apache.camel.ComponentAware, org.apache.camel.Endpoint, org.apache.camel.IsSingleton, org.apache.camel.Service, org.apache.camel.ShutdownableService, org.apache.camel.spi.EndpointServiceLocation, org.apache.camel.spi.HasCamelContext, org.apache.camel.spi.HasId, org.apache.camel.StatefulService, org.apache.camel.support.component.PropertiesInterceptor, org.apache.camel.support.component.PropertyNamesInterceptor, org.apache.camel.SuspendableService
@UriEndpoint(firstVersion="4.0.0", scheme="dhis2", title="DHIS2", syntax="dhis2:apiName/methodName", apiSyntax="apiName/methodName", category=API) public class Dhis2Endpoint extends org.apache.camel.support.component.AbstractApiEndpoint<Dhis2ApiName,Dhis2Configuration> implements org.apache.camel.spi.EndpointServiceLocation
Leverages the DHIS2 Java SDK to integrate Apache Camel with the DHIS2 Web API.

  • Field Summary

    Fields inherited from class org.apache.camel.support.component.AbstractApiEndpoint

    apiName, inBody, log, methodHelper, methodName

    Fields inherited from class org.apache.camel.support.service.BaseService

    BUILT, FAILED, INITIALIZED, INITIALIZING, lock, NEW, SHUTDOWN, SHUTTING_DOWN, STARTED, STARTING, status, STOPPED, STOPPING, SUSPENDED, SUSPENDING

  • Constructor Summary

    Constructors
    Constructor
    Description
    Dhis2Endpoint(String uri, Dhis2Component component, Dhis2ApiName apiName, String methodName, Dhis2Configuration endpointConfiguration)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    protected void
    afterConfigureProperties()
     
    org.apache.camel.Consumer
    createConsumer(org.apache.camel.Processor processor)
     
    org.apache.camel.Producer
    createProducer()
     
    Object
    getApiProxy(org.apache.camel.support.component.ApiMethod method, Map<String,Object> args)
     
    protected org.hisp.dhis.integration.sdk.api.Dhis2Client
    getClient()
     
    protected org.apache.camel.support.component.ApiMethodPropertiesHelper<Dhis2Configuration>
    getPropertiesHelper()
     
    Map<String,String>
    getServiceMetadata()
     
    String
    getServiceProtocol()
     
    String
    getServiceUrl()
     
    protected String
    getThreadProfileName()
     

    Methods inherited from class org.apache.camel.support.component.AbstractApiEndpoint

    configureConsumer, configureProperties, getApiName, getCandidates, getConfiguration, getConfigurationProperties, getConfigurationPropertyNames, getEndpointProperties, getEndpointPropertyNames, getExecutorService, getInBody, getMethodHelper, getMethodName, interceptProperties, interceptPropertyNames, setInBody

    Methods inherited from class org.apache.camel.support.ScheduledPollEndpoint

    configureScheduledPollConsumerProperties, doConfigureConsumer, getBackoffErrorThreshold, getBackoffIdleThreshold, getBackoffMultiplier, getDefaultDelay, getDelay, getInitialDelay, getPollStrategy, getRepeatCount, getRunLoggingLevel, getScheduledExecutorService, getScheduler, getSchedulerProperties, getTimeUnit, isGreedy, isSendEmptyMessageWhenIdle, isStartScheduler, isUseFixedDelay, setBackoffErrorThreshold, setBackoffIdleThreshold, setBackoffMultiplier, setDelay, setGreedy, setInitialDelay, setPollStrategy, setRepeatCount, setRunLoggingLevel, setScheduledExecutorService, setScheduler, setSchedulerProperties, setSendEmptyMessageWhenIdle, setStartScheduler, setTimeUnit, setUseFixedDelay

    Methods inherited from class org.apache.camel.support.DefaultEndpoint

    configureExchange, configurePollingConsumer, createAsyncProducer, createEndpointUri, createExchange, createExchange, createPollingConsumer, doInit, equals, getCamelContext, getComponent, getEndpointKey, getEndpointUri, getExceptionHandler, getExchangePattern, getId, getPollingConsumerBlockTimeout, getPollingConsumerQueueSize, hashCode, isAutowiredEnabled, isBridgeErrorHandler, isLazyStartProducer, isLenientProperties, isPollingConsumerBlockWhenFull, isPollingConsumerCopy, isSingleton, setAutowiredEnabled, setBridgeErrorHandler, setCamelContext, setComponent, setEndpointUri, setEndpointUriIfNotSpecified, setExceptionHandler, setExchangePattern, setLazyStartProducer, setPollingConsumerBlockTimeout, setPollingConsumerBlockWhenFull, setPollingConsumerCopy, setPollingConsumerQueueSize, setProperties, toString

    Methods inherited from class org.apache.camel.support.service.BaseService

    build, doBuild, doFail, doLifecycleChange, doResume, doShutdown, doStart, doStop, doSuspend, fail, getInternalLock, getStatus, init, isBuild, isInit, isNew, isRunAllowed, isShutdown, isStarted, isStarting, isStartingOrStarted, isStopped, isStopping, isStoppingOrStopped, isSuspended, isSuspending, isSuspendingOrSuspended, resume, shutdown, start, stop, suspend

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface org.apache.camel.ComponentAware

    getComponent, getComponent, setComponent

    Methods inherited from interface org.apache.camel.Endpoint

    configureExchange, createAsyncProducer, createExchange, createExchange, createPollingConsumer, getCamelContext, getEndpointBaseUri, getEndpointKey, getEndpointUri, getExchangePattern, isLenientProperties, isRemote, isSingletonProducer, setCamelContext

    Methods inherited from interface org.apache.camel.IsSingleton

    isSingleton

    Methods inherited from interface org.apache.camel.Service

    build, close, init, start, stop

    Methods inherited from interface org.apache.camel.ShutdownableService

    shutdown

    Methods inherited from interface org.apache.camel.StatefulService

    getStatus, isRunAllowed, isStarted, isStarting, isStopped, isStopping, isSuspending

    Methods inherited from interface org.apache.camel.SuspendableService

    isSuspended, resume, suspend

  • Constructor Details

  • Method Details

    • createProducer

      public org.apache.camel.Producer createProducer() throws Exception
      Specified by:
      createProducer in interface org.apache.camel.Endpoint
      Throws:
      Exception

    • createConsumer

      public org.apache.camel.Consumer createConsumer(org.apache.camel.Processor processor) throws Exception
      Specified by:
      createConsumer in interface org.apache.camel.Endpoint
      Throws:
      Exception

    • getPropertiesHelper

      protected org.apache.camel.support.component.ApiMethodPropertiesHelper<Dhis2Configuration> getPropertiesHelper()
      Specified by:
      getPropertiesHelper in class org.apache.camel.support.component.AbstractApiEndpoint<Dhis2ApiName,Dhis2Configuration>

    • getServiceUrl

      public String getServiceUrl()
      Specified by:
      getServiceUrl in interface org.apache.camel.spi.EndpointServiceLocation

    • getServiceMetadata

      public Map<String,String> getServiceMetadata()
      Specified by:
      getServiceMetadata in interface org.apache.camel.spi.EndpointServiceLocation

    • getServiceProtocol

      public String getServiceProtocol()
      Specified by:
      getServiceProtocol in interface org.apache.camel.spi.EndpointServiceLocation

    • getThreadProfileName

      protected String getThreadProfileName()
      Specified by:
      getThreadProfileName in class org.apache.camel.support.component.AbstractApiEndpoint<Dhis2ApiName,Dhis2Configuration>

    • afterConfigureProperties

      protected void afterConfigureProperties()
      Specified by:
      afterConfigureProperties in class org.apache.camel.support.component.AbstractApiEndpoint<Dhis2ApiName,Dhis2Configuration>

    • getApiProxy

      public Object getApiProxy(org.apache.camel.support.component.ApiMethod method, Map<String,Object> args)
      Specified by:
      getApiProxy in class org.apache.camel.support.component.AbstractApiEndpoint<Dhis2ApiName,Dhis2Configuration>

    • getClient

      protected org.hisp.dhis.integration.sdk.api.Dhis2Client getClient()