com.jalios.jcms.alert
Class AlertBuilder

java.lang.Object
  com.jalios.jcms.alert.AlertBuilder

All Implemented Interfaces:

AlertConstants, JcmsConstants, JaliosConstants

public class AlertBuilder
extends Object
implements AlertConstants, JcmsConstants

Field Summary

protected Member	author
protected Data	data
protected String	domain
protected boolean	isAuthorRecipient
protected static Thread	lastThread
protected Alert.Level	level
protected String	name
protected String	propPrefix

Fields inherited from interface com.jalios.jcms.alert.AlertConstants

HTML_MARKUP, MSG_PREFIX_PROP, NAME_PREFIX_PROP, TEXT_MARKUP, WIKI_MARKUP

Fields inherited from interface com.jalios.jcms.JcmsConstants

ADATE_SEARCH, ADMIN_NOTES_PROP, ADVANCED_TAB, ARCHIVES_DIR, ASCII_WIDTH, CATEGORY_TAB, CDATE_SEARCH, COMMON_ALARM, CONTENT_TAB, COOKIE_MAX_AGE, CTRL_TOPIC_INTERNAL, CTRL_TOPIC_REF, CTRL_TOPIC_VALUE, CTRL_TOPIC_WRITE, CUSTOM_PROP, DOCCHOOSER_HEIGHT, DOCCHOOSER_WIDTH, DOCS_DIR, EDATE_SEARCH, EMAIL_REGEXP, ERROR_MSG, FORBIDDEN_FILE_ACCESS, FORBIDDEN_REDIRECT, FORCE_REDIRECT, ICON_ARCHIVE, ICON_LOCK, ICON_LOCK_STRONG, ICON_WARN, ICON_WH_BOOK_CLOSED, ICON_WH_BOOK_OPEN, INFORMATION_MSG, JALIOS_JUNIT_PROP, JCMS_CADDY, JCMS_MSG_LIST, JSYNC_DOWNLOAD_DIR, JSYNC_SYNC_ALARM, LOG_FILE, LOG_TOPIC_SECURITY, LOGGER_PROP, LOGGER_XMLPROP, MBR_PHOTO_DIR, MDATE_SEARCH, MONITOR_XML, OP_CREATE, OP_CREATE_STR, OP_DEEP_COPY, OP_DEEP_COPY_STR, OP_DEEP_DELETE, OP_DEEP_DELETE_STR, OP_DELETE, OP_DELETE_STR, OP_MERGE, OP_MERGE_STR, OP_UPDATE, OP_UPDATE_STR, PDATE_SEARCH, PHOTO_DIR, PHOTO_ICON, PHOTO_ICON_HEIGHT, PHOTO_ICON_WIDTH, PHOTO_LARGE, PHOTO_LARGE_HEIGHT, PHOTO_LARGE_WIDTH, PHOTO_NORMAL, PHOTO_NORMAL_HEIGHT, PHOTO_NORMAL_WIDTH, PHOTO_SMALL, PHOTO_SMALL_HEIGHT, PHOTO_SMALL_WIDTH, PHOTO_TINY, PHOTO_TINY_HEIGHT, PHOTO_TINY_WIDTH, PREVIOUS_TAB, PRINT_VIEW, PRIVATE_FILE_ACCESS, PUBLIC_FILE_ACCESS, READ_RIGHT_TAB, REVISION, SDATE_SEARCH, SEARCHENGINE_ALARM, SESSION_AUTHORIZED_FILENAMES_SET, STATS_REPORT_DIR, STATUS_PROP, STORE_XML, TEMPLATE_TAB, THUMBNAIL_LARGE_HEIGHT, THUMBNAIL_LARGE_WIDTH, THUMBNAIL_SMALL_HEIGHT, THUMBNAIL_SMALL_WIDTH, TYPES_ICON_ALT_PROP, TYPES_ICON_SUFFIX_PROP, TYPES_ICON_TITLE_PROP, TYPES_PREFIX_PROP, TYPES_THUMB_SUFFIX_PROP, UDATE_SEARCH, UPDATE_RIGHT_TAB, UPLOAD_DIR, URL_REGEXP, WARNING_MSG, WEBAPP_PROP, WFEXPRESS_ALARM, WFREMINDER_ALARM, WORKFLOW_TAB, WORKFLOW_XML

Fields inherited from interface com.jalios.util.JaliosConstants

CRLF, MILLIS_IN_ONE_DAY, MILLIS_IN_ONE_HOUR, MILLIS_IN_ONE_MINUTE, MILLIS_IN_ONE_MONTH, MILLIS_IN_ONE_SECOND, MILLIS_IN_ONE_WEEK, MILLIS_IN_ONE_YEAR

Constructor Summary

AlertBuilder(Alert.Level level, String domain, String name)

AlertBuilder(Alert.Level level, String domain, String name, Data data)

AlertBuilder(Alert.Level level, String domain, String name, Data data, Member author)

AlertBuilder(Alert.Level level, String domain, String name, Data data, Member author, boolean isAuthorRecipient)

Method Summary

