com.liferay.portal.kernel.util

Class SubscriptionSender

java.lang.Object

com.liferay.portal.kernel.util.SubscriptionSender

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

GroupSubscriptionCheckSubscriptionSender

public class SubscriptionSender
extends java.lang.Object
implements java.io.Serializable

Author:

Brian Wing Shun Chan, Mate Thurzo, Raymond Augé, Sergio González, Roberto Díaz

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	SubscriptionSender.Hook<T>

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	body
protected boolean	bulk
protected long	companyId
protected long	creatorUserId
protected long	currentUserId
protected java.util.List<FileAttachment>	fileAttachments
protected java.lang.String	fromAddress
protected java.lang.String	fromName
protected long	groupId
protected boolean	htmlFormat
protected java.lang.String	inReplyTo
protected java.util.Map<java.util.Locale,java.lang.String>	localizedBodyMap
protected java.util.Map<java.util.Locale,java.lang.String>	localizedPortletTitleMap
protected java.util.Map<java.util.Locale,java.lang.String>	localizedSubjectMap
protected java.lang.String	mailId
protected java.lang.String	portletId
protected java.lang.String	replyToAddress
protected long	scopeGroupId
protected ServiceContext	serviceContext
protected SMTPAccount	smtpAccount
protected java.lang.String	subject
protected boolean	uniqueMailId

Constructor Summary

Constructors

Constructor and Description
SubscriptionSender()

Method Summary

Modifier and Type	Method and Description
void	addFileAttachment(java.io.File file)
void	addFileAttachment(java.io.File file, java.lang.String fileName)
<T> void	addHook(SubscriptionSender.Hook.Event<T> event, SubscriptionSender.Hook<T> hook)
void	addPersistedSubscribers(java.lang.String className, long classPK)
void	addRuntimeSubscribers(java.lang.String toAddress, java.lang.String toName)
protected void	deleteSubscription(Subscription subscription)
void	flushNotifications()
void	flushNotificationsAsync()
long	getCompanyId()
java.lang.Object	getContextAttribute(java.lang.String key)
long	getCurrentUserId()
java.lang.String	getMailId()
ServiceContext	getServiceContext()
long	getUserId() Deprecated. As of 7.0.0, replaced by getCurrentUserId()
protected boolean	hasPermission(Subscription subscription, java.lang.String className, long classPK, User user)
protected boolean	hasPermission(Subscription subscription, User user)
protected java.lang.Boolean	hasSubscribePermission(PermissionChecker permissionChecker, Subscription subscription)
void	initialize()
boolean	isBulk()
protected void	notifyPersistedSubscriber(Subscription subscription)
protected void	notifyPersistedSubscriber(Subscription subscription, java.lang.String className, long classPK)
protected void	notifyRuntimeSubscriber(javax.mail.internet.InternetAddress to, java.util.Locale locale)
protected void	notifySubscriber(Subscription subscription, java.lang.String inferredClassName, long inferredClassPK) Deprecated. As of 7.0.0, replaced by notifyPersistedSubscriber(Subscription)
protected void	populateNotificationEventJSONObject(JSONObject notificationEventJSONObject)
protected void	processMailMessage(MailMessage mailMessage, java.util.Locale locale)
protected java.lang.String	replaceContent(java.lang.String content, java.util.Locale locale) Deprecated. As of 7.0.0, with no direct replacement
protected java.lang.String	replaceContent(java.lang.String content, java.util.Locale locale, boolean escape) Deprecated. As of 7.0.0, with no direct replacement
protected void	sendEmail(javax.mail.internet.InternetAddress to, java.util.Locale locale)
protected void	sendEmailNotification(User user)
protected void	sendNotification(User user)
protected void	sendUserNotification(User user)
void	setBody(java.lang.String body)
void	setBulk(boolean bulk)
void	setClassName(java.lang.String className)
void	setClassPK(long classPK)
void	setCompanyId(long companyId)
void	setContextAttribute(java.lang.String key, EscapableObject<java.lang.String> value)
void	setContextAttribute(java.lang.String key, java.lang.Object value)
void	setContextAttribute(java.lang.String key, java.lang.Object value, boolean escape)
void	setContextAttributes(java.lang.Object... values)
void	setContextCreatorUserPrefix(java.lang.String contextCreatorUserPrefix)
void	setCreatorUserId(long creatorUserId)
void	setCurrentUserId(long currentUserId)
void	setEntryTitle(java.lang.String entryTitle)
void	setEntryURL(java.lang.String entryURL)
void	setFrom(java.lang.String fromAddress, java.lang.String fromName)
void	setGroupId(long groupId)
void	setHtmlFormat(boolean htmlFormat)
void	setInReplyTo(java.lang.String inReplyTo)
void	setLocalizedBodyMap(java.util.Map<java.util.Locale,java.lang.String> localizedBodyMap)
void	setLocalizedContextAttribute(java.lang.String key, EscapableLocalizableFunction value)
<T extends java.io.Serializable & Function<java.util.Locale,java.lang.String>> void	setLocalizedContextAttribute(java.lang.String key, T function)
<T extends java.io.Serializable & Function<java.util.Locale,java.lang.String>> void	setLocalizedContextAttribute(java.lang.String key, T function, boolean escape)
void	setLocalizedContextAttributeWithFunction(java.lang.String key, Function<java.util.Locale,java.lang.String> function)
void	setLocalizedContextAttributeWithFunction(java.lang.String key, Function<java.util.Locale,java.lang.String> function, boolean escape)
void	setLocalizedPortletTitleMap(java.util.Map<java.util.Locale,java.lang.String> localizedPortletTitleMap)
void	setLocalizedSubjectMap(java.util.Map<java.util.Locale,java.lang.String> localizedSubjectMap)
void	setMailId(java.lang.String popPortletPrefix, java.lang.Object... ids)
void	setNotificationClassNameId(long notificationClassNameId)
void	setNotificationType(int notificationType)
void	setPortletId(java.lang.String portletId)
void	setReplyToAddress(java.lang.String replyToAddress)
void	setScopeGroupId(long scopeGroupId)
void	setServiceContext(ServiceContext serviceContext)
void	setSMTPAccount(SMTPAccount smtpAccount)
void	setSubject(java.lang.String subject)
void	setUniqueMailId(boolean uniqueMailId)
void	setUserId(long userId) Deprecated. As of 7.0.0, replaced by setCurrentUserId(long)

