de.hybris.platform.mobileservices.text.engine.impl

Class SMPPSMSEngine

java.lang.Object

de.hybris.platform.mobileservices.text.engine.impl.AbstractSMSEngine

de.hybris.platform.mobileservices.text.engine.impl.SMPPSMSEngine

All Implemented Interfaces:

SMSEngine

public class SMPPSMSEngine
extends AbstractSMSEngine

The Class SMPPSMSEngine.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ENABLED_CFG_PARAMETER
static String	ENCODING_PARAMETER
static String	LOGIN_PARAMETER
static String	MODE_CFG_PARAMETER
static String	PASSWORD_PARAMETER
static String	RETRY_DELAY_PARAMETER
static String	SERVER_PARAMETER
static String	SERVER_PORT_PARAMETER
static String	SERVICE_TYPE_PARAMETER
static String	SHORTCODE_COUNTRY_PARAMETER
static String	SYS_TYPE_PARAMETER
static String	TARIFF_PARAMETER
static String	TIMEOUT_PARAMETER

Fields inherited from class de.hybris.platform.mobileservices.text.engine.impl.AbstractSMSEngine

messageScheduler, modelService, phoneNumberService, STARTUP_DELAY_PARAMETER

Constructor Summary

Constructors

Constructor and Description
SMPPSMSEngine()

Method Summary

Modifier and Type	Method and Description
protected String	collectRawDetails(DeliverSM packet)
protected de.hybris.platform.mobileservices.text.engine.impl.SMPPSMSEngine.SMPPAccountSettings	getAccountParameters(AggregatorSettingsDTO settings)
protected SMPPConnectionPool.SMPPConnection	getConnection(de.hybris.platform.mobileservices.text.engine.impl.SMPPSMSEngine.SMPPAccountSettings accountParameters)
boolean	isAvailable(AggregatorSettingsDTO settings) Tells if the engine currently accepts messages or not.
protected boolean	isSmppEnabled()
protected void	messageReceived(SMPPConnectionPool.SMPPConnection source, DeliverSM pak)
protected void	messageSubmitted(SMPPConnectionPool.SMPPConnection source, SubmitSMResp pak, Object token)
void	send(AggregatorSettingsDTO settings, OutgoingSMSMessageDTO message) Called by mobile framework for immediate sending of a SMS message.
protected void	sendLink(String normalizedPhoneNumber, String subject, String url, OutgoingSMSMessageDTO message, de.hybris.platform.mobileservices.text.engine.impl.SMPPSMSEngine.SMPPAccountSettings accountParameters)
protected void	sendSms(String normalizedPhoneNumber, String inputText, OutgoingSMSMessageDTO message, de.hybris.platform.mobileservices.text.engine.impl.SMPPSMSEngine.SMPPAccountSettings accountParameters)
void	setAvailable(boolean available)
void	setMessageGateway(IncomingSMSMessageGateway messageGateway)
void	setVendor(SMPPProviderStrategy vendor)
void	shutdown() Called once the system is about to shut down.
void	startup(Collection<AggregatorSettingsDTO> aggregatorSettings) Called once upon system startup.
void	updateAggregators(Collection<AggregatorSettingsDTO> aggregatorSettings) May be called while being connected.

Methods inherited from class de.hybris.platform.mobileservices.text.engine.impl.AbstractSMSEngine

getEngineId, getStartupDelaySeconds, setBeanName, setMessageScheduler, setModelService, setPhoneNumberService

Methods inherited from class java.lang.Object

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

Field Detail

SERVER_PARAMETER

public static final String SERVER_PARAMETER

See Also:

Constant Field Values

SERVER_PORT_PARAMETER

public static final String SERVER_PORT_PARAMETER

See Also:

Constant Field Values

LOGIN_PARAMETER

public static final String LOGIN_PARAMETER

See Also:

Constant Field Values

PASSWORD_PARAMETER

public static final String PASSWORD_PARAMETER

See Also:

Constant Field Values

SYS_TYPE_PARAMETER

public static final String SYS_TYPE_PARAMETER

See Also:

Constant Field Values

SERVICE_TYPE_PARAMETER

public static final String SERVICE_TYPE_PARAMETER

See Also:

Constant Field Values

SHORTCODE_COUNTRY_PARAMETER

public static final String SHORTCODE_COUNTRY_PARAMETER

See Also:

Constant Field Values

ENCODING_PARAMETER

public static final String ENCODING_PARAMETER

See Also:

Constant Field Values

