Em X Notification Util Base

/*
** emxNotificationUtilBase
**
** Copyright (c) 1992-2012 Dassault Systemes.
** All Rights Reserved.
** This program contains proprietary and trade secret information of MatrixOne,
** Inc. Copyright notice is precautionary only
** and does not evidence any actual or intended publication of such program
**
*/
import java.lang.reflect.Method;
import java.text.MessageFormat;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.HashSet;
import java.util.Hashtable;
import java.util.Iterator;
import java.util.Locale;
import java.util.Map;
import java.util.NoSuchElementException;
import java.util.Set;
import java.util.StringTokenizer;
import java.util.Vector;
import java.util.Collections;
import com.matrixone.apps.domain.DomainConstants;
import com.matrixone.apps.domain.DomainObject;
import com.matrixone.apps.domain.util.FrameworkProperties;
import com.matrixone.apps.domain.util.MapList;
import com.matrixone.apps.domain.util.MessageUtil;
import com.matrixone.apps.domain.util.MqlUtil;
import com.matrixone.apps.domain.util.ContextUtil;
import com.matrixone.apps.domain.util.PersonUtil;
import com.matrixone.apps.domain.util.PropertyUtil;
import com.matrixone.apps.domain.util.i18nNow;
import com.matrixone.apps.domain.util.FrameworkException;
import com.matrixone.util.MxMessage;
import matrix.db.Attribute;
import matrix.db.AttributeList;
import matrix.db.AttributeType;
import matrix.db.BusinessObject;
import matrix.db.BusinessObjectList;
import matrix.db.BusinessObjectWithSelect;
import matrix.db.BusinessObjectWithSelectList;
import matrix.db.Context;
import matrix.db.IconMail;
import matrix.db.JPO;
import matrix.db.MatrixClassLoader;
import matrix.db.Query;
import matrix.db.Relationship;
import matrix.db.RelationshipType;
import matrix.db.RelationshipWithSelect;
import matrix.db.RelationshipWithSelectItr;
import matrix.db.RelationshipWithSelectList;
import matrix.util.MatrixException;
import matrix.util.StringItr;
import matrix.util.StringList;
import com.matrixone.apps.domain.util.FrameworkUtil;
import com.matrixone.apps.framework.ui.UIUtil;
import com.matrixone.jsystem.util.ExceptionUtils;
import com.matrixone.jsystem.util.StringUtils;
import matrix.db.QueryIterator;
/**
* The <code>emxNotificationUtilBase</code> class contains static methods for
sending email.
*
* @version AEF 10.0.0.0 - Copyright (c) 2005, MatrixOne, Inc.
*/
public class ${CLASSNAME} extends ${CLASS:emxUtil}

{/** Lock object for synchronization.*/
static protected final Object _lock = new Object();
/** StringList which holds attribute actual names mapped from symbolic
names.*/
static protected StringList _sl;
/** Actual Notification type name mapped from symbolic name.*/
static protected String _notificationType;
/** Actual administration vault name mapped from symbolic name.*/
static protected String _adminVault;
/** Actual Active state name mapped from symbolic name.*/
static protected String _stateActive;
/** Vault pattern used for search of notification objects.*/
static protected String _vaultPattern;
/** programMap holds treemap values. */

static protected Hashtable programMap = new Hashtable();
/** ageMap holds timeout values. */
static protected Hashtable ageMap = new Hashtable();
/** _componentAge is a long value. */
static long _componentAge = 3600 * 1000;
/** Create new instance of emxMailUtil class. */
static protected ${CLASS:emxMailUtil} mailUtil = null;
/** Prefix for bundle name.*/

static final protected String _bundlePrefix = "emx";
/** Suffix for bundle name.*/
static final protected String _bundleSuffix = "StringResource";
static final protected String iconMail = "IconMail";
static final protected String email = "Email";
static final protected String both = "Both";
/** Constants for the delimiters and token types.*/

private static final String SELECT = "<";
private static final String END_SELECT = ">";
private static final String MACRO = "{";
private static final String END_MACRO = "}";
private static final String DELIMITER_START = "$";
private static final String DELIMITER_TYPE = SELECT + MACRO;
private static final String TEXT = "text";
private static final String USER_LIST_DELIMITER = "~";
private static final String INPUT_LIST_DELIMITER = ";";
private static final String INPUT_REPLYTO_DELIMITER = "|";
private static final String OUTPUT_LIST_DELIMITER = ", ";
private static final String OUTPUT_NO_VALUE = "";
private static final String OUTPUT_EMPTY_VALUE = "";
/** object and relationship constants.*/
private static final String OBJECT = "object";
private static final String RELATIONSHIP = "relationship";
/** Create a static mapping from token type to end delimiter string.*/
private static final Map delimiters;
static {
Map m = new HashMap(2);
m.put(SELECT, END_SELECT);
m.put(MACRO, END_MACRO);
delimiters = Collections.unmodifiableMap(m);
}
/**
* Constructor.
*
* @param context the eMatrix <code>Context</code> object
* @param args holds no arguments
* @throws Exception if the operation fails
* @since AEF 10.0.0.0
*/
public ${CLASSNAME}(Context context, String[] args)

throws Exception {
super(context, args);
synchronized(_lock)
{
if (_sl == null)
{
// Get admin names that are used in this program from
property names.
String[] s = new String[18];
s[0] = "type_Notification";
s[1] = "attribute_Filter";
s[2] = "attribute_FromAgent";
s[3] = "attribute_StaticToList";
s[4] = "attribute_StaticCcList";
s[5] = "attribute_StaticBccList";
s[6] = "attribute_DynamicToList";
s[7] = "attribute_DynamicCcList";
s[8] = "attribute_DynamicBccList";
s[9] = "attribute_SubjectText";
s[10] = "attribute_BodyText";
s[11] = "attribute_BodyHTML";
s[12] = "attribute_RegisteredSuite";
s[13] = "attribute_Attachments";
s[14] = "attribute_URLSuffix";
s[15] = "attribute_ReplyTo";
s[16] = "attribute_PreprocessJPO";
s[17] = "vault_eServiceAdministration";
ArrayList adminNames = getAdminNameFromProperties(context,

s);
_notificationType = (String)adminNames.get(0);
_adminVault = (String)adminNames.get(17);
// Get all the information about trigger objects found.
StringList sl = new StringList(17);
sl.addElement("current");
sl.addElement("attribute[" + (String)adminNames.get(1) +
"].value");
"].value");
"].value");
"].value");
"].value");
"].value");
"].value");
"].value");
"].value");
"].value");
"].value");
"].value");
"].value");
"].value");
"].value");
"].value");
_sl = sl.unmodifiableCopy();
_vaultPattern = _adminVault;
if (_vaultPattern == null || _vaultPattern.length() == 0)
_vaultPattern = "*";
// Get state names from properties

s = new String[2];
s[0] = "policy_BusinessRule";
s[1] = "state_Active";
ArrayList stateNames = getStateNamesFromProperties(context,
s);
_stateActive = (String)stateNames.get(0);
mailUtil = new ${CLASS:emxMailUtil}(context, null);
// Get cache age from properties file.
String propValue = mailUtil.getMessage(context,
"emxNavigator.UICache.ComponentAge", null, null, null, "emxSystem");
try
{
_componentAge = Long.parseLong(propValue) * 1000;
}
catch (Exception e)
{
_componentAge = 3600 * 1000;
}
}
}
}
/**
* This method is executed if a specific method is not specified.
*
* @return an int 0, status code.
* @since AEF 10.0.0.0
*/
public int mxMain(Context context, String[] args) throws Exception {

if (true) {
String languageStr = context.getSession().getLanguage();
String exMsg =
i18nNow.getI18nString("emxFramework.Message.Invocation","emxFrameworkStringResource
",languageStr);
exMsg +=
i18nNow.getI18nString("emxFramework.NotificationUtil","emxFrameworkStringResource",
languageStr);
throw new Exception(exMsg);
}
return 0;
}
/**
* This method creates a mail notification based on an object id.
* Only use this method if invoking from beans.
*
* @param args contains a Map with the following entries:
* objectId - a String holding the id of an object to be used for
* evaluating selects embedded in the subject and message strings
* notificationName - a String holding the name of the Notification
object
* payload - a Map containing information to pass on to helper JPO
methods
* @return an int 0 status code
* @since AEF 11.0.0.0
*/
public static int objectNotificationFromMap(Context context, String[] args)

throws Exception {
if (args == null || args.length < 1) {

throw (new IllegalArgumentException());
}
Map map = (Map) JPO.unpackArgs(args);
objectNotification(context,
(String) map.get("objectId"),
(String) map.get("notificationName"),
(Map) map.get("payload"));
return 0;
}
/**
* Only use this method if calling from triggers or tcl.
*
* @param args holds the following input arguments:
object
* @since AEF 11.0.0.0
*/
public static int objectNotification(Context context, String[] args)

throws Exception {
}
int index = 0;
String objectId = args[index++];
String notificationName = args[index++];
objectNotification(context, objectId, notificationName, null);

return 0;
}
/**
*
* @param objectId a String holding the id of an object to be used for
* @param notificationName a String holding the name of the Notification
object
* @param payload a Map containing information to pass on to helper JPO
methods
* @since AEF 11.0.0.0
*/
public static void objectNotification(Context context,

String objectId, String notificationName, Map payload)
throws Exception {
if(objectId != null && objectId.length() > 0)

{
String strResult = "";
try
{
//replace MQL call with Busselects
boolean isExists = doesBusinessObjectExist(context,
objectId);
if(isExists)
objectRelationshipNotification(context, objectId,
OBJECT, notificationName, payload);
else
{
strResult = MqlUtil.mqlCommand(context,"print
connection "+objectId+" select name dump |");
objectRelationshipNotification(context, objectId,
RELATIONSHIP, notificationName, payload);
}
}
catch(Exception e)
{
throw e;
}
}
}
public static boolean doesBusinessObjectExist(Context context, String

busId)throws Exception
{
boolean returnValue = false;
try{
String[] objIDs = new String[]{busId};
StringList busSelect = new StringList();

busSelect.add(DomainConstants.SELECT_EXISTS);
MapList mapList = DomainObject.getInfo(context, objIDs,

busSelect);
Map objectInformation = (Map) mapList.get(0);
returnValue = Boolean.parseBoolean((String)
objectInformation.get(DomainConstants.SELECT_EXISTS));
}
catch(Exception e){}
return returnValue;
}
/**
* This method creates a mail notification based on a relationship id.
* Only use this method if invoking from beans.
*
* relId - a String holding the id of a relationship to be used for
object
* payload - a Map containing information to pass on to helper JPO
methods
* @since AEF 11.0.0.0
*/
public static int relationshipNotificationFromMap(Context context, String[]
args)
throws Exception {

}
relationshipNotification(context,
(String) map.get("relId"),
(String) map.get("notificationName"),
(Map) map.get("payload"));
return 0;
}
/**
*
* relId - a String holding the id of a relationship to be used for
object
* @since AEF 11.0.0.0
*/
public static int relationshipNotification(Context context, String[] args)

