org.exoplatform.commons.api.notification.plugin

Class AbstractNotificationPlugin

java.lang.Object

org.exoplatform.container.component.BaseComponentPlugin

org.exoplatform.commons.api.notification.plugin.AbstractNotificationPlugin

All Implemented Interfaces:

org.exoplatform.container.component.ComponentPlugin

Direct Known Subclasses:

AbstractNotificationChildPlugin

public abstract class AbstractNotificationPlugin
extends org.exoplatform.container.component.BaseComponentPlugin

Field Summary

Fields inherited from class org.exoplatform.container.component.BaseComponentPlugin

desc, name

Constructor Summary

Constructors

Constructor and Description
AbstractNotificationPlugin(org.exoplatform.container.xml.InitParams initParams)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	buildDigest(NotificationContext ctx, Writer writer) Makes digest message
MessageInfo	buildMessage(NotificationContext ctx) Makes massage
NotificationInfo	buildNotification(NotificationContext ctx) Makes notification
void	end(NotificationContext ctx) End the plug in
abstract String	getId() Gets Notification Plug in key
NotificationKey	getKey() Creates the key for NotificationPlugin
protected String	getLanguage(NotificationInfo message)
protected org.exoplatform.services.organization.OrganizationService	getOrganizationService()
List<PluginConfig>	getPluginConfigs()
groovy.text.Template	getTemplateEngine() Get TemplateEngine of plugin
abstract boolean	isValid(NotificationContext ctx) Check, for each plugin, if we will send notification
protected abstract boolean	makeDigest(NotificationContext ctx, Writer writer) Makes the Digest message from given NotificationMessage what keep inside NotificationContext
protected abstract MessageInfo	makeMessage(NotificationContext ctx) Makes the MessageInfor from given NotificationMessage what keep inside NotificationContext
protected abstract NotificationInfo	makeNotification(NotificationContext ctx) Makes MessageInfo from given information what keep inside NotificationContext
void	setTemplateEngine(groovy.text.Template engine) Set TemplateEngine for plugin
void	start(NotificationContext ctx) Start the plug in

Methods inherited from class org.exoplatform.container.component.BaseComponentPlugin

getDescription, getName, setDescription, setName

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractNotificationPlugin

public AbstractNotificationPlugin(org.exoplatform.container.xml.InitParams initParams)

Method Detail

getPluginConfigs

public List<PluginConfig> getPluginConfigs()

start

public void start(NotificationContext ctx)

Start the plug in

Parameters:

context -

end

public void end(NotificationContext ctx)

End the plug in

Parameters:

context -

getId

public abstract String getId()

Gets Notification Plug in key

Returns:

isValid

public abstract boolean isValid(NotificationContext ctx)

Check, for each plugin, if we will send notification

Returns:

makeNotification

protected abstract NotificationInfo makeNotification(NotificationContext ctx)

Makes MessageInfo from given information what keep inside NotificationContext

Parameters:

context -

Returns:

makeMessage

protected abstract MessageInfo makeMessage(NotificationContext ctx)

Makes the MessageInfor from given NotificationMessage what keep inside NotificationContext

Parameters:

context -

Returns:

makeDigest

protected abstract boolean makeDigest(NotificationContext ctx,
                 Writer writer)

Makes the Digest message from given NotificationMessage what keep inside NotificationContext

Parameters:

ctx -

wtiter -

Returns:

buildNotification

public NotificationInfo buildNotification(NotificationContext ctx)

Makes notification

Parameters:

ctx -

Returns:

buildMessage

public MessageInfo buildMessage(NotificationContext ctx)

Makes massage

Parameters:

ctx -

Returns:

buildDigest

public boolean buildDigest(NotificationContext ctx,
                  Writer writer)

Makes digest message

Parameters:

ctx -

writer -

Returns:

getKey

public NotificationKey getKey()

Creates the key for NotificationPlugin

Returns:

getLanguage

protected String getLanguage(NotificationInfo message)

Parameters:

message -

Returns:

getOrganizationService

protected org.exoplatform.services.organization.OrganizationService getOrganizationService()

getTemplateEngine

public groovy.text.Template getTemplateEngine()

Get TemplateEngine of plugin

Returns:

the TemplateEngine

setTemplateEngine

public void setTemplateEngine(groovy.text.Template engine)

Set TemplateEngine for plugin

Parameters:

engine - the TemplateEngine to set