Extract identity manager interface.
authorDavid ‘Bombe’ Roden <bombe@pterodactylus.net>
Sun, 10 Aug 2014 10:35:35 +0000 (12:35 +0200)
committerDavid ‘Bombe’ Roden <bombe@pterodactylus.net>
Sun, 10 Aug 2014 10:41:59 +0000 (12:41 +0200)
src/main/java/net/pterodactylus/sone/freenet/wot/IdentityManager.java
src/main/java/net/pterodactylus/sone/freenet/wot/IdentityManagerImpl.java [new file with mode: 0644]
src/main/java/net/pterodactylus/sone/main/SonePlugin.java
src/test/java/net/pterodactylus/sone/freenet/wot/IdentityManagerTest.java

index 5978169..99d757b 100644 (file)
-/*
- * Sone - IdentityManager.java - Copyright © 2010–2013 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
- * the Free Software Foundation, either version 3 of the License, or
- * (at your option) any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- * GNU General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License
- * along with this program.  If not, see <http://www.gnu.org/licenses/>.
- */
-
 package net.pterodactylus.sone.freenet.wot;
 
-import java.util.Collection;
-import java.util.HashMap;
-import java.util.HashSet;
-import java.util.Map;
 import java.util.Set;
-import java.util.logging.Level;
-import java.util.logging.Logger;
 
-import net.pterodactylus.sone.freenet.plugin.PluginException;
-import net.pterodactylus.util.logging.Logging;
-import net.pterodactylus.util.service.AbstractService;
+import net.pterodactylus.util.service.Service;
 
-import com.google.common.collect.Sets;
 import com.google.common.eventbus.EventBus;
-import com.google.inject.Inject;
 
 /**
- * The identity manager takes care of loading and storing identities, their
- * contexts, and properties. It does so in a way that does not expose errors via
- * exceptions but it only logs them and tries to return sensible defaults.
- * <p>
- * It is also responsible for polling identities from the Web of Trust plugin
- * and sending events to the {@link EventBus} when {@link Identity}s and
- * {@link OwnIdentity}s are discovered or disappearing.
+ * Connects to a {@link WebOfTrustConnector} and sends identity events to an
+ * {@link EventBus}.
  *
  * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
  */
