2 * jFCPlib - WebOfTrustPlugin.java -
3 * Copyright © 2009 David Roden
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License
16 * along with this program; if not, write to the Free Software
17 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
20 package net.pterodactylus.fcp.plugin;
22 import java.io.IOException;
23 import java.util.HashMap;
24 import java.util.HashSet;
28 import net.pterodactylus.fcp.highlevel.FcpClient;
29 import net.pterodactylus.fcp.highlevel.FcpException;
32 * Simplifies handling of the web-of-trust plugin.
34 * @author David ‘Bombe’ Roden <bombe@freenetproject.org>
36 public class WebOfTrustPlugin {
38 /** The FCP client to use. */
39 private final FcpClient fcpClient;
42 * Creates a new web-of-trust plugin wrapper around the given FCP client.
45 * The FCP client to use for communication with the web-of-trust
48 public WebOfTrustPlugin(FcpClient fcpClient) {
49 this.fcpClient = fcpClient;
53 * Creates a new identity.
56 * The nickname of the new identity
58 * The context for the new identity
59 * @param publishTrustList
60 * {@code true} if the new identity should publish its trust list
61 * @return The new identity
63 * if an I/O error occurs
64 * @throws FcpException
65 * if an FCP error occurs
67 public OwnIdentity createIdentity(String nickname, String context, boolean publishTrustList) throws IOException, FcpException {
68 return createIdentity(nickname, context, publishTrustList, null, null);
72 * Creates a new identity from the given request and insert URI.
75 * The nickname of the new identity
77 * The context for the new identity
78 * @param publishTrustList
79 * {@code true} if the new identity should publish its trust list
81 * The request URI of the identity
83 * The insert URI of the identity
84 * @return The new identity
86 * if an I/O error occurs
87 * @throws FcpException
88 * if an FCP error occurs
90 public OwnIdentity createIdentity(String nickname, String context, boolean publishTrustList, String requestUri, String insertUri) throws IOException, FcpException {
91 Map<String, String> parameters = new HashMap<String, String>();
92 parameters.put("Message", "CreateIdentity");
93 parameters.put("Nickname", nickname);
94 parameters.put("Context", context);
95 parameters.put("PublishTrustList", String.valueOf(publishTrustList));
96 if ((requestUri != null) && (insertUri != null)) {
97 parameters.put("RequestURI", requestUri);
98 parameters.put("InsertURI", insertUri);
100 Map<String, String> replies = fcpClient.sendPluginMessage("plugins.WoT.WoT", parameters);
101 if (!replies.get("Message").equals("IdentityCreated")) {
102 throw new FcpException("WebOfTrust Plugin did not reply with “IdentityCreated” message!");
104 String identifier = replies.get("ID");
105 String newRequestUri = replies.get("RequestURI");
106 String newInsertUri = replies.get("InsertURI");
107 return new OwnIdentity(identifier, nickname, newRequestUri, newInsertUri);
111 * Returns all own identities of the web-of-trust plugins. Almost all other
112 * commands require an {@link OwnIdentity} to return meaningful values.
114 * @return All own identities of the web-of-trust plugin
115 * @throws IOException
116 * if an I/O error occurs
117 * @throws FcpException
118 * if an FCP error occurs
120 public Set<OwnIdentity> getOwnIdentites() throws IOException, FcpException {
121 Map<String, String> replies = fcpClient.sendPluginMessage("plugins.WoT.WoT", createParameters("Message", "GetOwnIdentities"));
122 if (!replies.get("Message").equals("OwnIdentities")) {
123 throw new FcpException("WebOfTrust Plugin did not reply with “OwnIdentities” message!");
125 Set<OwnIdentity> ownIdentities = new HashSet<OwnIdentity>();
126 for (int identityIndex = 1; replies.containsKey("Identity" + identityIndex); identityIndex++) {
127 String identity = replies.get("Identity" + identityIndex);
128 String nickname = replies.get("Nickname" + identityIndex);
129 String requestUri = replies.get("RequestURI" + identityIndex);
130 String insertUri = replies.get("InsertURI" + identityIndex);
131 ownIdentities.add(new OwnIdentity(identity, nickname, requestUri, insertUri));
133 return ownIdentities;
137 * Returns the trust given to the identity with the given identifier by the
138 * given own identity.
141 * The own identity that is used to calculate trust values
143 * The identifier of the identity whose trust to get
144 * @return The request identity trust
145 * @throws IOException
146 * if an I/O error occurs
147 * @throws FcpException
148 * if an FCP error occurs
150 public IdentityTrust getIdentityTrust(OwnIdentity ownIdentity, String identifier) throws IOException, FcpException {
151 Map<String, String> replies = fcpClient.sendPluginMessage("plugins.WoT.WoT", createParameters("Message", "GetIdentity", "TreeOwner", ownIdentity.getIdentifier(), "Identity", identifier));
152 if (!replies.get("Message").equals("Identity")) {
153 throw new FcpException("WebOfTrust Plugin did not reply with “Identity” message!");
157 trust = Byte.valueOf(replies.get("Trust"));
158 } catch (NumberFormatException nfe1) {
161 Integer score = null;
163 score = Integer.valueOf(replies.get("Score"));
164 } catch (NumberFormatException nfe1) {
169 rank = Integer.valueOf(replies.get("Rank"));
170 } catch (NumberFormatException nfe1) {
173 return new IdentityTrust(trust, score, rank);
177 * Adds a new identity by its request URI.
180 * The request URI of the identity to add
181 * @return The added identity
182 * @throws IOException
183 * if an I/O error occurs
184 * @throws FcpException
185 * if an FCP error occurs
187 public Identity addIdentity(String requestUri) throws IOException, FcpException {
188 Map<String, String> replies = fcpClient.sendPluginMessage("plugins.WoT.WoT", createParameters("Message", "AddIdentity", "RequestURI", requestUri));
189 if (!replies.get("Message").equals("IdentityAdded")) {
190 throw new FcpException("WebOfTrust Plugin did not reply with “IdentityAdded” message!");
192 String identifier = replies.get("ID");
193 String nickname = replies.get("Nickname");
194 return new Identity(identifier, nickname, requestUri);
202 * Creates a map from each pair of parameters in the given array.
205 * The array of parameters
206 * @return The map created from the array
207 * @throws ArrayIndexOutOfBoundsException
208 * if the given parameter array does not contains an even number
211 private Map<String, String> createParameters(String... parameters) throws ArrayIndexOutOfBoundsException {
212 Map<String, String> parameterMap = new HashMap<String, String>();
213 for (int index = 0; index < parameters.length; index += 2) {
214 parameterMap.put(parameters[index], parameters[index + 1]);
220 * Wrapper around a web-of-trust identity.
222 * @author David ‘Bombe’ Roden <bombe@freenetproject.org>
224 public static class Identity {
226 /** The identity’s identifier. */
227 private final String identifier;
229 /** The identity’s nickname. */
230 private final String nickname;
232 /** The identity’s request URI. */
233 private final String requestUri;
236 * Creates a new identity.
239 * The identifies of the identity
241 * The nickname of the identity
243 * The request URI of the identity
245 public Identity(String identifier, String nickname, String requestUri) {
246 this.identifier = identifier;
247 this.nickname = nickname;
248 this.requestUri = requestUri;
252 * Returns the identifier of this identity.
254 * @return This identity’s identifier
256 public String getIdentifier() {
261 * Returns the nickname of this identity.
263 * @return This identity’s nickname
265 public String getNickname() {
270 * Returns the request URI of this identity.
272 * @return This identity’s request URI
274 public String getRequestUri() {
281 * Container that stores the trust given to an identity.
283 * @author David ‘Bombe’ Roden <bombe@freenetproject.org>
285 public static class IdentityTrust {
287 /** The identity’s trust value. */
288 private final Byte trust;
290 /** The identity’s score value. */
291 private final Integer score;
293 /** The identity’s rank. */
294 private final Integer rank;
297 * Creates a new identity trust container.
300 * The trust value of the identity
302 * The score value of the identity
304 * The rank of the identity
306 public IdentityTrust(Byte trust, Integer score, Integer rank) {
313 * Returns the trust value of this identity.
315 * @return This identity’s trust value, or {@code null} if this
316 * identity’s trust value is not known
318 public Byte getTrust() {
323 * Returns the score value of this identity.
325 * @return This identity’s score value, or {@code null} if this
326 * identity’s score value is not known
328 public Integer getScore() {
333 * Returns the rank of this identity.
335 * @return This identity’s rank, or {@code null} if this identity’s rank
338 public Integer getRank() {
345 * Wrapper around a web-of-trust own identity.
347 * @author David ‘Bombe’ Roden <bombe@freenetproject.org>
349 public static class OwnIdentity extends Identity {
351 /** The identity’s insert URI. */
352 private final String insertUri;
355 * Creates a new web-of-trust own identity.
358 * The identifier of the identity
360 * The nickname of the identity
362 * The request URI of the identity
364 * The insert URI of the identity
366 public OwnIdentity(String identifier, String nickname, String requestUri, String insertUri) {
367 super(identifier, nickname, requestUri);
368 this.insertUri = insertUri;
372 * Returns the insert URI of this identity.
374 * @return This identity’s insert URI
376 public String getInsertUri() {