TIMEOUT_PARAMETER

public static final String TIMEOUT_PARAMETER

See Also:

Constant Field Values

TARIFF_PARAMETER

public static final String TARIFF_PARAMETER

See Also:

Constant Field Values

ENABLED_CFG_PARAMETER

public static final String ENABLED_CFG_PARAMETER

See Also:

Constant Field Values

MODE_CFG_PARAMETER

public static final String MODE_CFG_PARAMETER

See Also:

Constant Field Values

RETRY_DELAY_PARAMETER

public static final String RETRY_DELAY_PARAMETER

See Also:

Constant Field Values

Constructor Detail

SMPPSMSEngine

public SMPPSMSEngine()

Method Detail

startup

public void startup(Collection<AggregatorSettingsDTO> aggregatorSettings)

Description copied from interface: SMSEngine

Called once upon system startup. If necessary the engine should connect to external systems using the provided aggregator settings.

Specified by:

startup in interface SMSEngine

Overrides:

startup in class AbstractSMSEngine

Parameters:

aggregatorSettings - the settings of all aggregators which are using this engine

updateAggregators

public void updateAggregators(Collection<AggregatorSettingsDTO> aggregatorSettings)

Description copied from interface: SMSEngine

May be called while being connected. If necessary the engine should check if all connections are still valid according to the new collection of aggregator settings. Possible actions may be closing existing connections, opening new connections or re-connecting with different settings.

Specified by:

updateAggregators in interface SMSEngine

Overrides:

updateAggregators in class AbstractSMSEngine

shutdown

public void shutdown()

Description copied from interface: SMSEngine

Called once the system is about to shut down. If necessary the engine should close and clean up all connections.

Specified by:

shutdown in interface SMSEngine

Overrides:

shutdown in class AbstractSMSEngine

sendLink

protected void sendLink(String normalizedPhoneNumber,
                        String subject,
                        String url,
                        OutgoingSMSMessageDTO message,
                        de.hybris.platform.mobileservices.text.engine.impl.SMPPSMSEngine.SMPPAccountSettings accountParameters)
                 throws SMSEngineException

Throws:

SMSEngineException

getConnection

protected SMPPConnectionPool.SMPPConnection getConnection(de.hybris.platform.mobileservices.text.engine.impl.SMPPSMSEngine.SMPPAccountSettings accountParameters)

sendSms

protected void sendSms(String normalizedPhoneNumber,
                       String inputText,
                       OutgoingSMSMessageDTO message,
                       de.hybris.platform.mobileservices.text.engine.impl.SMPPSMSEngine.SMPPAccountSettings accountParameters)
                throws SMSEngineException

Throws:

SMSEngineException

isAvailable

public boolean isAvailable(AggregatorSettingsDTO settings)

Description copied from interface: SMSEngine

Tells if the engine currently accepts messages or not. This methods should return false to signal temporary unavailability. If there is a general (e.g. configuration) problem this should rather be causing a exception in SMSEngine.send(AggregatorSettingsDTO, OutgoingSMSMessageDTO) instead.

Specified by:

isAvailable in interface SMSEngine

Overrides:

isAvailable in class AbstractSMSEngine

Parameters:

settings - the settings of the specific aggregator to check

send

public void send(AggregatorSettingsDTO settings,
                 OutgoingSMSMessageDTO message)
          throws SMSEngineException

Description copied from interface: SMSEngine

Called by mobile framework for immediate sending of a SMS message.

Parameters:

settings - the settings of the specific aggregator to send to

message - the message including aggregator account data

Throws:

SMSEngineException

messageSubmitted

protected void messageSubmitted(SMPPConnectionPool.SMPPConnection source,
                                SubmitSMResp pak,
                                Object token)

messageReceived

protected void messageReceived(SMPPConnectionPool.SMPPConnection source,
                               DeliverSM pak)

setAvailable

public void setAvailable(boolean available)

Parameters:

available - the available flag to set

collectRawDetails

protected String collectRawDetails(DeliverSM packet)

getAccountParameters

protected de.hybris.platform.mobileservices.text.engine.impl.SMPPSMSEngine.SMPPAccountSettings getAccountParameters(AggregatorSettingsDTO settings)

setMessageGateway

public void setMessageGateway(IncomingSMSMessageGateway messageGateway)

isSmppEnabled

protected boolean isSmppEnabled()

setVendor

public void setVendor(SMPPProviderStrategy vendor)

Parameters:

vendor - the vendor to set