You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@usergrid.apache.org by to...@apache.org on 2014/10/29 18:23:19 UTC

[17/18] git commit: comments on interface

comments on interface


Project: http://git-wip-us.apache.org/repos/asf/incubator-usergrid/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-usergrid/commit/c51c0ce4
Tree: http://git-wip-us.apache.org/repos/asf/incubator-usergrid/tree/c51c0ce4
Diff: http://git-wip-us.apache.org/repos/asf/incubator-usergrid/diff/c51c0ce4

Branch: refs/heads/two-dot-o
Commit: c51c0ce4e55cbf503c0fe2194d3da4697ab190f2
Parents: 8f4720d
Author: Shawn Feldman <sf...@apache.org>
Authored: Wed Oct 29 11:08:31 2014 -0600
Committer: Shawn Feldman <sf...@apache.org>
Committed: Wed Oct 29 11:08:31 2014 -0600

----------------------------------------------------------------------
 .../notifications/ApplicationQueueManager.java  | 21 +++++++++++++++++++-
 1 file changed, 20 insertions(+), 1 deletion(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/c51c0ce4/stack/services/src/main/java/org/apache/usergrid/services/notifications/ApplicationQueueManager.java
----------------------------------------------------------------------
diff --git a/stack/services/src/main/java/org/apache/usergrid/services/notifications/ApplicationQueueManager.java b/stack/services/src/main/java/org/apache/usergrid/services/notifications/ApplicationQueueManager.java
index 8012b42..101c839 100644
--- a/stack/services/src/main/java/org/apache/usergrid/services/notifications/ApplicationQueueManager.java
+++ b/stack/services/src/main/java/org/apache/usergrid/services/notifications/ApplicationQueueManager.java
@@ -28,7 +28,7 @@ import rx.Observable;
 import java.util.List;
 
 /**
- * Classy class class.
+ * Manages Queues for Applications
  */
 public interface ApplicationQueueManager {
 
@@ -38,11 +38,30 @@ public interface ApplicationQueueManager {
 
     public static final  String DEFAULT_QUEUE_NAME = "push_v1";
 
+    /**
+     * send notification to queue
+     * @param notification
+     * @param jobExecution
+     * @throws Exception
+     */
     void queueNotification(Notification notification, JobExecution jobExecution) throws Exception;
 
+    /**
+     * send notifications to providers
+     * @param messages
+     * @param queuePath
+     * @return
+     */
     Observable sendBatchToProviders(List<QueueMessage> messages, String queuePath);
 
+    /**
+     * stop processing and send message to providers to stop
+     */
     void stop();
 
+    /**
+     * check for inactive devices, apple and google require this
+     * @throws Exception
+     */
     void asyncCheckForInactiveDevices() throws Exception;
 }