CloudhopperBuilder (ogham 3.1.0-SNAPSHOT API)

java.lang.Object
- fr.sii.ogham.core.fluent.AbstractParent<SmsBuilder>
- - fr.sii.ogham.sms.builder.cloudhopper.CloudhopperBuilder

All Implemented Interfaces:: Builder<CloudhopperSMPPSender>, Parent<SmsBuilder>

public class CloudhopperBuilder
extends AbstractParent<SmsBuilder>
implements Builder<CloudhopperSMPPSender>

Configures Cloudhopper:

SMPP protocol parameters (host, port, systemId, password, version...)
Session management (name, bind, timeouts, retry...)
SSL configuration
Logging options

To send Sms using Cloudhopper, you need to register this builder into a MessagingBuilder like this:

 
 MessagingBuilder msgBuilder = ...
 msgBuilder.sms()
    .sender(CloudhopperBuilder.class)    // registers the builder and accesses to that builder for configuring it

Once the builder is registered, sending sms through Cloudhopper requires at least host of the SMPP server. You can define it using:

 
 msgBuilder.sms()
    .sender(CloudhopperBuilder.class)    // registers the builder and accesses to that builder for configuring it
       .host("localhost")

Or you can also use property keys (using interpolation):

 
 msgBuilder
 .environment()
    .properties()
       .set("custom.property.for.host", "localhost")
       .and()
    .and()
 .sms()
    .sender(CloudhopperBuilder.class)    // registers the builder and accesses to that builder for configuring it
       .host()
         .properties("${custom.property.for.host}")

You can do the same with port of the SMPP server.

SMPP server may require authentication. In most cases, authentication is done using system_id/password. You can use this builder to quickly provide your system_id and password:

 
 .sender(CloudhopperBuilder.class)
        .systemId("foo")
        .password("bar")

Author:: Aurélien Baudet

Field Summary
- Fields inherited from class fr.sii.ogham.core.fluent.AbstractParent
  parent

Constructor Summary

