fr.sii.ogham.sms.builder

Class SmsBuilder

java.lang.Object

fr.sii.ogham.sms.builder.SmsBuilder

All Implemented Interfaces:

Builder<ConditionalSender>, MessagingSenderBuilder<ConditionalSender>

public class SmsBuilder
extends Object
implements MessagingSenderBuilder<ConditionalSender>

Specialized builder for SMS sender.

There exists several implementations to send an SMS:

• Using cloudhopper (SMPP library)
• Using jsmpp (SMPP library)
• Using any other library
• Using HTTP request to drive OVH API
• Using REST, HTTP or SOAP requests to drive smsglobal APIs
• Using any other web service
• ...

This builder provides a MultiImplementationSender. The aim of the MultiImplementationSender is to choose the best implementation for sending the SMS according to the runtime environment (detection of libraries in the classpath, availability of a particular property, ...).

This builder lets you the possibility to register any new implementation. It allows you to enable or not templating support and automatic filling of message values (like sender address for example).

Author:

Aurélien Baudet

See Also:

SmsSender, OvhSmsSender, CloudhopperSMPPSender, TemplateBuilder, ContentTranslatorBuilder, MessageFillerBuilder

Constructor Summary

Constructors

Constructor and Description
SmsBuilder()

Method Summary

Modifier and Type	Method and Description
ConditionalSender	build() Build the object
SmsBuilder	enableSmsTemplateKeys() Calling this method will enable different location for SMS templates from default one.
ContentTranslatorBuilder	getContentTranslatorBuilder() Get the builder used transform the content of the message.
MessageFillerBuilder	getMessageFillerBuilder() Get the builder used for filling messages.
PhoneNumberTranslatorBuilder	getRecipientNumberTranslatorBuilder() Get the builder for transformation of recipient phone numbers.
PhoneNumberTranslatorBuilder	getSenderNumberTranslatorBuilder() Get the builder for transformation of sender phone numbers.
TemplateBuilder	getTemplateBuilder() Shortcut to directly access template builder for fine tuning templating mechanism.
SmsBuilder	registerDefaultImplementations() Register all default implementations: OVH HTTP API implementation Configuration values come from system properties.
SmsBuilder	registerDefaultImplementations(Properties properties) Register all default implementations: OVH HTTP API implementation smsgloabl REST API implementation Cloudhopper SMPP implementation Configuration values come from provided properties.
SmsBuilder	registerImplementation(Condition<Message> condition, Builder<? extends MessageSender> builder) Register a new implementation for sending SMS.
SmsBuilder	registerImplementation(Condition<Message> condition, MessageSender implementation) Register a new implementation for sending SMS.
SmsBuilder	setTemplateExtensionKey(String extensionKey) Calling this method will enable different location for SMS templates from default one.
SmsBuilder	setTemplateParentPathKey(String parentPathKey) Calling this method will enable different location for SMS templates from default one.
SmsBuilder	useDefaults() Tells the builder to use all default behaviors and values: Registers OVH HTTP API implementation Enables automatic filling of message based on configuration properties Enables templating support Configuration values come from system properties.
SmsBuilder	useDefaults(Properties properties) Tells the builder to use all default behaviors and values: Registers OVH HTTP API implementation Enables automatic filling of message based on configuration properties Enables templating support Configuration values come from provided properties.
SmsBuilder	withAutoFilling() Enables filling of SMS with values that comes from system configuration properties.
SmsBuilder	withAutoFilling(MessageFillerBuilder builder) Enables automatic filling of SMS with values that come from multiple sources.
SmsBuilder	withAutoFilling(Properties props) Enables filling of SMS with values that comes from provided configuration properties.
SmsBuilder	withAutoFilling(Properties props, String... baseKeys) Enables filling of SMS with values that comes from provided configuration properties.
SmsBuilder	withCloudhopper(Properties properties) Enable Cloudhoppder SMPP implementation.
SmsBuilder	withoutTemplate() Disable templating support.
SmsBuilder	withOvhHttpApi(Properties properties) Enable OVH HTTP API implementation.
SmsBuilder	withPhoneNumberTranslation() Enables Addressing strategy using all default behaviors and values.
SmsBuilder	withPhoneNumberTranslation(PhoneNumberTranslatorBuilder senderBuilder, PhoneNumberTranslatorBuilder recipientBuilder) Enables Addressing strategy using the provided SenderPhoneNumberTranslatorBuilder and RecipientPhoneNumberTranslatorBuilder.
SmsBuilder	withReceiverPhoneNumberTranslation(PhoneNumberTranslatorBuilder builder) Enables Addressing strategy using the provided RecipientPhoneNumberTranslatorBuilder.
SmsBuilder	withSenderPhoneNumberTranslation(PhoneNumberTranslatorBuilder builder) Enables Addressing strategy using the provided SenderPhoneNumberTranslatorBuilder.
SmsBuilder	withSmsglobalRestApi(Properties properties) Enable smsglobal REST API implementation.
SmsBuilder	withTemplate() Enables templating support using all default behaviors and values.
SmsBuilder	withTemplate(ContentTranslatorBuilder builder) Enables templating support using the provided ContentTranslatorBuilder.

