From: David ‘Bombe’ Roden Date: Wed, 10 Jun 2009 21:57:38 +0000 (+0200) Subject: Add wrapper around web-of-trust plugin. X-Git-Tag: v0.1.1~46 X-Git-Url: https://git.pterodactylus.net/?a=commitdiff_plain;h=5a417401b78b76267ae4841b7b363624ec27464e;p=jFCPlib.git Add wrapper around web-of-trust plugin. --- diff --git a/src/net/pterodactylus/fcp/plugin/WebOfTrustPlugin.java b/src/net/pterodactylus/fcp/plugin/WebOfTrustPlugin.java new file mode 100644 index 0000000..7e5cc5a --- /dev/null +++ b/src/net/pterodactylus/fcp/plugin/WebOfTrustPlugin.java @@ -0,0 +1,199 @@ +/* + * jFCPlib - WebOfTrustPlugin.java - + * Copyright © 2009 David Roden + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation; either version 2 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. + */ + +package net.pterodactylus.fcp.plugin; + +import java.io.IOException; +import java.util.HashMap; +import java.util.HashSet; +import java.util.Map; +import java.util.Set; + +import net.pterodactylus.fcp.highlevel.FcpClient; +import net.pterodactylus.fcp.highlevel.FcpException; + +/** + * Simplifies handling of the web-of-trust plugin. + * + * @author David ‘Bombe’ Roden <bombe@freenetproject.org> + */ +public class WebOfTrustPlugin { + + /** The FCP client to use. */ + private final FcpClient fcpClient; + + /** + * Creates a new web-of-trust plugin wrapper around the given FCP client. + * + * @param fcpClient + * The FCP client to use for communication with the web-of-trust + * plugin + */ + public WebOfTrustPlugin(FcpClient fcpClient) { + this.fcpClient = fcpClient; + } + + /** + * Returns all own identities of the web-of-trust plugins. Almost all other + * commands require an {@link OwnIdentity} to return meaningful values. + * + * @return All own identities of the web-of-trust plugin + * @throws IOException + * if an I/O error occurs + * @throws FcpException + * if an FCP error occurs + */ + public Set getOwnIdentites() throws IOException, FcpException { + Map replies = fcpClient.sendPluginMessage("plugins.WoT.WoT", createParameters("Message", "GetOwnIdentities")); + if (!replies.get("Message").equals("OwnIdentities")) { + throw new FcpException("WebOfTrust Plugin did not reply with “OwnIdentities” message!"); + } + Set ownIdentities = new HashSet(); + for (int identityIndex = 1; replies.containsKey("Identity" + identityIndex); identityIndex++) { + String identity = replies.get("Identity" + identityIndex); + String nickname = replies.get("Nickname" + identityIndex); + String requestUri = replies.get("RequestURI" + identityIndex); + String insertUri = replies.get("InsertURI" + identityIndex); + ownIdentities.add(new OwnIdentity(identity, nickname, requestUri, insertUri)); + } + return ownIdentities; + } + + // + // PRIVATE METHODS + // + + /** + * Creates a map from each pair of parameters in the given array. + * + * @param parameters + * The array of parameters + * @return The map created from the array + * @throws ArrayIndexOutOfBoundsException + * if the given parameter array does not contains an even number + * of elements + */ + private Map createParameters(String... parameters) throws ArrayIndexOutOfBoundsException { + Map parameterMap = new HashMap(); + for (int index = 0; index < parameters.length; index += 2) { + parameterMap.put(parameters[index], parameters[index + 1]); + } + return parameterMap; + } + + /** + * Wrapper around a web-of-trust identity. + * + * @author David ‘Bombe’ Roden <bombe@freenetproject.org> + */ + public static class Identity { + + /** The identity’s identifier. */ + private final String identifier; + + /** The identity’s nickname. */ + private final String nickname; + + /** The identity’s request URI. */ + private final String requestUri; + + /** + * Creates a new identity. + * + * @param identifier + * The identifies of the identity + * @param nickname + * The nickname of the identity + * @param requestUri + * The request URI of the identity + */ + public Identity(String identifier, String nickname, String requestUri) { + this.identifier = identifier; + this.nickname = nickname; + this.requestUri = requestUri; + } + + /** + * Returns the identifier of this identity. + * + * @return This identity’s identifier + */ + public String getIdentifier() { + return identifier; + } + + /** + * Returns the nickname of this identity. + * + * @return This identity’s nickname + */ + public String getNickname() { + return nickname; + } + + /** + * Returns the request URI of this identity. + * + * @return This identity’s request URI + */ + public String getRequestUri() { + return requestUri; + } + + } + + /** + * Wrapper around a web-of-trust own identity. + * + * @author David ‘Bombe’ Roden <bombe@freenetproject.org> + */ + public static class OwnIdentity extends Identity { + + /** The identity’s insert URI. */ + private final String insertUri; + + /** + * Creates a new web-of-trust own identity. + * + * @param identifier + * The identifier of the identity + * @param nickname + * The nickname of the identity + * @param requestUri + * The request URI of the identity + * @param insertUri + * The insert URI of the identity + */ + public OwnIdentity(String identifier, String nickname, String requestUri, String insertUri) { + super(identifier, nickname, requestUri); + this.insertUri = insertUri; + } + + /** + * Returns the insert URI of this identity. + * + * @return This identity’s insert URI + */ + public String getInsertUri() { + return insertUri; + } + + } + +}