Complete javadoc.
[Sone.git] / src / main / java / net / pterodactylus / sone / web / ajax / GetNotificationsAjaxPage.java
1 /*
2  * Sone - GetNotificationsAjaxPage.java - Copyright © 2010 David Roden
3  *
4  * This program is free software: you can redistribute it and/or modify
5  * it under the terms of the GNU General Public License as published by
6  * the Free Software Foundation, either version 3 of the License, or
7  * (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
16  */
17
18 package net.pterodactylus.sone.web.ajax;
19
20 import java.util.ArrayList;
21 import java.util.Collections;
22 import java.util.List;
23 import java.util.Set;
24
25 import net.pterodactylus.sone.web.WebInterface;
26 import net.pterodactylus.util.json.JsonArray;
27 import net.pterodactylus.util.json.JsonObject;
28 import net.pterodactylus.util.notify.Notification;
29
30 /**
31  * Returns all changed notifications.
32  *
33  * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
34  */
35 public class GetNotificationsAjaxPage extends JsonPage {
36
37         /**
38          * Creates a new “get notifications” AJAX handler.
39          *
40          * @param webInterface
41          *            The Sone web interface
42          */
43         public GetNotificationsAjaxPage(WebInterface webInterface) {
44                 super("ajax/getNotifications.ajax", webInterface);
45         }
46
47         //
48         // JSONPAGE METHODS
49         //
50
51         /**
52          * {@inheritDoc}
53          */
54         @Override
55         protected JsonObject createJsonObject(Request request) {
56                 List<Notification> notifications = new ArrayList<Notification>(webInterface.getNotifications().getChangedNotifications());
57                 Set<Notification> removedNotifications = webInterface.getNotifications().getRemovedNotifications();
58                 Collections.sort(notifications, Notification.LAST_UPDATED_TIME_SORTER);
59                 JsonObject result = createSuccessJsonObject();
60                 JsonArray jsonNotifications = new JsonArray();
61                 for (Notification notification : notifications) {
62                         jsonNotifications.add(createJsonNotification(notification));
63                 }
64                 JsonArray jsonRemovedNotifications = new JsonArray();
65                 for (Notification notification : removedNotifications) {
66                         jsonRemovedNotifications.add(createJsonNotification(notification));
67                 }
68                 return result.put("notifications", jsonNotifications).put("removedNotifications", jsonRemovedNotifications);
69         }
70
71         /**
72          * {@inheritDoc}
73          */
74         @Override
75         protected boolean needsFormPassword() {
76                 return false;
77         }
78
79         //
80         // PRIVATE METHODS
81         //
82
83         /**
84          * Creates a JSON object from the given notification.
85          *
86          * @param notification
87          *            The notification to create a JSON object
88          * @return The JSON object
89          */
90         private static JsonObject createJsonNotification(Notification notification) {
91                 JsonObject jsonNotification = new JsonObject();
92                 jsonNotification.put("id", notification.getId());
93                 jsonNotification.put("text", notification.toString());
94                 jsonNotification.put("createdTime", notification.getCreatedTime());
95                 jsonNotification.put("lastUpdatedTime", notification.getLastUpdatedTime());
96                 jsonNotification.put("dismissable", notification.isDismissable());
97                 return jsonNotification;
98         }
99
100 }