oracle.panama.mobilealert
Interface AlertEngine

public interface AlertEngine

Generic Interface for pushing contents to OracleAS Wireless alert engine for alert message generation and delivery.

See Also:

AlertEngineLocator.getAlertEngine()

Method Summary

oracle.panama.mobilealert.engine.RecipientList	createRecipientList(boolean sharedContent) Create a recipient list with evaluateFurther = false.
oracle.panama.mobilealert.engine.RecipientList	createRecipientList(boolean evaluateFurther, boolean sharedContent, int userIdentifierType) Creates a recipient list object that you can use for the direct addressing feature.
void	handleFeedContent(long dataFeederOid, java.util.Map contentFields) Push contents to alert engine from a data feeder implemenation by giving the internal object id of the data feeder.
void	handleFeedContent(long dataFeederOid, java.util.Map contentFields, java.util.Map contentFieldsOldValues) Push contents to alert engine from a data feeder implemenation by giving the internal object id of the data feeder.
void	handleFeedContent(long dataFeederOid, java.util.Map contentFields, java.util.Map contentFieldsOldValues, oracle.panama.mobilealert.engine.RecipientList recipients) Push contents to alert engine from a data feeder implemenation by giving the internal object id of the data feeder.
void	handleFeedContent(long dataFeederOid, java.util.Map contentFields, oracle.panama.mobilealert.engine.RecipientList recipients) Push contents to alert engine from a data feeder implemenation by giving the internal object id of the data feeder.
void	handleFeedContent(java.lang.String dataFeederName, java.util.Map contentFields) Push contents to alert engine from a data feeder implemenation by giving the name of the data feeder.
void	handleFeedContent(java.lang.String dataFeederName, java.util.Map contentFields, java.util.Map contentFieldsOldValues) Push contents to alert engine from a data feeder implemenation by giving the name of the data feeder.
void	handleFeedContent(java.lang.String dataFeederName, java.util.Map contentFields, java.util.Map contentFieldsOldValues, oracle.panama.mobilealert.engine.RecipientList recipients) Push contents to alert engine from a data feeder implemenation by giving the name of the data feeder.
void	handleFeedContent(java.lang.String dataFeederName, java.util.Map contentFields, oracle.panama.mobilealert.engine.RecipientList recipients) Push contents to alert engine from a data feeder implemenation by giving the name of the data feeder.

Method Detail

createRecipientList

public oracle.panama.mobilealert.engine.RecipientList createRecipientList(boolean sharedContent)
                                                                   throws PanamaException

Create a recipient list with evaluateFurther = false.

Parameters:

sharedContent - Use "Shared Content" feature of Notification Engine, for performance reasons defaulted to TRUE!

Returns:

RecipientList object for passing into the notification engine handleFeedContent method!

Throws:

PanamaException

createRecipientList

public oracle.panama.mobilealert.engine.RecipientList createRecipientList(boolean evaluateFurther,
                                                                          boolean sharedContent,
                                                                          int userIdentifierType)
                                                                   throws PanamaException

Creates a recipient list object that you can use for the direct addressing feature. <BR/> Developers should create this object first, and then call the appropriate addRecipient methods.<BR/><BR/> When direct addressing is used, there are two possible methods for pushing recipient lists into notification engine: <BR/>

• evaluateFurther=no<BR/> Notification Engine will not take any filtering action, but send a notification message to all recipients specified in the recipient list!
• evaluateFurther=yes<BR/> Notification Engine will discard the recipients specified with this recipient list if specified objects does not have a corresponding subscription, and it will apply subscription filtering rules for those that exist in the subscription table.

Consider the following case: <BR/><BR/> Developer creates a recipient list with evaluateFurther is true, and adds 3 recipients as orcladmin, john, james. And, assume that only orcladmin and james have notification subscriptions and john does not have any subscription. In this case, notification engine will simply ignore john!<BR/> For orcladmin and james, it will find all active subscriptions they have and filter out proper subscriptions according to their triggering condition settings. And if the triggering conditions are met, then dispatches the applications. <BR/><BR/> Constraints:<BR/> If evaluateFurther == true<BR/>

• You must specify a userIdentifierType to define how you will pass user identifier, possible values are: DirectAddrRecipientList.USERTYPE_GUID, DirectAddrRecipientList.USERTYPE_USERNAME, DirectAddrRecipientList.USERTYPE_XUID, DirectAddrRecipientList.USERTYPE_DEVICEADDRESS
• You can not mix and match userIdentifiers, i.e. you can't create one subscriber using GUID for one user, and UNAME for another!
• Once user identifier type is set, call the DirectAddrRecipientList.addSubscriper(String userInfo) constructor with appropriate info, i.e. if userIdentifierType is set to GUID userInfo must contain the guid, otherwise notification engine will simply ignore this value

Shared Content must be specified ONLY IF evaluateFurther is false! Otherwise, you will not gain from performance optimizations offered by "Shared Content" feature of Notification Engine

Parameters:

evaluateFurther - Should Notification engine perform filtering for passed in recipient list, filter subscribers if set to true

sharedContent - Use "Shared Content" feature of Notification Engine, ignored if evaluateFurther is false, for performance reasons defaulted to TRUE!