Constructors
Constructor and Description
`CloudhopperBuilder()` Default constructor when using without all Ogham work.
`CloudhopperBuilder(SmsBuilder parent, BuildContext buildContext)` Constructor that is called when using Ogham builder:

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CloudhopperBuilder`	`addressRange(com.cloudhopper.smpp.type.Address range)` The address_range parameter is used in the bind_receiver and bind_transceiver command to specify a set of SME addresses serviced by the ESME client.
`ConfigurationValueBuilder<CloudhopperBuilder,com.cloudhopper.smpp.SmppBindType>`	`bindType()` The bind command type (see `SmppBindType`).
`CloudhopperBuilder`	`bindType(com.cloudhopper.smpp.SmppBindType bindType)` The bind command type (see `SmppBindType`).
`CloudhopperSMPPSender`	`build()` Instantiate and configures the instance.
`CloudhopperBuilder`	`clientSupplier(SmppClientSupplier supplier)` By default, `CloudhopperSMPPSender` uses `DefaultSmppClient` client.
`DataCodingSchemeBuilder`	`dataCodingScheme()` Data Coding Scheme is a one-octet field in Short Messages (SM) and Cell Broadcast Messages (CB) which carries a basic information how the recipient handset should process the received message.
`EncoderBuilder`	`encoder()` Configures how Cloudhopper will encode SMS messages.
`ConfigurationValueBuilder<CloudhopperBuilder,String>`	`host()` The SMPP server host (IP or address).
`CloudhopperBuilder`	`host(String host)` The SMPP server host (IP or address).
`ConfigurationValueBuilder<CloudhopperBuilder,InterfaceVersion>`	`interfaceVersion()` The SMPP protocol version (one of `InterfaceVersion.VERSION_3_3`, `InterfaceVersion.VERSION_3_4`, `InterfaceVersion.VERSION_5_0`).
`CloudhopperBuilder`	`interfaceVersion(Byte version)` The SMPP protocol version (one of `SmppConstants.VERSION_3_3`, `SmppConstants.VERSION_3_4`, `SmppConstants.VERSION_5_0`).
`CloudhopperBuilder`	`interfaceVersion(InterfaceVersion version)` The SMPP protocol version (one of `InterfaceVersion.VERSION_3_3`, `InterfaceVersion.VERSION_3_4`, `InterfaceVersion.VERSION_5_0`).
`LoggingBuilder`	`logging()` Configure logs: Enable/disable log of `Pdu`s Enable/disable log of bytes
`CloudhopperBuilder`	`messagePreparator(MessagePreparator preparator)` `Sms` message is converted to `SubmitSm`(s) using a `MessagePreparator`.
`ConfigurationValueBuilder<CloudhopperBuilder,String>`	`password()` The password parameter is used by the SMSC to authenticate the identity of the binding ESME.
`CloudhopperBuilder`	`password(String password)` The password parameter is used by the SMSC to authenticate the identity of the binding ESME.
`ConfigurationValueBuilder<CloudhopperBuilder,Integer>`	`port()` Set the SMPP server port.
`CloudhopperBuilder`	`port(Integer port)` Set the SMPP server port.
`SessionBuilder`	`session()` Configures Cloudhopper session management (timeouts, retry, session name...).
`CloudhopperBuilder`	`session(ExtendedSmppSessionConfiguration session)` Overrides any previously defined Cloudhopper parameters to use the provided session.
`CloudhopperBuilder`	`smppSessionHandlerSupplier(SmppSessionHandlerSupplier supplier)` By default, `CloudhopperSMPPSender` uses `DefaultSmppSessionHandler`.
`MessageSplitterBuilder`	`splitter()` Configures how Cloudhopper will split messages.
`SslBuilder`	`ssl()` Enable or disable SSL configuration and configure how SSL is handled.
`ConfigurationValueBuilder<CloudhopperBuilder,String>`	`systemId()` The system_id parameter is used to identify an ESME ( External Short Message Entity) or an SMSC (Short Message Service Centre) at bind time.
`CloudhopperBuilder`	`systemId(String systemId)` The system_id parameter is used to identify an ESME ( External Short Message Entity) or an SMSC (Short Message Service Centre) at bind time.
`ConfigurationValueBuilder<CloudhopperBuilder,String>`	`systemType()` The system_type parameter is used to categorize the type of ESME that is binding to the SMSC.
`CloudhopperBuilder`	`systemType(String systemType)` The system_type parameter is used to categorize the type of ESME that is binding to the SMSC.
`UserDataBuilder`	`userData()` SMS message (named "User Data" in SMPP specification) can be transmitted using: Either `short_message` field (standard field for "User Data"). Or `message_payload` optional parameter.

Methods inherited from class fr.sii.ogham.core.fluent.AbstractParent
and

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

- Constructor Detail
  - CloudhopperBuilder
```
public CloudhopperBuilder()
```
    Default constructor when using without all Ogham work. WARNING: use is only if you know what you are doing !
  - CloudhopperBuilder
```
public CloudhopperBuilder(SmsBuilder parent,
                          BuildContext buildContext)
```
    Constructor that is called when using Ogham builder:
```
 MessagingBuilder msgBuilder = ...
 msgBuilder
 .sms()
    .sender(CloudhopperBuilder.class)
 
```
    Parameters:
    
    parent - the parent builder instance for fluent chaining
    
    buildContext - for registering instances and property evaluation
- Method Detail
  - systemId
```
public CloudhopperBuilder systemId(String systemId)
```
    The system_id parameter is used to identify an ESME ( External Short Message Entity) or an SMSC (Short Message Service Centre) at bind time. An ESME system_id identifies the ESME or ESME agent to the SMSC. The SMSC system_id provides an identification of the SMSC to the ESME.
    The value set using this method takes precedence over any property and default value configured using systemId().
```
 .systemId("my-system-id")
 .systemId()
   .properties("${custom.property.high-priority}", "${custom.property.low-priority}")
   .defaultValue("default-system-id")
 
```
```
 .systemId("my-system-id")
 .systemId()
   .properties("${custom.property.high-priority}", "${custom.property.low-priority}")
   .defaultValue("default-system-id")
 
```
    In both cases, systemId("my-system-id") is used.
    If this method is called several times, only the last value is used.
    If null value is set, it is like not setting a value at all. The property/default value configuration is applied.
    Parameters:
    
    systemId - the system_id value
    
    Returns:
    
    this instance for fluent chaining
  - systemId
```
public ConfigurationValueBuilder<CloudhopperBuilder,String> systemId()
```
    The system_id parameter is used to identify an ESME ( External Short Message Entity) or an SMSC (Short Message Service Centre) at bind time. An ESME system_id identifies the ESME or ESME agent to the SMSC. The SMSC system_id provides an identification of the SMSC to the ESME.
    This method is mainly used by Configurers to register some property keys and/or a default value. The aim is to let developer be able to externalize its configuration (using system properties, configuration file or anything else). If the developer doesn't configure any value for the registered properties, the default value is used (if set).
```
 .systemId()
   .properties("${custom.property.high-priority}", "${custom.property.low-priority}")
   .defaultValue("default-system-id")
 
