org.exoplatform.services.cms.watch.impl

Class WatchDocumentServiceImpl

java.lang.Object

org.exoplatform.services.cms.watch.impl.WatchDocumentServiceImpl

All Implemented Interfaces:

WatchDocumentService, org.picocontainer.Startable

public class WatchDocumentServiceImpl
extends Object
implements WatchDocumentService, org.picocontainer.Startable

Field Summary

Fields

Modifier and Type	Field and Description
static String	EMAIL_WATCHERS_PROP
static String	EXO_WATCHABLE_MIXIN
static String	RSS_WATCHERS_PROP

Fields inherited from interface org.exoplatform.services.cms.watch.WatchDocumentService

FULL_NOTIFICATION, NOTIFICATION_BY_EMAIL, NOTIFICATION_BY_RSS

Constructor Summary

Constructors

Constructor and Description
WatchDocumentServiceImpl(org.exoplatform.container.xml.InitParams params, org.exoplatform.services.jcr.RepositoryService repoService, TemplateService templateService) Constructor Method

Method Summary

Modifier and Type	Method and Description
protected MessageConfig	getMessageConfig() This method will get message configuration when a node is observing and there is some changes with it's properties.
int	getNotificationType(javax.jcr.Node documentNode, String userName) This method will gets the type of notification for the specify document
void	initializeMessageConfig(MessageConfigPlugin msgConfigPlugin) Initialize the notification email contents of watching document when the notification type is by email.
void	start() using for re-observer
void	stop()
void	unwatchDocument(javax.jcr.Node documentNode, String userName, int notificationType) UnWatching the document that is specified by the node by giving a userName, notifyType
void	watchDocument(javax.jcr.Node documentNode, String userName, int notifyType) Watching the document that is specified by the node by giving a userName, notifyType

Methods inherited from class java.lang.Object

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

Field Detail

EXO_WATCHABLE_MIXIN

public static final String EXO_WATCHABLE_MIXIN

See Also:

Constant Field Values

EMAIL_WATCHERS_PROP

public static final String EMAIL_WATCHERS_PROP

See Also:

Constant Field Values

RSS_WATCHERS_PROP

public static final String RSS_WATCHERS_PROP

See Also:

Constant Field Values

Constructor Detail

WatchDocumentServiceImpl

public WatchDocumentServiceImpl(org.exoplatform.container.xml.InitParams params,
                                org.exoplatform.services.jcr.RepositoryService repoService,
                                TemplateService templateService)

Constructor Method

Parameters:

params -

repoService -

templateService -

Method Detail

initializeMessageConfig

public void initializeMessageConfig(MessageConfigPlugin msgConfigPlugin)

Initialize the notification email contents of watching document when the notification type is by email.

Specified by:

initializeMessageConfig in interface WatchDocumentService

Parameters:

msgConfigPlugin - The message configuration plug-in

getNotificationType

public int getNotificationType(javax.jcr.Node documentNode,
                               String userName)
                        throws Exception

This method will gets the type of notification for the specify document

If that document is not a exo:watchable document, the value return is -1 If notification is notified by email, the value return is 1 If notification is notified by rss, the value return is 2 If notification is notified by rss and email, the value return is 0

Specified by:

getNotificationType in interface WatchDocumentService

Parameters:

documentNode - Specify the document for watching

userName - The username of current user is votting. It can't be null

Returns:

0, 1, 2 or -1

Throws:

Exception

See Also:

Node

watchDocument

public void watchDocument(javax.jcr.Node documentNode,
                          String userName,
                          int notifyType)
                   throws Exception

Watching the document that is specified by the node by giving a userName, notifyType

If the document is watching, all thing that changes to it's property will be notified to user specified by the userName

Specified by:

watchDocument in interface WatchDocumentService

Parameters:

documentNode - Specify the document for watching

userName - he username of current user is votting. It can't be null

notifyType - Type of notification. Its can be 0, 1 or 2 0 : Notification by email 1 : Notification by rss 2 : Full notification

Throws:

Exception

See Also:

Node

unwatchDocument

public void unwatchDocument(javax.jcr.Node documentNode,
                            String userName,
                            int notificationType)
                     throws Exception

UnWatching the document that is specified by the node by giving a userName, notifyType

If the document is unwatching, all thing that changes to it's property will not be notified to user specified by the userName

Specified by:

unwatchDocument in interface WatchDocumentService

Parameters:

documentNode - Specify the document for watching

userName - The username of current user is votting. It can't be null

notificationType - Type of notification. Its can be 0, 1 or 2 0 : Notification by email 1 : Notification by rss 2 : Full notification

Throws:

Exception

See Also:

Node

getMessageConfig

protected MessageConfig getMessageConfig()

This method will get message configuration when a node is observing and there is some changes with it's properties.

Returns:

MessageCongig

start

public void start()

using for re-observer

Specified by:

start in interface org.picocontainer.Startable

stop

public void stop()

Specified by:

stop in interface org.picocontainer.Startable