Methods inherited from class java.lang.Object

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

Field Detail

body

protected java.lang.String body

bulk

protected boolean bulk

companyId

protected long companyId

creatorUserId

protected long creatorUserId

currentUserId

protected long currentUserId

fileAttachments

protected java.util.List<FileAttachment> fileAttachments

fromAddress

protected java.lang.String fromAddress

fromName

protected java.lang.String fromName

groupId

protected long groupId

htmlFormat

protected boolean htmlFormat

inReplyTo

protected java.lang.String inReplyTo

localizedBodyMap

protected java.util.Map<java.util.Locale,java.lang.String> localizedBodyMap

localizedPortletTitleMap

protected java.util.Map<java.util.Locale,java.lang.String> localizedPortletTitleMap

localizedSubjectMap

protected java.util.Map<java.util.Locale,java.lang.String> localizedSubjectMap

mailId

protected java.lang.String mailId

portletId

protected java.lang.String portletId

replyToAddress

protected java.lang.String replyToAddress

scopeGroupId

protected long scopeGroupId

serviceContext

protected ServiceContext serviceContext

smtpAccount

protected SMTPAccount smtpAccount

subject

protected java.lang.String subject

uniqueMailId

protected boolean uniqueMailId

Constructor Detail

SubscriptionSender

public SubscriptionSender()

Method Detail

addFileAttachment

public void addFileAttachment(java.io.File file)

addFileAttachment

public void addFileAttachment(java.io.File file,
                              java.lang.String fileName)