```
    Non-null value set using systemId(String) takes precedence over property values and default value.
```
 .systemId("my-system-id")
 .systemId()
   .properties("${custom.property.high-priority}", "${custom.property.low-priority}")
   .defaultValue("default-system-id")
 
```
    The value "my-system-id" is used regardless of the value of the properties and default value.
    See ConfigurationValueBuilder for more information.
    Returns:
    
    the builder to configure property keys/default value
  - systemType
```
public CloudhopperBuilder systemType(String systemType)
```
    The system_type parameter is used to categorize the type of ESME that is binding to the SMSC. Examples include “VMS” (voice mail system) and “OTA” (over-the-air activation system). Specification of the system_type is optional - some SMSC’s may not require ESME’s to provide this detail. In this case, the ESME can set the system_type to NULL. The system_type (optional) may be used to categorize the system, e.g., “EMAIL”, “WWW”, etc.
    The value set using this method takes precedence over any property and default value configured using systemType().
```
 .systemType("my-system-type")
 .systemType()
   .properties("${custom.property.high-priority}", "${custom.property.low-priority}")
   .defaultValue("default-system-type")
 
```
```
 .systemType("my-system-type")
 .systemType()
   .properties("${custom.property.high-priority}", "${custom.property.low-priority}")
   .defaultValue("default-system-type")
 
```
    In both cases, systemType("my-system-type") is used.
    If this method is called several times, only the last value is used.
    If null value is set, it is like not setting a value at all. The property/default value configuration is applied.
    Parameters:
    
    systemType - the system type value
    
    Returns:
    
    this instance for fluent chaining
  - systemType
```
public ConfigurationValueBuilder<CloudhopperBuilder,String> systemType()
```
    The system_type parameter is used to categorize the type of ESME that is binding to the SMSC. Examples include “VMS” (voice mail system) and “OTA” (over-the-air activation system). Specification of the system_type is optional - some SMSC’s may not require ESME’s to provide this detail. In this case, the ESME can set the system_type to NULL. The system_type (optional) may be used to categorize the system, e.g., “EMAIL”, “WWW”, etc.
    This method is mainly used by Configurers to register some property keys and/or a default value. The aim is to let developer be able to externalize its configuration (using system properties, configuration file or anything else). If the developer doesn't configure any value for the registered properties, the default value is used (if set).
```
 .systemType()
   .properties("${custom.property.high-priority}", "${custom.property.low-priority}")
   .defaultValue("defaut-system-type")
 
```
    Non-null value set using systemType(String) takes precedence over property values and default value.
```
 .systemType("my-system-type")
 .systemType()
   .properties("${custom.property.high-priority}", "${custom.property.low-priority}")
   .defaultValue("defaut-system-type")
 
```
    The value "my-system-type" is used regardless of the value of the properties and default value.
    See ConfigurationValueBuilder for more information.
    Returns:
    
    the builder to configure property keys/default value
  - password
```
public CloudhopperBuilder password(String password)
```
    The password parameter is used by the SMSC to authenticate the identity of the binding ESME. The Service Provider may require ESME’s to provide a password when binding to the SMSC. This password is normally issued by the SMSC system administrator. The password parameter may also be used by the ESME to authenticate the identity of the binding SMSC (e.g. in the case of the outbind operation).
    The value set using this method takes precedence over any property and default value configured using password().
```
 .password("my-password")
 .password()
   .properties("${custom.property.high-priority}", "${custom.property.low-priority}")
   .defaultValue("default-password")
 
```
```
 .password("my-password")
 .password()
   .properties("${custom.property.high-priority}", "${custom.property.low-priority}")
   .defaultValue("default-password")
 
