Package org.apache.camel.component.influxdb

Class InfluxDbEndpoint

  • All Implemented Interfaces:
    AutoCloseable, org.apache.camel.CamelContextAware, org.apache.camel.Endpoint, org.apache.camel.IsSingleton, org.apache.camel.Service, org.apache.camel.ShutdownableService, org.apache.camel.spi.HasId, org.apache.camel.StatefulService, org.apache.camel.SuspendableService
    @UriEndpoint(firstVersion="2.18.0",
             scheme="influxdb",
             title="InfluxDB",
             syntax="influxdb:connectionBean",
             category=DATABASE,
             producerOnly=true,
             headersClass=InfluxDbConstants.class)
public class InfluxDbEndpoint
extends org.apache.camel.support.DefaultEndpoint
    Interact with InfluxDB v1, a time series database.

    • Field Summary

      • 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

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      org.apache.camel.Consumer createConsumer​(org.apache.camel.Processor processor)  
      org.apache.camel.Producer createProducer()  
      protected void doInit()  
      String getConnectionBean()  
      String getDatabaseName()  
      org.influxdb.InfluxDB getInfluxDB()  
      String getOperation()  
      String getQuery()  
      String getRetentionPolicy()  
      boolean isAutoCreateDatabase()  
      boolean isBatch()  
      boolean isCheckDatabaseExistence()  
      void setAutoCreateDatabase​(boolean autoCreateDatabase)
      Define if we want to auto create the database if it's not present
      void setBatch​(boolean batch)
      Define if this operation is a batch operation or not
      void setCheckDatabaseExistence​(boolean checkDatabaseExistence)
      Define if we want to check the database existence while starting the endpoint
      void setConnectionBean​(String connectionBean)
      Connection to the influx database, of class InfluxDB.class
      void setDatabaseName​(String databaseName)
      The name of the database where the time series will be stored
      void setInfluxDB​(org.influxdb.InfluxDB influxDB)
      The Influx DB to use
      void setOperation​(String operation)
      Define if this operation is an insert or a query
      void setQuery​(String query)
      Define the query in case of operation query
      void setRetentionPolicy​(String retentionPolicy)
      The string that defines the retention policy to the data created by the endpoint

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

        configureConsumer, configureExchange, configurePollingConsumer, configureProperties, createAsyncProducer, createEndpointUri, createExchange, createExchange, createPollingConsumer, doStart, doStop, 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, doSuspend, fail, getStatus, init, isBuild, isInit, isNew, isRunAllowed, isShutdown, isStarted, isStarting, isStartingOrStarted, isStopped, isStopping, isStoppingOrStopped, isSuspended, isSuspending, isSuspendingOrSuspended, resume, shutdown, start, stop, suspend

      • Methods inherited from interface org.apache.camel.Endpoint

        getEndpointBaseUri, isSingletonProducer

      • 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

    • Method Detail

      • createProducer

        public org.apache.camel.Producer createProducer()
                                         throws Exception
        Throws:
        Exception

      • createConsumer

        public org.apache.camel.Consumer createConsumer​(org.apache.camel.Processor processor)
                                         throws Exception
        Throws:
        Exception

      • doInit

        protected void doInit()
               throws Exception
        Overrides:
        doInit in class org.apache.camel.support.DefaultEndpoint
        Throws:
        Exception

      • getInfluxDB

        public org.influxdb.InfluxDB getInfluxDB()

      • setInfluxDB

        public void setInfluxDB​(org.influxdb.InfluxDB influxDB)
        The Influx DB to use

      • getDatabaseName

        public String getDatabaseName()

      • setDatabaseName

        public void setDatabaseName​(String databaseName)
        The name of the database where the time series will be stored

      • getRetentionPolicy

        public String getRetentionPolicy()

      • setRetentionPolicy

        public void setRetentionPolicy​(String retentionPolicy)
        The string that defines the retention policy to the data created by the endpoint

      • getConnectionBean

        public String getConnectionBean()

      • setConnectionBean

        public void setConnectionBean​(String connectionBean)
        Connection to the influx database, of class InfluxDB.class

      • isBatch

        public boolean isBatch()

      • setBatch

        public void setBatch​(boolean batch)
        Define if this operation is a batch operation or not

      • getOperation

        public String getOperation()

      • setOperation

        public void setOperation​(String operation)
        Define if this operation is an insert or a query

      • getQuery

        public String getQuery()

      • setQuery

        public void setQuery​(String query)
        Define the query in case of operation query

      • isCheckDatabaseExistence

        public boolean isCheckDatabaseExistence()

      • setCheckDatabaseExistence

        public void setCheckDatabaseExistence​(boolean checkDatabaseExistence)
        Define if we want to check the database existence while starting the endpoint

      • isAutoCreateDatabase

        public boolean isAutoCreateDatabase()

      • setAutoCreateDatabase

        public void setAutoCreateDatabase​(boolean autoCreateDatabase)
        Define if we want to auto create the database if it's not present