de.hybris.platform.mobileservices.text.impl

Class DefaultTextService

java.lang.Object

de.hybris.platform.mobileservices.text.impl.DefaultTextService

All Implemented Interfaces:

TextService

public class DefaultTextService
extends Object
implements TextService

Constructor Summary

Constructors

Constructor and Description
DefaultTextService()

Method Summary

Modifier and Type	Method and Description
void	discard(MobileMessageContextModel message, MobileMessageError error, String errorMessage, Throwable cause) While processing a incoming message this methods allows to mark the message as discarded.
void	done(MobileMessageContextModel message) While processing a incoming message this methods allows to mark the message as done.
List<MobileShortcodeModel>	getAvailableShortcodesForSending(CountryModel country) Locates all shortcodes for the specified country which support sending of outgoing messages.
MobileShortcodeModel	getExclusiveShortCode(String shortCode) Looks up a exclusive shortcode using its unique code.
MobileShortcodeModel	getSharedShortCode(String shortCode, String keywordPrefix) Looks up a shared short code by a specified code and keywords
MobileMessageContextModel	replyWithLink(MobileMessageContextModel receivedMessage, String subject, String url) While processing a incoming message this methods allows to send a reply link message using the incoming message information.
MobileMessageContextModel	replyWithLink(MobileShortcodeModel shortcode, MobileMessageContextModel receivedMessage, String subject, String url) While processing a incoming message this methods allows to send a reply link message using the incoming message information.
MobileMessageContextModel	replyWithMessage(MobileMessageContextModel receivedMessage, String text) While processing a incoming message this methods allows to send a reply text message using the incoming message information.
MobileMessageContextModel	replyWithMessage(MobileShortcodeModel shortcode, MobileMessageContextModel receivedMessage, String text) While processing a incoming message this methods allows to send a reply text message using the incoming message information.
MobileMessageContextModel	sendLink(CountryModel country, PhoneNumberModel phone, String subject, String url) Convenience method delegating to TextService.sendLink(String, String, String, String).
MobileMessageContextModel	sendLink(MobileShortcodeModel shortcode, String countryIsoCode, String phone, String subject, String url) Sends a link SMS message to the specified number.
MobileMessageContextModel	sendLink(PhoneNumberModel phone, String subject, String url) Convenience method delegating to TextService.sendLink(String, String, String, String).
MobileMessageContextModel	sendLink(String countryIsoCode, String phone, String subject, String url) Sends a link SMS message to the specified number.
MobileMessageContextModel	sendMessage(CountryModel country, PhoneNumberModel phone, String text) Convenience method delegating to TextService.sendMessage(String, String, String).
MobileMessageContextModel	sendMessage(MobileShortcodeModel shortcode, String countryIsoCode, String phone, String text) Sends a text SMS message to the specified number.
MobileMessageContextModel	sendMessage(PhoneNumberModel phone, String text) Convenience method delegating to TextService.sendMessage(String, String, String).
MobileMessageContextModel	sendMessage(String countryIsoCode, String phone, String text) Sends a text SMS message to the specified number.
void	setFlexibleSearchService(FlexibleSearchService flexibleSearchService)
void	setMessageScheduler(MessageScheduler messageScheduler)
void	setModelService(ModelService modelService)
protected void	validateReceivedMessageForReply(MobileMessageContextModel receivedMessage)
protected void	validateShortcodeForSending(MobileShortcodeModel shortcode)

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultTextService

public DefaultTextService()

Method Detail

getAvailableShortcodesForSending

public List<MobileShortcodeModel> getAvailableShortcodesForSending(CountryModel country)

Description copied from interface: TextService

Locates all shortcodes for the specified country which support sending of outgoing messages.

Please note that the final routing decision is being done by the OutgoingMessageRoutingStrategy which is currently set up in the mobile spring configuration. This method will simply list all potential ones.

Specified by:

getAvailableShortcodesForSending in interface TextService

getExclusiveShortCode

public MobileShortcodeModel getExclusiveShortCode(String shortCode)

Description copied from interface: TextService

Looks up a exclusive shortcode using its unique code.

Specified by:

getExclusiveShortCode in interface TextService

Parameters:

shortCode - the code to look for

getSharedShortCode

public MobileShortcodeModel getSharedShortCode(String shortCode,
                                               String keywordPrefix)

Description copied from interface: TextService

Looks up a shared short code by a specified code and keywords

