SmppConfiguration (Camel :: SMPP 2.16.2 API)

java.lang.Object
- org.apache.camel.component.smpp.SmppConfiguration

All Implemented Interfaces:

Cloneable
```
@UriParams
public class SmppConfiguration
extends Object
implements Cloneable
```
Contains the SMPP component configuration properties

Version:

Constructor Summary

Constructors
Constructor and Description

SmppConfiguration()

Constructors
Constructor and Description
`SmppConfiguration()`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`configureFromURI(URI uri)` A POJO which contains all necessary configuration parameters for the SMPP connection
`SmppConfiguration`	`copy()`
`String`	`getAddressRange()`
`byte`	`getAlphabet()`
`byte`	`getDataCoding()`
`String`	`getDestAddr()`
`byte`	`getDestAddrNpi()`
`byte`	`getDestAddrTon()`
`String`	`getEncoding()`
`Integer`	`getEnquireLinkTimer()`
`String`	`getHost()`
`String`	`getHttpProxyHost()`
`String`	`getHttpProxyPassword()`
`Integer`	`getHttpProxyPort()`
`String`	`getHttpProxyUsername()`
`long`	`getInitialReconnectDelay()`
`byte`	`getNumberingPlanIndicator()`
`String`	`getPassword()` The password for connecting to SMSC server.
`Integer`	`getPort()`
`byte`	`getPriorityFlag()`
`byte`	`getProtocolId()`
`long`	`getReconnectDelay()`
`byte`	`getRegisteredDelivery()`
`byte`	`getReplaceIfPresentFlag()`
`String`	`getServiceType()`
`org.jsmpp.session.SessionStateListener`	`getSessionStateListener()`
`String`	`getSourceAddr()`
`byte`	`getSourceAddrNpi()`
`byte`	`getSourceAddrTon()`
`SmppSplittingPolicy`	`getSplittingPolicy()`
`String`	`getSystemId()`
`String`	`getSystemType()`
`Integer`	`getTransactionTimer()`
`byte`	`getTypeOfNumber()`
`boolean`	`getUsingSSL()`
`boolean`	`isLazySessionCreation()`
`void`	`setAddressRange(String addressRange)` You can specify the address range for the SmppConsumer as defined in section 5.2.7 of the SMPP 3.4 specification.
`void`	`setAlphabet(byte alphabet)` Defines encoding of data according the SMPP 3.4 specification, section 5.2.19.
`void`	`setDataCoding(byte dataCoding)` Defines the data coding according the SMPP 3.4 specification, section 5.2.19.
`void`	`setDestAddr(String destAddr)` Defines the destination SME address.
`void`	`setDestAddrNpi(byte destAddrNpi)` Defines the type of number (TON) to be used in the SME destination address parameters.
`void`	`setDestAddrTon(byte destAddrTon)` Defines the type of number (TON) to be used in the SME destination address parameters.
`void`	`setEncoding(String encoding)` Defines the encoding scheme of the short message user data.
`void`	`setEnquireLinkTimer(Integer enquireLinkTimer)` Defines the interval in milliseconds between the confidence checks.
`void`	`setHost(String host)` Hostname for the SMSC server to use.
`void`	`setHttpProxyHost(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.
`void`	`setHttpProxyPassword(String httpProxyPassword)` If your HTTP proxy requires basic authentication, set this attribute to the password required for your HTTP proxy.
`void`	`setHttpProxyPort(Integer httpProxyPort)` If you need to tunnel SMPP through a HTTP proxy, set this attribute to the port of your HTTP proxy.
`void`	`setHttpProxyUsername(String httpProxyUsername)` If your HTTP proxy requires basic authentication, set this attribute to the username required for your HTTP proxy.
`void`	`setInitialReconnectDelay(long initialReconnectDelay)` Defines the initial delay in milliseconds after the consumer/producer tries to reconnect to the SMSC, after the connection was lost.
`void`	`setLazySessionCreation(boolean lazySessionCreation)` Sessions can be lazily created to avoid exceptions, if the SMSC is not available when the Camel producer is started.
`void`	`setNumberingPlanIndicator(byte numberingPlanIndicator)` Defines the numeric plan indicator (NPI) to be used in the SME.
`void`	`setPassword(String password)`
`void`	`setPort(Integer port)` Port number for the SMSC server to use.
`void`	`setPriorityFlag(byte priorityFlag)` Allows the originating SME to assign a priority level to the short message.
`void`	`setProtocolId(byte protocolId)` The protocol id
`void`	`setReconnectDelay(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.
`void`	`setRegisteredDelivery(byte registeredDelivery)` Is used to request an SMSC delivery receipt and/or SME originated acknowledgements.
`void`	`setReplaceIfPresentFlag(byte replaceIfPresentFlag)` Used to request the SMSC to replace a previously submitted message, that is still pending delivery.
`void`	`setServiceType(String serviceType)` The service type parameter can be used to indicate the SMS Application service associated with the message.
`void`	`setSessionStateListener(org.jsmpp.session.SessionStateListener sessionStateListener)` You can refer to a org.jsmpp.session.SessionStateListener in the Registry to receive callbacks when the session state changed.
`void`	`setSourceAddr(String sourceAddr)` Defines the address of SME (Short Message Entity) which originated this message.
`void`	`setSourceAddrNpi(byte sourceAddrNpi)` Defines the numeric plan indicator (NPI) to be used in the SME originator address parameters.
`void`	`setSourceAddrTon(byte sourceAddrTon)` Defines the type of number (TON) to be used in the SME originator address parameters.
`void`	`setSplittingPolicy(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.
`void`	`setSystemId(String systemId)` The system id (username) for connecting to SMSC server.
`void`	`setSystemType(String systemType)` This parameter is used to categorize the type of ESME (External Short Message Entity) that is binding to the SMSC (max.
`void`	`setTransactionTimer(Integer transactionTimer)` Defines the maximum period of inactivity allowed after a transaction, after which an SMPP entity may assume that the session is no longer active.
`void`	`setTypeOfNumber(byte typeOfNumber)` Defines the type of number (TON) to be used in the SME.
`void`	`setUsingSSL(boolean usingSSL)` Whether using SSL with the smpps protocol
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - SmppConfiguration
```
public SmppConfiguration()
```
- Method Detail
  - configureFromURI
```
public void configureFromURI(URI uri)
```
    A POJO which contains all necessary configuration parameters for the SMPP connection
    
    Parameters:
    uri - the full URI of the endpoint
  - copy
```
public SmppConfiguration copy()
```
  - getHost
```
public String getHost()
```
  - setHost
```
public void setHost(String host)
```
    Hostname for the SMSC server to use.
  - getPort
```
public Integer getPort()
```
  - setPort
```
public void setPort(Integer port)
```
    Port number for the SMSC server to use.
  - getSystemId
```
public String getSystemId()
```
  - setSystemId
```
public void setSystemId(String systemId)
```
    The system id (username) for connecting to SMSC server.
  - getPassword
```
public String getPassword()
```
    The password for connecting to SMSC server.
  - getDataCoding
```
public byte getDataCoding()
```
  - setDataCoding
```
public void setDataCoding(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)
  - getAlphabet
```
public byte getAlphabet()
```
  - setAlphabet
```
public void setAlphabet(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
  - getEncoding
```
public String getEncoding()
```
  - setEncoding
```
public void setEncoding(String encoding)
```
    Defines the encoding scheme of the short message user data. Only for SubmitSm, ReplaceSm and SubmitMulti.
  - setPassword
```
public void setPassword(String password)
```
  - getEnquireLinkTimer
```
public Integer getEnquireLinkTimer()
```
  - setEnquireLinkTimer
```
public void setEnquireLinkTimer(Integer enquireLinkTimer)
```
    Defines the interval in milliseconds between the confidence checks. The confidence check is used to test the communication path between an ESME and an SMSC.
  - getTransactionTimer
```
public Integer getTransactionTimer()
```
  - setTransactionTimer
```
public void setTransactionTimer(Integer transactionTimer)
```
    Defines the maximum period of inactivity allowed after a transaction, after which an SMPP entity may assume that the session is no longer active. This timer may be active on either communicating SMPP entity (i.e. SMSC or ESME).
  - getSystemType
```
public String getSystemType()
```
  - setSystemType
```
public void setSystemType(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).
  - getRegisteredDelivery
```
public byte getRegisteredDelivery()
```
  - setRegisteredDelivery
```
public void setRegisteredDelivery(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.
  - getServiceType
```
public String getServiceType()
```
  - setServiceType
```
public void setServiceType(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
  - getSourceAddrTon
```
public byte getSourceAddrTon()
```
  - setSourceAddrTon
```
public void setSourceAddrTon(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
  - getDestAddrTon
```
public byte getDestAddrTon()
```
  - setDestAddrTon
```
public void setDestAddrTon(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
  - getSourceAddrNpi
```
public byte getSourceAddrNpi()
```
  - setSourceAddrNpi
```
public void setSourceAddrNpi(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)
  - getDestAddrNpi
```
public byte getDestAddrNpi()
```
  - setDestAddrNpi
```
public void setDestAddrNpi(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)
  - getProtocolId
```
public byte getProtocolId()
```
  - setProtocolId
```
public void setProtocolId(byte protocolId)
```
    The protocol id
  - getPriorityFlag
```
public byte getPriorityFlag()
```
  - setPriorityFlag
```
public void setPriorityFlag(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
  - getReplaceIfPresentFlag
```
public byte getReplaceIfPresentFlag()
```
  - setReplaceIfPresentFlag
```
public void setReplaceIfPresentFlag(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
  - getSourceAddr
```
public String getSourceAddr()
```
  - setSourceAddr
```
public void setSourceAddr(String sourceAddr)
```
    Defines the address of SME (Short Message Entity) which originated this message.
  - getDestAddr
```
public String getDestAddr()
```
  - setDestAddr
```
public void setDestAddr(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.
  - getTypeOfNumber
```
public byte getTypeOfNumber()
```
  - setTypeOfNumber
```
public void setTypeOfNumber(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
  - getNumberingPlanIndicator
```
public byte getNumberingPlanIndicator()
```
  - setNumberingPlanIndicator
```
public void setNumberingPlanIndicator(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)
  - getUsingSSL
```
public boolean getUsingSSL()
```
  - setUsingSSL
```
public void setUsingSSL(boolean usingSSL)
```
    Whether using SSL with the smpps protocol
  - getInitialReconnectDelay
```
public long getInitialReconnectDelay()
```
  - setInitialReconnectDelay
```
public void setInitialReconnectDelay(long initialReconnectDelay)
```
    Defines the initial delay in milliseconds after the consumer/producer tries to reconnect to the SMSC, after the connection was lost.
  - getReconnectDelay
```
public long getReconnectDelay()
```
  - setReconnectDelay
```
public void setReconnectDelay(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.
  - isLazySessionCreation
```
public boolean isLazySessionCreation()
```
  - setLazySessionCreation
```
public void setLazySessionCreation(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.
  - getHttpProxyHost
```
public String getHttpProxyHost()
```
  - setHttpProxyHost
```
public void setHttpProxyHost(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.
  - getHttpProxyPort
```
public Integer getHttpProxyPort()
```
  - setHttpProxyPort
```
public void setHttpProxyPort(Integer httpProxyPort)
```
    If you need to tunnel SMPP through a HTTP proxy, set this attribute to the port of your HTTP proxy.
  - getHttpProxyUsername
```
public String getHttpProxyUsername()
```
  - setHttpProxyUsername
```
public void setHttpProxyUsername(String httpProxyUsername)
```
    If your HTTP proxy requires basic authentication, set this attribute to the username required for your HTTP proxy.
  - getHttpProxyPassword
```
public String getHttpProxyPassword()
```
  - setHttpProxyPassword
```
public void setHttpProxyPassword(String httpProxyPassword)
```
    If your HTTP proxy requires basic authentication, set this attribute to the password required for your HTTP proxy.
  - getSessionStateListener
```
public org.jsmpp.session.SessionStateListener getSessionStateListener()
```
  - setSessionStateListener
```
public void setSessionStateListener(org.jsmpp.session.SessionStateListener sessionStateListener)
```
    You can refer to a org.jsmpp.session.SessionStateListener in the Registry to receive callbacks when the session state changed.
  - getAddressRange
```
public String getAddressRange()
```
  - setAddressRange
```
public void setAddressRange(String addressRange)
```
    You can specify the address range for the SmppConsumer as defined in section 5.2.7 of the SMPP 3.4 specification. The SmppConsumer will receive messages only from SMSC's which target an address (MSISDN or IP address) within this range.
  - getSplittingPolicy
```
public SmppSplittingPolicy getSplittingPolicy()
```
  - setSplittingPolicy
```
public void setSplittingPolicy(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.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class SmppConfiguration

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

SmppConfiguration

Method Detail

configureFromURI

copy

getHost

setHost

getPort

setPort

getSystemId

setSystemId

getPassword

getDataCoding

setDataCoding

getAlphabet

setAlphabet

getEncoding

setEncoding

setPassword

getEnquireLinkTimer

setEnquireLinkTimer

getTransactionTimer

setTransactionTimer

getSystemType

setSystemType

getRegisteredDelivery

setRegisteredDelivery

getServiceType

setServiceType

getSourceAddrTon

setSourceAddrTon

getDestAddrTon

setDestAddrTon

getSourceAddrNpi

setSourceAddrNpi

getDestAddrNpi

setDestAddrNpi

getProtocolId

setProtocolId

getPriorityFlag

setPriorityFlag

getReplaceIfPresentFlag

setReplaceIfPresentFlag

getSourceAddr

setSourceAddr

getDestAddr

setDestAddr

getTypeOfNumber

setTypeOfNumber

getNumberingPlanIndicator

setNumberingPlanIndicator

getUsingSSL

setUsingSSL

getInitialReconnectDelay

setInitialReconnectDelay

getReconnectDelay

setReconnectDelay

isLazySessionCreation

setLazySessionCreation

getHttpProxyHost

setHttpProxyHost

getHttpProxyPort

setHttpProxyPort

getHttpProxyUsername

setHttpProxyUsername

getHttpProxyPassword

setHttpProxyPassword

getSessionStateListener

setSessionStateListener

getAddressRange

setAddressRange

getSplittingPolicy

setSplittingPolicy

toString