com.communote.server.core.messaging

Interface NotificationManagement

All Known Implementing Classes:

NotificationManagementBase, NotificationManagementImpl

public interface NotificationManagement

NotificationManagement

Author:

Communote GmbH - http://www.communote.com/

Method Summary

Modifier and Type	Method and Description
void	disableUser(long userId, String connectorId) This method is called when a user disables a connector.
void	enableUser(long userId, String connectorId) This method is called if a user enables a connector.
String	getClientId(String client, String connectorId)
String	getUserAlias(String username, String connectorId)
String	getXMPPId()
void	registerMessagerConnector(MessagerConnector connector)
void	removeMessagerConnector(String connectorId)
void	sendMessage(Long noteId, Long userToNotify, NotificationDefinition notificationDefinition, Map<String,Object> model) Send notifications to users to inform about created or edited notes.
void	sendMessage(Note note, Collection<User> usersToNotify, NotificationDefinition notificationDefinition) Send notifications to users to inform about created or edited notes.
void	start() Use this method to initialise the management.
void	stop() Use this method to stop the management.

Method Detail

disableUser

void disableUser(long userId,
                 String connectorId)

This method is called when a user disables a connector.

Parameters:

userId - The users id.

connectorId - The connectors id.

enableUser

void enableUser(long userId,
                String connectorId)

This method is called if a user enables a connector.

Parameters:

userId - The users id.

connectorId - The connectors id.

getClientId

String getClientId(String client,
                   String connectorId)

Parameters:

client - The client.

connectorId - The connectors id.

Returns:

the client id dependent to the connector type.

getUserAlias

String getUserAlias(String username,
                    String connectorId)

Parameters:

username - Name of the user.

connectorId - Id of the connector.

Returns:

the user alias from the specific messager connector format.

getXMPPId

String getXMPPId()

Returns:

the jabber id the user has to use to connect to, e.g. tlu.comunardo@jabber.communote.com

registerMessagerConnector

void registerMessagerConnector(MessagerConnector connector)

Parameters:

connector - Connector to register.

removeMessagerConnector

void removeMessagerConnector(String connectorId)

Parameters:

connectorId - Id of the connector to unregister.

sendMessage

void sendMessage(Long noteId,
                 Long userToNotify,
                 NotificationDefinition notificationDefinition,
                 Map<String,Object> model)

Send notifications to users to inform about created or edited notes.

Parameters:

noteId - Id of the note, which should be send. the note to inform about

userToNotify - Id of the user to notify.

notificationDefinition - The current definition of the notification.

model - Additional elements used for the velocity context.

sendMessage

void sendMessage(Note note,
                 Collection<User> usersToNotify,
                 NotificationDefinition notificationDefinition)

Send notifications to users to inform about created or edited notes.

Parameters:

note - the note to inform about

usersToNotify - the users to be notified

notificationDefinition - The current definition of the notification.

start

void start()

Use this method to initialise the management.

stop

void stop()

Use this method to stop the management.