fr.sii.ogham.sms.builder.ovh

Class DefaultOvhSmsConfigurer

java.lang.Object

fr.sii.ogham.sms.builder.ovh.DefaultOvhSmsConfigurer

public final class DefaultOvhSmsConfigurer
extends Object

Default configurer that configures sending of SMS through OVH HTTP API .The configurer is automatically applied every time a MessagingBuilder instance is created through MessagingBuilder.standard().

The configurer has a priority of 20000 in order to be applied after templating configurers, email configurers and SMPP configurer.

This configurer is always applied but sender is only used if OVH URL, account, username and password are defined.

This configurer inherits environment configuration (see BuildContext).

This configurer applies the following configuration:

• Configures OVH URL:
  • It uses the property "ogham.sms.ovh.url" if defined. By default URL is "https://www.ovh.com/cgi-bin/sms/http2sms.cgi"
• Configures authentication:
  • It uses properties "ogham.sms.ovh.account", "ogham.sms.ovh.login" and "ogham.sms.ovh.password" (these properties are mandatory to be able to send SMS through OVH)
• Configures extra options:
  • It uses "ogham.sms.ovh.options.no-stop" property value to enable/disable "STOP" indication at the end of the message (useful to disable for non-commercial SMS). Default to true (disabled)
  • It uses "ogham.sms.ovh.options.sms-coding" property value to define message encoding (see SmsCoding): 1 for 7bit encoding, 2 for 16bit encoding (Unicode). If you use Unicode, your SMS will have a maximum size of 70 characters instead of 160. If nothing specified, auto-detection is used. Set this property if you want to force SmsCoding value.
  • It uses "ogham.sms.ovh.options.tag" to mark sent messages with a 20 maximum character string

Author:

Aurélien Baudet

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DefaultOvhSmsConfigurer.OvhSmsConfigurer

Method Summary

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait