Remove unnecessary class.
[Sone.git] / src / main / java / net / pterodactylus / sone / core / WebOfTrustUpdater.java
index 59abc8e..b8060d4 100644 (file)
@@ -1,5 +1,5 @@
 /*
- * Sone - WebOfTrustUpdater.java - Copyright © 2012 David Roden
+ * Sone - WebOfTrustUpdater.java - Copyright © 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
@@ -17,6 +17,8 @@
 
 package net.pterodactylus.sone.core;
 
+import static com.google.common.base.Preconditions.checkNotNull;
+
 import java.util.concurrent.BlockingQueue;
 import java.util.concurrent.LinkedBlockingQueue;
 import java.util.logging.Level;
@@ -31,7 +33,8 @@ import net.pterodactylus.sone.freenet.wot.WebOfTrustConnector;
 import net.pterodactylus.sone.freenet.wot.WebOfTrustException;
 import net.pterodactylus.util.logging.Logging;
 import net.pterodactylus.util.service.AbstractService;
-import net.pterodactylus.util.validation.Validation;
+
+import com.google.inject.Inject;
 
 /**
  * Updates WebOfTrust identity data in a background thread because communicating
@@ -60,6 +63,7 @@ public class WebOfTrustUpdater extends AbstractService {
         * @param webOfTrustConnector
         *            The web of trust connector
         */
+       @Inject
        public WebOfTrustUpdater(WebOfTrustConnector webOfTrustConnector) {
                super("Trust Updater");
                this.webOfTrustConnector = webOfTrustConnector;
@@ -70,28 +74,6 @@ public class WebOfTrustUpdater extends AbstractService {
        //
 
        /**
-        * Retrieves the trust relation between the truster and the trustee. This
-        * method will return immediately and perform a trust update in the
-        * background.
-        *
-        * @param truster
-        *            The identity giving the trust
-        * @param trustee
-        *            The identity receiving the trust
-        */
-       public void getTrust(OwnIdentity truster, Identity trustee) {
-               GetTrustJob getTrustJob = new GetTrustJob(truster, trustee);
-               if (!updateJobs.contains(getTrustJob)) {
-                       logger.log(Level.FINER, "Adding Trust Update Job: " + getTrustJob);
-                       try {
-                               updateJobs.put(getTrustJob);
-                       } catch (InterruptedException ie1) {
-                               /* the queue is unbounded so it should never block. */
-                       }
-               }
-       }
-
-       /**
         * Updates the trust relation between the truster and the trustee. This
         * method will return immediately and perform a trust update in the
         * background.
@@ -183,6 +165,61 @@ public class WebOfTrustUpdater extends AbstractService {
                return false;
        }
 
+       /**
+        * Removes the given context from the given own identity.
+        *
+        * @param ownIdentity
+        *            The own identity to remove the context from
+        * @param context
+        *            The context to remove
+        */
+       public void removeContext(OwnIdentity ownIdentity, String context) {
+               RemoveContextJob removeContextJob = new RemoveContextJob(ownIdentity, context);
+               if (!updateJobs.contains(removeContextJob)) {
+                       logger.log(Level.FINER, "Adding Context Job: " + removeContextJob);
+                       try {
+                               updateJobs.put(removeContextJob);
+                       } catch (InterruptedException ie1) {
+                               /* the queue is unbounded so it should never block. */
+                       }
+               }
+       }
+
+       /**
+        * Sets a property on the given own identity.
+        *
+        * @param ownIdentity
+        *            The own identity to set the property on
+        * @param propertyName
+        *            The name of the property to set
+        * @param propertyValue
+        *            The value of the property to set
+        */
+       public void setProperty(OwnIdentity ownIdentity, String propertyName, String propertyValue) {
+               SetPropertyJob setPropertyJob = new SetPropertyJob(ownIdentity, propertyName, propertyValue);
+               if (updateJobs.contains(setPropertyJob)) {
+                       updateJobs.remove(setPropertyJob);
+               }
+               logger.log(Level.FINER, "Adding Property Job: " + setPropertyJob);
+               try {
+                       updateJobs.put(setPropertyJob);
+               } catch (InterruptedException e) {
+                       /* the queue is unbounded so it should never block. */
+               }
+       }
+
+       /**
+        * Removes a property from the given own identity.
+        *
+        * @param ownIdentity
+        *            The own identity to remove the property from
+        * @param propertyName
+        *            The name of the property to remove
+        */
+       public void removeProperty(OwnIdentity ownIdentity, String propertyName) {
+               setProperty(ownIdentity, propertyName, null);
+       }
+
        //
        // SERVICE METHODS
        //
@@ -257,7 +294,6 @@ public class WebOfTrustUpdater extends AbstractService {
                 *
                 * @return {@code true} if this job finished successfully, {@code false}
                 *         otherwise
-                *
                 * @see WebOfTrustUpdater#stop()
                 */
                @SuppressWarnings("synthetic-access")
@@ -296,30 +332,122 @@ public class WebOfTrustUpdater extends AbstractService {
        }
 
        /**
-        * Base class for WebOfTrust trust update jobs.
+        * Update job that sets the trust relation between two identities.
         *
         * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
         */
-       private class WebOfTrustTrustUpdateJob extends WebOfTrustUpdateJob {
+       private class SetTrustJob extends WebOfTrustUpdateJob {
 
                /** The identity giving the trust. */
-               protected final OwnIdentity truster;
+               private final OwnIdentity truster;
 
                /** The identity receiving the trust. */
-               protected final Identity trustee;
+               private final Identity trustee;
+
+               /** The score of the relation. */
+               private final Integer score;
+
+               /** The comment of the relation. */
+               private final String comment;
 
                /**
-                * Creates a new trust update job.
+                * Creates a new set trust job.
                 *
                 * @param truster
                 *            The identity giving the trust
                 * @param trustee
                 *            The identity receiving the trust
+                * @param score
+                *            The score of the trust (from -100 to 100, may be
+                *            {@code null} to remote the trust relation completely)
+                * @param comment
+                *            The comment of the trust relation
                 */
-               @SuppressWarnings("synthetic-access")
-               public WebOfTrustTrustUpdateJob(OwnIdentity truster, Identity trustee) {
+               public SetTrustJob(OwnIdentity truster, Identity trustee, Integer score, String comment) {
                        this.truster = truster;
                        this.trustee = trustee;
+                       this.score = score;
+                       this.comment = comment;
+               }
+
+               /**
+                * {@inheritDoc}
+                */
+               @Override
+               @SuppressWarnings("synthetic-access")
+               public void run() {
+                       try {
+                               if (score != null) {
+                                       if (trustee instanceof DefaultIdentity) {
+                                               ((DefaultIdentity) trustee).setTrust(truster, new Trust(score, null, 0));
+                                       }
+                                       webOfTrustConnector.setTrust(truster, trustee, score, comment);
+                               } else {
+                                       if (trustee instanceof DefaultIdentity) {
+                                               ((DefaultIdentity) trustee).setTrust(truster, null);
+                                       }
+                                       webOfTrustConnector.removeTrust(truster, trustee);
+                               }
+                               finish(true);
+                       } catch (WebOfTrustException wote1) {
+                               logger.log(Level.WARNING, "Could not set Trust value for " + truster + " -> " + trustee + " to " + score + " (" + comment + ")!", wote1);
+                               finish(false);
+                       }
+               }
+
+               //
+               // OBJECT METHODS
+               //
+
+               /** {@inheritDoc} */
+               @Override
+               public boolean equals(Object object) {
+                       if ((object == null) || !object.getClass().equals(getClass())) {
+                               return false;
+                       }
+                       SetTrustJob updateJob = (SetTrustJob) object;
+                       return ((truster == null) ? (updateJob.truster == null) : updateJob.truster.equals(truster)) && ((trustee == null) ? (updateJob.trustee == null) : updateJob.trustee.equals(trustee));
+               }
+
+               /** {@inheritDoc} */
+               @Override
+               public int hashCode() {
+                       return getClass().hashCode() ^ ((truster == null) ? 0 : truster.hashCode()) ^ ((trustee == null) ? 0 : trustee.hashCode());
+               }
+
+               /** {@inheritDoc} */
+               @Override
+               public String toString() {
+                       return String.format("%s[truster=%s,trustee=%s]", getClass().getSimpleName(), (truster == null) ? null : truster.getId(), (trustee == null) ? null : trustee.getId());
+               }
+
+       }
+
+       /**
+        * Base class for context updates of an {@link OwnIdentity}.
+        *
+        * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
+        */
+       private class WebOfTrustContextUpdateJob extends WebOfTrustUpdateJob {
+
+               /** The own identity whose contexts to manage. */
+               protected final OwnIdentity ownIdentity;
+
+               /** The context to update. */
+               protected final String context;
+
+               /**
+                * Creates a new context update job.
+                *
+                * @param ownIdentity
+                *            The own identity to update
+                * @param context
+                *            The context to update
+                */
+               @SuppressWarnings("synthetic-access")
+               public WebOfTrustContextUpdateJob(OwnIdentity ownIdentity, String context) {
+                       this.ownIdentity = checkNotNull(ownIdentity, "ownIdentity must not be null");
+                       this.context = checkNotNull(context, "context must not be null");
                }
 
                //
@@ -334,8 +462,8 @@ public class WebOfTrustUpdater extends AbstractService {
                        if ((object == null) || !object.getClass().equals(getClass())) {
                                return false;
                        }
-                       WebOfTrustTrustUpdateJob updateJob = (WebOfTrustTrustUpdateJob) object;
-                       return ((truster == null) ? (updateJob.truster == null) : updateJob.truster.equals(truster)) && ((trustee == null) ? (updateJob.trustee == null) : updateJob.trustee.equals(trustee));
+                       WebOfTrustContextUpdateJob updateJob = (WebOfTrustContextUpdateJob) object;
+                       return updateJob.ownIdentity.equals(ownIdentity) && updateJob.context.equals(context);
                }
 
                /**
@@ -343,7 +471,7 @@ public class WebOfTrustUpdater extends AbstractService {
                 */
                @Override
                public int hashCode() {
-                       return getClass().hashCode() ^ ((truster == null) ? 0 : truster.hashCode()) ^ ((trustee == null) ? 0 : trustee.hashCode());
+                       return getClass().hashCode() ^ ownIdentity.hashCode() ^ context.hashCode();
                }
 
                /**
@@ -351,41 +479,28 @@ public class WebOfTrustUpdater extends AbstractService {
                 */
                @Override
                public String toString() {
-                       return String.format("%s[truster=%s,trustee=%s]", getClass().getSimpleName(), (truster == null) ? null : truster.getId(), (trustee == null) ? null : trustee.getId());
+                       return String.format("%s[ownIdentity=%s,context=%s]", getClass().getSimpleName(), ownIdentity, context);
                }
 
        }
 
        /**
-        * Update job that sets the trust relation between two identities.
+        * Job that adds a context to an {@link OwnIdentity}.
         *
         * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
         */
-       private class SetTrustJob extends WebOfTrustTrustUpdateJob {
-
-               /** The score of the relation. */
-               private final Integer score;
-
-               /** The comment of the relation. */
-               private final String comment;
+       private class AddContextJob extends WebOfTrustContextUpdateJob {
 
                /**
-                * Creates a new set trust job.
+                * Creates a new add-context job.
                 *
-                * @param truster
-                *            The identity giving the trust
-                * @param trustee
-                *            The identity receiving the trust
-                * @param score
-                *            The score of the trust (from -100 to 100, may be
-                *            {@code null} to remote the trust relation completely)
-                * @param comment
-                *            The comment of the trust relation
+                * @param ownIdentity
+                *            The own identity whose contexts to manage
+                * @param context
+                *            The context to add
                 */
-               public SetTrustJob(OwnIdentity truster, Identity trustee, Integer score, String comment) {
-                       super(truster, trustee);
-                       this.score = score;
-                       this.comment = comment;
+               public AddContextJob(OwnIdentity ownIdentity, String context) {
+                       super(ownIdentity, context);
                }
 
                /**
@@ -395,20 +510,11 @@ public class WebOfTrustUpdater extends AbstractService {
                @SuppressWarnings("synthetic-access")
                public void run() {
                        try {
-                               if (score != null) {
-                                       if (trustee instanceof DefaultIdentity) {
-                                               ((DefaultIdentity) trustee).setTrust(truster, new Trust(score, null, 0));
-                                       }
-                                       webOfTrustConnector.setTrust(truster, trustee, score, comment);
-                               } else {
-                                       if (trustee instanceof DefaultIdentity) {
-                                               ((DefaultIdentity) trustee).setTrust(truster, null);
-                                       }
-                                       webOfTrustConnector.removeTrust(truster, trustee);
-                               }
+                               webOfTrustConnector.addContext(ownIdentity, context);
+                               ownIdentity.addContext(context);
                                finish(true);
-                       } catch (WebOfTrustException wote1) {
-                               logger.log(Level.WARNING, "Could not set Trust value for " + truster + " -> " + trustee + " to " + score + " (" + comment + ")!", wote1);
+                       } catch (PluginException pe1) {
+                               logger.log(Level.WARNING, String.format("Could not add Context “%2$s” to Own Identity %1$s!", ownIdentity, context), pe1);
                                finish(false);
                        }
                }
@@ -416,22 +522,22 @@ public class WebOfTrustUpdater extends AbstractService {
        }
 
        /**
-        * Update job that retrieves the trust relation between two identities.
+        * Job that removes a context from an {@link OwnIdentity}.
         *
         * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
         */
-       private class GetTrustJob extends WebOfTrustTrustUpdateJob {
+       private class RemoveContextJob extends WebOfTrustContextUpdateJob {
 
                /**
-                * Creates a new trust update job.
+                * Creates a new remove-context job.
                 *
-                * @param truster
-                *            The identity giving the trust
-                * @param trustee
-                *            The identity receiving the trust
+                * @param ownIdentity
+                *            The own identity whose contexts to manage
+                * @param context
+                *            The context to remove
                 */
-               public GetTrustJob(OwnIdentity truster, Identity trustee) {
-                       super(truster, trustee);
+               public RemoveContextJob(OwnIdentity ownIdentity, String context) {
+                       super(ownIdentity, context);
                }
 
                /**
@@ -441,13 +547,11 @@ public class WebOfTrustUpdater extends AbstractService {
                @SuppressWarnings("synthetic-access")
                public void run() {
                        try {
-                               Trust trust = webOfTrustConnector.getTrust(truster, trustee);
-                               if (trustee instanceof DefaultIdentity) {
-                                       ((DefaultIdentity) trustee).setTrust(truster, trust);
-                               }
+                               webOfTrustConnector.removeContext(ownIdentity, context);
+                               ownIdentity.removeContext(context);
                                finish(true);
                        } catch (PluginException pe1) {
-                               logger.log(Level.WARNING, "Could not get Trust value for " + truster + " -> " + trustee + "!", pe1);
+                               logger.log(Level.WARNING, String.format("Could not remove Context “%2$s” to Own Identity %1$s!", ownIdentity, context), pe1);
                                finish(false);
                        }
                }
@@ -455,31 +559,30 @@ public class WebOfTrustUpdater extends AbstractService {
        }
 
        /**
-        * Base class for context updates of an {@link OwnIdentity}.
+        * Base class for update jobs that deal with properties.
         *
         * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
         */
-       private class WebOfTrustContextUpdateJob extends WebOfTrustUpdateJob {
+       private class WebOfTrustPropertyUpdateJob extends WebOfTrustUpdateJob {
 
-               /** The own identity whose contexts to manage. */
+               /** The own identity to update properties on. */
                protected final OwnIdentity ownIdentity;
 
-               /** The context to update. */
-               protected final String context;
+               /** The name of the property to update. */
+               protected final String propertyName;
 
                /**
-                * Creates a new context update job.
+                * Creates a new property update job.
                 *
                 * @param ownIdentity
-                *            The own identity to update
-                * @param context
-                *            The context to update
+                *            The own identity to update the property on
+                * @param propertyName
+                *            The name of the property to update
                 */
                @SuppressWarnings("synthetic-access")
-               public WebOfTrustContextUpdateJob(OwnIdentity ownIdentity, String context) {
-                       Validation.begin().isNotNull("OwnIdentity", ownIdentity).isNotNull("Context", context).check();
+               public WebOfTrustPropertyUpdateJob(OwnIdentity ownIdentity, String propertyName) {
                        this.ownIdentity = ownIdentity;
-                       this.context = context;
+                       this.propertyName = propertyName;
                }
 
                //
@@ -494,8 +597,8 @@ public class WebOfTrustUpdater extends AbstractService {
                        if ((object == null) || !object.getClass().equals(getClass())) {
                                return false;
                        }
-                       WebOfTrustContextUpdateJob updateJob = (WebOfTrustContextUpdateJob) object;
-                       return updateJob.ownIdentity.equals(ownIdentity) && updateJob.context.equals(context);
+                       WebOfTrustPropertyUpdateJob updateJob = (WebOfTrustPropertyUpdateJob) object;
+                       return updateJob.ownIdentity.equals(ownIdentity) && updateJob.propertyName.equals(propertyName);
                }
 
                /**
@@ -503,7 +606,7 @@ public class WebOfTrustUpdater extends AbstractService {
                 */
                @Override
                public int hashCode() {
-                       return getClass().hashCode() ^ ownIdentity.hashCode() ^ context.hashCode();
+                       return getClass().hashCode() ^ ownIdentity.hashCode() ^ propertyName.hashCode();
                }
 
                /**
@@ -511,28 +614,34 @@ public class WebOfTrustUpdater extends AbstractService {
                 */
                @Override
                public String toString() {
-                       return String.format("%s[ownIdentity=%s,context=%s]", getClass().getSimpleName(), ownIdentity, context);
+                       return String.format("%s[ownIdentity=%s,propertyName=%s]", getClass().getSimpleName(), ownIdentity, propertyName);
                }
 
        }
 
        /**
-        * Job that adds a context to an {@link OwnIdentity}.
+        * WebOfTrust update job that sets a property on an {@link OwnIdentity}.
         *
         * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
         */
-       private class AddContextJob extends WebOfTrustContextUpdateJob {
+       private class SetPropertyJob extends WebOfTrustPropertyUpdateJob {
+
+               /** The value of the property to set. */
+               private final String propertyValue;
 
                /**
-                * Creates a new add-context job.
+                * Creates a new set-property job.
                 *
                 * @param ownIdentity
-                *            The own identity whose contexts to manage
-                * @param context
-                *            The context to add
+                *            The own identity to set the property on
+                * @param propertyName
+                *            The name of the property to set
+                * @param propertyValue
+                *            The value of the property to set
                 */
-               public AddContextJob(OwnIdentity ownIdentity, String context) {
-                       super(ownIdentity, context);
+               public SetPropertyJob(OwnIdentity ownIdentity, String propertyName, String propertyValue) {
+                       super(ownIdentity, propertyName);
+                       this.propertyValue = propertyValue;
                }
 
                /**
@@ -542,11 +651,16 @@ public class WebOfTrustUpdater extends AbstractService {
                @SuppressWarnings("synthetic-access")
                public void run() {
                        try {
-                               webOfTrustConnector.addContext(ownIdentity, context);
-                               ownIdentity.addContext(context);
+                               if (propertyValue == null) {
+                                       webOfTrustConnector.removeProperty(ownIdentity, propertyName);
+                                       ownIdentity.removeProperty(propertyName);
+                               } else {
+                                       webOfTrustConnector.setProperty(ownIdentity, propertyName, propertyValue);
+                                       ownIdentity.setProperty(propertyName, propertyValue);
+                               }
                                finish(true);
                        } catch (PluginException pe1) {
-                               logger.log(Level.WARNING, String.format("Could not add Context “%2$s” to Own Identity %1$s!", ownIdentity, context), pe1);
+                               logger.log(Level.WARNING, String.format("Could not set Property “%2$s” to “%3$s” on Own Identity %1$s!", ownIdentity, propertyName, propertyValue), pe1);
                                finish(false);
                        }
                }