org.kaaproject.kaa.client.notification

Class DefaultNotificationManager

java.lang.Object

org.kaaproject.kaa.client.notification.DefaultNotificationManager

All Implemented Interfaces:

NotificationManager, NotificationProcessor

public class DefaultNotificationManager
extends Object
implements NotificationManager, NotificationProcessor

Default NotificationManager implementation.

Author:

Yaroslav Zeygerman

Constructor Summary

Constructors

Constructor and Description
DefaultNotificationManager(KaaClientState state, NotificationTransport transport)

Method Summary

Methods

Modifier and Type	Method and Description
void	addMandatoryTopicsListener(NotificationListener listener) Deprecated.
void	addNotificationListener(NotificationListener listener) Add listener to receive all notifications (both for mandatory and optional topics).
void	addNotificationListener(String topicId, NotificationListener listener) Add listener to receive notifications relating to the specified topic.
void	addTopicListListener(NotificationTopicListListener listener) Add listener for topics' list updates.
List<org.kaaproject.kaa.common.endpoint.gen.Topic>	getTopics() Retrieve a list of available topics.
void	notificationReceived(List<org.kaaproject.kaa.common.endpoint.gen.Notification> notifications) Called when new notifications arrived.
void	removeMandatoryTopicsListener(NotificationListener listener) Deprecated.
void	removeNotificationListener(NotificationListener listener) Remove listener receiving all notifications (both for mandatory and optional topics).
void	removeNotificationListener(String topicId, NotificationListener listener) Remove listener receiving notifications for the specified topic.
void	removeTopicListListener(NotificationTopicListListener listener) Remove listener of topics' list updates.
void	subscribeToTopic(String topicId, boolean forceSync) Subscribe to notifications relating to the specified optional topic.
void	subscribeToTopics(List<String> topicIds, boolean forceSync) Subscribe to notifications relating to the specified list of optional topics.
void	sync() Accept optional subscription changes.
void	topicsListUpdated(List<org.kaaproject.kaa.common.endpoint.gen.Topic> list) Called on topics' list update.
void	unsubscribeFromTopic(String topicId, boolean forceSync) Unsubscribe from notifications relating to the specified optional topic.
void	unsubscribeFromTopics(List<String> topicIds, boolean forceSync) Unsubscribe from notifications relating to the specified list of optional topics.
void	updateTopicSubscriptions(Map<String,List<NotificationListenerInfo>> subscribers) Deprecated.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultNotificationManager

public DefaultNotificationManager(KaaClientState state,
                          NotificationTransport transport)

Method Detail

addNotificationListener

public void addNotificationListener(NotificationListener listener)

Description copied from interface: NotificationManager

Add listener to receive all notifications (both for mandatory and optional topics).

Specified by:

addNotificationListener in interface NotificationManager

Parameters:

listener - Listener to receive notifications

See Also:

AbstractNotificationListener

removeNotificationListener

public void removeNotificationListener(NotificationListener listener)

Description copied from interface: NotificationManager

Remove listener receiving all notifications (both for mandatory and optional topics).

Specified by:

removeNotificationListener in interface NotificationManager

Parameters:

listener - Listener to receive notifications

See Also:

AbstractNotificationListener

updateTopicSubscriptions

@Deprecated
public void updateTopicSubscriptions(Map<String,List<NotificationListenerInfo>> subscribers)
                              throws UnavailableTopicException

Deprecated.

Description copied from interface: NotificationManager

Update (subscribe/unsubscribe) info about topic's subscriptions.

Basic usage is to subscribe for optional topic updates and unsubscribe from them. More than one listener may be used for the same topic.

