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=0e13e9e16a7b5a9f5a17083b9421ba6c2ffc689d;hb=64740709990291688170ebd1f192af5eb9090618;hpb=b6c31e4b57f25dc59813c8585505d26034dc59e0 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 0e13e9e..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 @@ -17,170 +17,111 @@ package net.pterodactylus.sone.freenet.wot; -import java.util.Collections; -import java.util.HashMap; -import java.util.HashSet; import java.util.Map; import java.util.Set; /** - * A Web of Trust identity. - * - * @author David ‘Bombe’ Roden + * 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. */ -public class Identity { - - /** The Web of Trust connector. */ - protected final WebOfTrustConnector webOfTrustConnector; - - /** The ID of the identity. */ - private final String id; - - /** The nickname of the identity. */ - private final String nickname; - - /** The request URI of the identity. */ - private final String requestUri; - - /** The contexts of the identity. */ - protected final Set contexts = Collections.synchronizedSet(new HashSet()); - - /** Whether the contexts have already been loaded. */ - private volatile boolean contextsLoaded = false; - - /** The properties of the identity. */ - private final Map properties = Collections.synchronizedMap(new HashMap()); - - /** - * Creates a new identity. - * - * @param webOfTrustConnector - * The Web of Trust connector - * @param id - * The ID of the identity - * @param nickname - * The nickname of the identity - * @param requestUri - * The request URI of the identity - */ - public Identity(WebOfTrustConnector webOfTrustConnector, String id, String nickname, String requestUri) { - this.webOfTrustConnector = webOfTrustConnector; - this.id = id; - this.nickname = nickname; - this.requestUri = requestUri; - } - - // - // ACCESSORS - // +public interface Identity { /** * Returns the ID of the identity. * * @return The ID of the identity */ - public String getId() { - return id; - } + public String getId(); /** * Returns the nickname of the identity. * * @return The nickname of the identity */ - public String getNickname() { - return nickname; - } + public String getNickname(); /** * Returns the request URI of the identity. * * @return The request URI of the identity */ - public String getRequestUri() { - return requestUri; - } + public String getRequestUri(); /** - * Returns the contexts of the identity. If the contexts have not been - * loaded yet, they will be loaded. If loading the contexts fails, an empty - * set is returned. + * Returns all contexts of this identity. * - * @return The contexts of the identity + * @return All contexts of this identity */ - public Set getContexts() { - try { - return getContexts(false); - } catch (PluginException pe1) { - return Collections.emptySet(); - } - } + public Set getContexts(); /** - * Returns the contexts of the identity. + * Returns whether this identity has the given context. * - * @param forceReload - * {@code true} to force a reload of the contexts - * @return The contexts of the identity - * @throws PluginException - * if an error occured communicating with the Web of Trust - * plugin + * @param context + * The context to check for + * @return {@code true} if this identity has the given context, + * {@code false} otherwise */ - public Set getContexts(boolean forceReload) throws PluginException { - if (!contextsLoaded || forceReload) { - Set contexts = webOfTrustConnector.loadIdentityContexts(this); - contextsLoaded = true; - this.contexts.clear(); - this.contexts.addAll(contexts); - } - return Collections.unmodifiableSet(contexts); - } + public boolean hasContext(String context); /** - * Returns whether the identity contains the given context. + * Adds the given context to this identity. * * @param context - * The context to check for - * @return {@code true} if this identity has the given context, - * {@code false} otherwise + * The context to add */ - public boolean hasContext(String context) { - return getContexts().contains(context); - } + public Identity addContext(String context); /** - * Returns the properties of the identity. + * Sets all contexts of this identity. * - * @return The properties of the identity + * @param contexts + * All contexts of the identity */ - public Map getProperties() { - return Collections.unmodifiableMap(properties); - } + 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 + */ + public Map getProperties(); /** * Returns the value of the property with the given name. * * @param name * The name of the property - * @return The value of the property, or {@code null} if there is no such - * property + * @return The value of the property */ - public String getProperty(String name) { - return properties.get(name); - } + public String getProperty(String name); /** * Sets the property with the given name to the given value. * * @param name - * The name of the property to set + * The name of the property * @param value - * The new value of the property + * The value of the property */ - public void setProperty(String name, String value) { - properties.put(name, value); - /* TODO - set 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. @@ -188,33 +129,38 @@ public class Identity { * @param name * The name of the property to remove */ - public void removeProperty(String name) { - properties.remove(name); - /* TODO - remove property. */ - } + public Identity removeProperty(String name); - // - // OBJECT METHODS - // + /** + * 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 + */ + public Trust getTrust(OwnIdentity ownIdentity); /** - * {@inheritDoc} + * 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 */ - @Override - public int hashCode() { - return id.hashCode(); - } + public Identity setTrust(OwnIdentity ownIdentity, Trust trust); /** - * {@inheritDoc} + * Removes trust assignment from the given own identity for this identity. + * + * @param ownIdentity + * The own identity that removed the trust assignment for this + * identity */ - @Override - public boolean equals(Object object) { - if (!(object instanceof Identity)) { - return false; - } - Identity identity = (Identity) object; - return identity.id.equals(id); - } + public Identity removeTrust(OwnIdentity ownIdentity); }