protected void	addParams(Member recipient, Map<String,String> paramMap, String markup) This method is called to add parameters to the map used to format the properties.
boolean	canBeSaved()
Map<String,Object>	getContext()
protected String	getDataLink(Data data, Member recipient) Returns the HTML link for the given data (with an absolute URL).
protected String	getDataRepresentation(Data data, String markup, Member recipient) Returns a representation of the given data suitable for the given markup.
protected String	getDataText(Data data, Member recipient) Returns the textual representation for the given data.
String	getDescription(Member recipient)
protected String	getDescriptionPropName()
protected String	getHtmlAbstract(Member recipient) Returns an HTML representation of the abstract of the data (only if data instanceof Publication).
protected Map<String,String>	getHtmlPropParamMap(Member recipient)
String	getMessage(Member mbr)
String	getMessageMarkup()
String	getShortDescription(Member recipient)
protected String	getShortDescriptionPropName()
protected Map<String,String>	getTextPropParamMap(Member recipient)
String	getTitle(Member recipient)
protected String	getTitlePropName()
protected String	glp(Member recipient, String prop, Map<String,String> paramMap)
boolean	isRecipient(Member mbr)
void	sendAlert(Collection<Member> recipientCollection)
void	sendAlert(Member recipient) Sends the alert to the given recipient.
void	sendAlertInCurrentThread(Collection<Member> recipientCollection)
static void	waitForSending() A convenient method for unit test to wait for the ending of the sending thread.

Methods inherited from class java.lang.Object

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

Field Detail

level

protected Alert.Level level

domain

protected String domain

name

protected String name

author

protected Member author

data

protected Data data

isAuthorRecipient

protected boolean isAuthorRecipient

propPrefix

protected String propPrefix

lastThread

protected static Thread lastThread

Constructor Detail

AlertBuilder

public AlertBuilder(Alert.Level level,
                    String domain,
                    String name)

AlertBuilder

public AlertBuilder(Alert.Level level,
                    String domain,
                    String name,
                    Data data)

AlertBuilder

public AlertBuilder(Alert.Level level,
                    String domain,
                    String name,
                    Data data,
                    Member author)

AlertBuilder

public AlertBuilder(Alert.Level level,
                    String domain,
                    String name,
                    Data data,
                    Member author,
                    boolean isAuthorRecipient)

Parameters:

level - the alert's level

domain - the alert's domain

name - the alert's name

data - the alert's data

author - the alert's author

isAuthorRecipient - if false the alert won't be sent to the alert's author

Since:

jcms-8.0.0

Method Detail

isRecipient

public boolean isRecipient(Member mbr)

getTitle

public String getTitle(Member recipient)

getShortDescription

public String getShortDescription(Member recipient)

getDescription

public String getDescription(Member recipient)

getMessage

public String getMessage(Member mbr)

getMessageMarkup

public String getMessageMarkup()

canBeSaved

public boolean canBeSaved()

getContext

public Map<String,Object> getContext()

getTitlePropName

protected String getTitlePropName()

getShortDescriptionPropName

protected String getShortDescriptionPropName()

getDescriptionPropName

protected String getDescriptionPropName()

glp

protected String glp(Member recipient,
                     String prop,
                     Map<String,String> paramMap)

addParams

protected void addParams(Member recipient,
                         Map<String,String> paramMap,
                         String markup)

This method is called to add parameters to the map used to format the properties.

Parameters:

recipient - the recipient

paramMap - the paramMap

markup - the markup used (i.e. TEXT_MARKUP or HTML_MARKUP)

Since:

jcms-8.0.0

getDataRepresentation

protected String getDataRepresentation(Data data,
                                       String markup,
                                       Member recipient)

Returns a representation of the given data suitable for the given markup.

Parameters:

data - the data

markup - the markup

recipient - the recipient (for localisation)

Returns:

a representation of the given data suitable for the given markup.

Since:

jcms-8.0.0

getDataLink

protected String getDataLink(Data data,
                             Member recipient)

Returns the HTML link for the given data (with an absolute URL).

Parameters:

data - the data

recipient - the recipient (for localisation)

Returns:

the HTML link for the given data (with an absolute URL).

Since:

jcms-8.0.0

getDataText

protected String getDataText(Data data,
                             Member recipient)

Returns the textual representation for the given data.

Parameters:

data - the data

recipient - the recipient (for localisation)

Returns:

the textual representation for the given data.

Since:

jcms-8.0.0

getHtmlAbstract

protected String getHtmlAbstract(Member recipient)

Returns an HTML representation of the abstract of the data (only if data instanceof Publication).

Parameters:

recipient - the recipient (for localisation)

Returns:

an HTML representation of the abstract of the data (only if data instanceof Publication).

Since:

jcms-8.0.0

getTextPropParamMap

protected Map<String,String> getTextPropParamMap(Member recipient)

getHtmlPropParamMap

protected Map<String,String> getHtmlPropParamMap(Member recipient)

sendAlert

public void sendAlert(Collection<Member> recipientCollection)

sendAlertInCurrentThread

public void sendAlertInCurrentThread(Collection<Member> recipientCollection)

waitForSending

public static void waitForSending()

A convenient method for unit test to wait for the ending of the sending thread. This method is not thread safe (it only wait for the last sending thread).

Since:

jcms-8.0.0

sendAlert

public void sendAlert(Member recipient)

Sends the alert to the given recipient.

Parameters:

recipient - the recipient

Since:

jcms-8.0.0