Package com.jalios.jcms
Class NotificationManager
java.lang.Object
com.jalios.jcms.NotificationManager
- All Implemented Interfaces:
JcmsConstants,JaliosConstants
This class is instantiated by a
Channel in method initAfterLoad()
only if property 'notification.enabled' is set to true.
The NotificationManager handles 4 alarms, one per hour, one per
day, one per week, one per month. A single AlarmManager listens to these alarms and launches notifications
threads (@see NotificationThread) each time an alarm is fired.
CAUTION: NotificationThread checks the server is not 127.0.0.1 nor localhost, to avoid emails
being sent by mistake while staging.-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected AlarmManagerstatic final Stringprotected Channelstatic final intprotected AlarmEntrystatic final Stringprotected AlarmEntrystatic final intprotected AlarmEntrystatic final intprotected AlarmEntrystatic final intstatic final intstatic final intDeprecated.static final intstatic final intstatic final int[]protected static final Stringprotected static final Stringprotected static final Stringstatic final String[]static final int[]static final int[]static final Stringprotected intVariable used to reinitialize the NotificationManager in case a PastDateException is thrown in initialization stage.static final intstatic final intstatic final intprotected AlarmEntrystatic final intFields 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_YEARFields inherited from interface com.jalios.jcms.JcmsConstants
ADATE_SEARCH, 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, DATA_DIRECTORY, DEFAULT_PHOTO_PROP, DOCCHOOSER_HEIGHT, DOCCHOOSER_WIDTH, DOCS_DIR, EDATE_SEARCH, EMAIL_REGEXP, ERROR_MSG, FORBIDDEN_FILE_ACCESS, FORBIDDEN_REDIRECT, FORCE_REDIRECT, GENERATIONAL_STORE_DIRECTORY, 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_MINI, PHOTO_MINI_HEIGHT, PHOTO_MINI_PROP_PREFIX, PHOTO_MINI_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, PHOTO_XLARGE, PHOTO_XLARGE_HEIGHT, PHOTO_XLARGE_PROP_PREFIX, PHOTO_XLARGE_WIDTH, PREVIOUS_TAB, PRINT_VIEW, PRIVATE_FILE_ACCESS, PUBLIC_FILE_ACCESS, RAW_CONTENT_ICON_PREFIX, READ_RIGHT_TAB, 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, SVGSPRITE_ICON_PREFIX, TEMPLATE_TAB, THEME_DIR, 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, TYPES_UNKNOWN_CLASS_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 -
Method Summary
Modifier and TypeMethodDescriptionprotected static booleancanBeFollowed(Class<?> clazz) Return true if given class can be followed.
It can be followed: if it is a Content, or a UserContent.static int[]static int[]static ListgetFollowedTypeList(String userLang) Returns the list of types that can be selected forNotificationCriteriaprotected static Collection<Class<?>> Returns the list of types that cannot be selected forNotificationCriteriaprotected static Collection<Class<?>> Returns the whitelist of exact types that can be selected forNotificationCriteriastatic Set<NotificationCriteria> getGroupsCriteriaSet(Member member) protected static Collection<Class<? extends Publication>> Returns the list of default root types to use for QueryHandler when user did not select any type to follow.
By default:ContentandUserContentclasses.
Does NOT check white and blacklist.static StringgetMutationTypeLabel(int mutationType) static NotificationCriteria[]getNotificationCriteria(Member member) static StringgetNotificationOriginMap(Member member) Compute origin of eachNotificationCriteriaof given Member.static StringgetPeriodLabel(int period) Retrieve the property used to retrieve label of the specified period.static String[]voidinit()static booleanisDefault(Notification notification) Tell if the given notification is equivalent to no notification at all.static booleanisDefault(NotificationCriteria[] criterias, int selectionCriteriaMode) static booleanisSameCriteria(NotificationCriteria[] criterias1, NotificationCriteria[] criterias2) Compares two arrays of NotificationCriteriastatic booleanisSameCriteria(NotificationCriteria criteria1, NotificationCriteria criteria2) Compares two NotificationCriteriavoidprocessNotification(int period) Launches a thread that notifies all members who have requested to be alerted of specific changes at each period.
-
Field Details
-
NOTIFICATION_FOLLOWED_TYPES
- See Also:
-
NOTIFICATION_FOLLOWED_TYPES_OFF
- See Also:
-
NOTIFICATION_QUERY_MAX_RESULTS
- See Also:
-
alarmMgr
-
channel
-
USE_CRITERIA_GROUP_AND_MEMBER
public static final int USE_CRITERIA_GROUP_AND_MEMBER- See Also:
-
USE_CRITERIA_MEMBER_ONLY
public static final int USE_CRITERIA_MEMBER_ONLY- See Also:
-
USE_CRITERIA_GROUP_ONLY
public static final int USE_CRITERIA_GROUP_ONLY- See Also:
-
HOURLY
public static final int HOURLY- See Also:
-
DAILY
public static final int DAILY- See Also:
-
WEEKLY
public static final int WEEKLY- See Also:
-
MONTHLY
public static final int MONTHLY- See Also:
-
MINUTED
public static final int MINUTED- See Also:
-
PERIODS_1
public static final int[] PERIODS_1 -
PERIODS_2
public static final int[] PERIODS_2 -
MUTATION_CREATE
Deprecated.DeprecatedUse insteadMUTATION_PUBLISH- See Also:
-
MUTATION_PUBLISH
public static final int MUTATION_PUBLISH- See Also:
-
MUTATION_MAJOR
public static final int MUTATION_MAJOR- See Also:
-
MUTATION_ALL
public static final int MUTATION_ALL- See Also:
-
MUTATION_TYPES
public static final int[] MUTATION_TYPES -
PERIOD_LABELS
-
CHANGES
- See Also:
-
DELETIONS
- See Also:
-
PUBCOUNT
- See Also:
-
reinit
protected int reinitVariable used to reinitialize the NotificationManager in case a PastDateException is thrown in initialization stage. -
minuteAlarmEntry
-
hourAlarmEntry
-
dayAlarmEntry
-
weekAlarmEntry
-
monthAlarmEntry
-
-
Constructor Details
-
NotificationManager
public NotificationManager()
-
-
Method Details
-
init
public void init() -
processNotification
public void processNotification(int period) Launches a thread that notifies all members who have requested to be alerted of specific changes at each period.- Parameters:
period- The period type
-
getAvailablePeriods
public static int[] getAvailablePeriods() -
getAvailableMutationTypes
public static int[] getAvailableMutationTypes() -
getPeriodLabels
-
getPeriodLabel
Retrieve the property used to retrieve label of the specified period. -
getMutationTypeLabel
-
getNotificationCriteria
-
getGroupsCriteriaSet
-
isDefault
Tell if the given notification is equivalent to no notification at all.- Parameters:
notification- the notification- Returns:
- true is notification is equivalent to no notification at all.
- Since:
- JCMS-5.7.5
-
isDefault
-
isSameCriteria
public static boolean isSameCriteria(NotificationCriteria[] criterias1, NotificationCriteria[] criterias2) Compares two arrays of NotificationCriteria- Parameters:
criterias1- the first array of NotificationCriteriacriterias2- the second array of NotificationCriteria- Returns:
- true if they can be considered as equivalent
- Since:
- JCMS-5.7.5
-
isSameCriteria
public static boolean isSameCriteria(NotificationCriteria criteria1, NotificationCriteria criteria2) Compares two NotificationCriteria- Parameters:
criteria1- the first NotificationCriteriacriteria2- the second NotificationCriteria- Returns:
- true if they can be considered as equivalent
- Since:
- JCMS-5.7.5
-
getNotificationMailSubject
- Parameters:
mbr- the recipient Member- Returns:
- the subject for given Member
- Since:
- jcms-8.0.0
-
getFollowedTypeList
Returns the list of types that can be selected forNotificationCriteria- Parameters:
userLang- the userLang (to sort types)- Returns:
- the list of types that can be selected for
NotificationCriteria - Since:
- jcms-8.0.0
-
getFollowedTypesOn
Returns the whitelist of exact types that can be selected forNotificationCriteria- Returns:
- the whitelist of exact types that can be selected for
NotificationCriteria - Since:
- jcms-10.0.1
-
getFollowedTypesOff
Returns the list of types that cannot be selected forNotificationCriteria- Returns:
- the list of types that cannot be selected for
NotificationCriteria - Since:
- jcms-10.0.1
-
getInternalQueryHandlerDefaultFollowedTypes
protected static Collection<Class<? extends Publication>> getInternalQueryHandlerDefaultFollowedTypes()Returns the list of default root types to use for QueryHandler when user did not select any type to follow.
By default:ContentandUserContentclasses.
Does NOT check white and blacklist.Internal method to prevent a stackOverflow.
- Returns:
- the list of default types to use for QueryHandler when user did not select any type to follow.
- Since:
- jcms-10.0.1
-
canBeFollowed
Return true if given class can be followed.
It can be followed:- if it is a Content, or a UserContent.
-
And:
- if either followed whitelist is empty
- else, if given clazz is in white list, or if a super clazz of given clazz is in white list
- and given exact clazz is not blacklisted.
- Parameters:
clazz- the clazz to test- Returns:
- true if given clazz matches followable types rules.
- Since:
- jcms-10.0.1
-
getNotificationOriginMap
Compute origin of eachNotificationCriteriaof given Member.NotificationCriteria's origin can be either the member itself, or a group the member belongs to.- Parameters:
member- the member to compute origin of its notification- Returns:
- a map with notificationCriteria's id as key, and member's id or group's id as value.
- Since:
- jcms-9.0.3
-