addHook

public <T> void addHook(SubscriptionSender.Hook.Event<T> event,
                        SubscriptionSender.Hook<T> hook)

addPersistedSubscribers

public void addPersistedSubscribers(java.lang.String className,
                                    long classPK)

addRuntimeSubscribers

public void addRuntimeSubscribers(java.lang.String toAddress,
                                  java.lang.String toName)

flushNotifications

public void flushNotifications()
                        throws java.lang.Exception

Throws:

java.lang.Exception

flushNotificationsAsync

public void flushNotificationsAsync()

getCompanyId

public long getCompanyId()

getContextAttribute

public java.lang.Object getContextAttribute(java.lang.String key)

getCurrentUserId

public long getCurrentUserId()

getMailId

public java.lang.String getMailId()

getServiceContext

public ServiceContext getServiceContext()

getUserId

@Deprecated
public long getUserId()

Deprecated. As of 7.0.0, replaced by getCurrentUserId()

initialize

public void initialize()
                throws java.lang.Exception

Throws:

java.lang.Exception

isBulk

public boolean isBulk()

setBody

public void setBody(java.lang.String body)

setBulk

public void setBulk(boolean bulk)

setClassName

public void setClassName(java.lang.String className)

setClassPK

public void setClassPK(long classPK)

setCompanyId

public void setCompanyId(long companyId)

setContextAttribute

public void setContextAttribute(java.lang.String key,
                                EscapableObject<java.lang.String> value)

setContextAttribute

public void setContextAttribute(java.lang.String key,
                                java.lang.Object value)

setContextAttribute

public void setContextAttribute(java.lang.String key,
                                java.lang.Object value,
                                boolean escape)

setContextAttributes

public void setContextAttributes(java.lang.Object... values)

setContextCreatorUserPrefix

public void setContextCreatorUserPrefix(java.lang.String contextCreatorUserPrefix)

setCreatorUserId

public void setCreatorUserId(long creatorUserId)

setCurrentUserId

public void setCurrentUserId(long currentUserId)

setEntryTitle

public void setEntryTitle(java.lang.String entryTitle)

setEntryURL

public void setEntryURL(java.lang.String entryURL)

setFrom

public void setFrom(java.lang.String fromAddress,
                    java.lang.String fromName)

setGroupId

public void setGroupId(long groupId)

setHtmlFormat

public void setHtmlFormat(boolean htmlFormat)

setInReplyTo

public void setInReplyTo(java.lang.String inReplyTo)

setLocalizedBodyMap

public void setLocalizedBodyMap(java.util.Map<java.util.Locale,java.lang.String> localizedBodyMap)

setLocalizedContextAttribute

public void setLocalizedContextAttribute(java.lang.String key,
                                         EscapableLocalizableFunction value)

setLocalizedContextAttribute

public <T extends java.io.Serializable & Function<java.util.Locale,java.lang.String>> void setLocalizedContextAttribute(java.lang.String key,
                                                                                                                        T function)

setLocalizedContextAttribute

public <T extends java.io.Serializable & Function<java.util.Locale,java.lang.String>> void setLocalizedContextAttribute(java.lang.String key,
                                                                                                                        T function,
                                                                                                                        boolean escape)

setLocalizedContextAttributeWithFunction

public void setLocalizedContextAttributeWithFunction(java.lang.String key,
                                                     Function<java.util.Locale,java.lang.String> function)

setLocalizedContextAttributeWithFunction

public void setLocalizedContextAttributeWithFunction(java.lang.String key,
                                                     Function<java.util.Locale,java.lang.String> function,
                                                     boolean escape)

setLocalizedPortletTitleMap

public void setLocalizedPortletTitleMap(java.util.Map<java.util.Locale,java.lang.String> localizedPortletTitleMap)

setLocalizedSubjectMap

public void setLocalizedSubjectMap(java.util.Map<java.util.Locale,java.lang.String> localizedSubjectMap)

setMailId

public void setMailId(java.lang.String popPortletPrefix,
                      java.lang.Object... ids)

