de.hybris.platform.mobileservices.text.engine

Interface SMSEngine

All Known Implementing Classes:

AbstractSMSEngine, DummyBrokenEngine, DummyEngine, DummyUnavailableEngine, HTTPSendSMSEngine, SMPPSMSEngine

public interface SMSEngine

Interface for outgoing messages to be implemented by specific aggregator connector providers.

Method Summary

Modifier and Type	Method and Description
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 aggregatorSettings) Tells if the engine currently accepts messages or not.
void	send(AggregatorSettingsDTO aggregatorSettings, OutgoingSMSMessageDTO message) Called by mobile framework for immediate sending of a SMS message.
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.

Method Detail

getEngineId

String getEngineId()

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

send

void send(AggregatorSettingsDTO aggregatorSettings,
          OutgoingSMSMessageDTO message)
   throws SMSEngineException

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

Parameters:

aggregatorSettings - the settings of the specific aggregator to send to

message - the message including aggregator account data

Throws:

SMSEngineException

isAvailable

boolean isAvailable(AggregatorSettingsDTO aggregatorSettings)

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 send(AggregatorSettingsDTO, OutgoingSMSMessageDTO) instead.

Parameters:

aggregatorSettings - the settings of the specific aggregator to check

startup

void startup(Collection<AggregatorSettingsDTO> aggregatorSettings)

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

Parameters:

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

updateAggregators

void updateAggregators(Collection<AggregatorSettingsDTO> aggregatorSettings)

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.

Parameters:

aggregatorSettings -

shutdown

void shutdown()

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

getStartupDelaySeconds

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