...
JMS uses "topics" as a distribution mechanism for publishing messages to multiple subscribers. MDM creates topics based on MDM zones and an event type. Each notification generated by MDM will be of a given topic (zone) and event type. The
The published list of notification event types and their payloads can be found on the MDM Service Event Notifications (this page should be updated as developers add new notification event types).
...
The scope of delivery for a given event type can be limited to the following:
Targeted Subscribers | Description |
---|---|
SELF | Subscribers that belong to the zone that generated the event. |
CHILDREN | Subscribers that belong to the zone that generated the event and children of that zone. |
ALL | All zones |
Notification Flow
This notification flow describes the interaction between the core YOUnite MDM service, the JMS service and client that subscribe to YOUnite MDM events (e.g. the YOUnite UI). This notification flow is separate from the YOUnite MDM Router/Adaptor flow that will be published in a separate document.
...
Notification
...
Payloads
This document describes the current MDM service event notification types and their payloads.<MAYANK>
Adding Notification Types to MDM
<MAYANK>
More notification types will need to be added as features are added to MDM. The process is broken down into the following steps:
- Add the new notification topic name to the
topic
enum in: open-mdm/src/main/resources/raml/schemas/topicPref.json. This is a RAML file so the source needs to be built for the change to take effect. - Typically the topic is generated at the resource layer (e.g.
impl.resource/DomainsResource.java
) after the service layer has successfully completed the event.- <MAYANK - Why is createEvent() commented>
The scope of delivery for an event type can be targeted for a set of subscribers. These are defined in
api/generated/model/NotificationPreferences.java
Targeted Subscribers Description SELF Subscribers that belong to the zone that generated the event.CHILDREN Subscribers that belong to the zone that generated the event and children of that zone.
ALL All zones
Subscribing to Topics
Clients such as the YOUnite UI require real time updates of MDM events. <Waiting on snippet>Background on how to develop applications that subscribe to events can be found on the MDM Service Event Notifications page.