throws Exception {
}
int index = 0;
String relId = args[index++];
relationshipNotification(context, relId, notificationName, null);
return 0;
}
/**
*
* @param relId a String holding the id of a relationship to be used for
object
methods
* @since AEF 11.0.0.0
*/
public static void relationshipNotification(Context context,
String relId, String notificationName, Map payload)
throws Exception {
if(relId != null && relId.length() > 0)

{
String strResult = "";
try
{
strResult = MqlUtil.mqlCommand(context,"print bus
"+relId+" select exists dump |");
if(strResult.equalsIgnoreCase("TRUE"))
objectRelationshipNotification(context, relId,
OBJECT, notificationName, payload);
else
{
strResult = MqlUtil.mqlCommand(context,"print
connection "+relId+" select name dump |");
objectRelationshipNotification(context, relId,
RELATIONSHIP, notificationName, payload);
}
}
catch(Exception e)
{
throw e;
}
}
}
/**
* This method creates a mail notification based on a either an object or
relationship id.
*
* @param id a String holding the id of an object or relationship to be used
for
* @param idType a String set to either "object" or "relationship"
object
methods
* @since AEF 11.0.0.0
*/
public static void objectRelationshipNotification(Context context,

String id, String idType, String notificationName, Map payload)
throws Exception {
StringTokenizer tokens = null;
String value;
BusinessObjectWithSelectList notificationWithSelectList =
(BusinessObjectWithSelectList)programMap.get(notificationName);
synchronized(_lock) {
long time = System.currentTimeMillis();
if (notificationWithSelectList != null) {
Long timeout = (Long)ageMap.get(notificationName);
if (timeout != null && timeout.longValue() < time)
notificationWithSelectList = null;
}
if (notificationWithSelectList == null) {
// search for all the notification business objects with
the name provided
notificationWithSelectList = new
BusinessObjectWithSelectList(1);
Query tempQuery = new Query("");
tempQuery.setBusinessObjectType(_notificationType);
tempQuery.setBusinessObjectName(notificationName);
tempQuery.setBusinessObjectRevision("*");
tempQuery.setVaultPattern(_vaultPattern);
try
{
ContextUtil.startTransaction(context,false);
QueryIterator qItr =
tempQuery.getIterator(context,_sl,(short)1000);
try {
while(qItr.hasNext())
notificationWithSelectList.addElement(qItr.next());
} finally {
qItr.close();
}
ContextUtil.commitTransaction(context);
}
catch(Exception ex)
{
ContextUtil.abortTransaction(context);
throw new Exception(ex.toString());
}
programMap.put(notificationName,
notificationWithSelectList);
ageMap.put(notificationName, new Long(time +
_componentAge));
}
}
for (int j = 0; j < notificationWithSelectList.size(); j++)

{
BusinessObjectWithSelect bows =
notificationWithSelectList.getElement(j);
if
(bows.getSelectData((String)_sl.elementAt(0)).compareTo(_stateActive) == 0)
{
String filter =
bows.getSelectData((String)_sl.elementAt(1));
// Evaluate filter to determine if email should be sent

if (evaluateFilter(context, id, idType, notificationName,
payload, filter) != 0) {
continue;
}
value = bows.getSelectData((String)_sl.elementAt(2));
String fromAgent = inputOrJPOToString(context, id, idType,
notificationName, payload, value);
StringList toList = inputListOrJPOToStringList(context, id,
idType, notificationName, payload, value);
StringList ccList = inputListOrJPOToStringList(context, id,
idType, notificationName, payload, value);
StringList bccList = inputListOrJPOToStringList(context,
id, idType, notificationName, payload, value);
StringList toSelectList =
inputListOrJPOToStringList(context, id, idType, notificationName, payload, value);
StringList ccSelectList =
StringList bccSelectList =
String subjectKey =
String messageKey =
String messageHTMLKey =
String basePropFile =
if (basePropFile != null && basePropFile.length() > 0) {
StringBuffer temp = new StringBuffer(_bundlePrefix);
temp.append(StringUtils.replaceAll(bows.getSelectData((String)_sl.elementAt(12)),
"\\\\s", ""));
temp.append(_bundleSuffix);
basePropFile = temp.toString();
}
StringList idSelectList =
String urlSuffix = inputOrJPOToString(context, id, idType,
notificationName, payload, value);
StringList replyTo = null;

if (value != null && value.length() > 0) {
tokens = new StringTokenizer(value,
INPUT_REPLYTO_DELIMITER);
replyTo = new StringList();
while (tokens.hasMoreTokens()) {
replyTo.addElement(tokens.nextToken().trim());
}
}
String preprocessJPOMethod =
/* From the Tolist obtained search to get the pipe(|)

delimitors so as to list the personList
based on their notification type. The convention follwed here is,
all the persons in the tolist upto the 1st pipe
are the person to be notified through Email and in between 1st
pipe and 2nd pipe are the persons to be notified throug IconMail and
persons follwing the 2nd pipe are to be notified through
both(Email and IconMail) the ways */
HashMap finalMap = getRefineList(context, toList);

StringList bothToList = (StringList)finalMap.get(both);
StringList iconMailToList =
(StringList)finalMap.get(iconMail);
StringList emailToList = (StringList)finalMap.get(email);
finalMap = getRefineList(context, ccList);

StringList bothCcList = (StringList)finalMap.get(both);
StringList iconMailCcList =
StringList emailCcList = (StringList)finalMap.get(email);
finalMap = getRefineList(context, bccList);

StringList bothBccList = (StringList)finalMap.get(both);
StringList iconMailBccList =
StringList emailBccList = (StringList)finalMap.get(email);
finalMap = getRefineList(context, toSelectList);

StringList bothToSelectList =
(StringList)finalMap.get(both);
StringList iconMailToSelectList =
StringList emailToSelectList =
(StringList)finalMap.get(email);
finalMap = getRefineList(context, ccSelectList);

StringList bothCcSelectList =
StringList iconMailCcSelectList =
StringList emailCcSelectList =
finalMap = getRefineList(context, bccSelectList);

StringList bothBccSelectList =
StringList iconMailBccSelectList =
StringList emailBccSelectList =
StringList finalIdList =
combineStaticAndDynamicLists(context, id, idType, null, idSelectList, false);
// Build up final to Both list

StringList finalToBothList =
combineStaticAndDynamicLists(context, id, idType, bothToList, bothToSelectList,
true);
// Build up final cc Both list
StringList finalCcBothList =
combineStaticAndDynamicLists(context, id, idType, bothCcList, bothCcSelectList,
true);
// Build up final bcc Both list
StringList finalBccBothList =
combineStaticAndDynamicLists(context, id, idType, bothBccList, bothBccSelectList,
true);
// Build up final to Email list

StringList finalToEmailList =
combineStaticAndDynamicLists(context, id, idType, emailToList, emailToSelectList,
true);
// Build up final cc Email list
StringList finalCcEmailList =
combineStaticAndDynamicLists(context, id, idType, emailCcList, emailCcSelectList,
true);
// Build up final bcc Email list
StringList finalBccEmailList =
combineStaticAndDynamicLists(context, id, idType, emailBccList, emailBccSelectList,
true);
// Build up final to IconMail list

StringList finalToIconMailList =
combineStaticAndDynamicLists(context, id, idType, iconMailToList,
iconMailToSelectList, true);
// Build up final cc IconMail list
StringList finalCcIconMailList =
combineStaticAndDynamicLists(context, id, idType, iconMailCcList,
iconMailCcSelectList, true);
// Build up final bcc IconMail list
StringList finalBccIconMailList =
combineStaticAndDynamicLists(context, id, idType, iconMailBccList,
iconMailBccSelectList, true);
finalToEmailList.addAll(finalToBothList);
finalToIconMailList.addAll(finalToBothList);
finalCcEmailList.addAll(finalCcBothList);
finalCcIconMailList.addAll(finalCcBothList);
finalBccEmailList.addAll(finalBccBothList);
finalBccIconMailList.addAll(finalBccBothList);
// String from = substituteValues(context, fromAgent);

String from = "";
if (fromAgent != null && fromAgent.trim().length() > 0) {
if (fromAgent.startsWith("$<person_")) {
from = substituteValues(context, fromAgent);
} else {
from = substituteValues(context, fromAgent, id,
idType, null);
}
}
// Evaluate selects in replyTo

if (replyTo != null && replyTo.size() > 1) {
String user = (String) replyTo.elementAt(0);
String personal = (String) replyTo.elementAt(1);
if (user != null && user.trim().length() > 0) {
if (user.startsWith("$<person_")) {
replyTo.setElementAt(substituteValues(context, user), 0);

} else {
replyTo.setElementAt(substituteValues(context, user, id, idType, null), 0);

}
}
if (personal != null && personal.trim().length() > 0)
{
replyTo.setElementAt(substituteValues(context,
personal, id, idType, null), 1);
}
}
/* Pass results to sendNotification through both email and

iconmail
if(finalToBothList.size()>0 || finalCcBothList.size()>0 ||
finalBccBothList.size()>0)
{
sendNotification(context, id, idType, notificationName,
payload, finalToBothList, finalCcBothList, finalBccBothList,
subjectKey, messageKey, messageHTMLKey, finalIdList,
basePropFile, urlSuffix,
from, replyTo, preprocessJPOMethod);
}*/
// Pass results to sendNotification through email
if(finalToEmailList.size()>0 || finalCcEmailList.size()>0
|| finalBccEmailList.size()>0)
{
sendNotification(context, id, idType,
notificationName, payload, finalToEmailList, finalCcEmailList, finalBccEmailList,
subjectKey, messageKey, messageHTMLKey,
finalIdList, basePropFile, urlSuffix,
from, replyTo, preprocessJPOMethod,
email);
}
// Pass results to sendNotification through IconMail

if(finalToIconMailList.size()>0 ||
finalCcIconMailList.size()>0 || finalBccIconMailList.size()>0)
{
sendNotification(context, id, idType,
notificationName, payload, finalToIconMailList, finalCcIconMailList,
finalBccIconMailList,
subjectKey, messageKey, messageHTMLKey,
finalIdList, basePropFile, urlSuffix,
from, replyTo, preprocessJPOMethod,
iconMail);
}
}
}
}
/**
* This method creates one or more mail notification based on an object id.
* The object id passed in will be expanded to get parent id's.
* The parent ids will be used to create mail notifications.
*
* objectId - id of an object that we want to expand. From this we
will
* check the ids from the expand to be used for
object
* relationshipPattern - relationship to expand on
* typePattern - type to expand to
* toDirection - expand to direction
* fromDirection - expand from direction
* @since AEF R211
*/
public static int objectParentsNotification(Context context, String[] args)

throws Exception {
}
int index = 0;
String relationshipPattern = PropertyUtil.getSchemaProperty(context,
args[index++]);
String typePattern = PropertyUtil.getSchemaProperty(context,
args[index++]);
boolean toDirection = "true".equals((String)args[index++])? true:false;
boolean fromDirection = "true".equals((String)args[index++])?
true:false;
short level = 1;
StringList objectSelects = new StringList(1);

objectSelects.add("id");
DomainObject domainObject = DomainObject.newInstance(context,

objectId);
// expand from parent

MapList mapList = domainObject.getRelatedObjects(
context, // context.
relationshipPattern, // relationship pattern.
typePattern, // type pattern.
objectSelects, // business object selectables.
null, // relationship selectables.
toDirection, // expand to direction.
fromDirection, // expand from direction.
level, // level
null, // object where clause
null,
0,
null,
null,
null);
Iterator itr = mapList.iterator();

while (itr.hasNext())
{
Map map = (Map) itr.next();
String id = (String) map.get("id");
objectNotification(context, id, notificationName, null);

}
return 0;
}
/**
* This method creates a mail notification for the specified users.
*
* evaluating selects embedded in the subject and message strings,
* and also to send with the notification
* toList - a StringList containing the list of users to notify
* ccList - a StringList containing the list of users to cc
* subjectKey - a String that contains the notification subject key
* messageKey - a String that contains the notification message key
* objectIdList - a StringList containing select clauses evaluated to
send objects with the notification
* basePropFileName - a String holding the property file to search for
keys
* toSelectList - a StringList containing select clauses evaluated to
expand the list of users to notify
* ccSelectList - a StringList containing select clauses evaluated to
expand the list of users to cc
* filter - a String holding an expression used to determine if the
notification should be sent
* urlSuffix - a String holding a suffix to be appended to the
embedded URL
* fromAgent - a String holding the from user appearing in the mail
* messageJPOMethod - a String holding the JPO name and method name
(colon delimited) used to append to the message
* filterJPOMethod - a String holding the JPO name and method name
(colon delimited) used to filter
* @since AEF 10.0.0.0
*/
public static int createNotificationFromMap(Context context, String[] args)

throws Exception {
}
createNotification(context,
(String) map.get("objectId"),
(StringList) map.get("toList"),
(StringList) map.get("ccList"),
(String) map.get("subjectKey"),
(String) map.get("messageKey"),
(StringList) map.get("objectIdList"),
(String) map.get("basePropFileName"),
(StringList) map.get("toSelectList"),
(StringList) map.get("ccSelectList"),
(String) map.get("filter"),
(String) map.get("urlSuffix"),
(String) map.get("fromAgent"),
(String) map.get("messageJPOMethod"),
(String) map.get("filterJPOMethod"));
return 0;
}
/**
* Only use this method if calling from triggers or tcl,
* otherwise use the method createNotificationFromMap().
*
* and also to send with the notification if no idSelectList given
* toList - a semicolon separated list of users to notify
* ccList - a semicolon separated list of users to cc
* subjectKey - a String that contains the notification subject key
* messageKey - a String that contains the notification message key
* basePropName - a String the property file to search for keys
* toSelectList - a semicolon separated list containing select clauses
evaluated to expand the list of users to notify
* ccSelectList - a semicolon separated list containing select clauses
evaluated to expand the list of users to cc
* filter - a String holding an expression used to determine if the
* urlSuffix - a String holding a suffix to be appended to the
embedded URL
* fromAgent - a String holding the from user appearing in the mail
* idSelectList - a semicolon separated list containing select clauses
evaluated to send objects with the notification
* messageJPOMethod - a String holding the JPO name and method name
* filterJPOMethod - a String holding the JPO name and method name
* @since AEF 10.0.0.0
*/
public static int createNotification(Context context, String[] args)