-public class IdentityManager extends AbstractService {
-
-       /** The logger. */
-       private static final Logger logger = Logging.getLogger(IdentityManager.class);
-
-       /** The event bus. */
-       private final EventBus eventBus;
-
-       private final IdentityLoader identityLoader;
-
-       /** The Web of Trust connector. */
-       private final WebOfTrustConnector webOfTrustConnector;
-
-       /** The currently known own identities. */
-       private final Set<OwnIdentity> currentOwnIdentities = Sets.newHashSet();
-
-       /**
-        * Creates a new identity manager.
-        *
-        * @param eventBus
-        *            The event bus
-        * @param webOfTrustConnector
-        *            The Web of Trust connector
-        */
-       @Inject
-       public IdentityManager(EventBus eventBus, WebOfTrustConnector webOfTrustConnector, IdentityLoader identityLoader) {
-               super("Sone Identity Manager", false);
-               this.eventBus = eventBus;
-               this.webOfTrustConnector = webOfTrustConnector;
-               this.identityLoader = identityLoader;
-       }
-
-       //
-       // ACCESSORS
-       //
-
-       /**
-        * Returns whether the Web of Trust plugin could be reached during the last
-        * try.
-        *
-        * @return {@code true} if the Web of Trust plugin is connected,
-        *         {@code false} otherwise
-        */
-       public boolean isConnected() {
-               try {
-                       webOfTrustConnector.ping();
-                       return true;
-               } catch (PluginException pe1) {
-                       /* not connected, ignore. */
-                       return false;
-               }
-       }
-
-       /**
-        * Returns all own identities.
-        *
-        * @return All own identities
-        */
-       public Set<OwnIdentity> getAllOwnIdentities() {
-               synchronized (currentOwnIdentities) {
-                       return new HashSet<OwnIdentity>(currentOwnIdentities);
-               }
-       }
-
-       //
-       // SERVICE METHODS
-       //
-
-       /**
-        * {@inheritDoc}
-        */
-       @Override
-       protected void serviceRun() {
-               Map<OwnIdentity, Collection<Identity>> oldIdentities = new HashMap<OwnIdentity, Collection<Identity>>();
-
-               while (!shouldStop()) {
-                       try {
-                               Map<OwnIdentity, Collection<Identity>> currentIdentities = identityLoader.loadIdentities();
-
-                               IdentityChangeEventSender identityChangeEventSender = new IdentityChangeEventSender(eventBus, oldIdentities);
-                               identityChangeEventSender.detectChanges(currentIdentities);
-
-                               oldIdentities = currentIdentities;
-
-                               synchronized (currentOwnIdentities) {
-                                       currentOwnIdentities.clear();
-                                       currentOwnIdentities.addAll(currentIdentities.keySet());
-                               }
-                       } catch (WebOfTrustException wote1) {
-                               logger.log(Level.WARNING, "WoT has disappeared!", wote1);
-                       }
+public interface IdentityManager extends Service {
 
-                       /* wait a minute before checking again. */
-                       sleep(60 * 1000);
-               }
-       }
+       boolean isConnected();
+       Set<OwnIdentity> getAllOwnIdentities();
 
 }
diff --git a/src/main/java/net/pterodactylus/sone/freenet/wot/IdentityManagerImpl.java b/src/main/java/net/pterodactylus/sone/freenet/wot/IdentityManagerImpl.java
new file mode 100644 (file)
index 0000000..3946c04
--- /dev/null
@@ -0,0 +1,146 @@
+/*
+ * Sone - IdentityManager.java - Copyright © 2010–2013 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
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+package net.pterodactylus.sone.freenet.wot;
+
+import java.util.Collection;
+import java.util.HashMap;
+import java.util.HashSet;
+import java.util.Map;
+import java.util.Set;
+import java.util.logging.Level;
+import java.util.logging.Logger;
+
+import net.pterodactylus.sone.freenet.plugin.PluginException;
+import net.pterodactylus.util.logging.Logging;
+import net.pterodactylus.util.service.AbstractService;
+
+import com.google.common.collect.Sets;
+import com.google.common.eventbus.EventBus;
+import com.google.inject.Inject;
+
+/**
+ * The identity manager takes care of loading and storing identities, their
+ * contexts, and properties. It does so in a way that does not expose errors via
+ * exceptions but it only logs them and tries to return sensible defaults.
+ * <p>
+ * It is also responsible for polling identities from the Web of Trust plugin
+ * and sending events to the {@link EventBus} when {@link Identity}s and
+ * {@link OwnIdentity}s are discovered or disappearing.
+ *
+ * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
+ */
+public class IdentityManagerImpl extends AbstractService implements IdentityManager {
+
+       /** The logger. */
+       private static final Logger logger = Logging.getLogger(IdentityManagerImpl.class);
+
+       /** The event bus. */
+       private final EventBus eventBus;
+
+       private final IdentityLoader identityLoader;
+
+       /** The Web of Trust connector. */
+       private final WebOfTrustConnector webOfTrustConnector;
+
+       /** The currently known own identities. */
+       private final Set<OwnIdentity> currentOwnIdentities = Sets.newHashSet();
+
+       /**
+        * Creates a new identity manager.
+        *
+        * @param eventBus
+        *            The event bus
+        * @param webOfTrustConnector
+        *            The Web of Trust connector
+        */
+       @Inject
+       public IdentityManagerImpl(EventBus eventBus, WebOfTrustConnector webOfTrustConnector, IdentityLoader identityLoader) {
+               super("Sone Identity Manager", false);
+               this.eventBus = eventBus;
+               this.webOfTrustConnector = webOfTrustConnector;
+               this.identityLoader = identityLoader;
+       }
+
+       //
+       // ACCESSORS
+       //
+
+       /**
+        * Returns whether the Web of Trust plugin could be reached during the last
+        * try.
+        *
+        * @return {@code true} if the Web of Trust plugin is connected,
+        *         {@code false} otherwise
+        */
+       @Override
+       public boolean isConnected() {
+               try {
+                       webOfTrustConnector.ping();
+                       return true;
+               } catch (PluginException pe1) {
+                       /* not connected, ignore. */
+                       return false;
+               }
+       }
+
+       /**
+        * Returns all own identities.
+        *
+        * @return All own identities
+        */
+       @Override
+       public Set<OwnIdentity> getAllOwnIdentities() {
+               synchronized (currentOwnIdentities) {
+                       return new HashSet<OwnIdentity>(currentOwnIdentities);
+               }
+       }
+
+       //
+       // SERVICE METHODS
+       //
+
+       /**
+        * {@inheritDoc}
+        */
+       @Override
+       protected void serviceRun() {
+               Map<OwnIdentity, Collection<Identity>> oldIdentities = new HashMap<OwnIdentity, Collection<Identity>>();
+
+               while (!shouldStop()) {
+                       try {
+                               Map<OwnIdentity, Collection<Identity>> currentIdentities = identityLoader.loadIdentities();
+
+                               IdentityChangeEventSender identityChangeEventSender = new IdentityChangeEventSender(eventBus, oldIdentities);
+                               identityChangeEventSender.detectChanges(currentIdentities);
+
+                               oldIdentities = currentIdentities;
+
+                               synchronized (currentOwnIdentities) {
+                                       currentOwnIdentities.clear();
+                                       currentOwnIdentities.addAll(currentIdentities.keySet());
+                               }
+                       } catch (WebOfTrustException wote1) {
+                               logger.log(Level.WARNING, "WoT has disappeared!", wote1);
+                       }
+
+                       /* wait a minute before checking again. */
+                       sleep(60 * 1000);
+               }
+       }
+
+}
index 7322219..ce2cd40 100644 (file)
@@ -39,6 +39,7 @@ import net.pterodactylus.sone.freenet.PluginStoreConfigurationBackend;
 import net.pterodactylus.sone.freenet.plugin.PluginConnector;
 import net.pterodactylus.sone.freenet.wot.Context;
 import net.pterodactylus.sone.freenet.wot.IdentityManager;
+import net.pterodactylus.sone.freenet.wot.IdentityManagerImpl;
 import net.pterodactylus.sone.freenet.wot.WebOfTrustConnector;
 import net.pterodactylus.sone.web.WebInterface;
 import net.pterodactylus.util.config.Configuration;
@@ -234,7 +235,7 @@ public class SonePlugin implements FredPlugin, FredPluginFCP, FredPluginL10n, Fr
                                bind(getOptionalContextTypeLiteral()).toInstance(of(context));
                                bind(WebOfTrustConnector.class).in(Singleton.class);
                                bind(WebOfTrustUpdater.class).to(WebOfTrustUpdaterImpl.class).in(Singleton.class);
-                               bind(IdentityManager.class).in(Singleton.class);
+                               bind(IdentityManager.class).to(IdentityManagerImpl.class).in(Singleton.class);
                                bind(SonePlugin.class).toInstance(SonePlugin.this);
                                bind(FcpInterface.class).in(Singleton.class);
                                bind(Database.class).to(MemoryDatabase.class);
index 548e46b..83c696d 100644 (file)
@@ -1,6 +1,5 @@
 package net.pterodactylus.sone.freenet.wot;
 
-import static com.google.common.base.Optional.fromNullable;
 import static com.google.common.base.Optional.of;
 import static org.hamcrest.MatcherAssert.assertThat;
 import static org.hamcrest.Matchers.is;
@@ -14,7 +13,7 @@ import com.google.common.eventbus.EventBus;
 import org.junit.Test;
 
 /**
- * Unit test for {@link IdentityManager}.
+ * Unit test for {@link IdentityManagerImpl}.
  *
  * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
  */
@@ -22,7 +21,7 @@ public class IdentityManagerTest {
 
        private final EventBus eventBus = mock(EventBus.class);
        private final WebOfTrustConnector webOfTrustConnector = mock(WebOfTrustConnector.class);
-       private final IdentityManager identityManager = new IdentityManager(eventBus, webOfTrustConnector, new IdentityLoader(webOfTrustConnector, of(new Context("Test"))));
+       private final IdentityManager identityManager = new IdentityManagerImpl(eventBus, webOfTrustConnector, new IdentityLoader(webOfTrustConnector, of(new Context("Test"))));
 
        @Test
        public void identityManagerPingsWotConnector() throws PluginException {