Package com.jalios.jcms.alert

Class AlertBuilder

java.lang.Object

com.jalios.jcms.alert.AlertBuilder

All Implemented Interfaces:

AlertConstants, JcmsConstants, JaliosConstants

Direct Known Subclasses:

SecurityAlertBuilder

public class AlertBuilder
extends java.lang.Object
implements AlertConstants, JcmsConstants

Field Summary

Fields

Modifier and Type	Field	Description
protected Member	author
protected Data	data
protected java.lang.String	domain
protected java.util.Date	expiration
protected boolean	isAuthorRecipient
protected static java.lang.Thread	lastThread
protected Alert.Level	level
protected java.lang.String	name
protected java.lang.String	propPrefix

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

CTXT_DELETE_ALERT, HTML_MARKUP, MSG_PREFIX_PROP, NAME_PREFIX_PROP, NO_ALERT_FLAG, TEXT_MARKUP, WIKI_MARKUP

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

Fields inherited from interface com.jalios.jcms.JcmsConstants

ADATE_SEARCH, ADMIN_NOTES_PROP, ADVANCED_TAB, AJAX_MODE_ATTR, ARCHIVES_DIR, ASCII_WIDTH, CATEGORY_TAB, CDATE_SEARCH, CLASS_PROPERTY, COMMON_ALARM, CONTENT_TAB, COOKIE_MAX_AGE, COUNTRY_SPRITE, CS_TYPOLOGY_ROOT_CAT_VID, CTRL_TOPIC_INTERNAL, CTRL_TOPIC_REF, CTRL_TOPIC_VALUE, CTRL_TOPIC_WRITE, CUSTOM_PROP, DEFAULT_PHOTO_PROP, DOCCHOOSER_HEIGHT, DOCCHOOSER_WIDTH, DOCS_DIR, EDATE_SEARCH, EMAIL_REGEXP, ERROR_MSG, FORBIDDEN_FILE_ACCESS, FORBIDDEN_REDIRECT, FORCE_REDIRECT, GLYPH_ICON_PREFIX, ICON_ARCHIVE, ICON_ICON_PREFIX, ICON_LOCK, ICON_LOCK_STRONG, ICON_PREFIX_PROP, ICON_WARN, ICON_WH_BOOK_CLOSED, ICON_WH_BOOK_OPEN, INFORMATION_MSG, IS_IN_FRONT_OFFICE, JALIOS_JUNIT_PROP, JCMS_CADDY, JCMS_MSG_LIST, JCMS_TOASTR_COLLECTION, JSYNC_DOWNLOAD_DIR, JSYNC_SYNC_ALARM, LANG_SPRITE, 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, ORGANIZATION_ROOT_GROUP_PROP, PDATE_SEARCH, PHOTO_DIR, PHOTO_ICON, PHOTO_ICON_HEIGHT, PHOTO_ICON_PROP_PREFIX, PHOTO_ICON_WIDTH, PHOTO_LARGE, PHOTO_LARGE_HEIGHT, PHOTO_LARGE_PROP_PREFIX, PHOTO_LARGE_WIDTH, PHOTO_NORMAL, PHOTO_NORMAL_HEIGHT, PHOTO_NORMAL_PROP_PREFIX, PHOTO_NORMAL_WIDTH, PHOTO_SMALL, PHOTO_SMALL_HEIGHT, PHOTO_SMALL_PROP_PREFIX, PHOTO_SMALL_WIDTH, PHOTO_TINY, PHOTO_TINY_HEIGHT, PHOTO_TINY_PROP_PREFIX, PHOTO_TINY_WIDTH, PREVIOUS_TAB, PRINT_VIEW, PRIVATE_FILE_ACCESS, PUBLIC_FILE_ACCESS, RAW_CONTENT_ICON_PREFIX, READ_RIGHT_TAB, REVISION, SDATE_SEARCH, SEARCHENGINE_ALARM, SECURITY_LOG_FILE, SESSION_AUTHORIZED_FILENAMES_SET, SPRITE_ICON_PREFIX, STATS_REPORT_DIR, STATUS_PROP, STORE_XML, SUCCESS_MSG, SVG_ICON_PREFIX, SVGINLINE_ICON_PREFIX, TEMPLATE_TAB, THUMBNAIL_LARGE_HEIGHT, THUMBNAIL_LARGE_WIDTH, THUMBNAIL_SMALL_HEIGHT, THUMBNAIL_SMALL_WIDTH, TTCARD_MEDIA_HEIGHT, TTCARD_MEDIA_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, UPLOAD_PERMISSION_COUNT_PROP_PREFIX, UPLOAD_PERMISSION_SIZE_PROP_PREFIX, URL_REGEXP, VID_LOGGED_MEMBER, WARNING_MSG, WEBAPP_PROP, WFEXPRESS_ALARM, WFREMINDER_ALARM, WORKFLOW_TAB, WORKFLOW_XML

Constructor Summary

Constructors

Constructor	Description
AlertBuilder(Alert.Level level, java.lang.String domain, java.lang.String name)
AlertBuilder(Alert.Level level, java.lang.String domain, java.lang.String name, Data data)
AlertBuilder(Alert.Level level, java.lang.String domain, java.lang.String name, Data data, Member author)
AlertBuilder(Alert.Level level, java.lang.String domain, java.lang.String name, Data data, Member author, boolean isAuthorRecipient)
AlertBuilder(Alert.Level level, java.lang.String domain, java.lang.String name, Data data, Member author, boolean isAuthorRecipient, java.util.Date expiration)