throws Exception {
}
int index = 0;
StringTokenizer tokens = null;
StringList toList = null;

if (args.length > index && args[index] != null) {
tokens = new StringTokenizer(args[index++],
INPUT_LIST_DELIMITER);
toList = new StringList();
toList.addElement(tokens.nextToken().trim());
}
}
StringList ccList = null;
ccList = new StringList();
ccList.addElement(tokens.nextToken().trim());
}
}
String subjectKey = null;

if (args.length > index) {
subjectKey = args[index++];
}
String messageKey = null;
messageKey = args[index++];
}
String basePropName = null;
basePropName = args[index++];
}
StringList toSelectList = null;

toSelectList = new StringList();
toSelectList.addElement(tokens.nextToken().trim());
}
}
StringList ccSelectList = null;
ccSelectList = new StringList();
ccSelectList.addElement(tokens.nextToken().trim());
}
}
String filter = null;
filter = args[index++];
}
String urlSuffix = null;
urlSuffix = args[index++];
}
String fromAgent = null;
fromAgent = args[index++];
}
StringList idSelectList = null;

idSelectList = new StringList();
idSelectList.addElement(tokens.nextToken().trim());
}
}
String messageJPOMethod = null;

messageJPOMethod = args[index++];
}
String filterJPOMethod = null;
filterJPOMethod = args[index++];
}
createNotification(context, objectId, toList, ccList, subjectKey,

messageKey, idSelectList, basePropName,
toSelectList, ccSelectList, filter, urlSuffix, fromAgent,
messageJPOMethod, filterJPOMethod);
return 0;
}
/**
*
* @param objectId a String holding the id of an object to be used for
* and also to send with the notification if no idSelectList given
* @param toList a StringList that contains the list of users to notify
* @param ccList a StringList that contains the list of users to cc
* @param subjectKey a String that contains the notification subject key
* @param messageKey a String that contains the notification message key
* @param idSelectList a StringList containing select clauses evaluated to
send objects with the notification
* @param basePropFile String that is used for the name of property files to
search for keys.
* @param toSelectList a StringList containing select clauses evaluated to
expand the list of users to notify
* @param ccSelectList a StringList containing select clauses evaluated to
expand the list of users to cc
* @param filter a String holding an expression used to determine if the
* @param urlSuffix a String holding a suffix to be appended to the embedded
URL
* @param fromAgent a String holding the from user appearing in the mail
* @param messageJPOMethod a String holding the JPO name and method name
* @param filterJPOMethod a String holding the JPO name and method name
* @since AEF 10.0.0.0
*/
public static void createNotification(Context context,

String objectId, StringList toList, StringList ccList,
String subjectKey, String messageKey,
StringList idSelectList, String basePropFile,
StringList toSelectList, StringList ccSelectList,
String filter, String urlSuffix, String fromAgent,
String messageJPOMethod, String filterJPOMethod)
throws Exception {
// Evaluate filter to determine if email should be sent

if (filter != null && !filter.equals("") && objectId != null
&& !objectId.equals("")) {
String expression = substituteValues(context, filter);
StringBuffer command = new StringBuffer();
command.append("evaluate expression '");
command.append(expression);
command.append("' on bus ");
command.append(objectId);
String filterResult = MqlUtil.mqlCommand(context, command
.toString());
if (filterResult.startsWith("FALSE")) {
return;
}
}
// Build up final to list
StringList finalToList = combineStaticAndDynamicLists(context,
objectId, OBJECT, toList, toSelectList, true);
// Build up final cc list

StringList finalCcList = combineStaticAndDynamicLists(context,
objectId, OBJECT, ccList, ccSelectList, true);
// Build up final object id list

StringList finalIdList = combineStaticAndDynamicLists(context,
objectId, OBJECT, null, idSelectList, false);
// String from = substituteValues(context, fromAgent);

String from = "";
if (fromAgent != null && fromAgent.trim().length() > 0
&& fromAgent.startsWith("$<person_")) {
from = substituteValues(context, fromAgent);
} else {
from = substituteValues(context, fromAgent, objectId, null);
}
if (objectId == null || objectId.equals("")) {

if (finalIdList != null && !finalIdList.isEmpty()) {
// If no objectId is given, we will assume the first object
id
// in the objectIdList can be used to evaluate selects
embedded
// in the
// subject and message strings.
objectId = (String) finalIdList.firstElement();
}
} else {
// If an objectId is given but no objectIdList, we add objectId
// to the objectIdList.
if (finalIdList == null) {
finalIdList = new StringList(1);
}
if (finalIdList.size() < 1) {
finalIdList.add(objectId);
}
}
// Execute filter JPO method to determine if email should be sent

if (filterJPOMethod != null && !"".equals(filterJPOMethod.trim())) {
int status = 0;
int index = filterJPOMethod.indexOf(":");
String methodName = "";
String name = "";
if (index >= 0) {
methodName = filterJPOMethod.substring(index+1);
name = filterJPOMethod.substring(0, index);
}
try {
status = JPO.invoke(context, name, new String[0],

methodName,(String[]) finalIdList.toArray());
} catch (Throwable e) {
System.out
.println("exception trying to invoke filter JPO method: "
+ e.toString());
}
if (status != 0) {
return;
}
}
// Pass results to sendNotification

sendNotification(context, objectId, finalToList, finalCcList, null,
subjectKey, messageKey, finalIdList, basePropFile,
urlSuffix,
from, messageJPOMethod);
}
private static String getClassNameForProg(Context context, String name)

throws Exception
{
command.append("print program '");
command.append(name);
command.append("' select classname dump |");
String className = MqlUtil.mqlCommand(context, command.toString());
return className;
}
/**
* This method sends a mail notification to the specified users.
*
* @param objectId String contains id of the object used to evaluate embedded
select clauses
* in the subject and message
* @param toList StringList that contains the list of users to notify
* @param ccList StringList that contains the list of users to cc
* @param bccList StringList that contains the list of users to bcc
* @param subjectKey String that contains the notification subject key
* @param messageKey String that contains the notification message key
* @param objectIdList StringList that contains the ids of objects to send
with the notification
search for keys
* @param urlSuffix String that contains additional info to append to
embedded URLs
* @param messageJPOMethod - a String holding the JPO name and method name
* @since AEF 10.0.0.0
*/
public static void sendNotification(Context context, String objectId,

StringList toList, StringList ccList, StringList bccList,
String subjectKey, String messageKey, StringList objectIdList,
String basePropFile, String urlSuffix, String fromAgent,
String messageJPOMethod)
throws Exception {
// If no toList given, then nobody to notify

if (toList == null || toList.size() < 1) {
return;
}
// If no subject given, then icon mail won't work

if (subjectKey == null || subjectKey.equals("")) {
return;
}
if (objectId == null || objectId.equals("")) {

if (objectIdList != null && !objectIdList.isEmpty()) {
id
embedded in the
objectId = (String) objectIdList.firstElement();
}
}
// If the base URL is available, then construct urls which will be
// appended to the end of the message.
StringBuffer urlsBuffer = new StringBuffer();
String baseURL = ${CLASS:emxMailUtil}.getBaseURL(context, null);
if (baseURL != null && !"".equals(baseURL)) {
if (objectIdList != null && objectIdList.size() > 0) {
urlsBuffer.append("\n");
Iterator i = objectIdList.iterator();
while (i.hasNext()) {
urlsBuffer.append(baseURL);
urlsBuffer.append("?objectId=");
urlsBuffer.append((String) i.next());
if (urlSuffix != null && !"".equals(urlSuffix)) {
urlsBuffer.append(urlSuffix);
}
}
}
}
String urls = urlsBuffer.toString();
// "names" holds the user names and language preferences

HashMap names = new HashMap();
// "languages" holds the unique languages

HashMap languages = new HashMap();
${CLASS:emxMailUtil}.getNamesAndLanguagePreferences(context, names,
languages, toList);
languages, ccList);
languages, bccList);
// send one message per language

