X-Git-Url: https://git.pterodactylus.net/?p=Sone.git;a=blobdiff_plain;f=src%2Fmain%2Fjava%2Fnet%2Fpterodactylus%2Fsone%2Ffreenet%2Fwot%2FIdentity.java;h=63bceb1f2004c57d5e6306e11569718afcb910e6;hp=41540e531cb9e00b5e89c72080d37a206da7343e;hb=64740709990291688170ebd1f192af5eb9090618;hpb=492506fb5a06f01a493cb9408ace3d435bd56f6b diff --git a/src/main/java/net/pterodactylus/sone/freenet/wot/Identity.java b/src/main/java/net/pterodactylus/sone/freenet/wot/Identity.java index 41540e5..63bceb1 100644 --- a/src/main/java/net/pterodactylus/sone/freenet/wot/Identity.java +++ b/src/main/java/net/pterodactylus/sone/freenet/wot/Identity.java @@ -1,5 +1,5 @@ /* - * Sone - Identity.java - Copyright © 2010 David Roden + * Sone - Identity.java - Copyright © 2010–2020 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 @@ -22,10 +22,8 @@ import java.util.Set; /** * Interface for web of trust identities, defining all functions that can be - * performed on an identity. The identity is the main entry point for identity - * management. - * - * @author David ‘Bombe’ Roden + * performed on an identity. An identity is only a container for identity data + * and will not perform any updating in the WebOfTrust plugin itself. */ public interface Identity { @@ -68,6 +66,30 @@ public interface Identity { public boolean hasContext(String context); /** + * Adds the given context to this identity. + * + * @param context + * The context to add + */ + public Identity addContext(String context); + + /** + * Sets all contexts of this identity. + * + * @param contexts + * All contexts of the identity + */ + public void setContexts(Set contexts); + + /** + * Removes the given context from this identity. + * + * @param context + * The context to remove + */ + public Identity removeContext(String context); + + /** * Returns all properties of this identity. * * @return All properties of this identity @@ -84,14 +106,61 @@ public interface Identity { public 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 + */ + public Identity setProperty(String name, String value); + + /** + * Sets all properties of this identity. + * + * @param properties + * The new properties of this identity + */ + public void setProperties(Map properties); + + /** + * Removes the property with the given name. + * + * @param name + * The name of the property to remove + */ + public Identity removeProperty(String name); + + /** * Retrieves the trust that this identity receives from the given own - * identity. + * 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 - * @throws WebOfTrustException + * @return The trust assigned to this identity, or {@code null} if the trust + * could not be retrieved + */ + public 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 + */ + public 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 */ - public Trust getTrust(OwnIdentity ownIdentity) throws WebOfTrustException; + public Identity removeTrust(OwnIdentity ownIdentity); }