```
    In both cases, password("my-password") is used.
    If this method is called several times, only the last value is used.
    If null value is set, it is like not setting a value at all. The property/default value configuration is applied.
    Parameters:
    
    password - the password used to authenticate
    
    Returns:
    
    this instance for fluent chaining
  - password
```
public ConfigurationValueBuilder<CloudhopperBuilder,String> password()
```
    The password parameter is used by the SMSC to authenticate the identity of the binding ESME. The Service Provider may require ESME’s to provide a password when binding to the SMSC. This password is normally issued by the SMSC system administrator. The password parameter may also be used by the ESME to authenticate the identity of the binding SMSC (e.g. in the case of the outbind operation).
    This method is mainly used by Configurers to register some property keys and/or a default value. The aim is to let developer be able to externalize its configuration (using system properties, configuration file or anything else). If the developer doesn't configure any value for the registered properties, the default value is used (if set).
```
 .password()
   .properties("${custom.property.high-priority}", "${custom.property.low-priority}")
   .defaultValue("default-password")
 
```
    Non-null value set using password(String) takes precedence over property values and default value.
```
 .password("my-password")
 .password()
   .properties("${custom.property.high-priority}", "${custom.property.low-priority}")
   .defaultValue("default-password")
 
```
    The value "my-password" is used regardless of the value of the properties and default value.
    See ConfigurationValueBuilder for more information.
    Returns:
    
    the builder to configure property keys/default value
  - host
```
public CloudhopperBuilder host(String host)
```
    The SMPP server host (IP or address).
    The value set using this method takes precedence over any property and default value configured using host().
```
 .host("localhost")
 .host()
   .properties("${custom.property.high-priority}", "${custom.property.low-priority}")
   .defaultValue("default-host")
 
```
```
 .host("localhost")
 .host()
   .properties("${custom.property.high-priority}", "${custom.property.low-priority}")
   .defaultValue("default-host")
 
```
    In both cases, host("localhost") is used.
    If this method is called several times, only the last value is used.
    If null value is set, it is like not setting a value at all. The property/default value configuration is applied.
    Parameters:
    
    host - the host address
    
    Returns:
    
    this instance for fluent chaining
  - host
```
public ConfigurationValueBuilder<CloudhopperBuilder,String> host()
```
    The SMPP server host (IP or address).
    This method is mainly used by Configurers to register some property keys and/or a default value. The aim is to let developer be able to externalize its configuration (using system properties, configuration file or anything else). If the developer doesn't configure any value for the registered properties, the default value is used (if set).
```
 .host()
   .properties("${custom.property.high-priority}", "${custom.property.low-priority}")
   .defaultValue("default-host")
 
```
    Non-null value set using host(String) takes precedence over property values and default value.
```
 .host("localhost")
 .host()
   .properties("${custom.property.high-priority}", "${custom.property.low-priority}")
   .defaultValue("default-host")
 
```
    The value "localhost" is used regardless of the value of the properties and default value.
    See ConfigurationValueBuilder for more information.
    Returns:
    
    the builder to configure property keys/default value
  - port
```
public CloudhopperBuilder port(Integer port)
```
    Set the SMPP server port.
    The value set using this method takes precedence over any property and default value configured using port().
```
 .port(2775)
 .port()
   .properties("${custom.property.high-priority}", "${custom.property.low-priority}")
   .defaultValue(1775)
 
```
```
 .port(2775)
 .port()
   .properties("${custom.property.high-priority}", "${custom.property.low-priority}")
   .defaultValue(1775)
 
```
    In both cases, port(2775) is used.
    If this method is called several times, only the last value is used.
    If null value is set, it is like not setting a value at all. The property/default value configuration is applied.
    Parameters:
    
    port - the SMPP server port
    
    Returns:
    
    this instance for fluent chaining
  - port
```
public ConfigurationValueBuilder<CloudhopperBuilder,Integer> port()
```
    Set the SMPP server port.
    This method is mainly used by Configurers to register some property keys and/or a default value. The aim is to let developer be able to externalize its configuration (using system properties, configuration file or anything else). If the developer doesn't configure any value for the registered properties, the default value is used (if set).
```
 .port()
   .properties("${custom.property.high-priority}", "${custom.property.low-priority}")
   .defaultValue(1775)
 
```
    Non-null value set using port(Integer) takes precedence over property values and default value.
```
 .port(2775)
 .port()
   .properties("${custom.property.high-priority}", "${custom.property.low-priority}")
   .defaultValue(1775)
 