Iterator itr = languages.keySet().iterator();
while (itr.hasNext()) {
String language = (String) itr.next();
Locale locale = null;
if (language.length() > 0) {
locale = MessageUtil.getLocale(language);
}
// build the to, cc and bcc lists for this language

StringList to = ${CLASS:emxMailUtil}.getNamesForLanguage(toList,
names, language);
StringList cc = ${CLASS:emxMailUtil}.getNamesForLanguage(ccList,
names, language);
StringList bcc = $
{CLASS:emxMailUtil}.getNamesForLanguage(bccList, names, language);
// fetch i18n subject and message content

String subject = null;
StringBuffer message = new StringBuffer();
subject = getMessage(context, objectId, subjectKey,
locale,
basePropFile);
message.append(getMessage(context, objectId, messageKey,

locale,
basePropFile));
message.append(urls);
if (messageJPOMethod != null
&& !"".equals(messageJPOMethod.trim())) {
String msg = "";
int index = messageJPOMethod.indexOf(":");
String name = "";
if (index >= 0) {
methodName = messageJPOMethod.substring(index+1);
name = messageJPOMethod.substring(0, index);
}
String className = getClassNameForProg(context, name);

try {
//Class jpo = Class.forName(className);
Class jpo = MatrixClassLoader.newClass(context,
className, 0);
Class[] types = new Class[] {
context.getClass(),
StringList.class,
Locale.class,
String.class,
String.class,
String.class};
Method method = jpo.getMethod(methodName, types);
Object[] args = new Object[] {

context,
objectIdList,
locale == null ? getLocale(context) :
locale,
basePropFile,
baseURL,
urlSuffix};
msg = (String)method.invoke(null, args);
} catch (Exception e) {
System.out.println("exception trying to invoke
message JPO method: " + e.toString());
}
if (msg.trim().length()>0) {
message.append("\n");
message.append(msg);
}
}
// Send the mail message.

sendMail(context, to, cc, bcc, subject, message.toString(),
objectIdList, fromAgent);
}
}
/**
*
* @param id a String holding the id of an object or relationship to be
* used for evaluating selects embedded in the subject and
* message strings
object
methods
* @param messageHTMLKey a String that contains the notification HTML message
key
search for keys
embedded URLs
* @param replyTo a StringList containing select clauses evaluated to fill
out
* the replyTo user and personal information
* @param preprocessJPOMethod a String holding the JPO name and method name
* @since AEF 11.0.0.0
*/
protected static void sendNotification(Context context, String id, String

idType,
String notificationName, Map payload,
String subjectKey, String messageKey, String messageHTMLKey,
StringList objectIdList, String basePropFile, String urlSuffix,
String fromAgent, StringList replyTo, String preprocessJPOMethod)
throws Exception {
//Call the overloaded sendNotification with notification type as Both
sendNotification(context, id, idType, notificationName, payload,
toList, ccList, bccList,
subjectKey, messageKey, messageHTMLKey, objectIdList,
basePropFile, urlSuffix,
fromAgent, replyTo, preprocessJPOMethod, both);
}
/**
*
* message strings
object
methods
* @param messageHTMLKey a String that contains the notification HTML message
key
search for keys
embedded URLs
* @param replyTo a StringList containing select clauses evaluated to fill
out
* the replyTo user and personal information
* @param preprocessJPOMethod a String holding the JPO name and method name
* @param notifyType Notification Type selected by user (email, iconmail, or
both)
* @since x+2
*/
protected static void sendNotification(Context context, String id, String

idType,
String notificationName, Map payload,
String subjectKey, String messageKey, String messageHTMLKey,
StringList objectIdList, String basePropFile, String urlSuffix,
String fromAgent, StringList replyTo, String preprocessJPOMethod,
String notifyType)
throws Exception {
final String subscriptionAgent =

PropertyUtil.getSchemaProperty(context, "person_SubscriptionAgent");
// If no toList given, then nobody to notify

if ((toList == null || toList.size() < 1) && (ccList == null ||
ccList.size() < 1) && (bccList == null || bccList.size() < 1) ) {
return;
}
// If no subject given, then icon mail won't work

if (subjectKey == null || subjectKey.equals("")) {
return;
}
if (id == null || id.equals("")) {

if (objectIdList != null && !objectIdList.isEmpty()) {
id
embedded in the
id = (String) objectIdList.firstElement();
}
}
// If the base URL is available, then construct urls which will be

// appended to the end of the message.
StringBuffer urlsBuffer = new StringBuffer();
if (baseURL != null && !"".equals(baseURL)) {
if (objectIdList != null && objectIdList.size() > 0) {
// Modified for Pub / Sub Relationship Feature

if(idType.equals("object"))
{
}
else
urlsBuffer.append("relationshipID=");
urlsBuffer.append((String) i.next());
if (urlSuffix != null && !"".equals(urlSuffix)) {
urlsBuffer.append(urlSuffix);
}
}
}
//Added for bug 356405
else
{
if(idType.equals("object"))
{
urlsBuffer.append(id);
}
else
{
}
}
//Ended
}
// Added for bug 356405
else
{
if(!idType.equals("object"))
{
}
}
//Ended
String urls = urlsBuffer.toString();
// Create the arguments for the JPO method

Map info = new HashMap();
info.put("id", id);
info.put("idType", idType);
info.put("notificationName", notificationName);
info.put("payload", payload);
info.put("from", fromAgent);
info.put("replyTo", replyTo);
info.put("objectIdList", objectIdList);
info.put("bundleName", basePropFile);
info.put("baseURL", baseURL);
info.put("urlSuffix", urlSuffix);
// "names" holds the user names and language preferences

HashMap nameAndLanguage = new HashMap();
// "languages" holds the unique languages

HashMap languages = new HashMap();
${CLASS:emxMailUtil}.getNamesAndLanguagePreferences(context,
nameAndLanguage, languages, toList);
nameAndLanguage, languages, ccList);
nameAndLanguage, languages, bccList);
// name is the key, frequency is the value

HashMap<String,String> nameAndFrequency = new HashMap<String,String>();
// load the maps
getNamesAndFrequencyPreferences(context, nameAndFrequency, toList);
getNamesAndFrequencyPreferences(context, nameAndFrequency, ccList);
getNamesAndFrequencyPreferences(context, nameAndFrequency, bccList);
// send one message per language

Iterator itr = languages.keySet().iterator();
String language = (String) itr.next();
Locale locale = null;
if (language.length() > 0) {
locale = MessageUtil.getLocale(language);
}
if (locale == null || locale.equals("")) {

locale = getLocale(context);
}
info.put("locale", locale);
info.put("status", "");
// build the to, cc and bcc lists for this language

StringList to = ${CLASS:emxMailUtil}.getNamesForLanguage(toList,
nameAndLanguage, language);
StringList cc = ${CLASS:emxMailUtil}.getNamesForLanguage(ccList,
StringList bcc = ${CLASS:emxMailUtil}.getNamesForLanguage(bccList,
info.put("toList", to);
info.put("ccList", cc);
info.put("bccList", bcc);
// fetch i18n subject and message content

String subject = inputOrJPOTolocalizedString(context, subjectKey,
info, null);
String isMxLang = (String)

FrameworkProperties.getProperty("emxFramework.UserDefined.Language");
//for mx-lang support
if(isMxLang.contains(locale.getLanguage()))
{
i18nNow i18n = new i18nNow();
subject =
i18n.getAutomationString(context.getSession().getLanguage(),subjectKey).append(subj
ect).toString();
}
String messageHTML = inputOrJPOTolocalizedString(context,

messageHTMLKey, info, urls);
String messageText = inputOrJPOTolocalizedString(context,
messageKey, info, urls);
//fromAgent = "Subscription Agent";
if((notifyType.equalsIgnoreCase(email)) &&
(fromAgent.equalsIgnoreCase(subscriptionAgent) || (replyTo!=null && ((String)
replyTo.elementAt(0)).equalsIgnoreCase(subscriptionAgent) )))
{
bcc.addAll(to);
bcc.addAll(cc);
to.clear();
cc.clear();
if(replyTo!=null)
{
String replyToObj = (String) replyTo.elementAt(1);
if(FrameworkUtil.isObjectId(context, replyToObj))
{
replyTo.setElementAt((String)
replyTo.elementAt(1)+"|", 1);
}
}
String toUsers = to.toString();

toUsers = "TO: "+toUsers.substring(1,toUsers.length()-1);
String ccUsers = cc.toString();

ccUsers = "CC: "+ccUsers.substring(1,ccUsers.length()-1);
String bccUsers = bcc.toString();

bccUsers= "BCC: "+bccUsers.substring(1,bccUsers.length()-
1);
if(messageHTML!=null
&& !"null".equalsIgnoreCase(messageHTML))
{
messageHTML = "-+-----+-----+-----+-----+-----+-----
+-----+-----+- Do Not Edit This Line ";
messageHTML =
messageHTML+toUsers+" "+ccUsers+" "+bccUsers+" "+inputOrJPOTolocal
izedString(context, messageHTMLKey, info, null);
}
if(messageText!=null
&& !"null".equalsIgnoreCase(messageText))
{
messageText = "-+-----+-----+-----+-----+-----+-----
+-----+-----+-\n Do Not Edit This Line \n\n";
messageText =
messageText+toUsers+"\n"+ccUsers+"\n"+bccUsers+"\n\n"+inputOrJPOTolocalizedString(c
ontext, messageKey, info, urls);
}
// start code for appending TYPE NAME REVISION in the
Subject of the mail
DomainObject dObj = new DomainObject(id);
String objType = dObj.getType(context);
String objName = dObj.getName(context);
String objRevision = dObj.getRevision(context);
subject = subject+" | '"+objType+"' '"+objName+"'
'"+objRevision+"'";
// end code for appending TYPE NAME REVISION in the Subject
of the mail
}
// Execute preprocess JPO method to determine final content and

whether to send
if (preprocessJPOMethod != null && preprocessJPOMethod.length() >
0) {
info.put("subject", subject);
info.put("messageText", messageText);
info.put("messageHTML", messageHTML);
int index = preprocessJPOMethod.indexOf(":");
String name = "";
if (index >= 0) {
methodName = preprocessJPOMethod.substring(index+1);
name = preprocessJPOMethod.substring(0, index);
}
try
{
// Pack arguments into string array
String[] args = JPO.packArgs(info);
try {
Map resultsMap = (Map)JPO.invoke(context, name,

new String[0], methodName, args, Map.class);
String status = (String)

resultsMap.get("status");
if (status != null && status.length() > 0) {
// Any sort of status implies not sending
the mail
continue;
}
to = (StringList) resultsMap.get("toList");
cc = (StringList) resultsMap.get("ccList");
bcc = (StringList) resultsMap.get("bccList");
subject = (String) resultsMap.get("subject");
messageText = (String)
resultsMap.get("messageText");
messageHTML = (String)
resultsMap.get("messageHTML");
objectIdList = (StringList)
resultsMap.get("objectIdList");
fromAgent = (String) resultsMap.get("from");
replyTo = (StringList)
resultsMap.get("replyTo");
System.out.println("Exception trying to invoke
method " + methodName +
" of JPO " + name + " ERROR: " +
e.toString());
}
System.out.println("Exception trying to print program
" + name + " ERROR: " + e.toString());
}
// get frequencies for notification recipients

HashSet<String> frequencies = new HashSet<String>();
getNotificationFrequencies(nameAndFrequency, to, frequencies);
getNotificationFrequencies(nameAndFrequency, cc, frequencies);
getNotificationFrequencies(nameAndFrequency, bcc, frequencies);
// loop over notification frequencies

Iterator<String> itrFreq = frequencies.iterator();
String frequency;
while (itrFreq.hasNext()) {
frequency = itrFreq.next();
// build the to, cc and bcc lists for this frequency
StringList toFreq = getNamesForFrequency(to, nameAndFrequency,
frequency);
StringList ccFreq = getNamesForFrequency(cc, nameAndFrequency,
frequency);
StringList bccFreq = getNamesForFrequency(bcc, nameAndFrequency,
frequency);
// if we have someone to notify

if (toFreq.size() > 0 || ccFreq.size() > 0 || bccFreq.size() > 0) {
// send if the preference is to notify immediately
if (frequency.equalsIgnoreCase("immediately")) {
sendJavaMail(context, toFreq, ccFreq, bccFreq, subject,
messageText, messageHTML,
fromAgent, replyTo, objectIdList, notifyType);
} else {
MapList spools;
if (frequency.equalsIgnoreCase("default")) {
// find the spools for this type of notification
spools = getSpools(context, notificationName);
} else {
// find the spool for this frequency
spools = getSpool(context, frequency);
}
// spool the notification if appropriate

if (spools != null && spools.size() > 0) {
spoolJavaMail(context, toFreq, ccFreq, bccFreq,
subject, messageText, messageHTML,
fromAgent, replyTo, objectIdList,
notifyType, notificationName, spools);
} else {
sendJavaMail(context, toFreq, ccFreq, bccFreq,
subject, messageText, messageHTML,
fromAgent, replyTo, objectIdList,
notifyType);
}
}
}
}
}
}
/**
* This method returns all of the spools that the given notification object is
connected to.
*
* @param notificationName a String holding the name of the Notification object
* @return a MapList of spool object ids
* @since x+2
*/
private static MapList getSpools(Context context, String notificationName)

throws Exception {
MapList spools = null;
StringList selects = new StringList();
selects.add("id");
MapList notifications = DomainObject.findObjects(context,
PropertyUtil.getSchemaProperty(context,
"type_Notification"),
"vault_eServiceAdministration"),
"name eq '" + notificationName + "'", selects);
if (notifications.size() > 0) {
Map m1 = (Map)notifications.get(0);
DomainObject notification = new
DomainObject((String)m1.get("id"));
//Modified:21-July-2010:s2e:R210:PRG:2011x- Email Notification

Enhancement
boolean isContextPushed = false;
try{
ContextUtil.pushContext(context);
isContextPushed = true;
spools = notification.getRelatedObjects(context,
"relationship_NotificationSpool"), // rel type
"type_NotificationSpool"), // object type
selects, // object selects
null, // rel selects
false, //get to-side
true, // get from-side
(short)1, // recurseToLevel
"", // objectWhere
"", // relationshipWhere
50 // limit
);
}
catch(Exception e){
throw new MatrixException(e);
}
finally{
if (isContextPushed) {
ContextUtil.popContext(context);
}
}
//End:21-July-2010:s2e:R210:PRG:2011x- Email Notification
Enhancement
}
return spools;
}
private static MapList getSpool(Context context, String spoolName) throws

