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

Class DefaultSMSEngineRegistry

java.lang.Object

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

All Implemented Interfaces:

SMSEngineRegistry

public class DefaultSMSEngineRegistry
extends java.lang.Object
implements SMSEngineRegistry

Constructor Summary

Constructors

Constructor and Description
DefaultSMSEngineRegistry()

Method Summary

Modifier and Type	Method and Description
void	addEngine(SMSEngine smsEngine)
void	afterPropertiesSet()
protected AggregatorSettingsDTO	createAggregatorSettings(MobileAggregatorModel aggregator)
protected OutgoingSMSMessageDTO	createMessageDTO(MobileMessageContextModel message)
java.util.Set<SMSEngine>	getAllEngines() Returns all registered engines.
SMSEngine	getEngine(EnginesType engine) Returns a engine for a specific engine enum.
protected java.util.Map<EnginesType,java.util.Set<MobileAggregatorModel>>	getEngineAggregators()
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	removeEngine(SMSEngine engine)
void	send(MobileAggregatorModel aggregator, MobileMessageContextModel message) Performs sending using the appropriate engine for the specified aggregator and the specified message.
void	setCollectedEngines(java.util.Collection<SMSEngine> collectedEngines)
void	setFlexibleSearchService(FlexibleSearchService flexibleSearchService)
void	setModelService(ModelService modelService)
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.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultSMSEngineRegistry

public DefaultSMSEngineRegistry()

Method Detail

isAvailable

public boolean isAvailable(MobileAggregatorModel aggregator)

Description copied from interface: SMSEngineRegistry

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

Specified by:

isAvailable in interface SMSEngineRegistry

Parameters:

aggregator - the aggregator to check

send

public void send(MobileAggregatorModel aggregator,
                 MobileMessageContextModel message)
          throws SMSEngineException

Description copied from interface: SMSEngineRegistry

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

Specified by:

send in interface SMSEngineRegistry

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

startupEngines

public void startupEngines()

Description copied from interface: SMSEngineRegistry

Called to start up engines once per tenant startup.

Specified by:

startupEngines in interface SMSEngineRegistry

shutdownEngines

public void shutdownEngines()

Description copied from interface: SMSEngineRegistry

Called to shut down engines once per tenant shutdown.

Specified by:

shutdownEngines in interface SMSEngineRegistry

updateEngines

public void updateEngines()

Description copied from interface: SMSEngineRegistry

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

Specified by:

updateEngines in interface SMSEngineRegistry

createAggregatorSettings

protected AggregatorSettingsDTO createAggregatorSettings(MobileAggregatorModel aggregator)

createMessageDTO

protected OutgoingSMSMessageDTO createMessageDTO(MobileMessageContextModel message)

getEngineAggregators

protected java.util.Map<EnginesType,java.util.Set<MobileAggregatorModel>> getEngineAggregators()

getAllEngines

public java.util.Set<SMSEngine> getAllEngines()

Description copied from interface: SMSEngineRegistry

Returns all registered engines.

Specified by:

getAllEngines in interface SMSEngineRegistry

getEngine

public SMSEngine getEngine(EnginesType engine)

Description copied from interface: SMSEngineRegistry

Returns a engine for a specific engine enum.

Specified by:

getEngine in interface SMSEngineRegistry

isValidEngine

public boolean isValidEngine(EnginesType engine)

Description copied from interface: SMSEngineRegistry

Tells whether a given id is a valid SMSEngine id.

Specified by:

isValidEngine in interface SMSEngineRegistry

Returns:

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

addEngine

public void addEngine(SMSEngine smsEngine)

removeEngine

public void removeEngine(SMSEngine engine)

setCollectedEngines

public void setCollectedEngines(java.util.Collection<SMSEngine> collectedEngines)

afterPropertiesSet

public void afterPropertiesSet()
                        throws java.lang.Exception

Throws:

java.lang.Exception

setFlexibleSearchService

public void setFlexibleSearchService(FlexibleSearchService flexibleSearchService)

setModelService

public void setModelService(ModelService modelService)