2 * Sone - Identity.java - Copyright © 2010–2013 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 net.pterodactylus.sone.freenet.wot;
20 import java.util.Collection;
21 import java.util.Collections;
23 import java.util.Map.Entry;
26 import com.google.common.base.Function;
29 * Interface for web of trust identities, defining all functions that can be
30 * performed on an identity. An identity is only a container for identity data
31 * and will not perform any updating in the WebOfTrust plugin itself.
33 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
35 public interface Identity {
37 public static final Function<Identity, Set<String>> TO_CONTEXTS = new Function<Identity, Set<String>>() {
39 public Set<String> apply(Identity identity) {
40 return (identity == null) ? Collections.<String>emptySet() : identity.getContexts();
44 public static final Function<Identity, Collection<Map.Entry<String, String>>> TO_PROPERTIES = new Function<Identity, Collection<Entry<String, String>>>() {
46 public Collection<Entry<String, String>> apply(Identity input) {
47 return (input == null) ? Collections.<Map.Entry<String, String>>emptySet() : input.getProperties().entrySet();
52 * Returns the ID of the identity.
54 * @return The ID of the identity
56 public String getId();
59 * Returns the nickname of the identity.
61 * @return The nickname of the identity
63 public String getNickname();
66 * Returns the request URI of the identity.
68 * @return The request URI of the identity
70 public String getRequestUri();
73 * Returns all contexts of this identity.
75 * @return All contexts of this identity
77 public Set<String> getContexts();
80 * Returns whether this identity has the given context.
83 * The context to check for
84 * @return {@code true} if this identity has the given context,
85 * {@code false} otherwise
87 public boolean hasContext(String context);
90 * Adds the given context to this identity.
95 public void addContext(String context);
98 * Sets all contexts of this identity.
101 * All contexts of the identity
103 public void setContexts(Collection<String> contexts);
106 * Removes the given context from this identity.
109 * The context to remove
111 public void removeContext(String context);
114 * Returns all properties of this identity.
116 * @return All properties of this identity
118 public Map<String, String> getProperties();
121 * Returns the value of the property with the given name.
124 * The name of the property
125 * @return The value of the property
127 public String getProperty(String name);
130 * Sets the property with the given name to the given value.
133 * The name of the property
135 * The value of the property
137 public void setProperty(String name, String value);
140 * Sets all properties of this identity.
143 * The new properties of this identity
145 public void setProperties(Map<String, String> properties);
148 * Removes the property with the given name.
151 * The name of the property to remove
153 public void removeProperty(String name);
156 * Retrieves the trust that this identity receives from the given own
157 * identity. If this identity is not in the own identity’s trust tree, a
158 * {@link Trust} is returned that has all its elements set to {@code null}.
159 * If the trust can not be retrieved, {@code null} is returned.
162 * The own identity to get the trust for
163 * @return The trust assigned to this identity, or {@code null} if the trust
164 * could not be retrieved
166 public Trust getTrust(OwnIdentity ownIdentity);
169 * Sets the trust given by an own identity to this identity.
172 * The own identity that gave trust to this identity
174 * The trust given by the given own identity
176 public void setTrust(OwnIdentity ownIdentity, Trust trust);
179 * Removes trust assignment from the given own identity for this identity.
182 * The own identity that removed the trust assignment for this
185 public void removeTrust(OwnIdentity ownIdentity);