Exception {
MapList spool = null;

try {
StringList selects = new StringList(1);

selects.add("id");
spool = DomainObject.findObjects(context,
"type_NotificationSpool"),
spoolName, "*", "*", "*",
"attribute[Enable For Preference]==TRUE", false,
selects);
}
catch(Exception e) {
}
finally {
}
}
return (spool);
}
/**
* This method spools a mail notification to the specified users. Sometime
later the
* spooled messages can be consolidated and sent.
*
* @param to StringList that contains the list of users to notify
* @param cc StringList that contains the list of users to cc
* @param bcc StringList that contains the list of users to bcc
* @param subject String that contains the notification subject
* @param messageText String that contains the notification message
* @param messageHTML a String that contains the notification HTML message
* @param replyTo a StringList containing the replyTo user and personal
information
* @param objectIdList StringList that contains the ids of objects to send with
the notification
both)
* @param notificationName a String holding the name of the Notification object
* @since x+2
*/
private static void spoolJavaMail(Context context, StringList to,

StringList cc, StringList bcc, String subject, String
messageText,
String messageHTML, String fromAgent, StringList replyTo,
StringList objectIdList, String notifyType, String
notificationName,
MapList spools) throws Exception {
AttributeList attributes = new AttributeList();

AttributeType attrType = null;
Attribute attrObject = null;
StringBuffer buf = new StringBuffer();
attrType = new AttributeType(

"attribute_StaticToList"));
buf.delete(0, buf.length());
if (to != null) {
int count = 0;
Iterator stringItr = to.iterator();
while (stringItr.hasNext()) {
if (count > 0) {
buf.append(",");
}
String name = (String)stringItr.next();
buf.append(name);
count++;
}
}
attrObject = new Attribute(attrType, buf.toString());
attributes.addElement(attrObject);

"attribute_StaticCcList"));
if (cc != null) {
int count = 0;
Iterator stringItr = cc.iterator();
if (count > 0) {
buf.append(",");
}
buf.append(name);
count++;
}
}

"attribute_StaticBccList"));
if (bcc != null) {
int count = 0;
Iterator stringItr = bcc.iterator();
if (count > 0) {
buf.append(",");
}
buf.append(name);
count++;
}
}

"attribute_SubjectText"));
attrObject = new Attribute(attrType, subject);

"attribute_BodyText"));
attrObject = new Attribute(attrType, messageText);

"attribute_BodyHTML"));
attrObject = new Attribute(attrType, messageHTML);

"attribute_FromAgent"));
attrObject = new Attribute(attrType, fromAgent);
"attribute_ReplyTo"));
if (replyTo != null) {
int count = 0;
Iterator stringItr = replyTo.iterator();
if (count > 0) {
buf.append(",");
}
buf.append(name);
count++;
}
}

"attribute_Attachments"));
if (objectIdList != null) {
int count = 0;
Iterator stringItr = objectIdList.iterator();
if (count > 0) {
buf.append(",");
}
buf.append(name);
count++;
}
}

"attribute_NotificationType"));
attrObject = new Attribute(attrType, notifyType);

"attribute_NotificationName"));
attrObject = new Attribute(attrType, notificationName);
Iterator spoolItr = spools.iterator();

while (spoolItr.hasNext()) {
Map child = (Map)spoolItr.next();
String spoolId = (String)child.get("id");
DomainObject spool = new DomainObject(spoolId);
// Create rel to hold deferred mail elements
RelationshipType relType = new RelationshipType(
"relationship_NotificationRequest"));
//Modified:10-August-2010:s2e:R210:PRG:2011x- Email Notification
Enhancement
try{
Relationship rel = spool.addRelatedObject(context,
relType,
true, // isFrom
spoolId);
rel.setAttributes(context, attributes);
}
catch(Exception e){
}
finally{
}
}
//End:10-August-2010:s2e:R210:PRG:2011x- Email Notification
Enhancement
}
return;
}
/**
* This method sends mail using the Java Mail API.
*
* @param subject String that contains the subject
* @param messageText String that contains the message in plain text
* @param messageHTML String that contains the message in HTML format
* @param replyTo a StringList holding the replyTo user and personal info
appearing in the mail
* @since AEF 11.0.0.0
*/
public static void sendJavaMail(Context context, StringList toList,

StringList ccList, StringList bccList, String subject,
String messageText, String messageHTML,
String fromAgent, StringList replyTo) throws Exception {
//send notifications through both Email and IconMail
sendJavaMail(context, toList, ccList, bccList, subject, messageText,
messageHTML,
fromAgent, replyTo,null, both);
}
/**
* This method sends mail using the Java Mail API.
*
* @param subject String that contains the subject
* @param messageText String that contains the message in plain text
* @param messageHTML String that contains the message in HTML format
* @param replyTo a StringList holding the replyTo user and personal info
appearing in the mail
both)
* @since x+2
*/
public static void sendJavaMail(Context context, StringList toList,

String messageText, String messageHTML,
String fromAgent, StringList replyTo, StringList objectIdList,
String notifyType) throws Exception
{
// IR-058366V6R2011x Modification -Starts
${CLASS:emxContextUtil} utilityClass = new ${CLASS:emxContextUtil}
(context, null);
// IR-058366V6R2011x Modification -Ends
try
{
MxMessage msg = new MxMessage();

//msg.setDebug(true);
if (replyTo != null && replyTo.size() > 1) {

msg.setReplyTo((String)replyTo.elementAt(0));
msg.setReplyToText((String)replyTo.elementAt(1));
}
msg.setSubject(subject);
if (messageText != null) {
msg.setMessage(messageText);
}
if (messageHTML != null) {
msg.setHtmlMessage(messageHTML);
}
if (toList != null) {
ArrayList to = new ArrayList();
to.addAll(toList);
msg.setToList(to);
}
if (ccList != null) {
ArrayList cc = new ArrayList();
cc.addAll(ccList);
msg.setCcList(cc);
}
if (bccList != null) {
ArrayList bcc = new ArrayList();
bcc.addAll(bccList);
msg.setBccList(bcc);
}
// IR-058366V6R2011x Commented here and declared at the begining
before try block -starts
// boolean isContextPushed = false;
// ${CLASS:emxContextUtil} utilityClass = new $
{CLASS:emxContextUtil}(context, null);
// IR-058366V6R2011x Commented here and declared at the begining
before try block -Ends
// Test if spoofing should be performed on the "from" field.
String agentName = fromAgent;
if (agentName == null || "".equals(agentName)) {
agentName = ${CLASS:emxMailUtil}.getAgentName(context,
null);
}
if (agentName != null && !"".equals(agentName)) {
try {
// Push Notification Agent
String[] pushArgs = { agentName };
utilityClass.pushContext(context, pushArgs);
} catch (Exception ex) {

}
}
//msg.sendJavaMail(context, false); false for not sending icon

mail
//status can be 0 or 1. Zero represents external mails have been
sent successfully and 1
// implies external mail was not configured on subscribed
persons.
try
{
//Send mail only using email
if(email.equalsIgnoreCase(notifyType) ||
both.equalsIgnoreCase(notifyType))
{
int emailStatus = msg.sendJavaMail(context, false);
}
}
catch(Exception ex)
{
System.out.println("Message: Please check SMTP settings for
sending an Email");
throw new FrameworkException(ex);
}
//Send mail only using IconMail

if(iconMail.equalsIgnoreCase(notifyType) ||
both.equalsIgnoreCase(notifyType))
{
IconMail iconMail = new IconMail();
iconMail.create(context);
iconMail.setMessage(messageText);
if (toList != null && toList.size() > 0)
iconMail.setToList(toList);
if (ccList != null && ccList.size() > 0)
iconMail.setCcList(ccList);
if (bccList != null && bccList.size() > 0)
iconMail.setBccList(bccList);
if(objectIdList != null && objectIdList.size() != 0)
{
BusinessObjectList bol = new
BusinessObjectList(objectIdList.size());
String id = (String) i.next();
BusinessObject bo = new BusinessObject(id);
// Added the condition to check if the mail is
sending for relationship then not attaching the
// connection id
if(messageText.indexOf("relationshipID=") ==
-1)
{
bo.open(context);
bol.addElement(bo);
}
bo.open(context);
bol.addElement(bo);
}
iconMail.setObjects(bol);
}
iconMail.send(context, subject, false);
}
// IR-058366V6R2011x Modification - Starts
// if (isContextPushed == true) {
// Pop Notification Agent
// utilityClass.popContext(context, null);
// }
// IR-058366V6R2011x Modification - Ends
}catch(Exception e)
{
e.printStackTrace();
}
finally // IR-058366V6R2011x Added finally block - Starts
{
if (isContextPushed == true) {
utilityClass.popContext(context, null);
}
} // IR-058366V6R2011x Added finally block - Ends
}
/**
* This method sends an icon mail notification to the specified users.
*
* @param subject String that contains the notification subject
* @param message String that contains the notification message
* @since AEF 10.0.0.0
*/
protected static void sendMail(Context context, StringList toList,

String message, StringList objectIdList,
String fromAgent) throws Exception {
// viewing Icon mail in application '<' and '>' are read as tags by
html
// These char's need to be eliminated before sending the mail message.
subject = subject.replace('<', ' ');
subject = subject.replace('>', ' ');
message = message.replace('<', ' ');
message = message.replace('>', ' ');
// Create iconmail object.

IconMail mail = new IconMail();
mail.create(context);
// Set the "to" list.

mail.setToList(toList);
// Set the "cc" list.

if (ccList != null) {
mail.setCcList(ccList);
}
// Set the "bcc" list.

if (bccList != null) {
mail.setBccList(bccList);
}
// Set the object list. If the object id list is available,

// then send the objects along with the notification.
if (objectIdList != null && objectIdList.size() != 0) {
BusinessObjectList bol = new
BusinessObjectList(objectIdList.size());
String id = (String) i.next();
bo.open(context);
bol.addElement(bo);
}
mail.setObjects(bol);
}
// Set the message.