Method Summary

Modifier and Type	Method	Description
protected void	addParams(Member recipient, java.util.Map<java.lang.String,java.lang.String> paramMap, java.lang.String markup)	This method is called to add parameters to the map used to format the properties.
boolean	canBeSaved()
protected Alert	doCreateAlert(Member recipient)
java.util.Map<java.lang.String,java.lang.Object>	getContext()
protected java.lang.String	getDataLink(Data data, Member recipient)	Returns the HTML link for the given data (with an absolute URL).
protected java.lang.String	getDataRepresentation(Data data, java.lang.String markup, Member recipient)	Returns a representation of the given data suitable for the given markup.
protected java.lang.String	getDataText(Data data, Member recipient)	Returns the textual representation for the given data.
java.lang.String	getDescription(Member recipient)
protected java.lang.String	getDescriptionPropName()
protected java.lang.String	getHtmlAbstract(Member recipient)	Returns an HTML representation of the abstract of the data (only if data instanceof Publication).
protected java.util.Map<java.lang.String,java.lang.String>	getHtmlPropParamMap(Member recipient)
java.lang.String	getMessage(Member mbr)
java.lang.String	getMessageMarkup()
java.lang.String	getShortDescription(Member recipient)
protected java.lang.String	getShortDescriptionPropName()
java.lang.String	getSummary(Member recipient)
protected java.lang.String	getSummaryPropName()
protected java.util.Map<java.lang.String,java.lang.String>	getTextPropParamMap(Member recipient)
java.lang.String	getTitle(Member recipient)
protected java.lang.String	getTitlePropName()
protected java.lang.String	glp(Member recipient, java.lang.String prop, java.util.Map<java.lang.String,java.lang.String> paramMap)
boolean	isRecipient(Member mbr)
void	sendAlert(Member recipient)	Sends the alert to the given recipient.
void	sendAlert(java.util.Collection<Member> recipientCollection)
void	sendAlertInCurrentThread(java.util.Collection<Member> recipientCollection)
AlertBuilder	sendToContact()	Force the Alert to be sent to recipient even if recipient Member is a contact.
AlertBuilder	sendToDisabledAccount()	Force the Alert to be sent to recipient even if recipient Member is disabled.
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 java.lang.String domain

name

protected java.lang.String name

author

protected Member author

data

protected Data data

isAuthorRecipient

protected boolean isAuthorRecipient

expiration

protected java.util.Date expiration

propPrefix

protected java.lang.String propPrefix

lastThread

protected static java.lang.Thread lastThread

Constructor Detail

AlertBuilder

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

AlertBuilder

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

AlertBuilder

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

AlertBuilder

public AlertBuilder(Alert.Level level,
                    java.lang.String domain,
                    java.lang.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

AlertBuilder

public AlertBuilder(Alert.Level level,
                    java.lang.String domain,
                    java.lang.String name,
                    Data data,
                    Member author,
                    boolean isAuthorRecipient,
                    java.util.Date expiration)

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

expiration - the alert's expiration date

Since:

jcms-9.0.0

Method Detail

isRecipient

public boolean isRecipient(Member mbr)

getTitle

public java.lang.String getTitle(Member recipient)

getShortDescription

public java.lang.String getShortDescription(Member recipient)

getDescription

public java.lang.String getDescription(Member recipient)

getSummary

public java.lang.String getSummary(Member recipient)

getMessage

public java.lang.String getMessage(Member mbr)

getMessageMarkup

public java.lang.String getMessageMarkup()

canBeSaved

public boolean canBeSaved()

getContext

public java.util.Map<java.lang.String,java.lang.Object> getContext()

getTitlePropName

protected java.lang.String getTitlePropName()

getShortDescriptionPropName

protected java.lang.String getShortDescriptionPropName()

getDescriptionPropName

protected java.lang.String getDescriptionPropName()

getSummaryPropName

protected java.lang.String getSummaryPropName()

glp

protected java.lang.String glp(Member recipient,
                               java.lang.String prop,
                               java.util.Map<java.lang.String,java.lang.String> paramMap)

addParams

protected void addParams(Member recipient,
                         java.util.Map<java.lang.String,java.lang.String> paramMap,
                         java.lang.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 java.lang.String getDataRepresentation(Data data,
                                                 java.lang.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 java.lang.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 java.lang.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 java.lang.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 java.util.Map<java.lang.String,java.lang.String> getTextPropParamMap(Member recipient)

getHtmlPropParamMap

protected java.util.Map<java.lang.String,java.lang.String> getHtmlPropParamMap(Member recipient)

sendAlert

public void sendAlert(java.util.Collection<Member> recipientCollection)

sendAlertInCurrentThread

public void sendAlertInCurrentThread(java.util.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

doCreateAlert

protected Alert doCreateAlert(Member recipient)

sendToDisabledAccount

public AlertBuilder sendToDisabledAccount()

Force the Alert to be sent to recipient even if recipient Member is disabled. Default behavior is to NOT send Alert to disabled account.

Returns:

this AlertBuilder, for method chaining

Since:

10.0.7 / JCMS-9426

sendToContact

public AlertBuilder sendToContact()

Force the Alert to be sent to recipient even if recipient Member is a contact.

Default behavior is to NOT send Alert to contact.

Returns:

this AlertBuilder, for method chaining

Since:

10.0.7 / JCMS-9426