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=5816b47772e0e750117c6e92c3fb69630cb2ff4f;hb=64740709990291688170ebd1f192af5eb9090618;hpb=d4d0a56c658d54e1ca12e125d5977b6de70ba894 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 5816b47..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,102 +17,43 @@ 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 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. */ - private final Set contexts = Collections.synchronizedSet(new HashSet()); - - /** The properties of the identity. */ - private final Map properties = Collections.synchronizedMap(new HashMap()); - - /** - * Creates a new identity. - * - * @param id - * The ID of the identity - * @param nickname - * The nickname of the identity - * @param requestUri - * The request URI of the identity - */ - public Identity(String id, String nickname, String requestUri) { - 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 all contexts of this identity. * * @return All contexts of this identity */ - public Set getContexts() { - return Collections.unmodifiableSet(contexts); - } - - /** - * Sets all contexts of this identity. - *

- * This method is only called by the {@link IdentityManager}. - * - * @param contexts - * All contexts of the identity - */ - void setContexts(Set contexts) { - this.contexts.clear(); - this.contexts.addAll(contexts); - } + public Set getContexts(); /** * Returns whether this identity has the given context. @@ -122,133 +63,104 @@ public class Identity { * @return {@code true} if this identity has the given context, * {@code false} otherwise */ - public boolean hasContext(String context) { - return contexts.contains(context); - } + public boolean hasContext(String context); /** * Adds the given context to this identity. - *

- * This method is only called by the {@link IdentityManager}. * * @param context * The context to add */ - void addContext(String context) { - contexts.add(context); - } + 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. - *

- * This method is only called by the {@link IdentityManager}. * * @param context * The context to remove */ - void removeContext(String context) { - contexts.remove(context); - } + public Identity removeContext(String context); /** * Returns all properties of this identity. * * @return All properties of this identity */ - public Map getProperties() { - synchronized (properties) { - return Collections.unmodifiableMap(properties); - } - } + public Map getProperties(); /** - * Sets all properties of this identity. - *

- * This method is only called by the {@link IdentityManager}. + * Returns the value of the property with the given name. * - * @param properties - * The new properties of this identity + * @param name + * The name of the property + * @return The value of the property */ - void setProperties(Map properties) { - synchronized (this.properties) { - this.properties.clear(); - this.properties.putAll(properties); - } - } + public String getProperty(String name); /** * Sets the property with the given name to the given value. - *

- * This method is only called by the {@link IdentityManager}. * * @param name * The name of the property * @param value * The value of the property */ - void setProperty(String name, String value) { - synchronized (properties) { - properties.put(name, value); - } - } + public Identity setProperty(String name, String value); /** - * Returns the value of the property with the given name. + * Sets all properties of this identity. * - * @param name - * The name of the property - * @return The value of the property + * @param properties + * The new properties of this identity */ - public String getProperty(String name) { - synchronized (properties) { - return properties.get(name); - } - } + public void setProperties(Map properties); /** * Removes the property with the given name. - *

- * This method is only called by the {@link IdentityManager}. * * @param name * The name of the property to remove */ - void removeProperty(String name) { - synchronized (properties) { - properties.remove(name); - } - } - - // - // OBJECT METHODS - // + public Identity removeProperty(String name); /** - * {@inheritDoc} + * 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 */ - @Override - public int hashCode() { - return id.hashCode(); - } + 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 boolean equals(Object object) { - if (!(object instanceof Identity)) { - return false; - } - Identity identity = (Identity) object; - return identity.id.equals(id); - } + 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 String toString() { - return getClass().getSimpleName() + "[id=" + id + ",nickname=" + nickname + ",contexts=" + contexts + ",properties=" + properties + "]"; - } + public Identity removeTrust(OwnIdentity ownIdentity); }