mail.setMessage(message);

${CLASS:emxContextUtil} utilityClass = new ${CLASS:emxContextUtil}
(context,
null);
// Test if spoofing should be performed on the "from" field.
String agentName = fromAgent;
if (agentName == null || "".equals(agentName)) {
agentName = ${CLASS:emxMailUtil}.getAgentName(context, null);
}
if (agentName != null && !"".equals(agentName)) {
try {
// Push Notification Agent
String[] pushArgs = { agentName };
utilityClass.pushContext(context, pushArgs);
}
}
// Set the subject and send the iconmail.

mail.send(context, subject);
if (isContextPushed == true) {
utilityClass.popContext(context, null);
}
}
/**
* Returns a processed and translated message for a given key.
*
* @param objectId a String contains id of the object
* @param messageKey the notification message key
* @param locale the locale used to determine language
* @param basePropFileName used to identify property file.
* @return a String containing the message
* @since AEF 10.0.0.0
*/
protected static String getMessage(Context context, String objectId,

String messageKey,
Locale locale, String basePropFileName)
throws Exception {
return (getMessage(context, objectId, OBJECT, messageKey, null, locale,
basePropFileName));
}
/**
* Returns a processed and translated message for a given key or string.
*
* @param objectId a String contains id of the object
* @param messageKey the notification message key or string
* @param formatArgs an array of message place holder values
* @param basePropFileName used to identify property file if key given
* @since AEF 10.0.0.0
*/
protected static String getMessage(Context context, String objectId,

String messageKey, Object[] formatArgs,
Locale locale, String basePropFileName) throws Exception {
return getMessage(context, objectId, OBJECT, messageKey, formatArgs,

locale, basePropFileName);
}
/**
* Returns a processed and translated message for a given key.
*
* message strings
* @param messageKey the notification message key
* @param basePropFileName used to identify property file.
* @since AEF 11.0.0.0
*/
protected static String getMessage(Context context, String id, String idType,

String messageKey,
Locale locale, String basePropFileName)
throws Exception {
return (getMessage(context, id, idType, messageKey, null, locale,
basePropFileName));
}
/**
* Returns a processed and translated message for a given key or string.
*
* message strings
* @param messageKey the notification message key or string
* @param formatArgs an array of message place holder values
* @param basePropFileName used to identify property file if key given
* @since AEF 11.0.0.0
*/
protected static String getMessage(Context context, String id, String idType,

String messageKey, Object[] formatArgs,
Locale locale, String basePropFileName) throws Exception {
if (locale == null || locale.equals("")) {
locale = getLocale(context);
}
String message = null;

if (basePropFileName == null || basePropFileName.equals("")) {
message = loadConvert(messageKey);
} else {
// Define the message from the given key.
message = MessageUtil.getString(basePropFileName, messageKey,
null,
locale);
}
if (message != null) {
// Do the normal macro substitution (i.e. $<type>, ${OBJECTID},
etc.)
message = substituteValues(context, message, id, idType,
locale.getLanguage());
// Substitute using format arguments (java.text.MessageFormat)

if (formatArgs != null && formatArgs.length > 0 && message !=
null) {
message = substituteMessageArgs(context, message,
formatArgs,locale);
}
}
return (message);
}
/**
* Get locale for given context.
*
* @return locale object
* @since AEF 10.0.0.0
*/
protected static Locale getLocale(Context context) {

return (MessageUtil.getLocale(context.getSession().getLanguage()));
}
/**
* Replace symbolic names embedded in a string with true names.
*
* @param expression the string containing embedded selectables
* @return the evaluated result
* @since AEF 10.0.0.0
*/
protected static String substituteValues(Context context, String expression)
throws Exception {
return (substituteValues(context, expression, null, null));
}
/**
* Replace object selectables embedded in a string with their
* values based on the given object.
*
* @param objectId the id of the object used to evaluate the selectables
* @param language the string containing a language for i18n of type and
vault
* @since AEF 10.0.0.0
*/
protected static String substituteValues(Context context, String expression,

String objectId, String language) throws Exception {
return substituteValues(context, expression, objectId, OBJECT,
language);
}
/**
* Replace selectables embedded in a string with their
* values based on the given object or relationship.
*
* message strings
* @param language the string containing a language for i18n of type and
vault
* @since AEF 11.0.0.0
*/
protected static String substituteValues(Context context, String expression,

String id, String idType, String language) throws Exception {
try {
if (expression == null || expression.equals("")) {
return expression;
}
// Initialize the return string.
StringBuffer message = new StringBuffer();
// Create a mapping from token type to a set

// that holds selects, macros, and variables.
Map expressions = new HashMap(3);
expressions.put(SELECT, new HashSet());
expressions.put(MACRO, new HashSet());
// Create a mapping from token type to a map that maps

// the selects, macros, and variables to their values.
Map values = new HashMap(3);
values.put(SELECT, new HashMap());
values.put(MACRO, new HashMap());
// Create lists to hold the tokens and their types.

ArrayList tokens = new ArrayList();
ArrayList types = new ArrayList();
//
// Parse the input string into typed tokens.
//
// Loop through the tokens until the end of the string.

StringTokenizer st = new StringTokenizer(expression,
DELIMITER_START, true);
while (true) {
String token = null;
String type = null;
try {
// get everything up to the first delimiter
token = st.nextToken(DELIMITER_START);
// if this is the delimiter, then determine the token

type
if ("$".equals(token)) {
type = st.nextToken(DELIMITER_TYPE);
// look for the matching end token

String delimiter = (String)
delimiters.get(type);
// if this wasn't a known delimiter

if (delimiter == null) {
// must have been some text
tokens.add(type);
types.add(TEXT);
} else {
token = st.nextToken(delimiter);
if (type.equals(SELECT) &&
token.indexOf("_") > -1) {
token =
replaceSymbolicTokens(context, token);
}
tokens.add(token);
types.add(type);
// add the expression to the list by type

((HashSet)
expressions.get(type)).add(token);
// throw out the matching end token

token = st.nextToken();
}
}
// otherwise, save the token as text
else {
// must have been some text
tokens.add(token);
types.add(TEXT);
}
} catch (NoSuchElementException e) {
break;
}
}
//
// Get the selectable information from the object.
//
// Create a select list from the select set.

StringList selects = new StringList(((HashSet) expressions
.get(SELECT)).size());
Iterator itr = ((HashSet) expressions.get(SELECT)).iterator();
selects.add((String) itr.next());
}
// use the select list to get info from the object

// save the select map
if (id != null) {
values.put(SELECT, getInfo(context, id, idType, selects));
}
// If select is type or vault then internationalize them.
if (language != null) {
Hashtable selectMap = new Hashtable((Map)
values.get(SELECT));
/*modified by common team to accomodate macro

Current(State), for any changes/issues please contact BPS-Common team*/
for (int i = 0; i < selects.size(); i++) {

if (((String)
selects.get(i)).equalsIgnoreCase("type")) {
StringList selectValueList = (StringList)
selectMap.get(selects
.get(i));
String selectValue = (String)
selectValueList.firstElement();
String selectProp = "emxFramework.Type."
+ selectValue.replace(' ', '_');
String selectPropValue = i18nNow.getI18nString(
selectProp,
"emxFrameworkStringResource",
language);
selectValueList.setElementAt(selectPropValue,
0);
selectMap.put(selects.get(i), selectValueList);
} else if (((String) selects.get(i))
.equalsIgnoreCase("vault")) {
.get(i));
String selectProp = "emxFramework.Vault."
selectProp,
language);
0);
}else if (((String) selects.get(i))
.equalsIgnoreCase("current")) {
DomainObject dom =
DomainObject.newInstance(context,id);
.get(i));
String selectProp = "emxFramework.State." +
dom.getPolicy(context).getName().replace(' ', '_') + "."
selectProp,
language);
0);
}
}
values.put(SELECT, selectMap);
}
// Build the macro map from the macro set.

Map macros = new HashMap();
itr = ((HashSet) expressions.get(MACRO)).iterator();
String name = (String) itr.next();

command.append("get env '");
command.append(name);
command.append("'");
String value = MqlUtil.mqlCommand(context,

command.toString());
macros.put(name, value);
}
// Save the macro map.

values.put(MACRO, macros);
//
// Put the string back together while replacing tokens with
values.
//
// Loop through the token and type list together.