Also it may be used to add/remove specific listener(s) for some mandatory topic.

 // Assume, BasicNotification is a notification class auto-generated according to predefined Avro schema
 public class UserNotificationListener extends AbstractNotificationListener<BasicNotification> {
     public UserNotificationListener() {}
     protected Class<BasicNotification> getNotificationClass() {
         return BasicNotification.class;
     }
     public void onNotification(String topicId, BasicNotification notification) {
         System.out.println("Got notification: " + notification.toString());
     }
 }

 // Assume, there are one mandatory topic with id "mand_id" and
 // one optional with id "vol_id".
 Map<String, List<NotificationListenerInfo>> subscriptions = new HashMap<>();

 // Add specific listener for "mand_id" topic
 UserNotificationListener mandatoryListener = new UserNotificationListener();
 subscriptions.put("mand_id", Arrays.asList(
      new NotificationListenerInfo(mandatoryListener, NotificationListenerInfo.Action.ADD)));

 // Subscribe for optional topic updates
 UserNotificationListener optionalListener = new UserNotificationListener();
 subscriptions.put("vol_id", Arrays.asList(
      new NotificationListenerInfo(optionalListener, NotificationListenerInfo.Action.ADD)));

 kaaClient.getNotificationManager().updateTopicSubscriptions(subscriptions);
 
 

Specified by:

updateTopicSubscriptions in interface NotificationManager

Parameters:

subscribers - collections of pairs topic id/subscriber info.

Throws:

UnavailableTopicException - Throw if unknown topic id is provided.

See Also:

NotificationManager.subscribeToTopic(String, boolean), NotificationManager.subscribeToTopics(List, boolean), NotificationManager.addNotificationListener(NotificationListener), NotificationManager.addNotificationListener(String, NotificationListener)

addMandatoryTopicsListener

@Deprecated
public void addMandatoryTopicsListener(NotificationListener listener)

Deprecated.

Description copied from interface: NotificationManager

Add listener for all mandatory topics' updates.

Use NotificationManager.addNotificationListener(NotificationListener) instead.

If specific listener is needed for some mandatory topic, use NotificationManager.addNotificationListener(String, NotificationListener).

Specified by:

addMandatoryTopicsListener in interface NotificationManager

Parameters:

listener - the listener to receive notification.

See Also:

AbstractNotificationListener

removeMandatoryTopicsListener

@Deprecated
public void removeMandatoryTopicsListener(NotificationListener listener)

Deprecated.

Description copied from interface: NotificationManager

Remove listener for mandatory topics' updates.

Use NotificationManager.removeNotificationListener(NotificationListener) instead.

Specified by:

removeMandatoryTopicsListener in interface NotificationManager

Parameters:

listener - the listener which is no longer needs updates.

See Also:

AbstractNotificationListener, NotificationManager.removeNotificationListener(NotificationListener)

addTopicListListener

public void addTopicListListener(NotificationTopicListListener listener)

Description copied from interface: NotificationManager

Add listener for topics' list updates.

Specified by:

addTopicListListener in interface NotificationManager

Parameters:

listener - the listener to receive updates.

See Also:

NotificationTopicListListener

removeTopicListListener

public void removeTopicListListener(NotificationTopicListListener listener)

Description copied from interface: NotificationManager

Remove listener of topics' list updates.

Specified by:

removeTopicListListener in interface NotificationManager

Parameters:

listener - listener the listener which is no longer needs updates.

See Also:

NotificationTopicListListener

getTopics

public List<org.kaaproject.kaa.common.endpoint.gen.Topic> getTopics()

Description copied from interface: NotificationManager

Retrieve a list of available topics.

Specified by:

getTopics in interface NotificationManager

Returns:

List of available topics

subscribeToTopic

public void subscribeToTopic(String topicId,
                    boolean forceSync)
                      throws UnavailableTopicException

Description copied from interface: NotificationManager

Subscribe to notifications relating to the specified optional topic.

Specified by:

subscribeToTopic in interface NotificationManager

Parameters:

topicId - Id of a optional topic.

forceSync - Define whether current subscription update should be accepted immediately (see NotificationManager.sync()).

Throws:

UnavailableTopicException - Throw if unknown topic id is provided or topic isn't optional.

See Also:

NotificationManager.sync()

subscribeToTopics

public void subscribeToTopics(List<String> topicIds,
                     boolean forceSync)
                       throws UnavailableTopicException

Description copied from interface: NotificationManager

Subscribe to notifications relating to the specified list of optional topics.

Specified by:

subscribeToTopics in interface NotificationManager

Parameters:

topicIds - List of optional topic id.

forceSync - Define whether current subscription update should be accepted immediately (see NotificationManager.sync()).