Methods inherited from class java.lang.Object

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

Constructor Detail

SmsBuilder

public SmsBuilder()

Method Detail

build

public ConditionalSender build()
                        throws BuildException

Description copied from interface: Builder

Build the object

Specified by:

build in interface Builder<ConditionalSender>

Returns:

The built object

Throws:

BuildException - when the object couldn't be constructed

useDefaults

public SmsBuilder useDefaults()

Tells the builder to use all default behaviors and values:

• Registers OVH HTTP API implementation
• Enables automatic filling of message based on configuration properties
• Enables templating support

Configuration values come from system properties.

Returns:

this instance for fluent use

useDefaults

public SmsBuilder useDefaults(Properties properties)

Tells the builder to use all default behaviors and values:

• Registers OVH HTTP API implementation
• Enables automatic filling of message based on configuration properties
• Enables templating support

Configuration values come from provided properties.

Parameters:

properties - the properties to use instead of default ones

Returns:

this instance for fluent use

registerImplementation

public SmsBuilder registerImplementation(Condition<Message> condition,
                                         MessageSender implementation)

Register a new implementation for sending SMS. The implementation is associated to a condition. If the condition evaluation returns true at runtime then it means that the implementation can be used. If several implementations are available, only the first implementation is really invoked.

Parameters:

condition - the condition that indicates at runtime if the implementation can be used or not

implementation - the implementation to register

Returns:

this instance for fluent use

registerImplementation

public SmsBuilder registerImplementation(Condition<Message> condition,
                                         Builder<? extends MessageSender> builder)

Register a new implementation for sending SMS. The implementation is associated to a condition. If the condition evaluation returns true at runtime then it means that the implementation can be used. If several implementations are available, only the first implementation is really invoked.

Parameters:

condition - the condition that indicates at runtime if the implementation can be used or not

builder - the builder for the implementation to register

Returns:

this instance for fluent use

registerDefaultImplementations

public SmsBuilder registerDefaultImplementations()

Register all default implementations:

• OVH HTTP API implementation

Configuration values come from system properties.

Automatically called by useDefaults() and useDefaults(Properties)

Returns:

this instance for fluent use

registerDefaultImplementations

public SmsBuilder registerDefaultImplementations(Properties properties)

Register all default implementations:

• OVH HTTP API implementation
• smsgloabl REST API implementation
• Cloudhopper SMPP implementation

Configuration values come from provided properties.

Automatically called by useDefaults() and useDefaults(Properties)

Parameters:

properties - the properties to use

Returns:

this instance for fluent use

withSmsglobalRestApi

public SmsBuilder withSmsglobalRestApi(Properties properties)

Enable smsglobal REST API implementation. This implementation is used only if the associated condition indicates that smsglobal REST API can be used. The condition checks if:

• The property ogham.sms.smsglobal.api.key is set

Parameters:

properties - the properties to use for checking if property exists

Returns:

this builder instance for fluent use

withOvhHttpApi

public SmsBuilder withOvhHttpApi(Properties properties)

