Package org.cyclos.impl.utils.sms

Class InboundSmsRequestHandlerImpl

java.lang.Object

org.cyclos.impl.utils.sms.InboundSmsRequestHandlerImpl

All Implemented Interfaces:

InboundSmsRequestHandler

public class InboundSmsRequestHandlerImpl
extends Object
implements InboundSmsRequestHandler

Default implementation for InboundSmsRequestHandler

Field Summary

Fields

Modifier and Type	Field	Description
protected static Pattern	PARAM_PATTERN

Constructor Summary

Constructors

Constructor	Description
InboundSmsRequestHandlerImpl()

Method Summary

Modifier and Type	Method	Description
protected ResponseInfo	generateDefaultResponse()
ResponseInfo	generateResponse(ConfigurationAccessor configuration, SmsChannelConfiguration channelConfiguration, RequestInfo request, InboundSmsData smsData, InboundSms sms)	Generates the response to the SMS gateway
ResponseInfo	generateResponseForError(ConfigurationAccessor configuration, SmsChannelConfiguration channelConfiguration, RequestInfo request, Exception exception)	Generates the response to the SMS gateway when there is a general error
ResponseInfo	generateResponseForMissingParameters(ConfigurationAccessor configuration, SmsChannelConfiguration channelConfiguration, RequestInfo request)	Generates the response to the SMS gateway when the bare minimum parameters - number and message - are missing
protected String	normalizePhoneNumber(ConfigurationAccessor configuration, SmsChannelConfiguration channelConfiguration, RequestInfo request, String phoneNumber)
protected String	processParameters(ConfigurationAccessor configuration, SmsChannelConfiguration channelConfiguration, RequestInfo request, String pattern)	Replaces all parameter names by their values, in the form {paramName}...
InboundSmsBasicData	resolveSmsData(ConfigurationAccessor configuration, SmsChannelConfiguration channelConfiguration, RequestInfo request)	Parses, from the given request, the inbound SMS data
protected List<String>	splitMessageParts(ConfigurationAccessor configuration, SmsChannelConfiguration channelConfiguration, RequestInfo request, String message)	Splits the message by spaces

Methods inherited from class java.lang.Object

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

Field Detail

PARAM_PATTERN

protected static final Pattern PARAM_PATTERN

Constructor Detail

InboundSmsRequestHandlerImpl

public InboundSmsRequestHandlerImpl()

Method Detail

generateResponse

public ResponseInfo generateResponse(ConfigurationAccessor configuration,
                                     SmsChannelConfiguration channelConfiguration,
                                     RequestInfo request,
                                     InboundSmsData smsData,
                                     InboundSms sms)

Description copied from interface: InboundSmsRequestHandler

Generates the response to the SMS gateway

Specified by:

generateResponse in interface InboundSmsRequestHandler

generateResponseForError

public ResponseInfo generateResponseForError(ConfigurationAccessor configuration,
                                             SmsChannelConfiguration channelConfiguration,
                                             RequestInfo request,
                                             Exception exception)

Description copied from interface: InboundSmsRequestHandler

Generates the response to the SMS gateway when there is a general error

Specified by:

generateResponseForError in interface InboundSmsRequestHandler

generateResponseForMissingParameters

public ResponseInfo generateResponseForMissingParameters(ConfigurationAccessor configuration,
                                                         SmsChannelConfiguration channelConfiguration,
                                                         RequestInfo request)

Description copied from interface: InboundSmsRequestHandler

Generates the response to the SMS gateway when the bare minimum parameters - number and message - are missing

Specified by:

generateResponseForMissingParameters in interface InboundSmsRequestHandler

resolveSmsData

public InboundSmsBasicData resolveSmsData(ConfigurationAccessor configuration,
                                          SmsChannelConfiguration channelConfiguration,
                                          RequestInfo request)

Description copied from interface: InboundSmsRequestHandler

Parses, from the given request, the inbound SMS data

Specified by:

resolveSmsData in interface InboundSmsRequestHandler

generateDefaultResponse

protected ResponseInfo generateDefaultResponse()

normalizePhoneNumber

protected String normalizePhoneNumber(ConfigurationAccessor configuration,
                                      SmsChannelConfiguration channelConfiguration,
                                      RequestInfo request,
                                      String phoneNumber)

processParameters

protected String processParameters(ConfigurationAccessor configuration,
                                   SmsChannelConfiguration channelConfiguration,
                                   RequestInfo request,
                                   String pattern)

Replaces all parameter names by their values, in the form {paramName}... For example: abc{param1}-{param2}def, if param1 = 123 and param2 is null, returns abc123-def

splitMessageParts

protected List<String> splitMessageParts(ConfigurationAccessor configuration,
                                         SmsChannelConfiguration channelConfiguration,
                                         RequestInfo request,
                                         String message)

Splits the message by spaces