Package org.apache.camel.builder.endpoint.dsl

Interface SmppEndpointBuilderFactory.SmppEndpointProducerBuilder

  • All Superinterfaces:
    org.apache.camel.builder.EndpointProducerBuilder, org.apache.camel.EndpointProducerResolver
    All Known Subinterfaces:
    SmppEndpointBuilderFactory.SmppEndpointBuilder
    Enclosing interface:
    SmppEndpointBuilderFactory
    public static interface SmppEndpointBuilderFactory.SmppEndpointProducerBuilder
extends org.apache.camel.builder.EndpointProducerBuilder
    Builder for endpoint producers for the SMPP component.

    • Method Detail

      • initialReconnectDelay

        default SmppEndpointBuilderFactory.SmppEndpointProducerBuilder initialReconnectDelay​(long initialReconnectDelay)
        Defines the initial delay in milliseconds after the consumer/producer tries to reconnect to the SMSC, after the connection was lost. The option is a: <code>long</code> type. Default: 5000 Group: common
        Parameters:
        initialReconnectDelay - the value to set
        Returns:
        the dsl builder

      • initialReconnectDelay

        default SmppEndpointBuilderFactory.SmppEndpointProducerBuilder initialReconnectDelay​(String initialReconnectDelay)
        Defines the initial delay in milliseconds after the consumer/producer tries to reconnect to the SMSC, after the connection was lost. The option will be converted to a <code>long</code> type. Default: 5000 Group: common
        Parameters:
        initialReconnectDelay - the value to set
        Returns:
        the dsl builder

      • maxReconnect

        default SmppEndpointBuilderFactory.SmppEndpointProducerBuilder maxReconnect​(int maxReconnect)
        Defines the maximum number of attempts to reconnect to the SMSC, if SMSC returns a negative bind response. The option is a: <code>int</code> type. Default: 2147483647 Group: common
        Parameters:
        maxReconnect - the value to set
        Returns:
        the dsl builder

      • maxReconnect

        default SmppEndpointBuilderFactory.SmppEndpointProducerBuilder maxReconnect​(String maxReconnect)
        Defines the maximum number of attempts to reconnect to the SMSC, if SMSC returns a negative bind response. The option will be converted to a <code>int</code> type. Default: 2147483647 Group: common
        Parameters:
        maxReconnect - the value to set
        Returns:
        the dsl builder

      • reconnectDelay

        default SmppEndpointBuilderFactory.SmppEndpointProducerBuilder reconnectDelay​(long reconnectDelay)
        Defines the interval in milliseconds between the reconnect attempts, if the connection to the SMSC was lost and the previous was not succeed. The option is a: <code>long</code> type. Default: 5000 Group: common
        Parameters:
        reconnectDelay - the value to set
        Returns:
        the dsl builder

      • reconnectDelay

        default SmppEndpointBuilderFactory.SmppEndpointProducerBuilder reconnectDelay​(String reconnectDelay)
        Defines the interval in milliseconds between the reconnect attempts, if the connection to the SMSC was lost and the previous was not succeed. The option will be converted to a <code>long</code> type. Default: 5000 Group: common
        Parameters:
        reconnectDelay - the value to set
        Returns:
        the dsl builder

      • splittingPolicy

        default SmppEndpointBuilderFactory.SmppEndpointProducerBuilder splittingPolicy​(org.apache.camel.component.smpp.SmppSplittingPolicy splittingPolicy)
        You can specify a policy for handling long messages: ALLOW - the default, long messages are split to 140 bytes per message TRUNCATE - long messages are split and only the first fragment will be sent to the SMSC. Some carriers drop subsequent fragments so this reduces load on the SMPP connection sending parts of a message that will never be delivered. REJECT - if a message would need to be split, it is rejected with an SMPP NegativeResponseException and the reason code signifying the message is too long. The option is a: <code>org.apache.camel.component.smpp.SmppSplittingPolicy</code> type. Default: ALLOW Group: common
        Parameters:
        splittingPolicy - the value to set
        Returns:
        the dsl builder

      • splittingPolicy

        default SmppEndpointBuilderFactory.SmppEndpointProducerBuilder splittingPolicy​(String splittingPolicy)
        You can specify a policy for handling long messages: ALLOW - the default, long messages are split to 140 bytes per message TRUNCATE - long messages are split and only the first fragment will be sent to the SMSC. Some carriers drop subsequent fragments so this reduces load on the SMPP connection sending parts of a message that will never be delivered. REJECT - if a message would need to be split, it is rejected with an SMPP NegativeResponseException and the reason code signifying the message is too long. The option will be converted to a <code>org.apache.camel.component.smpp.SmppSplittingPolicy</code> type. Default: ALLOW Group: common
        Parameters:
        splittingPolicy - the value to set
        Returns:
        the dsl builder

      • systemType

        default SmppEndpointBuilderFactory.SmppEndpointProducerBuilder systemType​(String systemType)
        This parameter is used to categorize the type of ESME (External Short Message Entity) that is binding to the SMSC (max. 13 characters). The option is a: <code>java.lang.String</code> type. Group: common
        Parameters:
        systemType - the value to set
        Returns:
        the dsl builder

      • destAddr

        default SmppEndpointBuilderFactory.SmppEndpointProducerBuilder destAddr​(String destAddr)
        Defines the destination SME address. For mobile terminated messages, this is the directory number of the recipient MS. Only for SubmitSm, SubmitMulti, CancelSm and DataSm. The option is a: <code>java.lang.String</code> type. Default: 1717 Group: producer
        Parameters:
        destAddr - the value to set
        Returns:
        the dsl builder

      • destAddrNpi

        default SmppEndpointBuilderFactory.SmppEndpointProducerBuilder destAddrNpi​(byte destAddrNpi)
        Defines the type of number (TON) to be used in the SME destination address parameters. Only for SubmitSm, SubmitMulti, CancelSm and DataSm. The following NPI values are defined: 0: Unknown 1: ISDN (E163/E164) 2: Data (X.121) 3: Telex (F.69) 6: Land Mobile (E.212) 8: National 9: Private 10: ERMES 13: Internet (IP) 18: WAP Client Id (to be defined by WAP Forum). The option is a: <code>byte</code> type. Group: producer
        Parameters:
        destAddrNpi - the value to set
        Returns:
        the dsl builder

      • destAddrNpi

        default SmppEndpointBuilderFactory.SmppEndpointProducerBuilder destAddrNpi​(String destAddrNpi)
        Defines the type of number (TON) to be used in the SME destination address parameters. Only for SubmitSm, SubmitMulti, CancelSm and DataSm. The following NPI values are defined: 0: Unknown 1: ISDN (E163/E164) 2: Data (X.121) 3: Telex (F.69) 6: Land Mobile (E.212) 8: National 9: Private 10: ERMES 13: Internet (IP) 18: WAP Client Id (to be defined by WAP Forum). The option will be converted to a <code>byte</code> type. Group: producer
        Parameters:
        destAddrNpi - the value to set
        Returns:
        the dsl builder

      • destAddrTon

        default SmppEndpointBuilderFactory.SmppEndpointProducerBuilder destAddrTon​(byte destAddrTon)
        Defines the type of number (TON) to be used in the SME destination address parameters. Only for SubmitSm, SubmitMulti, CancelSm and DataSm. The following TON values are defined: 0: Unknown 1: International 2: National 3: Network Specific 4: Subscriber Number 5: Alphanumeric 6: Abbreviated. The option is a: <code>byte</code> type. Group: producer
        Parameters:
        destAddrTon - the value to set
        Returns:
        the dsl builder

      • destAddrTon

        default SmppEndpointBuilderFactory.SmppEndpointProducerBuilder destAddrTon​(String destAddrTon)
        Defines the type of number (TON) to be used in the SME destination address parameters. Only for SubmitSm, SubmitMulti, CancelSm and DataSm. The following TON values are defined: 0: Unknown 1: International 2: National 3: Network Specific 4: Subscriber Number 5: Alphanumeric 6: Abbreviated. The option will be converted to a <code>byte</code> type. Group: producer
        Parameters:
        destAddrTon - the value to set
        Returns:
        the dsl builder

      • lazySessionCreation

        default SmppEndpointBuilderFactory.SmppEndpointProducerBuilder lazySessionCreation​(boolean lazySessionCreation)
        Sessions can be lazily created to avoid exceptions, if the SMSC is not available when the Camel producer is started. Camel will check the in message headers 'CamelSmppSystemId' and 'CamelSmppPassword' of the first exchange. If they are present, Camel will use these data to connect to the SMSC. The option is a: <code>boolean</code> type. Default: false Group: producer
        Parameters:
        lazySessionCreation - the value to set
        Returns:
        the dsl builder

      • lazySessionCreation

        default SmppEndpointBuilderFactory.SmppEndpointProducerBuilder lazySessionCreation​(String lazySessionCreation)
        Sessions can be lazily created to avoid exceptions, if the SMSC is not available when the Camel producer is started. Camel will check the in message headers 'CamelSmppSystemId' and 'CamelSmppPassword' of the first exchange. If they are present, Camel will use these data to connect to the SMSC. The option will be converted to a <code>boolean</code> type. Default: false Group: producer
        Parameters:
        lazySessionCreation - the value to set
        Returns:
        the dsl builder

      • numberingPlanIndicator

        default SmppEndpointBuilderFactory.SmppEndpointProducerBuilder numberingPlanIndicator​(byte numberingPlanIndicator)
        Defines the numeric plan indicator (NPI) to be used in the SME. The following NPI values are defined: 0: Unknown 1: ISDN (E163/E164) 2: Data (X.121) 3: Telex (F.69) 6: Land Mobile (E.212) 8: National 9: Private 10: ERMES 13: Internet (IP) 18: WAP Client Id (to be defined by WAP Forum). The option is a: <code>byte</code> type. Group: producer
        Parameters:
        numberingPlanIndicator - the value to set
        Returns:
        the dsl builder

      • numberingPlanIndicator

        default SmppEndpointBuilderFactory.SmppEndpointProducerBuilder numberingPlanIndicator​(String numberingPlanIndicator)
        Defines the numeric plan indicator (NPI) to be used in the SME. The following NPI values are defined: 0: Unknown 1: ISDN (E163/E164) 2: Data (X.121) 3: Telex (F.69) 6: Land Mobile (E.212) 8: National 9: Private 10: ERMES 13: Internet (IP) 18: WAP Client Id (to be defined by WAP Forum). The option will be converted to a <code>byte</code> type. Group: producer
        Parameters:
        numberingPlanIndicator - the value to set
        Returns:
        the dsl builder

      • priorityFlag

        default SmppEndpointBuilderFactory.SmppEndpointProducerBuilder priorityFlag​(byte priorityFlag)
        Allows the originating SME to assign a priority level to the short message. Only for SubmitSm and SubmitMulti. Four Priority Levels are supported: 0: Level 0 (lowest) priority 1: Level 1 priority 2: Level 2 priority 3: Level 3 (highest) priority. The option is a: <code>byte</code> type. Group: producer
        Parameters:
        priorityFlag - the value to set
        Returns:
        the dsl builder

      • priorityFlag

        default SmppEndpointBuilderFactory.SmppEndpointProducerBuilder priorityFlag​(String priorityFlag)
        Allows the originating SME to assign a priority level to the short message. Only for SubmitSm and SubmitMulti. Four Priority Levels are supported: 0: Level 0 (lowest) priority 1: Level 1 priority 2: Level 2 priority 3: Level 3 (highest) priority. The option will be converted to a <code>byte</code> type. Group: producer
        Parameters:
        priorityFlag - the value to set
        Returns:
        the dsl builder

      • registeredDelivery

        default SmppEndpointBuilderFactory.SmppEndpointProducerBuilder registeredDelivery​(byte registeredDelivery)
        Is used to request an SMSC delivery receipt and/or SME originated acknowledgements. The following values are defined: 0: No SMSC delivery receipt requested. 1: SMSC delivery receipt requested where final delivery outcome is success or failure. 2: SMSC delivery receipt requested where the final delivery outcome is delivery failure. The option is a: <code>byte</code> type. Group: producer
        Parameters:
        registeredDelivery - the value to set
        Returns:
        the dsl builder

      • registeredDelivery

        default SmppEndpointBuilderFactory.SmppEndpointProducerBuilder registeredDelivery​(String registeredDelivery)
        Is used to request an SMSC delivery receipt and/or SME originated acknowledgements. The following values are defined: 0: No SMSC delivery receipt requested. 1: SMSC delivery receipt requested where final delivery outcome is success or failure. 2: SMSC delivery receipt requested where the final delivery outcome is delivery failure. The option will be converted to a <code>byte</code> type. Group: producer
        Parameters:
        registeredDelivery - the value to set
        Returns:
        the dsl builder

      • replaceIfPresentFlag

        default SmppEndpointBuilderFactory.SmppEndpointProducerBuilder replaceIfPresentFlag​(byte replaceIfPresentFlag)
        Used to request the SMSC to replace a previously submitted message, that is still pending delivery. The SMSC will replace an existing message provided that the source address, destination address and service type match the same fields in the new message. The following replace if present flag values are defined: 0: Don't replace 1: Replace. The option is a: <code>byte</code> type. Group: producer
        Parameters:
        replaceIfPresentFlag - the value to set
        Returns:
        the dsl builder

      • replaceIfPresentFlag

        default SmppEndpointBuilderFactory.SmppEndpointProducerBuilder replaceIfPresentFlag​(String replaceIfPresentFlag)
        Used to request the SMSC to replace a previously submitted message, that is still pending delivery. The SMSC will replace an existing message provided that the source address, destination address and service type match the same fields in the new message. The following replace if present flag values are defined: 0: Don't replace 1: Replace. The option will be converted to a <code>byte</code> type. Group: producer
        Parameters:
        replaceIfPresentFlag - the value to set
        Returns:
        the dsl builder

      • serviceType

        default SmppEndpointBuilderFactory.SmppEndpointProducerBuilder serviceType​(String serviceType)
        The service type parameter can be used to indicate the SMS Application service associated with the message. The following generic service_types are defined: CMT: Cellular Messaging CPT: Cellular Paging VMN: Voice Mail Notification VMA: Voice Mail Alerting WAP: Wireless Application Protocol USSD: Unstructured Supplementary Services Data. The option is a: <code>java.lang.String</code> type. Group: producer
        Parameters:
        serviceType - the value to set
        Returns:
        the dsl builder

      • sourceAddr

        default SmppEndpointBuilderFactory.SmppEndpointProducerBuilder sourceAddr​(String sourceAddr)
        Defines the address of SME (Short Message Entity) which originated this message. The option is a: <code>java.lang.String</code> type. Default: 1616 Group: producer
        Parameters:
        sourceAddr - the value to set
        Returns:
        the dsl builder

      • sourceAddrNpi

        default SmppEndpointBuilderFactory.SmppEndpointProducerBuilder sourceAddrNpi​(byte sourceAddrNpi)
        Defines the numeric plan indicator (NPI) to be used in the SME originator address parameters. The following NPI values are defined: 0: Unknown 1: ISDN (E163/E164) 2: Data (X.121) 3: Telex (F.69) 6: Land Mobile (E.212) 8: National 9: Private 10: ERMES 13: Internet (IP) 18: WAP Client Id (to be defined by WAP Forum). The option is a: <code>byte</code> type. Group: producer
        Parameters:
        sourceAddrNpi - the value to set
        Returns:
        the dsl builder

      • sourceAddrNpi

        default SmppEndpointBuilderFactory.SmppEndpointProducerBuilder sourceAddrNpi​(String sourceAddrNpi)
        Defines the numeric plan indicator (NPI) to be used in the SME originator address parameters. The following NPI values are defined: 0: Unknown 1: ISDN (E163/E164) 2: Data (X.121) 3: Telex (F.69) 6: Land Mobile (E.212) 8: National 9: Private 10: ERMES 13: Internet (IP) 18: WAP Client Id (to be defined by WAP Forum). The option will be converted to a <code>byte</code> type. Group: producer
        Parameters:
        sourceAddrNpi - the value to set
        Returns:
        the dsl builder

      • sourceAddrTon

        default SmppEndpointBuilderFactory.SmppEndpointProducerBuilder sourceAddrTon​(byte sourceAddrTon)
        Defines the type of number (TON) to be used in the SME originator address parameters. The following TON values are defined: 0: Unknown 1: International 2: National 3: Network Specific 4: Subscriber Number 5: Alphanumeric 6: Abbreviated. The option is a: <code>byte</code> type. Group: producer
        Parameters:
        sourceAddrTon - the value to set
        Returns:
        the dsl builder

      • sourceAddrTon

        default SmppEndpointBuilderFactory.SmppEndpointProducerBuilder sourceAddrTon​(String sourceAddrTon)
        Defines the type of number (TON) to be used in the SME originator address parameters. The following TON values are defined: 0: Unknown 1: International 2: National 3: Network Specific 4: Subscriber Number 5: Alphanumeric 6: Abbreviated. The option will be converted to a <code>byte</code> type. Group: producer
        Parameters:
        sourceAddrTon - the value to set
        Returns:
        the dsl builder

      • typeOfNumber

        default SmppEndpointBuilderFactory.SmppEndpointProducerBuilder typeOfNumber​(byte typeOfNumber)
        Defines the type of number (TON) to be used in the SME. The following TON values are defined: 0: Unknown 1: International 2: National 3: Network Specific 4: Subscriber Number 5: Alphanumeric 6: Abbreviated. The option is a: <code>byte</code> type. Group: producer
        Parameters:
        typeOfNumber - the value to set
        Returns:
        the dsl builder

      • typeOfNumber

        default SmppEndpointBuilderFactory.SmppEndpointProducerBuilder typeOfNumber​(String typeOfNumber)
        Defines the type of number (TON) to be used in the SME. The following TON values are defined: 0: Unknown 1: International 2: National 3: Network Specific 4: Subscriber Number 5: Alphanumeric 6: Abbreviated. The option will be converted to a <code>byte</code> type. Group: producer
        Parameters:
        typeOfNumber - the value to set
        Returns:
        the dsl builder

      • alphabet

        default SmppEndpointBuilderFactory.SmppEndpointProducerBuilder alphabet​(byte alphabet)
        Defines encoding of data according the SMPP 3.4 specification, section 5.2.19. 0: SMSC Default Alphabet 4: 8 bit Alphabet 8: UCS2 Alphabet. The option is a: <code>byte</code> type. Group: codec
        Parameters:
        alphabet - the value to set
        Returns:
        the dsl builder

      • alphabet

        default SmppEndpointBuilderFactory.SmppEndpointProducerBuilder alphabet​(String alphabet)
        Defines encoding of data according the SMPP 3.4 specification, section 5.2.19. 0: SMSC Default Alphabet 4: 8 bit Alphabet 8: UCS2 Alphabet. The option will be converted to a <code>byte</code> type. Group: codec
        Parameters:
        alphabet - the value to set
        Returns:
        the dsl builder

      • dataCoding

        default SmppEndpointBuilderFactory.SmppEndpointProducerBuilder dataCoding​(byte dataCoding)
        Defines the data coding according the SMPP 3.4 specification, section 5.2.19. Example data encodings are: 0: SMSC Default Alphabet 3: Latin 1 (ISO-8859-1) 4: Octet unspecified (8-bit binary) 8: UCS2 (ISO/IEC-10646) 13: Extended Kanji JIS(X 0212-1990). The option is a: <code>byte</code> type. Group: codec
        Parameters:
        dataCoding - the value to set
        Returns:
        the dsl builder

      • dataCoding

        default SmppEndpointBuilderFactory.SmppEndpointProducerBuilder dataCoding​(String dataCoding)
        Defines the data coding according the SMPP 3.4 specification, section 5.2.19. Example data encodings are: 0: SMSC Default Alphabet 3: Latin 1 (ISO-8859-1) 4: Octet unspecified (8-bit binary) 8: UCS2 (ISO/IEC-10646) 13: Extended Kanji JIS(X 0212-1990). The option will be converted to a <code>byte</code> type. Group: codec
        Parameters:
        dataCoding - the value to set
        Returns:
        the dsl builder

      • encoding

        default SmppEndpointBuilderFactory.SmppEndpointProducerBuilder encoding​(String encoding)
        Defines the encoding scheme of the short message user data. Only for SubmitSm, ReplaceSm and SubmitMulti. The option is a: <code>java.lang.String</code> type. Default: ISO-8859-1 Group: codec
        Parameters:
        encoding - the value to set
        Returns:
        the dsl builder

      • httpProxyHost

        default SmppEndpointBuilderFactory.SmppEndpointProducerBuilder httpProxyHost​(String httpProxyHost)
        If you need to tunnel SMPP through a HTTP proxy, set this attribute to the hostname or ip address of your HTTP proxy. The option is a: <code>java.lang.String</code> type. Group: proxy
        Parameters:
        httpProxyHost - the value to set
        Returns:
        the dsl builder

      • httpProxyPassword

        default SmppEndpointBuilderFactory.SmppEndpointProducerBuilder httpProxyPassword​(String httpProxyPassword)
        If your HTTP proxy requires basic authentication, set this attribute to the password required for your HTTP proxy. The option is a: <code>java.lang.String</code> type. Group: proxy
        Parameters:
        httpProxyPassword - the value to set
        Returns:
        the dsl builder

      • httpProxyPort

        default SmppEndpointBuilderFactory.SmppEndpointProducerBuilder httpProxyPort​(Integer httpProxyPort)
        If you need to tunnel SMPP through a HTTP proxy, set this attribute to the port of your HTTP proxy. The option is a: <code>java.lang.Integer</code> type. Default: 3128 Group: proxy
        Parameters:
        httpProxyPort - the value to set
        Returns:
        the dsl builder

      • httpProxyPort

        default SmppEndpointBuilderFactory.SmppEndpointProducerBuilder httpProxyPort​(String httpProxyPort)
        If you need to tunnel SMPP through a HTTP proxy, set this attribute to the port of your HTTP proxy. The option will be converted to a <code>java.lang.Integer</code> type. Default: 3128 Group: proxy
        Parameters:
        httpProxyPort - the value to set
        Returns:
        the dsl builder

      • httpProxyUsername

        default SmppEndpointBuilderFactory.SmppEndpointProducerBuilder httpProxyUsername​(String httpProxyUsername)
        If your HTTP proxy requires basic authentication, set this attribute to the username required for your HTTP proxy. The option is a: <code>java.lang.String</code> type. Group: proxy
        Parameters:
        httpProxyUsername - the value to set
        Returns:
        the dsl builder

      • proxyHeaders

        default SmppEndpointBuilderFactory.SmppEndpointProducerBuilder proxyHeaders​(Map<String,​String> proxyHeaders)
        These headers will be passed to the proxy server while establishing the connection. The option is a: <code>java.util.Map&lt;java.lang.String, java.lang.String&gt;</code> type. Group: proxy
        Parameters:
        proxyHeaders - the value to set
        Returns:
        the dsl builder

      • proxyHeaders

        default SmppEndpointBuilderFactory.SmppEndpointProducerBuilder proxyHeaders​(String proxyHeaders)
        These headers will be passed to the proxy server while establishing the connection. The option will be converted to a <code>java.util.Map&lt;java.lang.String, java.lang.String&gt;</code> type. Group: proxy
        Parameters:
        proxyHeaders - the value to set
        Returns:
        the dsl builder

      • systemId

        default SmppEndpointBuilderFactory.SmppEndpointProducerBuilder systemId​(String systemId)
        The system id (username) for connecting to SMSC server. The option is a: <code>java.lang.String</code> type. Default: smppclient Group: security
        Parameters:
        systemId - the value to set
        Returns:
        the dsl builder

      • usingSSL

        default SmppEndpointBuilderFactory.SmppEndpointProducerBuilder usingSSL​(boolean usingSSL)
        Whether using SSL with the smpps protocol. The option is a: <code>boolean</code> type. Default: false Group: security
        Parameters:
        usingSSL - the value to set
        Returns:
        the dsl builder

      • usingSSL

        default SmppEndpointBuilderFactory.SmppEndpointProducerBuilder usingSSL​(String usingSSL)
        Whether using SSL with the smpps protocol. The option will be converted to a <code>boolean</code> type. Default: false Group: security
        Parameters:
        usingSSL - the value to set
        Returns:
        the dsl builder