org.ametys.plugins.pagesubscription.observer

Class AbstractPageSubscriptionObserver

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.plugins.pagesubscription.observer.AbstractPageSubscriptionObserver

All Implemented Interfaces:

Observer, LogEnabled, Serviceable

Direct Known Subclasses:

PageSubscriptionDeletePageObserver, PageSubscriptionExplorerObserver, PageSubscriptionValidateContentObserver

public abstract class AbstractPageSubscriptionObserver
extends AbstractLogEnabled
implements Observer, Serviceable

Abstract implementation of the observers of Page Subscription.

Field Summary

Fields

Modifier and Type	Field and Description
protected I18nUtils	_i18nUtils The i18n utils
protected AmetysObjectResolver	_resolver The Ametys object resolver
protected SiteConfigurationExtensionPoint	_siteConfigurationEP The site configuration
protected UserManager	_userManager The user manager
static String	SUBSCRIBERS_PROPERTY_NAME Constant for the attachment node name.

Fields inherited from interface org.ametys.core.observation.Observer

MAX_PRIORITY, MIN_PRIORITY

Constructor Summary

Constructors

Constructor and Description
AbstractPageSubscriptionObserver()

Method Summary

Modifier and Type	Method and Description
protected String	_getAbsolutePageUrl(Page page) Get the absolute URL of a page
protected abstract String	_getMailBody(Event event, Page page) Create the mail body depend on the event
protected abstract String	_getMailSubject(Event event, Page page) Create the mail subject depend on the event
protected abstract Collection<Page>	_getPages(Event event) Get the pages linked to the event
protected Set<String>	_getSubscribers(JCRAmetysObject page) Get the page's subscribers
int	getPriority(Event event) Retrieves the priority to observe this event. This can be used to process a supported event before others observers.
protected abstract String	getSiteParameterId() Id of the site parameter to enable/disable the notification
protected boolean	isNotificationEnabled(Page page) Determines if the notification is currently enabled
void	observe(Event event, Map<String,Object> transientVars) Observes an event.
void	service(ServiceManager smanager)

Methods inherited from class org.ametys.runtime.plugin.component.AbstractLogEnabled

getLogger, setLogger

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.ametys.core.observation.Observer

supports

Field Detail

SUBSCRIBERS_PROPERTY_NAME

public static final String SUBSCRIBERS_PROPERTY_NAME

Constant for the attachment node name.

See Also:

Constant Field Values

_userManager

protected UserManager _userManager

The user manager

_siteConfigurationEP

protected SiteConfigurationExtensionPoint _siteConfigurationEP

The site configuration

_resolver

protected AmetysObjectResolver _resolver

The Ametys object resolver

_i18nUtils

protected I18nUtils _i18nUtils

The i18n utils

Constructor Detail

AbstractPageSubscriptionObserver

public AbstractPageSubscriptionObserver()

Method Detail

service

public void service(ServiceManager smanager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

getPriority

public int getPriority(Event event)

Description copied from interface: Observer

Retrieves the priority to observe this event.
This can be used to process a supported event before others observers.

Specified by:

getPriority in interface Observer

Parameters:

event - the event.

Returns:

the priority where 0 the max priority and Integer.MAX_VALUE the min priority.

observe

public void observe(Event event,
                    Map<String,Object> transientVars)

Description copied from interface: Observer

Observes an event.

Specified by:

observe in interface Observer

Parameters:

event - the event.

transientVars - transientVars passed from one Observer to another when processing a single Event. This may allow optimizations between observers.

isNotificationEnabled

protected boolean isNotificationEnabled(Page page)

Determines if the notification is currently enabled

Parameters:

page - The page

Returns:

true if the notification is enabled

getSiteParameterId

protected abstract String getSiteParameterId()

Id of the site parameter to enable/disable the notification

Returns:

The id of site

_getSubscribers

protected Set<String> _getSubscribers(JCRAmetysObject page)

Get the page's subscribers

Parameters:

page - the page

Returns:

the registered emails

_getAbsolutePageUrl

protected String _getAbsolutePageUrl(Page page)

Get the absolute URL of a page

Parameters:

page - The page to retrieve the url

Returns:

The absolute url of the page

_getMailSubject

protected abstract String _getMailSubject(Event event,
                                          Page page)

Create the mail subject depend on the event

Parameters:

event - the event

page - the page

Returns:

the mail subject

_getMailBody

protected abstract String _getMailBody(Event event,
                                       Page page)

Create the mail body depend on the event

Parameters:

event - the event

page - the page

Returns:

the mail body

_getPages

protected abstract Collection<Page> _getPages(Event event)

Get the pages linked to the event

Parameters:

event - the event

Returns:

the pages linked to the event