Class PahoMqtt5Endpoint

  • 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="3.8.0",
                 scheme="paho-mqtt5",
                 title="Paho MQTT 5",
                 category={MESSAGING,IOT},
                 syntax="paho-mqtt5:topic",
                 headersClass=PahoMqtt5Constants.class)
    public class PahoMqtt5Endpoint
    extends org.apache.camel.support.DefaultEndpoint
    Communicate with MQTT message brokers using Eclipse Paho MQTT v5 Client.
    • 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 Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      org.apache.camel.Consumer createConsumer​(org.apache.camel.Processor processor)  
      protected static org.eclipse.paho.mqttv5.client.MqttClientPersistence createMqttClientPersistence​(PahoMqtt5Configuration configuration)  
      protected org.eclipse.paho.mqttv5.client.MqttConnectionOptions createMqttConnectionOptions()  
      org.apache.camel.Producer createProducer()  
      protected static String generateClientId()  
      org.eclipse.paho.mqttv5.client.MqttClient getClient()  
      PahoMqtt5Component getComponent()  
      PahoMqtt5Configuration getConfiguration()  
      String getTopic()  
      void setClient​(org.eclipse.paho.mqttv5.client.MqttClient client)
      To use an existing mqtt client
      • Methods inherited from class org.apache.camel.support.DefaultEndpoint

        configureConsumer, configureExchange, configurePollingConsumer, configureProperties, createAsyncProducer, createEndpointUri, createExchange, createExchange, createPollingConsumer, doInit, doStart, doStop, equals, getCamelContext, 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
      • getComponent

        public PahoMqtt5Component getComponent()
        Overrides:
        getComponent in class org.apache.camel.support.DefaultEndpoint
      • getTopic

        public String getTopic()
      • createMqttConnectionOptions

        protected org.eclipse.paho.mqttv5.client.MqttConnectionOptions createMqttConnectionOptions()
      • generateClientId

        protected static String generateClientId()
      • createMqttClientPersistence

        protected static org.eclipse.paho.mqttv5.client.MqttClientPersistence createMqttClientPersistence​(PahoMqtt5Configuration configuration)
      • getClient

        public org.eclipse.paho.mqttv5.client.MqttClient getClient()
      • setClient

        public void setClient​(org.eclipse.paho.mqttv5.client.MqttClient client)
        To use an existing mqtt client