Throws:

UnavailableTopicException - Throw if unknown topic id is provided or topic isn't optional.

See Also:

NotificationManager.sync()

unsubscribeFromTopic

public void unsubscribeFromTopic(String topicId,
                        boolean forceSync)
                          throws UnavailableTopicException

Description copied from interface: NotificationManager

Unsubscribe from notifications relating to the specified optional topic.

All previously added listeners will be removed automatically.

Specified by:

unsubscribeFromTopic in interface NotificationManager

Parameters:

topicId - Id of a optional topic.

forceSync - Define whether current subscription update should be accepted immediately (see NotificationManager.sync()).

Throws:

UnavailableTopicException - Throw if unknown topic id is provided or topic isn't optional.

See Also:

NotificationManager.sync()

unsubscribeFromTopics

public void unsubscribeFromTopics(List<String> topicIds,
                         boolean forceSync)
                           throws UnavailableTopicException

Description copied from interface: NotificationManager

Unsubscribe from notifications relating to the specified list of optional topics.

All previously added listeners will be removed automatically.

Specified by:

unsubscribeFromTopics in interface NotificationManager

Parameters:

topicIds - List of optional topic id.

forceSync - Define whether current subscription update should be accepted immediately (see NotificationManager.sync()).

Throws:

UnavailableTopicException - Throw if unknown topic id is provided or topic isn't optional.

See Also:

NotificationManager.sync()

addNotificationListener

public void addNotificationListener(String topicId,
                           NotificationListener listener)
                             throws UnavailableTopicException

Description copied from interface: NotificationManager

Add listener to receive notifications relating to the specified topic.

Listener(s) for optional topics may be added/removed irrespective to whether subscription was already or not.

Specified by:

addNotificationListener in interface NotificationManager

Parameters:

topicId - Id of topic (both mandatory and optional).

listener - Listener to receive notifications.

Throws:

UnavailableTopicException - Throw if unknown topic id is provided.

See Also:

AbstractNotificationListener

removeNotificationListener

public void removeNotificationListener(String topicId,
                              NotificationListener listener)
                                throws UnavailableTopicException

Description copied from interface: NotificationManager

Remove listener receiving notifications for the specified topic.

Listener(s) for optional topics may be added/removed irrespective to whether subscription was already or not.

Specified by:

removeNotificationListener in interface NotificationManager

Parameters:

topicId - Id of topic (both mandatory and optional).

listener - Listener to receive notifications.

Throws:

UnavailableTopicException - Throw if unknown topic id is provided.

See Also:

AbstractNotificationListener

sync

public void sync()

Description copied from interface: NotificationManager

Accept optional subscription changes.

Should be used after all NotificationManager.subscribeToTopic(String, boolean), NotificationManager.subscribeToTopics(List, boolean), NotificationManager.unsubscribeFromTopic(String, boolean), NotificationManager.unsubscribeFromTopics(List, boolean) calls with parameter forceSync set to false.

Use it as a convenient way to make different consequent changes in the optional subscription:

 NotificationManager notificationManager = kaaClient.getNotificationManager();

  // Make subscription changes
  notificationManager.subscribeOnTopics(Arrays.asList(
          "optional_topic1", "optional_topic2", "optional_topic3"), false);
  notificationManager.unsubscribeFromTopic("optional_topic4", false);

  // Add listeners for optional topics here

  // Commit changes
  notificationManager.sync();
 
 

Specified by:

sync in interface NotificationManager

topicsListUpdated

public void topicsListUpdated(List<org.kaaproject.kaa.common.endpoint.gen.Topic> list)

Description copied from interface: NotificationProcessor

Called on topics' list update.

Specified by:

topicsListUpdated in interface NotificationProcessor

Parameters:

list - the new topics' list.

See Also:

Topic

notificationReceived

public void notificationReceived(List<org.kaaproject.kaa.common.endpoint.gen.Notification> notifications)
                          throws IOException

Description copied from interface: NotificationProcessor

Called when new notifications arrived.

Specified by:

notificationReceived in interface NotificationProcessor

Parameters:

notifications - the list of new notifications.

Throws:

IOException

See Also:

Notification