org.deepamehta.notifications

Class NotificationsPlugin

java.lang.Object

de.deepamehta.core.osgi.PluginActivator

org.deepamehta.notifications.NotificationsPlugin

All Implemented Interfaces:

de.deepamehta.core.osgi.PluginContext, de.deepamehta.core.service.EventListener, de.deepamehta.websockets.event.WebsocketTextMessageListener, NotificationsService, org.osgi.framework.BundleActivator

public class NotificationsPlugin
extends de.deepamehta.core.osgi.PluginActivator
implements NotificationsService, de.deepamehta.websockets.event.WebsocketTextMessageListener

A DeepaMehta 4 Plugin introducing notifications on subscribed topics based on dm4-websockets.

Version:

1.0

Author:

Malte Reißig

Field Summary

Fields inherited from class de.deepamehta.core.osgi.PluginActivator

bundle, dm4, mf

Fields inherited from interface org.deepamehta.notifications.NotificationsService

EMAIL_SUBSCRIPTION, IN_APP_SUBSCRIPTION, INVOLVED_ITEM_ID, NOTIFICATION, NOTIFICATION_BODY, NOTIFICATION_RECIPIENT_EDGE, NOTIFICATION_SEEN, NOTIFICATION_TITLE, SUBSCRIBED_ITEM_ID, SUBSCRIPTION_EDGE, SUBSCRIPTION_TYPE

Constructor Summary

Constructors

Constructor and Description
NotificationsPlugin()

Method Summary

Modifier and Type	Method and Description
List<de.deepamehta.core.RelatedTopic>	getNotifications() Gets all notifications for the logged-in user.
List<de.deepamehta.core.RelatedTopic>	getNotificationsForUser()
List<de.deepamehta.core.RelatedTopic>	getSubscriptions() Gets all subscribed topics for the logged-in user.
ArrayList<de.deepamehta.core.RelatedTopic>	getUnseenNotifications() Gets all unread notifications for the logged-in user.
ArrayList<de.deepamehta.core.RelatedTopic>	getUnseenNotificationsForUser()
void	notifySubscribers(String title, String message, long actingUsername, de.deepamehta.core.DeepaMehtaObject involvedItem) Creates new notifications for all users with a direct or indirect (tags) subscription to the given item.
javax.ws.rs.core.Response	setNotificationSeen(long newsId)
void	subscribeInApp(long accountId, long itemId) Create a subscription edge for useraccount to item.
javax.ws.rs.core.Response	subscribeUser(long itemId)
void	unsubscribe(long accountId, long itemId) Remove subscription (edge) for given user account and item.
javax.ws.rs.core.Response	unsubscribeUser(long itemId)
void	websocketTextMessage(String string, de.deepamehta.websockets.WebSocketConnection wsc)

Methods inherited from class de.deepamehta.core.osgi.PluginActivator

getBundleContext, getPluginName, getStaticResource, getUri, init, preInstall, publishFileSystem, serviceArrived, serviceGone, setCoreService, shutdown, start, stop, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

NotificationsPlugin

public NotificationsPlugin()

Method Detail

subscribeUser

public javax.ws.rs.core.Response subscribeUser(long itemId)

unsubscribeUser

public javax.ws.rs.core.Response unsubscribeUser(long itemId)

getSubscriptions

public List<de.deepamehta.core.RelatedTopic> getSubscriptions()

Description copied from interface: NotificationsService

Gets all subscribed topics for the logged-in user.

Specified by:

getSubscriptions in interface NotificationsService

getNotificationsForUser

public List<de.deepamehta.core.RelatedTopic> getNotificationsForUser()

getUnseenNotificationsForUser

public ArrayList<de.deepamehta.core.RelatedTopic> getUnseenNotificationsForUser()

setNotificationSeen

public javax.ws.rs.core.Response setNotificationSeen(long newsId)

subscribeInApp

public void subscribeInApp(long accountId,
                           long itemId)

Description copied from interface: NotificationsService

Create a subscription edge for useraccount to item.

Specified by:

subscribeInApp in interface NotificationsService

Parameters:

accountId - topic-id of user account

itemId - topic-id of user account

unsubscribe

public void unsubscribe(long accountId,
                        long itemId)

Description copied from interface: NotificationsService

Remove subscription (edge) for given user account and item.

Specified by:

unsubscribe in interface NotificationsService

Parameters:

accountId - topic-id of user account

itemId - topic-id of subscribed item

notifySubscribers

public void notifySubscribers(String title,
                              String message,
                              long actingUsername,
                              de.deepamehta.core.DeepaMehtaObject involvedItem)

Description copied from interface: NotificationsService

Creates new notifications for all users with a direct or indirect (tags) subscription to the given item. Notifications are created if the (given) item is either of TopicType "User Account" or of any other TopicType which has the TopicType=Tag as a child-type. In the latter case, all subscribers of the _Tag_ are notified.

Specified by:

notifySubscribers in interface NotificationsService

Parameters:

title - title of the notification

message - text part of the notification

actingUsername - topic-id of user account performing the action which leads to the notification of all others

involvedItem - item users can have subscribed (either "User Account" or any TopicType with "Tags" as child)

getNotifications

public List<de.deepamehta.core.RelatedTopic> getNotifications()

Description copied from interface: NotificationsService

Gets all notifications for the logged-in user.

Specified by:

getNotifications in interface NotificationsService

getUnseenNotifications

public ArrayList<de.deepamehta.core.RelatedTopic> getUnseenNotifications()

Description copied from interface: NotificationsService

Gets all unread notifications for the logged-in user.

Specified by:

getUnseenNotifications in interface NotificationsService

websocketTextMessage

public void websocketTextMessage(String string,
                                 de.deepamehta.websockets.WebSocketConnection wsc)

Specified by:

websocketTextMessage in interface de.deepamehta.websockets.event.WebsocketTextMessageListener