Specified by:

getSharedShortCode in interface TextService

Parameters:

shortCode - the shared code

keywordPrefix - the keyword

validateShortcodeForSending

protected void validateShortcodeForSending(MobileShortcodeModel shortcode)

sendMessage

public MobileMessageContextModel sendMessage(MobileShortcodeModel shortcode,
                                             String countryIsoCode,
                                             String phone,
                                             String text)

Description copied from interface: TextService

Sends a text SMS message to the specified number. The specified MobileShortcodeModel will be used to send the message on behalf.

Messages are not sent immediately but are enqueue. Therefore the returned model will show intermediate states. Use MessageHelper.blockUntilProcessed(de.hybris.platform.core.PK, long) if you must wait until sending is done.

Specified by:

sendMessage in interface TextService

Parameters:

shortcode - the shortcode to be used for sending (defines aggregator and thus engine)

countryIsoCode - the country for the given phone number

phone - the phone number

text - the message content

Returns:

the scheduled message context model

sendMessage

public MobileMessageContextModel sendMessage(String countryIsoCode,
                                             String phone,
                                             String text)

Description copied from interface: TextService

Sends a text SMS message to the specified number. Internally a suitable MobileShortcodeModel will be found and the message is being sent using its aggregator.

Messages are not sent immediately but are enqueue. Therefore the returned model will show intermediate states. Use MessageHelper.blockUntilProcessed(de.hybris.platform.core.PK, long) if you must wait until sending is done.

Specified by:

sendMessage in interface TextService

Parameters:

countryIsoCode - the country for the given phone number

phone - the phone number

text - the message content

Returns:

the scheduled message context model

sendLink

public MobileMessageContextModel sendLink(MobileShortcodeModel shortcode,
                                          String countryIsoCode,
                                          String phone,
                                          String subject,
                                          String url)

Description copied from interface: TextService

Sends a link SMS message to the specified number. The specified MobileShortcodeModel will be used to send the message on behalf.

Messages are not sent immediately but are enqueue. Therefore the returned model will show intermediate states.

Specified by:

sendLink in interface TextService

Parameters:

shortcode - the shortcode to be used for sending (defines aggregator and thus engine)

Returns:

the scheduled message context model

sendLink

public MobileMessageContextModel sendLink(String countryIsoCode,
                                          String phone,
                                          String subject,
                                          String url)

Description copied from interface: TextService

Sends a link SMS message to the specified number. Internally a suitable MobileShortcodeModel will be found and the message is being sent using its aggregator.

Messages are not sent immediately but are enqueue. Therefore the returned model will show intermediate states.

Specified by:

sendLink in interface TextService

Returns:

the scheduled message context model

validateReceivedMessageForReply

protected void validateReceivedMessageForReply(MobileMessageContextModel receivedMessage)

replyWithMessage

public MobileMessageContextModel replyWithMessage(MobileShortcodeModel shortcode,
                                                  MobileMessageContextModel receivedMessage,
                                                  String text)

Description copied from interface: TextService

While processing a incoming message this methods allows to send a reply text message using the incoming message information.

The specified MobileShortcodeModel will be used to send the message on behalf.

Reply messages are not sent immediately but are enqueue. Therefore the returned model will show intermediate states. Use MessageHelper.blockUntilProcessed(de.hybris.platform.core.PK, long) if you must wait until sending is done.

Specified by:

replyWithMessage in interface TextService

Parameters:

shortcode - the shortcode to be used for sending (defines aggregator and thus engine)

receivedMessage - the previously received message

text - the reply text

Returns:

the scheduled message

replyWithMessage

public MobileMessageContextModel replyWithMessage(MobileMessageContextModel receivedMessage,
                                                  String text)

Description copied from interface: TextService

While processing a incoming message this methods allows to send a reply text message using the incoming message information.

Internally the receiving MobileShortcodeModel may be used for sending or, if more appropriate a suitable short code will be chosen.

Reply messages are not sent immediately but are enqueue. Therefore the returned model will show intermediate states. Use MessageHelper.blockUntilProcessed(de.hybris.platform.core.PK, long) if you must wait until sending is done.

Specified by:

replyWithMessage in interface TextService

Parameters:

receivedMessage - the previously received message

text - the reply text

Returns:

the scheduled message

replyWithLink

public MobileMessageContextModel replyWithLink(MobileShortcodeModel shortcode,
                                               MobileMessageContextModel receivedMessage,
                                               String subject,
                                               String url)