```
    The value 2775 is used regardless of the value of the properties and default value.
    See ConfigurationValueBuilder for more information.
    Returns:
    
    the builder to configure property keys/default value
  - interfaceVersion
```
public CloudhopperBuilder interfaceVersion(InterfaceVersion version)
```
    The SMPP protocol version (one of InterfaceVersion.VERSION_3_3, InterfaceVersion.VERSION_3_4, InterfaceVersion.VERSION_5_0).
    The value set using this method takes precedence over any property and default value configured using interfaceVersion().
```
 .interfaceVersion(InterfaceVersion.VERSION_5_0)
 .interfaceVersion()
   .properties("${custom.property.high-priority}", "${custom.property.low-priority}")
   .defaultValue(InterfaceVersion.VERSION_3_4)
 
```
```
 .interfaceVersion(InterfaceVersion.VERSION_5_0)
 .interfaceVersion()
   .properties("${custom.property.high-priority}", "${custom.property.low-priority}")
   .defaultValue(InterfaceVersion.VERSION_3_4)
 
```
    In both cases, interfaceVersion(InterfaceVersion.VERSION_5_0) is used.
    If this method is called several times, only the last value is used.
    If null value is set, it is like not setting a value at all. The property/default value configuration is applied.
    Parameters:
    
    version - the version of the SMPP protocol
    
    Returns:
    
    this instance for fluent chaining
  - interfaceVersion
```
public CloudhopperBuilder interfaceVersion(Byte version)
```
    The SMPP protocol version (one of SmppConstants.VERSION_3_3, SmppConstants.VERSION_3_4, SmppConstants.VERSION_5_0).
    The value set using this method takes precedence over any property and default value configured using interfaceVersion().
```
 .interfaceVersion(SmppConstants.VERSION_5_0)
 .interfaceVersion()
   .properties("${custom.property.high-priority}", "${custom.property.low-priority}")
   .defaultValue(SmppConstants.VERSION_3_4)
 
```
```
 .interfaceVersion(SmppConstants.VERSION_5_0)
 .interfaceVersion()
   .properties("${custom.property.high-priority}", "${custom.property.low-priority}")
   .defaultValue(SmppConstants.VERSION_3_4)
 
```
    In both cases, interfaceVersion(SmppConstants.VERSION_5_0) is used.
    If this method is called several times, only the last value is used.
    If null value is set, it is like not setting a value at all. The property/default value configuration is applied.
    Parameters:
    
    version - the version of the SMPP protocol
    
    Returns:
    
    this instance for fluent chaining
  - interfaceVersion
```
public ConfigurationValueBuilder<CloudhopperBuilder,InterfaceVersion> interfaceVersion()
```
    The SMPP protocol version (one of InterfaceVersion.VERSION_3_3, InterfaceVersion.VERSION_3_4, InterfaceVersion.VERSION_5_0).
    This method is mainly used by Configurers to register some property keys and/or a default value. The aim is to let developer be able to externalize its configuration (using system properties, configuration file or anything else). If the developer doesn't configure any value for the registered properties, the default value is used (if set).
```
 .interfaceVersion()
   .properties("${custom.property.high-priority}", "${custom.property.low-priority}")
   .defaultValue(InterfaceVersion.VERSION_3_4)
 
```
    Non-null value set using interfaceVersion(InterfaceVersion) takes precedence over property values and default value.
```
 .interfaceVersion(InterfaceVersion.VERSION_5_0)
 .interfaceVersion()
   .properties("${custom.property.high-priority}", "${custom.property.low-priority}")
   .defaultValue(InterfaceVersion.VERSION_3_4)
 
```
    The value InterfaceVersion.VERSION_5_0 is used regardless of the value of the properties and default value.
    See ConfigurationValueBuilder for more information.
    Returns:
    
    the builder to configure property keys/default value
  - bindType
```
public CloudhopperBuilder bindType(com.cloudhopper.smpp.SmppBindType bindType)
```
    The bind command type (see SmppBindType).
    The value set using this method takes precedence over any property and default value configured using bindType().
```
 .bindType(SmppBindType.TRANSCEIVER)
 .bindType()
   .properties("${custom.property.high-priority}", "${custom.property.low-priority}")
   .defaultValue(SmppBindType.RECEIVER)
 
```
```
 .bindType(SmppBindType.TRANSCEIVER)
 .bindType()
   .properties("${custom.property.high-priority}", "${custom.property.low-priority}")
   .defaultValue(SmppBindType.RECEIVER)
 
