Add Freenet plugin and WoT subprojects

[fwot.git] / wot / src / main / java / net / pterodactylus / freenet / wot / Identity.java

diff --git a/wot/src/main/java/net/pterodactylus/freenet/wot/Identity.java b/wot/src/main/java/net/pterodactylus/freenet/wot/Identity.java
new file mode 100644 (file)
index 0000000..f6afcf9
--- /dev/null
+++ b/wot/src/main/java/net/pterodactylus/freenet/wot/Identity.java
@@ -0,0 +1,169 @@
+/*
+ * Sone - Identity.java - Copyright © 2010–2013 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 3 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, see <http://www.gnu.org/licenses/>.
+ */
+
+package net.pterodactylus.freenet.wot;
+
+import java.util.Collection;
+import java.util.Map;
+import java.util.Set;
+
+/**
+ * Interface for web of trust identities, defining all functions that can be
+ * performed on an identity. An identity is only a container for identity data
+ * and will not perform any updating in the WebOfTrust plugin itself.
+ *
+ * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
+ */
+public interface Identity {
+
+       /**
+        * Returns the ID of the identity.
+        *
+        * @return The ID of the identity
+        */
+       String getId();
+
+       /**
+        * Returns the nickname of the identity.
+        *
+        * @return The nickname of the identity
+        */
+       String getNickname();
+
+       /**
+        * Returns the request URI of the identity.
+        *
+        * @return The request URI of the identity
+        */
+       String getRequestUri();
+
+       /**
+        * Returns all contexts of this identity.
+        *
+        * @return All contexts of this identity
+        */
+       Set<String> getContexts();
+
+       /**
+        * Returns whether this identity has the given context.
+        *
+        * @param context
+        *              The context to check for
+        * @return {@code true} if this identity has the given context,
+        * {@code false} otherwise
+        */
+       boolean hasContext(String context);
+
+       /**
+        * Adds the given context to this identity.
+        *
+        * @param context
+        *              The context to add
+        */
+       Identity addContext(String context);
+
+       /**
+        * Sets all contexts of this identity.
+        *
+        * @param contexts
+        *              All contexts of the identity
+        */
+       void setContexts(Collection<String> contexts);
+
+       /**
+        * Removes the given context from this identity.
+        *
+        * @param context
+        *              The context to remove
+        */
+       Identity removeContext(String context);
+
+       /**
+        * Returns all properties of this identity.
+        *
+        * @return All properties of this identity
+        */
+       Map<String, String> getProperties();
+
+       /**
+        * Returns the value of the property with the given name.
+        *
+        * @param name
+        *              The name of the property
+        * @return The value of the property
+        */
+       String getProperty(String name);
+
+       /**
+        * Sets the property with the given name to the given value.
+        *
+        * @param name
+        *              The name of the property
+        * @param value
+        *              The value of the property
+        */
+       Identity setProperty(String name, String value);
+
+       /**
+        * Sets all properties of this identity.
+        *
+        * @param properties
+        *              The new properties of this identity
+        */
+       void setProperties(Map<String, String> properties);
+
+       /**
+        * Removes the property with the given name.
+        *
+        * @param name
+        *              The name of the property to remove
+        */
+       Identity removeProperty(String name);
+
+       /**
+        * Retrieves the trust that this identity receives from the given own
+        * identity. If this identity is not in the own identity’s trust tree, a
+        * {@link Trust} is returned that has all its elements set to {@code null}.
+        * If the trust can not be retrieved, {@code null} is returned.
+        *
+        * @param ownIdentity
+        *              The own identity to get the trust for
+        * @return The trust assigned to this identity, or {@code null} if the trust
+        * could not be retrieved
+        */
+       Trust getTrust(OwnIdentity ownIdentity);
+
+       /**
+        * Sets the trust given by an own identity to this identity.
+        *
+        * @param ownIdentity
+        *              The own identity that gave trust to this identity
+        * @param trust
+        *              The trust given by the given own identity
+        */
+       Identity setTrust(OwnIdentity ownIdentity, Trust trust);
+
+       /**
+        * Removes trust assignment from the given own identity for this identity.
+        *
+        * @param ownIdentity
+        *              The own identity that removed the trust assignment for this
+        *              identity
+        */
+       Identity removeTrust(OwnIdentity ownIdentity);
+
+}