Description copied from interface: TextService

While processing a incoming message this methods allows to send a reply link message using the incoming message information.

The specified MobileShortcodeModel will be used to send the message on behalf.

Reply messages are not sent immediately but are enqueue. Therefore the returned model will show intermediate states. Use MessageHelper.blockUntilProcessed(de.hybris.platform.core.PK, long) if you must wait until sending is done.

Specified by:

replyWithLink in interface TextService

Parameters:

shortcode - the shortcode to be used for sending (defines aggregator and thus engine)

receivedMessage - the previously received message

subject - the reply link subject

url - the reply link url

Returns:

the scheduled message

replyWithLink

public MobileMessageContextModel replyWithLink(MobileMessageContextModel receivedMessage,
                                               String subject,
                                               String url)

Description copied from interface: TextService

While processing a incoming message this methods allows to send a reply link message using the incoming message information.

Internally the receiving MobileShortcodeModel may be used for sending or, if more appropriate a suitable short code will be chosen.

Reply messages are not sent immediately but are enqueue. Therefore the returned model will show intermediate states. Use MessageHelper.blockUntilProcessed(de.hybris.platform.core.PK, long) if you must wait until sending is done.

Specified by:

replyWithLink in interface TextService

Parameters:

receivedMessage - the previously received message

subject - the reply link subject

url - the reply link url

Returns:

the scheduled message

done

public void done(MobileMessageContextModel message)

Description copied from interface: TextService

While processing a incoming message this methods allows to mark the message as done. Such a message is considered as processed without error. The mobile framework is allowed to either delete or archive it from now.

Since message processing is done by custom actions it is recommended that implementors signal the end of processing by calling either TextService.done(MobileMessageContextModel) or TextService.discard(MobileMessageContextModel, MobileMessageError, String, Throwable) in case no reply is being triggered.

Specified by:

done in interface TextService

Parameters:

message - the message to be marked as done.

discard

public void discard(MobileMessageContextModel message,
                    MobileMessageError error,
                    String errorMessage,
                    Throwable cause)

Description copied from interface: TextService

While processing a incoming message this methods allows to mark the message as discarded. It further allows optionally to specify a error type, message and even a causing exception to be specified. Such a message is considered as processed abnormally. Therefore the mobile framework may keep such messages for reporting reasons.

Since message processing is done by custom actions it is recommended that implementors signal the end of processing by calling either TextService.done(MobileMessageContextModel) or TextService.discard(MobileMessageContextModel, MobileMessageError, String, Throwable) in case no reply is being triggered.

Specified by:

discard in interface TextService

Parameters:

message - the message to be marked as done.

sendLink

public MobileMessageContextModel sendLink(CountryModel country,
                                          PhoneNumberModel phone,
                                          String subject,
                                          String url)

Description copied from interface: TextService

Convenience method delegating to TextService.sendLink(String, String, String, String).

Specified by:

sendLink in interface TextService

Parameters:

country - is providing the country iso code for the given phone number

phone - the phone number

subject - the link subject

url - the link url

sendLink

public MobileMessageContextModel sendLink(PhoneNumberModel phone,
                                          String subject,
                                          String url)

Description copied from interface: TextService

Convenience method delegating to TextService.sendLink(String, String, String, String).

Specified by:

sendLink in interface TextService

Parameters:

phone - the phone number model which contains both country and number data

subject - the link subject

url - the link url

sendMessage

public MobileMessageContextModel sendMessage(CountryModel country,
                                             PhoneNumberModel phone,
                                             String text)

Description copied from interface: TextService

Convenience method delegating to TextService.sendMessage(String, String, String).

Specified by:

sendMessage in interface TextService

Parameters:

country - is providing the country iso code for the given phone number

phone - the phone number

text - the message content

sendMessage

public MobileMessageContextModel sendMessage(PhoneNumberModel phone,
                                             String text)

Description copied from interface: TextService

Convenience method delegating to TextService.sendMessage(String, String, String).

Specified by:

sendMessage in interface TextService

Parameters:

phone - the phone number model which contains both country and number data

text - the message content

setModelService

public void setModelService(ModelService modelService)

setFlexibleSearchService

public void setFlexibleSearchService(FlexibleSearchService flexibleSearchService)

setMessageScheduler

public void setMessageScheduler(MessageScheduler messageScheduler)