```
    In both cases, bindType(SmppBindType.TRANSCEIVER) is used.
    If this method is called several times, only the last value is used.
    If null value is set, it is like not setting a value at all. The property/default value configuration is applied.
    Parameters:
    
    bindType - the bind type
    
    Returns:
    
    this instance for fluent chaining
  - bindType
```
public ConfigurationValueBuilder<CloudhopperBuilder,com.cloudhopper.smpp.SmppBindType> bindType()
```
    The bind command type (see SmppBindType).
    This method is mainly used by Configurers to register some property keys and/or a default value. The aim is to let developer be able to externalize its configuration (using system properties, configuration file or anything else). If the developer doesn't configure any value for the registered properties, the default value is used (if set).
```
 .bindType()
   .properties("${custom.property.high-priority}", "${custom.property.low-priority}")
   .defaultValue(SmppBindType.RECEIVER)
 
```
    Non-null value set using bindType(SmppBindType) takes precedence over property values and default value.
```
 .bindType(SmppBindType.TRANSCEIVER)
 .bindType()
   .properties("${custom.property.high-priority}", "${custom.property.low-priority}")
   .defaultValue(SmppBindType.RECEIVER)
 
```
    The value SmppBindType.TRANSCEIVER is used regardless of the value of the properties and default value.
    See ConfigurationValueBuilder for more information.
    Returns:
    
    the builder to configure property keys/default value
  - encoder
```
public EncoderBuilder encoder()
```
    Configures how Cloudhopper will encode SMS messages. Charsets defined by the SMPP protocol may be different from NIO charsets.
    The encoder will be used to transform Java String into a byte array that is understandable by SMPP servers.
    This builder configures encoders for both messages that are split and message that are not split.
    This builder allows to configure:
    - Enable/disable the standard GSM encoders (GSM 7-bit, GSM 8-bit and UCS-2) as defined in GSM 03.38 specification. It also allows to define different priority order
    - Enable/disable automatic guessing of encoding (based on previously registered priorities).
    - Define a fallback encoder based on Charset
    - Provide custom Encoders
```
 
 .encoder()
    .gsm7()
      .properties("${ogham.sms.cloudhopper.encoder.gsm7bit-packed.priority}", "${ogham.sms.smpp.encoder.gsm7bit-packed.priority}")
      .defaultValue(100000)
      .and()
    .gsm8()
      .properties("${ogham.sms.cloudhopper.encoder.gsm8bit.priority}", "${ogham.sms.smpp.encoder.gsm8bit.priority}")
      .defaultValue(99000)
      .and()
    .ucs2()
      .properties("${ogham.sms.cloudhopper.encoder.ucs2.priority}", "${ogham.sms.smpp.encoder.ucs2.priority}")
      .defaultValue(98000)
      .and()
    .autoGuess()
      .properties("${ogham.sms.cloudhopper.encoder.auto-guess.enable}", "${ogham.sms.smpp.encoder.auto-guess.enable}")
      .defaultValue(true)
      .and()
    .fallback()
      .properties("${ogham.sms.cloudhopper.encoder.default-charset}", "${ogham.sms.smpp.encoder.default-charset}")
      .defaultValue(CharsetUtil.NAME_GSM)
      .and()
    .customEncoder(new MyCustomEncoder(), 50000)
 
 
