311a7ca9431edd3ea89bedc5565d0d27b10cb8c5
[Sone.git] / UnlockSoneCommand.java
1 /*
2  * Sone - UnlockSoneCommand.java - Copyright © 2013–2016 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.fcp;
19
20 import net.pterodactylus.sone.core.Core;
21 import net.pterodactylus.sone.data.Sone;
22 import net.pterodactylus.sone.freenet.SimpleFieldSetBuilder;
23 import net.pterodactylus.sone.freenet.fcp.FcpException;
24
25 import freenet.support.SimpleFieldSet;
26 import freenet.support.api.Bucket;
27
28 import com.google.common.base.Optional;
29
30 /**
31  * Implements the “UnlockSone” FCP command. If a valid local Sone was given as
32  * parameter “Sone,” this command will always unlock the Sone and reply with
33  * “SoneUnlocked.”
34  *
35  * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
36  */
37 public class UnlockSoneCommand extends AbstractSoneCommand {
38
39         /**
40          * Creates a new “LockSone” FCP command.
41          *
42          * @param core
43          *              The core to operate on
44          */
45         public UnlockSoneCommand(Core core) {
46                 super(core, true);
47         }
48
49         //
50         // COMMAND METHODS
51         //
52
53         @Override
54         public Response execute(SimpleFieldSet parameters, Bucket data, AccessType accessType) throws FcpException {
55                 Optional<Sone> sone = getSone(parameters, "Sone", true, true);
56                 getCore().unlockSone(sone.get());
57                 return new Response("SoneUnlocked", new SimpleFieldSetBuilder().put("Sone", sone.get().getId()).get());
58         }
59
60 }