Iterator tokenItr = tokens.iterator();
Iterator typeItr = types.iterator();
while (tokenItr.hasNext()) {
String token = (String) tokenItr.next();
String type = (String) typeItr.next();
// Get the appropriate token map based on the type.

Map valueMap = (Map) values.get(type);
// If the type map is null, then the token is text,

// so just put it in the message.
// Otherwise, get the value for the token
// and put that in the message.
if (valueMap == null) {
message.append(token);
} else {
String value = null;
// if we are dealing with the SELECT map then we have
// StringList entries with multiple potential values
if (type.equals(SELECT)) {
StringList result = (StringList)
valueMap.get(token);
if (result != null) {
if (result.size() == 1) {
value = (String)
result.firstElement();
} else {
Set set = new HashSet();
// move values into set to
eliminate duplicates
set.addAll(result);
Iterator setItr = set.iterator();
StringBuffer list = new
StringBuffer();
if (setItr.hasNext()) {
list.append((String)
setItr.next());
}
while (setItr.hasNext()) {
list.append(OUTPUT_LIST_DELIMITER);
list.append((String)
setItr.next());
}
value = list.toString();
}
}
} else {
value = (String) valueMap.get(token);
}
if (id != null) {
if (value == null) {
message.append(OUTPUT_NO_VALUE);
} else if (value == "") {
message.append(OUTPUT_EMPTY_VALUE);
} else {
message.append(value);
}
} else {
// if there is no value, just place the token
message.append(value == null ? token : value);
}
}
}
return (message.toString());
throw (e);
}
}
/**
* Given an expression, replace all of the symbolic references
* with their real values.
*
* @param expression the expression containing the symbolic references
* @since AEF 10.0.0.0
*/
protected static String replaceSymbolicTokens(Context context,

String expression) throws Exception {
String newExpression = expression;
if (expression.indexOf("_") > -1) {

StringTokenizer st = new StringTokenizer(expression, "
[],\'\"",true);
StringBuffer buffer = new StringBuffer();
while (true) {
try {
String token = st.nextToken();
if (token.indexOf("_") > -1) {

buffer.append(lookupSymbolicToken(context,
token));
} else {
buffer.append(token);
}
} catch (NoSuchElementException e) {
break;
}
}
newExpression = buffer.toString();
}
return (newExpression);
}
/**
* Lookup a symbolic token and return the real value. If
* the token can't be found, return the original token.
*
* @param symbolicToken the token to lookup
* @return the result of the property lookup
* @since AEF 10.0.0.0
*/
protected static String lookupSymbolicToken(Context context,
String symbolicToken) {
String token = null;
try {
token = PropertyUtil.getSchemaProperty(context, symbolicToken);
}
if (token == null || token.length() == 0) {

token = symbolicToken;
}
return (token);
}
/**
* Returns a formatted message.
*
* @param message the message containing format information
* @param formatArgs array of replacement values for the message
* @return a String containing the formatted message
* @since AEF 10.0.0.0
*/
protected static String substituteMessageArgs(Context context, String

message,
Object[] formatArgs, Locale locale) throws Exception {
MessageFormat formatter = new MessageFormat("");
formatter.setLocale(locale);
formatter.applyPattern(message);
return (formatter.format(formatArgs));
}
/**
* Get information regarding a given business object.
* The map that is returned contains all StringList entries. This ensures
that
* multiple values are handled. This also means for a single value you need
to
* extract the first element on the StringList.
*
* @param objectId the id of the given object
* @param objectSelects the eMatrix <code>StringList</code> object that holds
the list of object selectables
* @return Map containing information about the object based on selectables
* @since AEF 10.0.0.0
*/
protected static Map getInfo(Context context,
String objectId,
StringList objectSelects) throws Exception {
return getInfo(context, objectId, OBJECT, objectSelects);
}
/**
* Get information regarding a given business object or relationship.
* The map that is returned contains all StringList entries. This ensures
that
* multiple values are handled. This also means for a single value you need
to
* extract the first element on the StringList.
*
* message strings
* @param selects the eMatrix <code>StringList</code> object that holds the
list of selectables
* @return Map containing information about the object or relationship based
on selectables
* @since AEF 11.0.0.0
*/
protected static Map getInfo(Context context,

String id, String idType,
StringList selects) throws Exception {
HashMap hashMap = null;

if (idType.equalsIgnoreCase(OBJECT)) {
BusinessObjectWithSelect bows = bo.select(context, selects);
Vector keys = bows.getSelectKeys();
int size = keys.size();
hashMap = new HashMap(size);
for (int i=0; i < size; i++) {
String name = (String) keys.elementAt(i);
hashMap.put(name, bows.getSelectDataList(name));
}
} else {
String[] relIdList = {id};
RelationshipWithSelectList relWSelList =
Relationship.getSelectRelationshipData(context, relIdList,
selects);
RelationshipWithSelectItr relWSelItr =
new RelationshipWithSelectItr(relWSelList);
relWSelItr.next();
RelationshipWithSelect relWSel = relWSelItr.obj();
Vector keys = relWSel.getSelectKeys();
int size = keys.size();
hashMap = new HashMap(size);
for (int i=0; i < size; i++) {
String name = (String) keys.elementAt(i);
hashMap.put(name, relWSel.getSelectDataList(name));
}
}
return (hashMap);
}
/*
* Converts encoded \uxxxx to unicode chars
* and changes special saved chars to their original forms
*/
protected static String loadConvert(String theString) {
char aChar;
int len = theString.length();
StringBuffer outBuffer = new StringBuffer(len);
for (int x=0; x<len; ) {

aChar = theString.charAt(x++);
if (aChar == '\\') {
if (aChar == 'u') {
// Read the xxxx
int value=0;
for (int i=0; i<4; i++) {
switch (aChar) {
case '0': case '1': case '2': case '3': case
'4':
case '5': case '6': case '7': case '8': case
'9':
value = (value << 4) + aChar - '0';
break;
case 'a': case 'b': case 'c':
case 'd': case 'e': case 'f':
value = (value << 4) + 10 + aChar - 'a';
break;
case 'A': case 'B': case 'C':
case 'D': case 'E': case 'F':
value = (value << 4) + 10 + aChar - 'A';
break;
default:
throw new IllegalArgumentException(
"Malformed \\\\uxxxx
encoding.");
}
}
outBuffer.append((char)value);
} else {
if (aChar == 't') aChar = '\t';
else if (aChar == 'r') aChar = '\r';
else if (aChar == 'n') aChar = '\n';
else if (aChar == 'f') aChar = '\f';
outBuffer.append(aChar);
}
} else
outBuffer.append(aChar);
}
return outBuffer.toString();
}
/**
* Gets additional message that needs to be appended with the Message body of
Inbox Task Notification.
* @param objectIdList the idList for which the message needs to be returned
* @param locale the Locale object
* @param basePropFile the name of the property file in which the
notification keys are defined
* @param baseURL the URL link to the corresponding inbox task
* @param urlSuffix the Suffix that needs to be appended with the url
* @return String containing message to be appended
* @since AEF 10.6.SP1
*/
public static String getNotificationMessageForInboxTask(Context context,

StringList objectIdList, Locale locale, String basePropFile, String baseURL, String
urlSuffix)
throws Exception {
String inBoxTaskId =null;
String sTempObjId = null;
String msg=null;
DomainObject doTempObj = DomainObject.newInstance(context);
// If the base URL and object id list are available,
// then iterate
if ( (baseURL != null && ! "".equals(baseURL)) &&
(objectIdList != null && objectIdList.size() != 0) )
{
while (i.hasNext())
{
sTempObjId= (String)i.next();
if( (sTempObjId != null) && (!sTempObjId.equals("")))

{
try{
doTempObj.setId(sTempObjId);
if( (doTempObj.getInfo(context,DomainConstants.SELECT_TYPE)).equals(DomainConstants
.TYPE_INBOX_TASK)){
inBoxTaskId = sTempObjId;
break;
}
}catch(Exception ex){
throw (ex);
}
}
}
}
// If it is inbox task the message has to be modified accordingly.
if( (inBoxTaskId != null) && (!inBoxTaskId.equals("")) ){
if(locale !=null){
msg = $
{CLASS:emxMailUtil}.getInboxTaskMailMessage(context,inBoxTaskId,locale,basePropFile
,baseURL,urlSuffix);
}else{
msg = $
{CLASS:emxMailUtil}.getInboxTaskMailMessage(context,inBoxTaskId,getLocale(context),
basePropFile,baseURL,urlSuffix);
}
}
return msg;
}
/**
* Evaluate given filter expression (or JPO method).
*
for
object
methods
* @param filter a String holding the filter expression or "JPO
<jponame>:<methodname>"
* @return int containing status (0 pass, filter out)
* @since AEF 11.0.0.0
*/
protected static int evaluateFilter(Context context, String id, String

idType, String notificationName,
Map payload, String filter) throws Exception {
int status = 0;
if (filter != null && !filter.equals("")) {
if (filter.startsWith("JPO")) {
// Execute filter JPO method to determine if email should
be sent
int index = filter.indexOf(":");
String name = "";
if (index >= 0) {
methodName = filter.substring(index+1);
name = filter.substring(4, index);
}
try
{
Map note = new HashMap();
note.put("id", id);
note.put("idType", idType);
note.put("notificationName", notificationName);
note.put("payload", payload);

String[] args = JPO.packArgs(note);
try {
status = JPO.invoke(context, name, new
String[0], methodName, args);
e.toString());
}
}
} else {
if (id != null && !id.equals("")) {
String expression = substituteValues(context,
filter);
command.append("evaluate expression '");
command.append(expression);
if (idType.equalsIgnoreCase(OBJECT)) {
command.append("' on bus ");
} else {
command.append("' on relationship ");
}
command.append(id);
String filterResult = MqlUtil.mqlCommand(context,
command
.toString());
if (filterResult.startsWith("FALSE")) {
status = 1;
}
}
}
}
return status;
}
/**
* Parse list of items and return as a StringList.
*
* @param value a String holding the delimited list of items
* @return list a StringList holding the items
* @since AEF 11.0.0.0
*/
protected static StringList inputListToStringList(String value) {
StringList list = null;

StringTokenizer tokens = new StringTokenizer(value,
list = new StringList();
list.addElement(tokens.nextToken().trim());
}
}
return list;
}
/**
* Parse list of items (or execute JPO method) and return as a StringList.
*
for
object
methods
* @param value a String holding the delimited list of items
* @return list a StringList holding the items
* @since AEF 11.0.0.0
*/
protected static StringList inputListOrJPOToStringList(Context context,

String id, String idType, String notificationName,
Map payload, String value) throws Exception {
StringList list = null;

if (value.startsWith("JPO")) {
// Execute JPO method to determine list of items
int index = value.indexOf(":");
String name = "";
if (index >= 0) {
methodName = value.substring(index+1);
name = value.substring(4, index);
}
try {
note.put("id", id);

try {
list = (StringList)JPO.invoke(context, name,
new String[0], methodName, args, StringList.class);
e.toString());
throw new
FrameworkException(ExceptionUtils.getStackTrace(e));
}
throw new FrameworkException(e);
}
} else {
list = inputListToStringList(value);
}
}
return list;
}
/**
* Take given value (or execute JPO method) and return as a String.
*
for
object
methods
* @param value a String holding the given value
* @return item a String holding the resulting item
* @since AEF 11.0.0.0
*/
protected static String inputOrJPOToString(Context context, String id, String

idType, String notificationName,
Map payload, String value) throws Exception {
String item = null;

// Execute JPO method to determine item
String name = "";
if (index >= 0) {
}
try
{
note.put("id", id);

try {
item = (String)JPO.invoke(context, name, new
String[0], methodName, args, String.class);
e.toString());
}
}
} else {
item = value;
}
}
return item;
}
/**
* Take given key value (or execute JPO method) and return localized String.
*
* @param value a String holding the given value
* @param info a Map containing information to pass on to helper JPO methods
* @param urls a String of urls to append to the results
* @return results a String holding the localized results
* @since AEF 11.0.0.0
*/
protected static String inputOrJPOTolocalizedString(Context context, String

value, Map info,
String urls) throws Exception {
StringBuffer results = new StringBuffer();

// Execute JPO method to determine item
String name = "";
if (index >= 0) {
}
try {

String[] args = JPO.packArgs(info);
try {
results.append((String)JPO.invoke(context,
name, new String[0], methodName, args, String.class));
e.toString());
}
}
} else {
results.append(getMessage(context,
(String) info.get("id"),
(String) info.get("idType"),
value,
(Locale) info.get("locale"),
(String) info.get("bundleName")));
if (!UIUtil.isNullOrEmpty(urls)) {
results.append("\n").append(urls);
}
}
}
return results.toString();
}
/**
* Combine a static list and the results of a dynamic list.
*
for
* @param list a StringList holding the static values
* @param selects a StringList holding the dynamic values
* @param userListMode a boolean set to true if evaluated selects generate
lists of users
* @return finalList a StringList holding the combined lists (fully
evaluates)
* @since AEF 11.0.0.0
*/
protected static StringList combineStaticAndDynamicLists(Context context,

String id, String idType,
StringList list, StringList selects, boolean userListMode) throws
Exception {
// Build up final list

StringList finalList = new StringList();
Iterator itr = null, itr2 = null;
if (list != null && list.size() > 0) {
itr = list.iterator();
finalList.add(substituteValues(context, (String)
itr.next()));
}
}
// Evaluate select clauses and add to corresponding final list