Enable OVH HTTP API implementation. This implementation is used only if the associated condition indicates that OVH HTTP API can be used. The condition checks if:

• The property ogham.sms.ovh.account is set
• The property ogham.sms.ovh.login is set
• The property ogham.sms.ovh.password is set

Parameters:

properties - the properties to use for checking if property exists

Returns:

this builder instance for fluent use

withCloudhopper

public SmsBuilder withCloudhopper(Properties properties)

Enable Cloudhoppder SMPP implementation. This implementation is used only if the associated condition indicates that Cloudhopper SMPP can be used. The condition checks if:

• The property ogham.sms.smpp.host is set
• The property ogham.sms.smpp.port is set
• The class com.cloudhopper.smpp.SmppClient is available in the classpath

The registration can silently fail if the ch-smpp jar is not in the classpath. In this case, the Cloudhopper implementation is not registered at all.

Parameters:

properties - the properties to use for checking if property exists

Returns:

this builder instance for fluent use

withAutoFilling

public SmsBuilder withAutoFilling(MessageFillerBuilder builder)

Enables automatic filling of SMS with values that come from multiple sources. It let you use your own builder instead of using default behaviors.

Parameters:

builder - the builder for constructing the message filler

Returns:

this instance for fluent use

withAutoFilling

public SmsBuilder withAutoFilling(Properties props,
                                  String... baseKeys)

Enables filling of SMS with values that comes from provided configuration properties.

Automatically called by useDefaults() and useDefaults(Properties)

Parameters:

props - the properties that contains the values to set on the SMS

baseKeys - the prefix(es) for the keys used for filling the message

Returns:

this instance for fluent use

withAutoFilling

public SmsBuilder withAutoFilling(Properties props)

Enables filling of SMS with values that comes from provided configuration properties. It uses the default prefix for the keys ("sms" and "ogham.sms").

Automatically called by useDefaults() and useDefaults(Properties)

Parameters:

props - the properties that contains the values to set on the SMS

Returns:

this instance for fluent use

withAutoFilling

public SmsBuilder withAutoFilling()

Enables filling of SMS with values that comes from system configuration properties. It uses the default prefixes for the keys ("sms" and "ogham.sms").

Automatically called by useDefaults() and useDefaults(Properties)

Returns:

this instance for fluent use

withTemplate

public SmsBuilder withTemplate()

Enables templating support using all default behaviors and values. See ContentTranslatorBuilder.useDefaults() for more information.

Automatically called by useDefaults() and useDefaults(Properties)

Returns:

this instance for fluent use

withTemplate

public SmsBuilder withTemplate(ContentTranslatorBuilder builder)

Enables templating support using the provided ContentTranslatorBuilder. It decorates the SMS sender with a ContentTranslatorSender.

Parameters:

builder - the builder to use to build the ContentTranslator instead of using the default one

Returns:

this instance for fluent use

withoutTemplate

public SmsBuilder withoutTemplate()

Disable templating support.

Returns:

this instance for fluent use

enableSmsTemplateKeys

public SmsBuilder enableSmsTemplateKeys()

Calling this method will enable different location for SMS templates from default one. The location will be specified by different property keys for parent path and extension.

By default default properties are:

