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

Class AbstractSMSEngine

java.lang.Object

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

All Implemented Interfaces:

SMSEngine

Direct Known Subclasses:

DummyBrokenEngine, DummyEngine, HTTPSendSMSEngine, SMPPSMSEngine

public abstract class AbstractSMSEngine
extends java.lang.Object
implements SMSEngine

Convenience class for new SMSEngine implementations.

Field Summary

Fields

Modifier and Type	Field and Description
protected MessageScheduler	messageScheduler
protected ModelService	modelService
protected PhoneNumberService	phoneNumberService
static java.lang.String	STARTUP_DELAY_PARAMETER

Constructor Summary

Constructors

Constructor and Description
AbstractSMSEngine()

Method Summary

Modifier and Type	Method and Description
java.lang.String	getEngineId() Provides the unique engine id.
int	getStartupDelaySeconds() Called when starting up to find out how many seconds should the engine wait before starting up, to let the hybris suite prepare to process incoming traffic
boolean	isAvailable(AggregatorSettingsDTO settings) Tells if the engine currently accepts messages or not.
void	setBeanName(java.lang.String name)
void	setMessageScheduler(MessageScheduler messageScheduler)
void	setModelService(ModelService modelService)
void	setPhoneNumberService(PhoneNumberService phoneNumberHelper)
void	shutdown() Called once the system is about to shut down.
void	startup(java.util.Collection<AggregatorSettingsDTO> aggregatorSettings) Called once upon system startup.
void	updateAggregators(java.util.Collection<AggregatorSettingsDTO> aggregatorSettings) May be called while being connected.

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.hybris.platform.mobileservices.text.engine.SMSEngine

send

Field Detail

STARTUP_DELAY_PARAMETER

public static final java.lang.String STARTUP_DELAY_PARAMETER

See Also:

Constant Field Values

modelService

protected ModelService modelService

phoneNumberService

protected PhoneNumberService phoneNumberService

messageScheduler

protected MessageScheduler messageScheduler

Constructor Detail

AbstractSMSEngine

public AbstractSMSEngine()

Method Detail

setBeanName

public void setBeanName(java.lang.String name)

getEngineId

public java.lang.String getEngineId()

Description copied from interface: SMSEngine

Provides the unique engine id. This id is used for matching aggregator items

Specified by:

getEngineId in interface SMSEngine

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

Parameters:

settings - the settings of the specific aggregator to check

setModelService

public void setModelService(ModelService modelService)

setPhoneNumberService

public void setPhoneNumberService(PhoneNumberService phoneNumberHelper)

setMessageScheduler

public void setMessageScheduler(MessageScheduler messageScheduler)

startup

public void startup(java.util.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

Parameters:

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

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

updateAggregators

public void updateAggregators(java.util.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

getStartupDelaySeconds

public int getStartupDelaySeconds()

Description copied from interface: SMSEngine

Called when starting up to find out how many seconds should the engine wait before starting up, to let the hybris suite prepare to process incoming traffic

Specified by:

getStartupDelaySeconds in interface SMSEngine