setNotificationClassNameId

public void setNotificationClassNameId(long notificationClassNameId)

setNotificationType

public void setNotificationType(int notificationType)

See Also:

UserNotificationDefinition

setPortletId

public void setPortletId(java.lang.String portletId)

setReplyToAddress

public void setReplyToAddress(java.lang.String replyToAddress)

setScopeGroupId

public void setScopeGroupId(long scopeGroupId)

See Also:

BaseIndexer.getSiteGroupId(long)

setServiceContext

public void setServiceContext(ServiceContext serviceContext)

setSMTPAccount

public void setSMTPAccount(SMTPAccount smtpAccount)

setSubject

public void setSubject(java.lang.String subject)

setUniqueMailId

public void setUniqueMailId(boolean uniqueMailId)

setUserId

@Deprecated
public void setUserId(long userId)

Deprecated. As of 7.0.0, replaced by setCurrentUserId(long)

deleteSubscription

protected void deleteSubscription(Subscription subscription)
                           throws java.lang.Exception

Throws:

java.lang.Exception

hasPermission

protected boolean hasPermission(Subscription subscription,
                                java.lang.String className,
                                long classPK,
                                User user)
                         throws java.lang.Exception

Throws:

java.lang.Exception

hasPermission

protected boolean hasPermission(Subscription subscription,
                                User user)
                         throws java.lang.Exception

Throws:

java.lang.Exception

hasSubscribePermission

protected java.lang.Boolean hasSubscribePermission(PermissionChecker permissionChecker,
                                                   Subscription subscription)
                                            throws PortalException

Throws:

PortalException

notifyPersistedSubscriber

protected void notifyPersistedSubscriber(Subscription subscription)
                                  throws java.lang.Exception

Throws:

java.lang.Exception

notifyPersistedSubscriber

protected void notifyPersistedSubscriber(Subscription subscription,
                                         java.lang.String className,
                                         long classPK)
                                  throws java.lang.Exception

Throws:

java.lang.Exception

notifyRuntimeSubscriber

protected void notifyRuntimeSubscriber(javax.mail.internet.InternetAddress to,
                                       java.util.Locale locale)
                                throws java.lang.Exception

Throws:

java.lang.Exception

notifySubscriber

@Deprecated
protected void notifySubscriber(Subscription subscription,
                                            java.lang.String inferredClassName,
                                            long inferredClassPK)
                                     throws java.lang.Exception

Deprecated. As of 7.0.0, replaced by notifyPersistedSubscriber(Subscription)

Throws:

java.lang.Exception

populateNotificationEventJSONObject

protected void populateNotificationEventJSONObject(JSONObject notificationEventJSONObject)

processMailMessage

protected void processMailMessage(MailMessage mailMessage,
                                  java.util.Locale locale)
                           throws java.lang.Exception

Throws:

java.lang.Exception

replaceContent

@Deprecated
protected java.lang.String replaceContent(java.lang.String content,
                                                      java.util.Locale locale)
                                               throws java.lang.Exception

Deprecated. As of 7.0.0, with no direct replacement

Throws:

java.lang.Exception

replaceContent

@Deprecated
protected java.lang.String replaceContent(java.lang.String content,
                                                      java.util.Locale locale,
                                                      boolean escape)
                                               throws java.lang.Exception

Deprecated. As of 7.0.0, with no direct replacement

Throws:

java.lang.Exception

sendEmail

protected void sendEmail(javax.mail.internet.InternetAddress to,
                         java.util.Locale locale)
                  throws java.lang.Exception

Throws:

java.lang.Exception

sendEmailNotification

protected void sendEmailNotification(User user)
                              throws java.lang.Exception

Throws:

java.lang.Exception

sendNotification

protected void sendNotification(User user)
                         throws java.lang.Exception

Throws:

java.lang.Exception

sendUserNotification

protected void sendUserNotification(User user)
                             throws java.lang.Exception

Throws:

java.lang.Exception