userIdentifierType - User information type, must be set if evaluate further is true, ignored if evaluate further is false

Returns:

RecipientList object for passing into the notification engine handleFeedContent method!

Throws:

PanamaException

handleFeedContent

public void handleFeedContent(long dataFeederOid,
                              java.util.Map contentFields)
                       throws PanamaException

Push contents to alert engine from a data feeder implemenation by giving the internal object id of the data feeder.

Parameters:

dataFeederOid - Internal object id of the data feeder

contentFields - a map of key/value pair which contains content values for all data feeder input and output parameters

Throws:

PanamaException

handleFeedContent

public void handleFeedContent(long dataFeederOid,
                              java.util.Map contentFields,
                              java.util.Map contentFieldsOldValues)
                       throws PanamaException

Push contents to alert engine from a data feeder implemenation by giving the internal object id of the data feeder. This API is used to filter out duplicate triggers as we check the trigger condition for both current and previous contents and fire the trigger only if the current content meets the trigger condition and the previous content does not meet the trigger condition.

Parameters:

dataFeederOid - Internal object id of the data feeder

contentFields - a map of key/value pair which contains content values for all the data feeder input and output parameters from the current content feed

contentFieldsOldValues - a map of key/value pair which contains content values for all the data feeder input and output parameters from the privious content feed

Throws:

PanamaException

handleFeedContent

public void handleFeedContent(long dataFeederOid,
                              java.util.Map contentFields,
                              java.util.Map contentFieldsOldValues,
                              oracle.panama.mobilealert.engine.RecipientList recipients)
                       throws PanamaException

Push contents to alert engine from a data feeder implemenation by giving the internal object id of the data feeder. This API is used to filter out duplicate triggers as we check the trigger condition for both current and previous contents and fire the trigger only if the current content meets the trigger condition and the previous content does not meet the trigger condition.

Parameters:

dataFeederOid - Internal object id of the data feeder

contentFields - a map of key/value pair which contains content values for all the data feeder input and output parameters from the current content feed

contentFieldsOldValues - a map of key/value pair which contains content values for all the data feeder input and output parameters from the privious content feed

recipients - RecipientList object constructud by using createRecipientList method

Throws:

PanamaException

handleFeedContent

public void handleFeedContent(long dataFeederOid,
                              java.util.Map contentFields,
                              oracle.panama.mobilealert.engine.RecipientList recipients)
                       throws PanamaException

Push contents to alert engine from a data feeder implemenation by giving the internal object id of the data feeder.

Parameters:

dataFeederOid - Internal object id of the data feeder

contentFields - a map of key/value pair which contains content values for all the data feeder input and output parameters

recipients - RecipientList object constructud by using createRecipientList method

Throws:

PanamaException

handleFeedContent

public void handleFeedContent(java.lang.String dataFeederName,
                              java.util.Map contentFields)
                       throws PanamaException

Push contents to alert engine from a data feeder implemenation by giving the name of the data feeder.

Parameters:

dataFeederName - Name of the data feeder

contentFields - a map of key/value pair which contains content values for all data feeder input and output parameters

Throws:

PanamaException

handleFeedContent

public void handleFeedContent(java.lang.String dataFeederName,
                              java.util.Map contentFields,
                              java.util.Map contentFieldsOldValues)
                       throws PanamaException

Push contents to alert engine from a data feeder implemenation by giving the name of the data feeder. The following two APIs are used to filter out duplicate triggers as we check the trigger condition for both current and previous contents and fire the trigger only if the current content meets the trigger condition and the previous content does not meet the trigger condition.

Parameters:

dataFeederName - Name of the data feeder

contentFields - a map of key/value pair which contains content values for all the data feeder input and output parameters from the current content feed

contentFieldsOldValues - a map of key/value pair which contains content values for all the data feeder input and output parameters from the privious content feed

Throws:

PanamaException

handleFeedContent

public void handleFeedContent(java.lang.String dataFeederName,
                              java.util.Map contentFields,
                              java.util.Map contentFieldsOldValues,
                              oracle.panama.mobilealert.engine.RecipientList recipients)
                       throws PanamaException

Push contents to alert engine from a data feeder implemenation by giving the name of the data feeder. This API is used to filter out duplicate triggers as we check the trigger condition for both current and previous contents and fire the trigger only if the current content meets the trigger condition and the previous content does not meet the trigger condition.

Parameters:

dataFeederName - Name of the data feeder

contentFields - a map of key/value pair which contains content values for all the data feeder input and output parameters from the current content feed

contentFieldsOldValues - a map of key/value pair which contains content values for all the data feeder input and output parameters from the privious content feed

recipients - RecipientList object constructud by using createRecipientList method

Throws:

PanamaException

handleFeedContent

public void handleFeedContent(java.lang.String dataFeederName,
                              java.util.Map contentFields,
                              oracle.panama.mobilealert.engine.RecipientList recipients)
                       throws PanamaException

Push contents to alert engine from a data feeder implemenation by giving the name of the data feeder.

Parameters:

dataFeederName - Name of the data feeder

contentFields - a map of key/value pair which contains content values for all data feeder input and output parameters

recipients - RecipientList object constructud by using createRecipientList method

Throws:

PanamaException