com.openkm.api

Class OKMNotification

java.lang.Object

com.openkm.api.OKMNotification

All Implemented Interfaces:

NotificationModule

public class OKMNotification
extends Object
implements NotificationModule

Author:

pavila

Method Summary

Methods

Modifier and Type	Method and Description
static OKMNotification	getInstance()
Set<String>	getSubscriptors(String token, String nodePath) Get user subscriptions from am item (document or folder).
void	notify(String token, String nodeId, List<String> users, List<String> mails, String message, boolean attachment) Send a notification message to an user list.
void	proposedSubscription(String token, String nodeId, List<String> users, String comment) Send a proposedSubscription comment to an user list.
void	subscribe(String token, String nodePath) Add user subscription to a node.
void	unsubscribe(String token, String nodePath) Remove an user subscription from a node.

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

public static OKMNotification getInstance()

subscribe

public void subscribe(String token,
             String nodePath)
               throws PathNotFoundException,
                      AccessDeniedException,
                      RepositoryException,
                      DatabaseException

Description copied from interface: NotificationModule

Add user subscription to a node.

Specified by:

subscribe in interface NotificationModule

nodePath - The complete path to the node.

Throws:

PathNotFoundException - If the node defined by nodePath do not exists.

AccessDeniedException - If the token authorization information is not valid.

RepositoryException - If there is any error accessing to the repository.

DatabaseException

unsubscribe

public void unsubscribe(String token,
               String nodePath)
                 throws PathNotFoundException,
                        AccessDeniedException,
                        RepositoryException,
                        DatabaseException

Description copied from interface: NotificationModule

Remove an user subscription from a node.

Specified by:

unsubscribe in interface NotificationModule

nodePath - The complete path to the node.

Throws:

PathNotFoundException - If the node defined by nodePath do not exists.

AccessDeniedException - If the token authorization information is not valid.

RepositoryException - If there is any error accessing to the repository.

DatabaseException

getSubscriptors

public Set<String> getSubscriptors(String token,
                          String nodePath)
                            throws PathNotFoundException,
                                   AccessDeniedException,
                                   RepositoryException,
                                   DatabaseException

Description copied from interface: NotificationModule

Get user subscriptions from am item (document or folder).

Specified by:

getSubscriptors in interface NotificationModule

nodePath - The complete path to the node.

Returns:

A Collection of subscribed users.

Throws:

PathNotFoundException - If the node defined by nodePath do not exists.

AccessDeniedException - If the token authorization information is not valid.

RepositoryException - If there is any error accessing to the repository.

DatabaseException

notify

public void notify(String token,
          String nodeId,
          List<String> users,
          List<String> mails,
          String message,
          boolean attachment)
            throws PathNotFoundException,
                   AccessDeniedException,
                   PrincipalAdapterException,
                   RepositoryException,
                   DatabaseException,
                   IOException

Description copied from interface: NotificationModule

Send a notification message to an user list.

Specified by:

notify in interface NotificationModule

nodeId - The complete path to the node or its UUID.

users - Array of users to notify.

mails - Array of external mails to notify.

message - An String with the notification message.

Throws:

PathNotFoundException - If the node defined by nodePath do not exists.

AccessDeniedException - If the token authorization information is not valid.

RepositoryException - If there is any error accessing to the repository.

PrincipalAdapterException

DatabaseException

IOException

proposedSubscription

public void proposedSubscription(String token,
                        String nodeId,
                        List<String> users,
                        String comment)
                          throws PathNotFoundException,
                                 AccessDeniedException,
                                 PrincipalAdapterException,
                                 RepositoryException,
                                 DatabaseException,
                                 IOException

Description copied from interface: NotificationModule

Send a proposedSubscription comment to an user list.

Specified by:

proposedSubscription in interface NotificationModule

nodeId - The complete path to the node or its UUID.

users - Array of users to proposedSubscription.

comment - An String with the notification message. *

Throws:

PathNotFoundException

AccessDeniedException

PrincipalAdapterException

RepositoryException

DatabaseException

IOException