Package org.cyclos.impl.utils.sms

Class ScriptInboundSmsRequestHandlerImpl

java.lang.Object

org.cyclos.impl.utils.sms.ScriptInboundSmsRequestHandlerImpl

All Implemented Interfaces:

InboundSmsRequestHandler

public class ScriptInboundSmsRequestHandlerImpl
extends Object
implements InboundSmsRequestHandler

Implementation of InboundSmsRequestHandler which delegates the logic to a custom script

Field Summary

Fields

Modifier and Type	Field	Description
static String	ATTR_CHANNEL_CONFIGURATION	Script attribute: the SmsChannelConfiguration
static String	ATTR_CONFIGURATION	Script attribute: the ConfigurationAccessor
static String	ATTR_INBOUND_SMS	Script attribute: the InboundSms
static String	ATTR_INBOUND_SMS_DATA	Script attribute: the InboundSmsData
static String	ATTR_INBOUND_SMS_EXCEPTION	Script attribute: the Exception
static String	ATTR_INBOUND_SMS_RESPONSE_TYPE	Script attribute: the InboundSmsResponseType
static String	ATTR_REQUEST	Script attribute: the RequestInfo
static String	GENERATE_RESPONSE_FUNCTION_NAME	The function name called on scripts for generating the gateway response for a well-formatted request
static String	GENERATE_RESPONSE_MISSING_PARAMETERS_FUNCTION_NAME	The function name called on scripts for generating the gateway response for a request missing parameters
static String	RESOLVE_SMS_DATA_FUNCTION_NAME	The function name called on scripts for resolving the InboundSmsData

Constructor Summary

Constructors

Constructor	Description
ScriptInboundSmsRequestHandlerImpl()

Method Summary

Modifier and Type	Method	Description
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
void	initialize()
InboundSmsBasicData	resolveSmsData(ConfigurationAccessor configuration, SmsChannelConfiguration channelConfiguration, RequestInfo request)	Parses, from the given request, the inbound SMS data

Methods inherited from class java.lang.Object

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

Field Detail

GENERATE_RESPONSE_FUNCTION_NAME

public static final String GENERATE_RESPONSE_FUNCTION_NAME

The function name called on scripts for generating the gateway response for a well-formatted request

See Also:

Constant Field Values

GENERATE_RESPONSE_MISSING_PARAMETERS_FUNCTION_NAME

public static final String GENERATE_RESPONSE_MISSING_PARAMETERS_FUNCTION_NAME

The function name called on scripts for generating the gateway response for a request missing parameters

See Also:

Constant Field Values

RESOLVE_SMS_DATA_FUNCTION_NAME

public static final String RESOLVE_SMS_DATA_FUNCTION_NAME

The function name called on scripts for resolving the InboundSmsData

See Also:

Constant Field Values

ATTR_CONFIGURATION

public static final String ATTR_CONFIGURATION

Script attribute: the ConfigurationAccessor

See Also:

Constant Field Values

ATTR_CHANNEL_CONFIGURATION

public static final String ATTR_CHANNEL_CONFIGURATION

Script attribute: the SmsChannelConfiguration

See Also:

Constant Field Values

ATTR_REQUEST

public static final String ATTR_REQUEST

Script attribute: the RequestInfo

See Also:

Constant Field Values

ATTR_INBOUND_SMS_RESPONSE_TYPE

public static final String ATTR_INBOUND_SMS_RESPONSE_TYPE

Script attribute: the InboundSmsResponseType

See Also:

Constant Field Values

ATTR_INBOUND_SMS_EXCEPTION

public static final String ATTR_INBOUND_SMS_EXCEPTION

Script attribute: the Exception

See Also:

Constant Field Values

ATTR_INBOUND_SMS_DATA

public static final String ATTR_INBOUND_SMS_DATA

Script attribute: the InboundSmsData

See Also:

Constant Field Values

ATTR_INBOUND_SMS

public static final String ATTR_INBOUND_SMS

Script attribute: the InboundSms

See Also:

Constant Field Values

Constructor Detail

ScriptInboundSmsRequestHandlerImpl

public ScriptInboundSmsRequestHandlerImpl()

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

initialize

@PostConstruct
public void initialize()

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