Fix header comments.
[Sone.git] / src / main / java / net / pterodactylus / sone / web / ajax / LockSoneAjaxPage.java
1 /*
2  * Sone - LockSoneAjaxPage.java - Copyright © 2010–2012 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 net.pterodactylus.sone.core.Core;
21 import net.pterodactylus.sone.data.Sone;
22 import net.pterodactylus.sone.web.WebInterface;
23 import net.pterodactylus.sone.web.page.FreenetRequest;
24 import net.pterodactylus.util.json.JsonObject;
25
26 /**
27  * Lets the user {@link Core#lockSone(Sone) lock} a {@link Sone}.
28  *
29  * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
30  */
31 public class LockSoneAjaxPage extends JsonPage {
32
33         /**
34          * Creates a new “lock Sone” AJAX handler.
35          *
36          * @param webInterface
37          *            The Sone web interface
38          */
39         public LockSoneAjaxPage(WebInterface webInterface) {
40                 super("lockSone.ajax", webInterface);
41         }
42
43         /**
44          * {@inheritDoc}
45          */
46         @Override
47         protected JsonObject createJsonObject(FreenetRequest request) {
48                 String soneId = request.getHttpRequest().getParam("sone");
49                 Sone sone = webInterface.getCore().getLocalSone(soneId, false);
50                 if (sone == null) {
51                         return createErrorJsonObject("invalid-sone-id");
52                 }
53                 webInterface.getCore().lockSone(sone);
54                 return createSuccessJsonObject();
55         }
56
57         /**
58          * {@inheritDoc}
59          */
60         @Override
61         protected boolean requiresLogin() {
62                 return false;
63         }
64
65 }