```
    Returns:
    
    the builder to configure the encoder
  - splitter
```
public MessageSplitterBuilder splitter()
```
    Configures how Cloudhopper will split messages.
    The splitter will check if the whole message can fit in a single segment. If not the splitter will split the whole message in several segments with a header to indicate splitting information such as number of segments, reference number and current segment number.
    Encoder configured using encoder() is used to encode each segment.
    If automatic guessing of best standard encoder is enabled for Encoder (using encoder().autoGuess(true)), and message splitting is enabled, then standard message splitting is configured such as:
    - If GSM 7-bit encoder is enabled, GsmMessageSplitter is used to split messages that support this encoding. If whole message can fit in a single segment of 160 characters. Longer message is split into segments of either 153 characters or 152 characters (depending on reference number generation, see ReferenceNumberGenerator)
    - If GSM 8-bit encoder is enabled, GsmMessageSplitter is used to split messages that support this encoding. If whole message can fit in a single segment of 140 characters. Longer message is split into segments of either 134 characters or 133 characters (depending on reference number generation, see ReferenceNumberGenerator)
    - If UCS-2 encoder is enabled, GsmMessageSplitter is used to split messages that support this encoding. If whole message can fit in a single segment of 70 characters. Longer message is split into segments of either 67 characters or 66 characters (depending on reference number generation, see ReferenceNumberGenerator)
    Each registered splitter uses the same priority as associated Encoder. If you don't want standard message splitting based on supported Encoders, you can either disable message splitting or provide a custom splitter with higher priority.
    This builder allows to configure:
    - Enable/disable message splitting
    - Provide a custom split strategy
    - Choose strategy for reference number generation
    Examples of usage:
```
 
 .splitter()
   .enable()
     .properties("${ogham.sms.cloudhopper.split.enable}", "${ogham.sms.smpp.split.enable}", "${ogham.sms.split.enable}")
     .defaultValue(true)
     .and()
   .customSplitter(new MyCustomSplitter(), 100000)
   .referenceNumber()
     .random()
     .random(new Random())
     .generator(new MyCustomReferenceNumberGenerator())
 
 
```
    Returns:
    
    the builder to configure message splitting
  - session
```
public SessionBuilder session()
```
    Configures Cloudhopper session management (timeouts, retry, session name...).
    
    Returns:
    
    the builder to configure the session management
  - session
```
public CloudhopperBuilder session(ExtendedSmppSessionConfiguration session)
```
    Overrides any previously defined Cloudhopper parameters to use the provided session.
    If this method is called several times, only the last session is used.
    
    Parameters:
    
    session - the Cloudhopper session to use
    
    Returns:
    
    this instance for fluent chaining
  - addressRange
```
public CloudhopperBuilder addressRange(com.cloudhopper.smpp.type.Address range)
```
    The address_range parameter is used in the bind_receiver and bind_transceiver command to specify a set of SME addresses serviced by the ESME client. A single SME address may also be specified in the address_range parameter. UNIX Regular Expression notation should be used to specify a range of addresses. Messages addressed to any destination in this range shall be routed to the ESME. Default to null. Note: For IP addresses, it is only possible to specify a single IP address. A range of IP addresses are not allowed. IP version 6.0 is not currently supported in this version of the protocol. Note: It is likely that the addr_range field is not supported or deliberately ignored on most Message Centres. The reason for this is that most carriers will not allow an ESME control the message routing as this can carry the risk of mis-routing messages. In such circumstances, the ESME will be requested to set the field to NULL.
    
    Parameters:
    
    range - the address range
    
    Returns:
    
    this instance for fluent chaining
  - ssl
```
public SslBuilder ssl()
```
    Enable or disable SSL configuration and configure how SSL is handled. See How to use SSL with cloudhopper-smpp
    
    Returns:
    
    the builder to configure SSL
  - logging
```
public LoggingBuilder logging()
```
    Configure logs:
    - Enable/disable log of Pdus
    - Enable/disable log of bytes
    Returns:
    
    the builder to enable/disable some logs
  - clientSupplier
```
public CloudhopperBuilder clientSupplier(SmppClientSupplier supplier)
```
    By default, CloudhopperSMPPSender uses DefaultSmppClient client. This option provides a way to use another SmppClient.
    
    Parameters:
    
    supplier - an implementation that provides an instance of a SmppClient
    
    Returns:
    
    this instance for fluent chaining
  - smppSessionHandlerSupplier
```
public CloudhopperBuilder smppSessionHandlerSupplier(SmppSessionHandlerSupplier supplier)
```
    By default, CloudhopperSMPPSender uses DefaultSmppSessionHandler. This option provides a way to use another SmppSessionHandler.
    
    Parameters:
    
    supplier - an implementation that provides an instance of a SmppSessionHandler
    
    Returns:
    
    this instance for fluent chaining
  - messagePreparator
```
public CloudhopperBuilder messagePreparator(MessagePreparator preparator)
```
    Sms message is converted to SubmitSm(s) using a MessagePreparator.
    You can provide a custom MessagePreparator instance if the default behavior doesn't fit your needs.
    
    If a custom MessagePreparator is set, any other preparator (using userData()) is not used.
    
    If this method is called several times, only the last value is used.
    
    If null value is provided, then custom MessagePreparator is disabled. Other configured preparators are used (using userData()).
    
    Parameters:
    
    preparator - the custom preprator instance
    
    Returns:
    
    this instance for fluent chaining
    
    See Also:
    
    userData()
  - userData
```
public UserDataBuilder userData()
```
    SMS message (named "User Data" in SMPP specification) can be transmitted using:
    - Either short_message field (standard field for "User Data").
    - Or message_payload optional parameter.
    This builder allow to configure which strategy to use for sending message:
    - Either use short_message field
    - Or use message_payload field
    The result of userData() configuration affects the message preparation strategy.
    
    Examples of usage:
```
 
 .userData()
   .useShortMessage()
     .properties("${ogham.sms.cloudhopper.user-data.use-short-message}", "${ogham.sms.smpp.user-data.use-short-message}")
     .defaultValue(true)
     .and()
   .useTlvMessagePayload()
     .properties("${ogham.sms.cloudhopper.user-data.use-tlv-message-payload}", "${ogham.sms.smpp.user-data.use-tlv-message-payload}")
     .defaultValue(false)
 
 
