com.openkm.module

Interface NotificationModule

All Known Implementing Classes:

DbNotificationModule, OKMNotification

public interface NotificationModule

Method Summary

Methods

Modifier and Type	Method and Description
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.

Method Detail

subscribe

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

Add user subscription to a node.

Parameters:

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

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

Remove an user subscription from a node.

Parameters:

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

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

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

Parameters:

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

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

Send a notification message to an user list.

Parameters:

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

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

Send a proposedSubscription comment to an user list.

Parameters:

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