2 * Sone - Identity.java - Copyright © 2010–2019 David Roden
4 * This program is free software: you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License as published by
6 * the Free Software Foundation, either version 3 of the License, or
7 * (at your option) any later version.
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
14 * You should have received a copy of the GNU General Public License
15 * along with this program. If not, see <http://www.gnu.org/licenses/>.
18 package de.todesbaum.util.freenet.fcp2.wot;
20 import java.util.Collection;
25 * Interface for web of trust identities, defining all functions that can be
26 * performed on an identity. An identity is only a container for identity data
27 * and will not perform any updating in the WebOfTrust plugin itself.
29 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
31 public interface Identity {
34 * Returns the ID of the identity.
36 * @return The ID of the identity
38 public String getId();
41 * Returns the nickname of the identity.
43 * @return The nickname of the identity
45 public String getNickname();
48 * Returns the request URI of the identity.
50 * @return The request URI of the identity
52 public String getRequestUri();
55 * Returns all contexts of this identity.
57 * @return All contexts of this identity
59 public Set<String> getContexts();
62 * Returns whether this identity has the given context.
65 * The context to check for
66 * @return {@code true} if this identity has the given context,
67 * {@code false} otherwise
69 public boolean hasContext(String context);
72 * Adds the given context to this identity.
77 public void addContext(String context);
80 * Sets all contexts of this identity.
83 * All contexts of the identity
85 public void setContexts(Collection<String> contexts);
88 * Removes the given context from this identity.
91 * The context to remove
93 public void removeContext(String context);
96 * Returns all properties of this identity.
98 * @return All properties of this identity
100 public Map<String, String> getProperties();
103 * Returns the value of the property with the given name.
106 * The name of the property
107 * @return The value of the property
109 public String getProperty(String name);
112 * Sets the property with the given name to the given value.
115 * The name of the property
117 * The value of the property
119 public void setProperty(String name, String value);
122 * Sets all properties of this identity.
125 * The new properties of this identity
127 public void setProperties(Map<String, String> properties);
130 * Removes the property with the given name.
133 * The name of the property to remove
135 public void removeProperty(String name);
138 * Retrieves the trust that this identity receives from the given own
139 * identity. If this identity is not in the own identity’s trust tree, a
140 * {@link Trust} is returned that has all its elements set to {@code null}.
141 * If the trust can not be retrieved, {@code null} is returned.
144 * The own identity to get the trust for
145 * @return The trust assigned to this identity, or {@code null} if the trust
146 * could not be retrieved
148 public Trust getTrust(OwnIdentity ownIdentity);
151 * Sets the trust given by an own identity to this identity.
154 * The own identity that gave trust to this identity
156 * The trust given by the given own identity
158 public void setTrust(OwnIdentity ownIdentity, Trust trust);
161 * Removes trust assignment from the given own identity for this identity.
164 * The own identity that removed the trust assignment for this
167 public void removeTrust(OwnIdentity ownIdentity);