/*
- * 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
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 <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
+ * 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<String> contexts = Collections.synchronizedSet(new HashSet<String>());
-
- /** The properties of the identity. */
- private final Map<String, String> properties = Collections.synchronizedMap(new HashMap<String, String>());
-
- /**
- * 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<String> getContexts() {
- return Collections.unmodifiableSet(contexts);
- }
-
- /**
- * Sets all contexts of this identity.
- * <p>
- * This method is only called by the {@link IdentityManager}.
- *
- * @param contexts
- * All contexts of the identity
- */
- void setContexts(Set<String> contexts) {
- this.contexts.clear();
- this.contexts.addAll(contexts);
- }
+ public Set<String> getContexts();
/**
* Returns whether this identity has the given context.
* @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.
- * <p>
- * 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<String> contexts);
/**
* Removes the given context from this identity.
- * <p>
- * 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<String, String> getProperties() {
- synchronized (properties) {
- return Collections.unmodifiableMap(properties);
- }
- }
+ public Map<String, String> getProperties();
/**
- * Sets all properties of this identity.
- * <p>
- * 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<String, String> 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.
- * <p>
- * 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<String, String> properties);
/**
* Removes the property with the given name.
- * <p>
- * 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);
}
projects / Sone.git / blobdiff