if (id != null) {
if (selects != null && selects.size() > 0) {
StringList finalSelects = new StringList(selects.size());
itr = selects.iterator();
finalSelects.add(substituteValues(context, (String)
itr.next()));
}
Map values = getInfo(context, id, idType, finalSelects);
itr = finalSelects.iterator();
String select = (String) itr.next();
StringList result = (StringList) values.get(select);
if (result != null) {
itr2 = result.iterator();
while (itr2.hasNext()) {
if (userListMode) {
StringTokenizer tokens = new
StringTokenizer(
(String) itr2.next(),
USER_LIST_DELIMITER);
finalList.addElement(tokens.nextToken()
.trim());
}
}else {
finalList.add((String)
itr2.next());
}
}
}
}
// move values into set to eliminate duplicates
Set set = new HashSet();
set.addAll(finalList);
Iterator setItr = set.iterator();
finalList = new StringList(set.size());
while (setItr.hasNext()) {
finalList.add((String) setItr.next());
}
}
}
return finalList;
}
/**
* Parse userList and groups email persons List, IconMail persons List, and
Both persons list
*
* @param userList contains the list of the users along with notification
type in <person>|<notification type>
* @return HashMap a containing 'Email', 'IconMail' and 'Both' keys that
represent Notification Type and has list of persons
* as their values
* @since X+2
*/
private static HashMap getRefineList(Context context, StringList userList)
throws Exception
{
HashMap finalMap = new HashMap();
StringList EmailToList = new StringList();
StringList IconMailToList = new StringList();
StringList BothToList = new StringList();
StringTokenizer strTokenizer = null;
finalMap.put(email,EmailToList);
finalMap.put(iconMail,IconMailToList);
finalMap.put(both,BothToList);
if(userList!=null && userList.size()>0)
{
//Parse the toList to get the email persons List IconMail
persons List and Both persons list .
for(int i =0;i<userList.size();i++)
{
String personNotify = userList.get(i).toString();
strTokenizer = new StringTokenizer(personNotify, "|");
if(strTokenizer.hasMoreTokens())
{
String toPerson = strTokenizer.nextToken();
if(strTokenizer.hasMoreTokens())
{
String notifyType =strTokenizer.nextToken();
if(email.equalsIgnoreCase(notifyType))
{
EmailToList.add(toPerson);
}
else if(iconMail.equalsIgnoreCase(notifyType))
{
IconMailToList.add(toPerson);
}
else if(both.equalsIgnoreCase(notifyType) ||
"".equalsIgnoreCase(notifyType.trim()))
{
BothToList.add(toPerson);
}
}
else
{
BothToList.add(toPerson);
}
}
}
}
return finalMap;
}
/**
* resetCache.
*
* @return an int 0 for success and non-zero for failure
*/
public int resetCache(Context context, String[] args)

{
programMap.clear();
ageMap.clear();
}
return 0;
}
/**
* Specifies the component age value.
*
* @param age is a long value
*/
public void setComponentAge(long age)

{
_componentAge = age;
}
}
/**
* Specifies the component age value.
*
* 0 - Contains Long value
* @return an int 0 for success and non-zero for failure
*/
public int setComponentAge(Context context, String[] args) throws Exception

{
Long l = new Long(args[0]);
_componentAge = l.longValue();
}
return 0;
}
/**
* This method gets the names and notification frequency preferences from the
list.
*
* @param names from the list along with notification frequency preference will
be added to this map
* @param frequencies notification frequency preferences will be added to this
map
* @param list the list of recipients
* @since AEF R213
*/
protected static void getNamesAndFrequencyPreferences(Context context,

HashMap<String,String>
nameAndFrequency,
final StringList names)
{
if (names != null) {
StringItr itr = new StringItr(names);
while (itr.next()) {
if (nameAndFrequency.containsKey(itr.obj()) == false) {
String frequency = "";
try {
frequency = PropertyUtil.getAdminProperty(context, "user",
itr.obj(), "preference_EmailNotifications");
if (frequency == null || frequency.length() == 0) {
frequency = "default";
}
frequency = "default";
}
nameAndFrequency.put(itr.obj(), frequency);
}
}
}
}
protected static void getNotificationFrequencies(final HashMap<String,String>
nameAndFrequency, final StringList names, HashSet<String> frequencies) {
if (names != null && frequencies != null) {
StringItr itr = new StringItr(names);
frequencies.add(nameAndFrequency.get(itr.obj()));
}
}
}
/**
* This method gets names from the list with given notification frequency
preference.
*
* @param list the list of recipients
* @param nameAndFrequency map of key names and value frequency
* @param frequency String holds the frequency we are filtering on
* @return a StringList contains list of recipients expecting a notification in
the given time frame
* @since R213
*/
protected static StringList getNamesForFrequency(final StringList list,

final HashMap<String,String>
nameAndFrequency,
final String frequency)
{
StringList names = null;
if (list != null) {
names = new StringList(list.size());
StringItr itr = new StringItr(list);

if (frequency.equals(nameAndFrequency.get(itr.obj()))) {
names.addElement(itr.obj());
}
}
}
return (names);
}
/**
* Called when showing preference choices. Used in
AEFEmailNotificationPreference
* command, "Access Program" and "Access Function" properties.
*
* @return always return "true" to allow preference.
* @since BPS 2012x
*/
public boolean hasEmailNotificationAccess(Context context,String args[]) throws
Exception {
return (true);
}
public static String getObjectLinkHTML(Context context, String text, String

objectId) throws Exception {
String link = getObjectLink(context, objectId);

if (link != null && link.length() > 0) {
link = "<a href='" + link + "'>" + text + "</a>";
}
else {
link = text;
}
return (link);
}
public static String getObjectLink(Context context, String objectId) throws

Exception {
String link = "";

if (baseURL != null && baseURL.length() > 0) {
link = baseURL + "?objectId=" + objectId;
}
return (link);
}
}

Em X Notification Util Base

Uploaded by

Document Information

Original Title

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

Em X Notification Util Base

Uploaded by

Copyright:

Available Formats

/*

public class ${CLASSNAME} extends ${CLASS:emxUtil}

/** programMap holds treemap values. */

/** Prefix for bundle name.*/

/** Constants for the delimiters and token types.*/

public ${CLASSNAME}(Context context, String[] args)

ArrayList adminNames = getAdminNameFromProperties(context,

// Get state names from properties

public int mxMain(Context context, String[] args) throws Exception {

public static int objectNotificationFromMap(Context context, String[] args)

if (args == null || args.length < 1) {

public static int objectNotification(Context context, String[] args)

objectNotification(context, objectId, notificationName, null);

public static void objectNotification(Context context,

if(objectId != null && objectId.length() > 0)

public static boolean doesBusinessObjectExist(Context context, String

StringList busSelect = new StringList();

MapList mapList = DomainObject.getInfo(context, objIDs,

Map objectInformation = (Map) mapList.get(0);

if (args == null || args.length < 1) {

public static int relationshipNotification(Context context, String[] args)

relationshipNotification(context, relId, notificationName, null);

if(relId != null && relId.length() > 0)

public static void objectRelationshipNotification(Context context,

for (int j = 0; j < notificationWithSelectList.size(); j++)

// Evaluate filter to determine if email should be sent

StringList replyTo = null;

/* From the Tolist obtained search to get the pipe(|)

HashMap finalMap = getRefineList(context, toList);

finalMap = getRefineList(context, ccList);

finalMap = getRefineList(context, bccList);

finalMap = getRefineList(context, toSelectList);

finalMap = getRefineList(context, ccSelectList);

finalMap = getRefineList(context, bccSelectList);

// Build up final to Both list

// Build up final to Email list

// Build up final to IconMail list

// String from = substituteValues(context, fromAgent);

// Evaluate selects in replyTo

replyTo.setElementAt(substituteValues(context, user), 0);

replyTo.setElementAt(substituteValues(context, user, id, idType, null), 0);

/* Pass results to sendNotification through both email and

// Pass results to sendNotification through IconMail

public static int objectParentsNotification(Context context, String[] args)

StringList objectSelects = new StringList(1);

DomainObject domainObject = DomainObject.newInstance(context,

// expand from parent

Iterator itr = mapList.iterator();

objectNotification(context, id, notificationName, null);

public static int createNotificationFromMap(Context context, String[] args)

public static int createNotification(Context context, String[] args)

String objectId = args[index++];

StringList toList = null;

String subjectKey = null;

StringList toSelectList = null;

StringList idSelectList = null;

String messageJPOMethod = null;

createNotification(context, objectId, toList, ccList, subjectKey,

public static void createNotification(Context context,

// Evaluate filter to determine if email should be sent

// Build up final cc list

// Build up final object id list

// String from = substituteValues(context, fromAgent);