public class GatewayMessageHandler extends CSDatabaseItem
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
ITEM_ACTION_DELETE
One of the valid item actions.
|
static java.lang.String |
ITEM_ACTION_INSERT
One of the valid item actions.
|
static java.lang.String |
ITEM_ACTION_UPDATE
One of the valid item actions.
|
static java.lang.String |
ITEM_TYPE_MESSAGE
One of the valid item types that a gateway message can be triggered for.
|
static java.lang.String |
ITEM_TYPE_METADATA
One of the valid item types that a gateway message can be triggered for.
|
static java.lang.String |
ITEM_TYPE_OBJECT
One of the valid item types that a gateway message can be triggered for.
|
static java.lang.String |
ITEM_TYPE_USER
One of the valid item types that a gateway message can be triggered for.
|
static java.lang.String |
ITEM_TYPE_USERGROUP
One of the valid item types that a gateway message can be triggered for.
|
LEVEL_ALL, LEVEL_ALL_PLUS_RELATED, LEVEL_DETAIL, LEVEL_ID, LEVEL_SUMMARY
Constructor and Description |
---|
GatewayMessageHandler(java.lang.String propertyFile) |
GatewayMessageHandler(java.lang.String propertyFile,
java.lang.String itemType,
CSDelimList itemIds,
java.lang.String action) |
GatewayMessageHandler(java.lang.String propertyFile,
java.lang.String itemType,
CSDelimList itemIds,
java.lang.String action,
java.util.Map additionalData) |
GatewayMessageHandler(java.lang.String propertyFile,
java.lang.String itemType,
int itemId,
java.lang.String action) |
GatewayMessageHandler(java.lang.String propertyFile,
java.lang.String itemType,
int itemId,
java.lang.String action,
java.util.Map additionalData) |
Modifier and Type | Method and Description |
---|---|
java.util.Map |
getAdditionalData()
Returns any additional data relating to the message(s)
|
java.lang.String |
getItemAction()
Returns the action on the item to which the message(s) relate
|
CSDelimList |
getItemIds()
Returns the Ids of the items the message is to be sent for
|
java.lang.String |
getItemType()
Returns the type of item the message is being sent for.
|
java.util.ArrayList |
send() |
void |
setAdditionalData(java.util.Map additionalData)
Sets any additional data relating to the message(s)
|
void |
setItemAction(java.lang.String action)
Sets the action on the item to which the message(s) relate
|
void |
setItemIds(CSDelimList objIds)
Sets the type of item the message is being sent for.
|
void |
setItemIds(java.lang.String objIds)
Sets the type of item the message is being sent for.
|
void |
setItemType(java.lang.String strType)
Sets the type of item the message is being sent for.
|
java.lang.String |
toString()
Returns the details of this gateway message handler as a string.
|
clearRecordedGatewayMessages, clone, count, delete, equals, exist, get, getCache, getCachingEnabled, getDatabaseVersion, getDatabaseVersion, getDebugOutput, getDetailLevel, getPreview, getPropertyFile, getPropertyFileExtension, getPropertyFilePathname, getRecordedGatewayMessages, getRecordGatewayMessages, getSendGatewayMessages, getUseCache, setDebugOutput, setDetailLevel, setPreview, setPropertyFile, setRecordGatewayMessages, setSendGatewayMessages, setUseCache, update
public static final java.lang.String ITEM_TYPE_MESSAGE
public static final java.lang.String ITEM_TYPE_METADATA
public static final java.lang.String ITEM_TYPE_OBJECT
public static final java.lang.String ITEM_TYPE_USER
public static final java.lang.String ITEM_TYPE_USERGROUP
public static final java.lang.String ITEM_ACTION_INSERT
public static final java.lang.String ITEM_ACTION_UPDATE
public static final java.lang.String ITEM_ACTION_DELETE
public GatewayMessageHandler(java.lang.String propertyFile)
public GatewayMessageHandler(java.lang.String propertyFile, java.lang.String itemType, CSDelimList itemIds, java.lang.String action)
public GatewayMessageHandler(java.lang.String propertyFile, java.lang.String itemType, CSDelimList itemIds, java.lang.String action, java.util.Map additionalData)
public GatewayMessageHandler(java.lang.String propertyFile, java.lang.String itemType, int itemId, java.lang.String action)
public GatewayMessageHandler(java.lang.String propertyFile, java.lang.String itemType, int itemId, java.lang.String action, java.util.Map additionalData)
public java.lang.String getItemType()
public void setItemType(java.lang.String strType)
The valid types are as follows :
ITEM_TYPE_METADATA
ITEM_TYPE_OBJECT
ITEM_TYPE_USER
ITEM_TYPE_USERGROUP
public CSDelimList getItemIds()
public void setItemIds(CSDelimList objIds)
public void setItemIds(java.lang.String objIds)
public java.lang.String getItemAction()
public void setItemAction(java.lang.String action)
action
- item action.public java.util.Map getAdditionalData()
public void setAdditionalData(java.util.Map additionalData)
additionalData
- Any message specific datapublic java.util.ArrayList send() throws java.sql.SQLException, CSException
java.sql.SQLException
CSException
public java.lang.String toString()
toString
in class CSDatabaseItem
Copyright © 2022 Goss Interactive Ltd. All Rights Reserved.