• ogham.template.prefix (see TemplateConstants.PREFIX_PROPERTY)
• ogham.template.suffix (see TemplateConstants.SUFFIX_PROPERTY

Calling this method will change the property keys to:

• ogham.sms.template.prefix (see SmsConstants.TemplateConstants.PREFIX_PROPERTY
• ogham.sms.template.suffix (see SmsConstants.TemplateConstants.SUFFIX_PROPERTY

Returns:

this instance for fluent use

setTemplateParentPathKey

public SmsBuilder setTemplateParentPathKey(String parentPathKey)

Calling this method will enable different location for SMS templates from default one. The location will be specified by a different property key for parent path.

By default default property key is ogham.template.prefix (see TemplateConstants.PREFIX_PROPERTY)

Calling this method will change the property key to the provided key.

Parameters:

parentPathKey - the new key for the SMS template parent path

Returns:

this instance for fluent use

setTemplateExtensionKey

public SmsBuilder setTemplateExtensionKey(String extensionKey)

Calling this method will enable different location for SMS templates from default one. The location will be specified by a different property key for extension.

By default default property key is ogham.template.suffix (see TemplateConstants.SUFFIX_PROPERTY)

Calling this method will change the property key to the provided key.

Parameters:

extensionKey - the new key for the SMS template extension

Returns:

this instance for fluent use

withPhoneNumberTranslation

public SmsBuilder withPhoneNumberTranslation()

Enables Addressing strategy using all default behaviors and values. See SenderPhoneNumberTranslatorBuilder and RecipientPhoneNumberTranslatorBuilder.

Automatically called by useDefaults() and useDefaults(Properties)

Returns:

this instance for fluent use

withPhoneNumberTranslation

public SmsBuilder withPhoneNumberTranslation(PhoneNumberTranslatorBuilder senderBuilder,
                                             PhoneNumberTranslatorBuilder recipientBuilder)

Enables Addressing strategy using the provided SenderPhoneNumberTranslatorBuilder and RecipientPhoneNumberTranslatorBuilder. It decorates the SMS sender with a PhoneNumberTranslatorSender

Parameters:

senderBuilder - the builder to use to build the PhoneNumberTranslator for sender instead of using the default one

recipientBuilder - the builder to use to build the PhoneNumberTranslator for sender instead of using the default one

Returns:

this instance for fluent use

withReceiverPhoneNumberTranslation

public SmsBuilder withReceiverPhoneNumberTranslation(PhoneNumberTranslatorBuilder builder)

Enables Addressing strategy using the provided RecipientPhoneNumberTranslatorBuilder. It decorates the SMS sender with a PhoneNumberTranslatorSender

Parameters:

builder - the builder to use to build the PhoneNumberTranslator instead of using the default one

Returns:

this instance for fluent use

withSenderPhoneNumberTranslation

public SmsBuilder withSenderPhoneNumberTranslation(PhoneNumberTranslatorBuilder builder)

Enables Addressing strategy using the provided SenderPhoneNumberTranslatorBuilder. It decorates the SMS sender with a PhoneNumberTranslatorSender

Parameters:

builder - the builder to use to build the PhoneNumberTranslator instead of using the default one

Returns:

this instance for fluent use

getMessageFillerBuilder

public MessageFillerBuilder getMessageFillerBuilder()

Get the builder used for filling messages.

Access this builder if you want to:

• Enable/disable automatic filling of messages with values provided in configuration
• Enable/disable automatic filling of subject for messages based on templates
• Add your own message filler

Returns:

the builder used for filling messages

getContentTranslatorBuilder

public ContentTranslatorBuilder getContentTranslatorBuilder()

Get the builder used transform the content of the message. It may be useful to fine tune templating mechanism, resource inlining and messages with with several contents.

Access this builder if you want to:

• Customize templating mechanism (see getTemplateBuilder())
• Enable/disable support for messages with multiple contents
• Enable/disable support for inlining of resources
• Add your own content translator

Returns:

the builder used to transform the content of the message

getTemplateBuilder

public TemplateBuilder getTemplateBuilder()

Shortcut to directly access template builder for fine tuning templating mechanism.

Access this builder if you want to:

• Customize how template resources are resolved
• Register a custom lookup mapping resolver for template resources
• Use your own template engine
• Customize the template engine configuration
• Set the parent path and extension for template resolution
• Set the property key for parent path and extension resolution

Returns:

the template builder

getRecipientNumberTranslatorBuilder

public PhoneNumberTranslatorBuilder getRecipientNumberTranslatorBuilder()

Get the builder for transformation of recipient phone numbers.

Access to this builder if you want to:

• Enable/disable international format transformation

Returns:

the builder for transformation of recipient phone numbers

getSenderNumberTranslatorBuilder

public PhoneNumberTranslatorBuilder getSenderNumberTranslatorBuilder()

Get the builder for transformation of sender phone numbers.

Access to this builder if you want to:

• Enable/disable alpha-numeric format transformation
• Enable/disable short code format transformation
• Enable/disable international format transformation

Returns:

the builder for transformation of sender phone numbers