```
    If any of ogham.sms.cloudhopper.user-data.use-short-message property or ogham.sms.user-data.use-short-message property is set to true, it uses short_message field. If any of ogham.sms.cloudhopper.user-data.use-tlv-message-payload property or ogham.sms.user-data.use-tlv-message-payload property is set to true, it uses message_payload field. If none of the above properties is set, it uses short_message field is used (last value of shortMessage is set to "true").
    If userData() is not configured at all, then default behavior is used (short_message field is used).
    Returns:
    
    the builder to configure how the "User Data" is sent
  - dataCodingScheme
```
public DataCodingSchemeBuilder dataCodingScheme()
```
    Data Coding Scheme is a one-octet field in Short Messages (SM) and Cell Broadcast Messages (CB) which carries a basic information how the recipient handset should process the received message. The information includes:
    - the character set or message coding which determines the encoding of the message user data
    - the message class which determines to which component of the Mobile Station (MS) or User Equipment (UE) should be the message delivered
    - the request to automatically delete the message after reading
    - the state of flags indicating presence of unread voicemail, fax, e-mail or other messages
    - the indication that the message content is compressed
    - the language of the cell broadcast message
    The field is described in 3GPP 23.040 and 3GPP 23.038 under the name TP-DCS (see SMS Data Coding Scheme). SMPP 3.4 introduced a new list of data_coding values (see Short Message Peer to Peer).
    This builder allows to configure how Data Coding Scheme value is determined:
    - Use automatic mode base on interface version (see interfaceVersion(InterfaceVersion) and interfaceVersion(Byte)) and charset encoding (see encoder()) used to encode the message ("User Data")
    - Use a fixed value used for every message
    - Use a custom implementation
    Examples of usage:
```
 
 .dataCodingScheme()
   .auto("${ogham.sms.cloudhopper.data-coding-scheme.auto.enable}", "${ogham.sms.smpp.data-coding-scheme.auto.enable}")
   .value("${ogham.sms.cloudhopper.data-coding-scheme.value}", "${ogham.sms.smpp.data-coding-scheme.value}")
   .custom(new MyCustomDataCodingProvider())
 
 
```
    See DataCodingSchemeBuilder.auto(Boolean), DataCodingSchemeBuilder.value(Byte) and DataCodingSchemeBuilder.custom(DataCodingProvider) for more information.
    Returns:
    
    the builder to configure how to determine Data Coding Scheme value
  - build
```
public CloudhopperSMPPSender build()
```
    Description copied from interface: Builder
    
    Instantiate and configures the instance.
    
    Specified by:
    
    build in interface Builder<CloudhopperSMPPSender>
    
    Returns:
    
    The built instance

Class CloudhopperBuilder

Field Summary

Fields inherited from class fr.sii.ogham.core.fluent.AbstractParent

Constructor Summary

Method Summary

Methods inherited from class fr.sii.ogham.core.fluent.AbstractParent

Methods inherited from class java.lang.Object

Constructor Detail

CloudhopperBuilder

CloudhopperBuilder

Method Detail

systemId

systemId

systemType

systemType

password

password

host

host

port

port

interfaceVersion

interfaceVersion

interfaceVersion

bindType

bindType

encoder

splitter

session

session

addressRange

ssl

logging

clientSupplier

smppSessionHandlerSupplier

messagePreparator

userData

dataCodingScheme

build