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=1cf1644ee4f9bebccb1ea097b04cbaa486a91b33;hp=2909936ac2c65ccff8f6c3ed324a8bc59382fb28;hb=c9e306ac8e3ada846e87a0cc256a20fc148f381c;hpb=da6c0a57ac23f13e25a2347237ef3d9ac52ac332 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 2909936..1cf1644 100644 --- a/src/main/java/net/pterodactylus/sone/freenet/wot/Identity.java +++ b/src/main/java/net/pterodactylus/sone/freenet/wot/Identity.java @@ -17,197 +17,83 @@ 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. + * 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 */ -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()); - - /** 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; - } - - /** - * Returns the contexts of the identity. - * - * @return The contexts of the identity - * @throws PluginException - * if an error occured communicating with the Web of Trust - * plugin - */ - public Set getContexts() throws PluginException { - return getContexts(false); - } + public String getRequestUri(); /** - * Returns the contexts of the identity. + * Returns all contexts of this identity. * - * @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 + * @return All contexts of this identity */ - public Set getContexts(boolean forceReload) throws PluginException { - if (contexts.isEmpty() || forceReload) { - Set contexts = webOfTrustConnector.loadIdentityContexts(this); - this.contexts.clear(); - this.contexts.addAll(contexts); - } - return Collections.unmodifiableSet(contexts); - } + public Set getContexts(); /** - * Returns whether the identity contains the given context. + * 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 */ - public boolean hasContext(String context) { - return contexts.contains(context); - } + public boolean hasContext(String context); /** - * Returns the properties of the identity. + * Returns all properties of this identity. * - * @return The properties of the identity + * @return All properties of this identity */ - public Map getProperties() { - return Collections.unmodifiableMap(properties); - } + 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. + * 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 name - * The name of the property to set - * @param value - * The new value of the property - */ - public void setProperty(String name, String value) { - properties.put(name, value); - /* TODO - set property. */ - } - - /** - * Removes the property with the given name. - * - * @param name - * The name of the property to remove - */ - public void removeProperty(String name) { - properties.remove(name); - /* TODO - remove property. */ - } - - // - // OBJECT METHODS - // - - /** - * {@inheritDoc} - */ - @Override - public int hashCode() { - return id.hashCode(); - } - - /** - * {@inheritDoc} + * @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 boolean equals(Object object) { - if (!(object instanceof Identity)) { - return false; - } - Identity identity = (Identity) object; - return identity.id.equals(id); - } + public Trust getTrust(OwnIdentity ownIdentity); }