Package org.exoplatform.commons.api.notification.plugin

Class BaseNotificationPlugin

java.lang.Object

org.exoplatform.container.component.BaseComponentPlugin

org.exoplatform.commons.api.notification.plugin.BaseNotificationPlugin

All Implemented Interfaces:

org.exoplatform.container.component.ComponentPlugin

Direct Known Subclasses:

AbstractNotificationChildPlugin, AbstractNotificationPlugin

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

Field Summary

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

desc, name

Constructor Summary

Constructors

Constructor	Description
BaseNotificationPlugin(org.exoplatform.container.xml.InitParams initParams)

Method Summary

Modifier and Type	Method	Description
NotificationInfo	buildNotification(NotificationContext ctx)	Makes notification
void	end(NotificationContext ctx)	End the plug in
abstract String	getId()	Gets Notification Plug in key
PluginKey	getKey()	Creates the key for NotificationPlugin
protected org.exoplatform.services.organization.OrganizationService	getOrganizationService()
List<PluginConfig>	getPluginConfigs()
boolean	isOldPlugin()	Determines the plugin is old or new mechanism The target adapts the old plugin from PLF 4.1 to work well new mechanism
abstract boolean	isValid(NotificationContext ctx)	Check, for each plugin, if we will send notification
protected abstract NotificationInfo	makeNotification(NotificationContext ctx)	Makes MessageInfo from given information what keep inside NotificationContext
void	setOldPlugin(boolean isOldPlugin)	Sets the flag value TRUE/FALSE The target adapts the old plugin on PLF 4.1 to work well new mechanism
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

BaseNotificationPlugin

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

Method Detail

getPluginConfigs

public List<PluginConfig> getPluginConfigs()

start

public void start(NotificationContext ctx)

Start the plug in

Parameters:

ctx -

end

public void end(NotificationContext ctx)

End the plug in

Parameters:

ctx -

isOldPlugin

public boolean isOldPlugin()

Determines the plugin is old or new mechanism The target adapts the old plugin from PLF 4.1 to work well new mechanism

Returns:

setOldPlugin

public void setOldPlugin(boolean isOldPlugin)

Sets the flag value TRUE/FALSE The target adapts the old plugin on PLF 4.1 to work well new mechanism

Parameters:

isOldPlugin -

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:

ctx -

Returns:

buildNotification

public NotificationInfo buildNotification(NotificationContext ctx)

Makes notification

Parameters:

ctx -

Returns:

getKey

public PluginKey getKey()

Creates the key for NotificationPlugin

Returns:

getOrganizationService

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