de.hybris.platform.mobileservices.text.engine

Interface SMSEngineRegistry

All Known Implementing Classes:

DefaultSMSEngineRegistry

public interface SMSEngineRegistry

Registry for managing SMSEngine instances.

Method Summary

Modifier and Type	Method and Description
Set<SMSEngine>	getAllEngines() Returns all registered engines.
SMSEngine	getEngine(EnginesType engine) Returns a engine for a specific engine enum.
boolean	isAvailable(MobileAggregatorModel aggregator) Checks if the engine for the given aggregator is actually available.
boolean	isValidEngine(EnginesType engine) Tells whether a given id is a valid SMSEngine id.
void	send(MobileAggregatorModel aggregator, MobileMessageContextModel message) Performs sending using the appropriate engine for the specified aggregator and the specified message.
void	shutdownEngines() Called to shut down engines once per tenant shutdown.
void	startupEngines() Called to start up engines once per tenant startup.
void	updateEngines() May be called to update engines with current aggregator settings.

Method Detail

getEngine

SMSEngine getEngine(EnginesType engine)

Returns a engine for a specific engine enum.

Throws:

IllegalArgumentException - if no such engine exists

getAllEngines

Set<SMSEngine> getAllEngines()

Returns all registered engines.

isValidEngine

boolean isValidEngine(EnginesType engine)

Tells whether a given id is a valid SMSEngine id.

Returns:

true if a engine has been registered using that id, false otherwise

startupEngines

void startupEngines()

Called to start up engines once per tenant startup.

shutdownEngines

void shutdownEngines()

Called to shut down engines once per tenant shutdown.

updateEngines

void updateEngines()

May be called to update engines with current aggregator settings. Normally aggregator item changes are not automatically detected otherwise!

send

void send(MobileAggregatorModel aggregator,
          MobileMessageContextModel message)
   throws SMSEngineException

Performs sending using the appropriate engine for the specified aggregator and the specified message.

Parameters:

aggregator - the aggregator to specify the engine to be used

message - the message context item to use

Throws:

SMSEngineException - in case of sending error

IllegalArgumentException - in case the aggregator holds a invalid engine id

isAvailable

boolean isAvailable(MobileAggregatorModel aggregator)

Checks if the engine for the given aggregator is actually available.

Parameters:

aggregator - the aggregator to check