Package org.apache.camel.component.smpp

Class SmppEndpoint

  • 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.2.0",
             scheme="smpp,smpps",
             title="SMPP",
             syntax="smpp:host:port",
             category=MOBILE,
             lenientProperties=true,
             headersClass=SmppConstants.class)
public class SmppEndpoint
extends org.apache.camel.support.DefaultEndpoint
    Send and receive SMS messages using a SMSC (Short Message Service Center).

    • 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)  
      protected String createEndpointUri()  
      org.apache.camel.Exchange createOnAcceptDataSm​(org.apache.camel.ExchangePattern exchangePattern, org.jsmpp.bean.DataSm dataSm, String smppMessageId)
      Create a new exchange for communicating with this endpoint from a SMSC with the specified ExchangePattern such as whether its going to be an ExchangePattern.InOnly or ExchangePattern.InOut exchange
      org.apache.camel.Exchange createOnAcceptDataSm​(org.jsmpp.bean.DataSm dataSm, String smppMessageId)
      Create a new exchange for communicating with this endpoint from a SMSC
      org.apache.camel.Exchange createOnAcceptDeliverSmExchange​(org.apache.camel.ExchangePattern exchangePattern, org.jsmpp.bean.DeliverSm deliverSm)
      Create a new exchange for communicating with this endpoint from a SMSC with the specified ExchangePattern such as whether its going to be an ExchangePattern.InOnly or ExchangePattern.InOut exchange
      org.apache.camel.Exchange createOnAcceptDeliverSmExchange​(org.jsmpp.bean.DeliverSm deliverSm)
      Create a new exchange for communicating with this endpoint from a SMSC
      org.apache.camel.Producer createProducer()  
      SmppBinding getBinding()  
      SmppConfiguration getConfiguration()
      Returns the smpp configuration
      String getConnectionString()
      Returns the connection string for the current connection which has the form: smpp://@:
      boolean isLenientProperties()  
      void setBinding​(SmppBinding binding)  

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

        configureConsumer, configureExchange, configurePollingConsumer, configureProperties, createAsyncProducer, createExchange, createExchange, createPollingConsumer, doInit, doStart, doStop, equals, getCamelContext, getComponent, getEndpointKey, getEndpointUri, getExceptionHandler, getExchangePattern, getId, getPollingConsumerBlockTimeout, getPollingConsumerQueueSize, hashCode, isAutowiredEnabled, isBridgeErrorHandler, isLazyStartProducer, 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

    • Constructor Detail

      • SmppEndpoint

        public SmppEndpoint​(String endpointUri,
                    org.apache.camel.Component component,
                    SmppConfiguration configuration)

    • Method Detail

      • createEndpointUri

        protected String createEndpointUri()
        Overrides:
        createEndpointUri in class org.apache.camel.support.DefaultEndpoint

      • isLenientProperties

        public boolean isLenientProperties()
        Specified by:
        isLenientProperties in interface org.apache.camel.Endpoint
        Overrides:
        isLenientProperties in class org.apache.camel.support.DefaultEndpoint

      • createConsumer

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

      • createProducer

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

      • createOnAcceptDeliverSmExchange

        public org.apache.camel.Exchange createOnAcceptDeliverSmExchange​(org.jsmpp.bean.DeliverSm deliverSm)
                                                          throws Exception
        Create a new exchange for communicating with this endpoint from a SMSC
        Parameters:
        deliverSm - the received message from the SMSC
        Returns:
        a new exchange
        Throws:
        Exception

      • createOnAcceptDeliverSmExchange

        public org.apache.camel.Exchange createOnAcceptDeliverSmExchange​(org.apache.camel.ExchangePattern exchangePattern,
                                                                 org.jsmpp.bean.DeliverSm deliverSm)
                                                          throws Exception
        Create a new exchange for communicating with this endpoint from a SMSC with the specified ExchangePattern such as whether its going to be an ExchangePattern.InOnly or ExchangePattern.InOut exchange
        Parameters:
        exchangePattern - the message exchange pattern for the exchange
        deliverSm - the received message from the SMSC
        Returns:
        a new exchange
        Throws:
        Exception

      • createOnAcceptDataSm

        public org.apache.camel.Exchange createOnAcceptDataSm​(org.jsmpp.bean.DataSm dataSm,
                                                      String smppMessageId)
        Create a new exchange for communicating with this endpoint from a SMSC
        Parameters:
        dataSm - the received message from the SMSC
        smppMessageId - the smpp message id which will be used in the response
        Returns:
        a new exchange

      • createOnAcceptDataSm

        public org.apache.camel.Exchange createOnAcceptDataSm​(org.apache.camel.ExchangePattern exchangePattern,
                                                      org.jsmpp.bean.DataSm dataSm,
                                                      String smppMessageId)
        Create a new exchange for communicating with this endpoint from a SMSC with the specified ExchangePattern such as whether its going to be an ExchangePattern.InOnly or ExchangePattern.InOut exchange
        Parameters:
        exchangePattern - the message exchange pattern for the exchange
        dataSm - the received message from the SMSC
        smppMessageId - the smpp message id which will be used in the response
        Returns:
        a new exchange

      • getConnectionString

        public String getConnectionString()
        Returns the connection string for the current connection which has the form: smpp://@:
        Returns:
        the connection string

      • getConfiguration

        public SmppConfiguration getConfiguration()
        Returns the smpp configuration
        Returns:
        the configuration

      • setBinding

        public void setBinding​(SmppBinding binding)