Package org.cyclos.impl.utils.sms

Class BaseSmsOperation

java.lang.Object

org.cyclos.impl.utils.sms.BaseSmsOperation

All Implemented Interfaces:

SmsOperation

Direct Known Subclasses:

AcceptPaymentRequestSmsOperation, AccountInformationSmsOperation, CustomSmsOperation, DenyPaymentRequestSmsOperation, HelpSmsOperation, PaymentSmsOperation, PerformExternalPaymentSmsOperation, RedeemVoucherSmsOperation, RegisterSmsOperation, SendPaymentRequestSmsOperation, TextSmsOperation

public abstract class BaseSmsOperation
extends Object
implements SmsOperation

Base class for SMS operations

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	BaseSmsOperation.BaseError	Commons built-in sms operation errors.

Field Summary

Fields

Modifier and Type	Field	Description
protected AccountHandler	accountHandler
protected AgreementLogServiceLocal	agreementLogService
protected ConfigurationHandler	configurationHandler
protected ConversionHandler	conversionHandler
protected DataTranslationHandler	dataTranslationHandler
protected EntityManagerHandler	entityManagerHandler
protected InvokerHandler	invokerHandler
protected OutboundSmsHandler	outboundSmsHandler
protected PasswordHandler	passwordHandler
protected ProfileFieldHandler	profileFieldHandler
protected TranslationHandler	translationHandler
protected UserLocatorHandler	userLocatorHandler

Constructor Summary

Constructors

Constructor	Description
BaseSmsOperation()

Method Summary

Modifier and Type	Method	Description
protected abstract void	checkParametersCount(SmsOperationConfiguration operationConfiguration, List<String> parameters)	This method must be implemented to check the minimum and maximum expected parameters
protected abstract void	doExecute(SmsOperationConfiguration operationConfiguration, MobilePhone phone, InboundSmsData sms, SmsParameterProcessor processor)
void	execute(SmsOperationConfiguration operationConfiguration, MobilePhone phone, InboundSmsData sms)	Executes this operation for the given context
protected String	formatShort(AccountOwner accountOwner)
protected SmsOperationFormatterImpl	getFormatter()
String	getHelp(SmsOperationConfiguration operationConfiguration, String alias)
protected abstract List<String>	getHelpComponents(SmsOperationConfiguration operationConfiguration)
protected String	getLongestAlias(SmsOperationConfiguration operationConfiguration)
SmsOperationExecution	getOperationExecution(SmsOperationConfiguration operationConfiguration)	Returns who can execute this operation
protected SessionData	getSessionData()
protected void	handleError(MobilePhone phone, String phoneNumber, SmsOperationConfiguration operationConfiguration, Exception err)
protected String	message(MessageKey key, Object... args)
protected void	sendEvenIfDisabled(MobilePhone phone, String response)
protected void	sendResponse(MobilePhone phone, String response)
protected void	sendToUnregistered(String phoneNumber, String response)

Methods inherited from class java.lang.Object

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

Field Detail

passwordHandler

@Autowired
protected PasswordHandler passwordHandler

invokerHandler

@Autowired
protected InvokerHandler invokerHandler

userLocatorHandler

@Autowired
protected UserLocatorHandler userLocatorHandler

outboundSmsHandler

@Autowired
protected OutboundSmsHandler outboundSmsHandler

translationHandler

@Autowired
protected TranslationHandler translationHandler

dataTranslationHandler

@Autowired
protected DataTranslationHandler dataTranslationHandler

configurationHandler

@Autowired
protected ConfigurationHandler configurationHandler

conversionHandler

@Autowired
protected ConversionHandler conversionHandler

accountHandler

@Autowired
protected AccountHandler accountHandler

profileFieldHandler

@Autowired
protected ProfileFieldHandler profileFieldHandler

entityManagerHandler

@Autowired
protected EntityManagerHandler entityManagerHandler

agreementLogService

@Autowired
protected AgreementLogServiceLocal agreementLogService

Constructor Detail

BaseSmsOperation

public BaseSmsOperation()

Method Detail

execute

public final void execute(SmsOperationConfiguration operationConfiguration,
                          MobilePhone phone,
                          InboundSmsData sms)
                   throws SmsOperationException

Description copied from interface: SmsOperation

Executes this operation for the given context

Specified by:

execute in interface SmsOperation

Throws:

SmsOperationException - if any error has occurred processing the operation

getHelp

public final String getHelp(SmsOperationConfiguration operationConfiguration,
                            String alias)

Specified by:

getHelp in interface SmsOperation

Returns:

a help message for the operation

getOperationExecution

public SmsOperationExecution getOperationExecution(SmsOperationConfiguration operationConfiguration)

Description copied from interface: SmsOperation

Returns who can execute this operation

Specified by:

getOperationExecution in interface SmsOperation

checkParametersCount

protected abstract void checkParametersCount(SmsOperationConfiguration operationConfiguration,
                                             List<String> parameters)
                                      throws SmsOperationException

This method must be implemented to check the minimum and maximum expected parameters

Throws:

SmsOperationException

doExecute

protected abstract void doExecute(SmsOperationConfiguration operationConfiguration,
                                  MobilePhone phone,
                                  InboundSmsData sms,
                                  SmsParameterProcessor processor)
                           throws CyclosException

Throws:

CyclosException

formatShort

protected String formatShort(AccountOwner accountOwner)

getFormatter

protected SmsOperationFormatterImpl getFormatter()

getHelpComponents

protected abstract List<String> getHelpComponents(SmsOperationConfiguration operationConfiguration)

getLongestAlias

protected String getLongestAlias(SmsOperationConfiguration operationConfiguration)

getSessionData

protected SessionData getSessionData()

handleError

protected void handleError(MobilePhone phone,
                           String phoneNumber,
                           SmsOperationConfiguration operationConfiguration,
                           Exception err)
                    throws SmsOperationException

Throws:

SmsOperationException

message

protected String message(MessageKey key,
                         Object... args)

sendEvenIfDisabled

protected void sendEvenIfDisabled(MobilePhone phone,
                                  String response)

sendResponse

protected void sendResponse(MobilePhone phone,
                            String response)

sendToUnregistered

protected void sendToUnregistered(String phoneNumber,
                                  String response)