/*
- * 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
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;
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.common.annotations.VisibleForTesting;
+import com.google.inject.Inject;
/**
* Updates WebOfTrust identity data in a background thread because communicating
* Creates a new trust updater.
*
* @param webOfTrustConnector
- * The web of trust connector
+ * The web of trust connector
*/
+ @Inject
public WebOfTrustUpdater(WebOfTrustConnector webOfTrustConnector) {
super("Trust Updater");
this.webOfTrustConnector = webOfTrustConnector;
//
/**
- * Updates the trust relation between the truster and the trustee. This
- * method will return immediately and perform a trust update in the
- * background.
+ * Updates 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
+ * The identity giving the trust
* @param trustee
- * The identity receiving the trust
+ * The identity receiving the trust
* @param score
- * The new level of trust (from -100 to 100, may be {@code null}
- * to remove the trust completely)
+ * The new level of trust (from -100 to 100, may be {@code null} to remove
+ * the trust completely)
* @param comment
- * The comment of the trust relation
+ * The comment of the trust relation
*/
public void setTrust(OwnIdentity truster, Identity trustee, Integer score, String comment) {
SetTrustJob setTrustJob = new SetTrustJob(truster, trustee, score, comment);
}
/**
- * Adds the given context to the given own identity.
+ * Adds the given context to the given own identity, waiting for completion of
+ * the operation.
*
* @param ownIdentity
- * The own identity to add the context to
+ * The own identity to add the context to
* @param context
- * The context to add
- */
- public void addContext(OwnIdentity ownIdentity, String context) {
- addContextWait(ownIdentity, context, false);
- }
-
- /**
- * Adds the given context to the given own identity, waiting for completion
- * of the operation.
- *
- * @param ownIdentity
- * The own identity to add the context to
- * @param context
- * The context to add
+ * The context to add
* @return {@code true} if the context was added successfully, {@code false}
* otherwise
*/
public boolean addContextWait(OwnIdentity ownIdentity, String context) {
- return addContextWait(ownIdentity, context, true);
- }
-
- /**
- * Adds the given context to the given own identity, waiting for completion
- * of the operation.
- *
- * @param ownIdentity
- * The own identity to add the context to
- * @param context
- * The context to add
- * @param wait
- * {@code true} to wait for the end of the operation,
- * {@code false} to return immediately
- * @return {@code true} if the context was added successfully, {@code false}
- * if the context was not added successfully, or if the job should
- * not wait for completion
- */
- private boolean addContextWait(OwnIdentity ownIdentity, String context, boolean wait) {
AddContextJob addContextJob = new AddContextJob(ownIdentity, context);
if (!updateJobs.contains(addContextJob)) {
logger.log(Level.FINER, "Adding Context Job: " + addContextJob);
} catch (InterruptedException ie1) {
/* the queue is unbounded so it should never block. */
}
- if (wait) {
- return addContextJob.waitForCompletion();
- }
- } else if (wait) {
+ return addContextJob.waitForCompletion();
+ } else {
for (WebOfTrustUpdateJob updateJob : updateJobs) {
if (updateJob.equals(addContextJob)) {
return updateJob.waitForCompletion();
* Removes the given context from the given own identity.
*
* @param ownIdentity
- * The own identity to remove the context from
+ * The own identity to remove the context from
* @param context
- * The context to remove
+ * The context to remove
*/
public void removeContext(OwnIdentity ownIdentity, String context) {
RemoveContextJob removeContextJob = new RemoveContextJob(ownIdentity, context);
* Sets a property on the given own identity.
*
* @param ownIdentity
- * The own identity to set the property on
+ * The own identity to set the property on
* @param propertyName
- * The name of the property to set
+ * The name of the property to set
* @param propertyValue
- * The value of the property to set
+ * The value of the property to set
*/
public void setProperty(OwnIdentity ownIdentity, String propertyName, String propertyValue) {
SetPropertyJob setPropertyJob = new SetPropertyJob(ownIdentity, propertyName, propertyValue);
* Removes a property from the given own identity.
*
* @param ownIdentity
- * The own identity to remove the property from
+ * The own identity to remove the property from
* @param propertyName
- * The name of the property to remove
+ * The name of the property to remove
*/
public void removeProperty(OwnIdentity ownIdentity, String propertyName) {
setProperty(ownIdentity, propertyName, null);
// SERVICE METHODS
//
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
protected void serviceRun() {
while (!shouldStop()) {
try {
WebOfTrustUpdateJob updateJob = updateJobs.take();
- if (shouldStop() || (updateJob == stopJob)) {
+ if (shouldStop()) {
break;
}
logger.log(Level.FINE, "Running Trust Update Job: " + updateJob);
}
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
protected void serviceStop() {
try {
*
* @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
*/
- private class WebOfTrustUpdateJob {
+ @VisibleForTesting
+ class WebOfTrustUpdateJob implements Runnable {
/** Object for synchronization. */
@SuppressWarnings("hiding")
/**
* Performs the actual update operation.
- * <p>
+ * <p/>
* The implementation of this class does nothing.
*/
+ @Override
public void run() {
/* does nothing. */
}
/**
- * Waits for completion of this job or stopping of the WebOfTrust
- * updater.
+ * Waits for completion of this job or stopping of the WebOfTrust updater.
*
* @return {@code true} if this job finished successfully, {@code false}
* otherwise
- *
* @see WebOfTrustUpdater#stop()
*/
@SuppressWarnings("synthetic-access")
* Signals that this job has finished.
*
* @param success
- * {@code true} if this job finished successfully,
- * {@code false} otherwise
+ * {@code true} if this job finished successfully, {@code false} otherwise
*/
protected void finish(boolean success) {
synchronized (syncObject) {
}
/**
- * 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 {
+ @VisibleForTesting
+ 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;
-
- /**
- * Creates a new trust update job.
- *
- * @param truster
- * The identity giving the trust
- * @param trustee
- * The identity receiving the trust
- */
- @SuppressWarnings("synthetic-access")
- public WebOfTrustTrustUpdateJob(OwnIdentity truster, Identity trustee) {
- this.truster = truster;
- this.trustee = trustee;
- }
-
- //
- // OBJECT METHODS
- //
-
- /**
- * {@inheritDoc}
- */
- @Override
- public boolean equals(Object object) {
- 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));
- }
-
- /**
- * {@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());
- }
-
- }
-
- /**
- * Update job that sets the trust relation between two identities.
- *
- * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
- */
- private class SetTrustJob extends WebOfTrustTrustUpdateJob {
+ private final Identity trustee;
/** The score of the relation. */
private final Integer score;
* Creates a new set trust job.
*
* @param truster
- * The identity giving the trust
+ * The identity giving the trust
* @param trustee
- * The identity receiving the trust
+ * 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)
+ * 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
+ * The comment of the trust relation
*/
public SetTrustJob(OwnIdentity truster, Identity trustee, Integer score, String comment) {
- super(truster, trustee);
+ this.truster = checkNotNull(truster, "truster must not be null");
+ this.trustee = checkNotNull(trustee, "trustee must not be null");
this.score = score;
this.comment = comment;
}
- /**
- * {@inheritDoc}
- */
+ /** {@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);
+ trustee.setTrust(truster, new Trust(score, null, 0));
} else {
- if (trustee instanceof DefaultIdentity) {
- ((DefaultIdentity) trustee).setTrust(truster, null);
- }
webOfTrustConnector.removeTrust(truster, trustee);
+ trustee.removeTrust(truster);
}
finish(true);
} catch (WebOfTrustException wote1) {
}
}
+ //
+ // OBJECT METHODS
+ //
+
+ /** {@inheritDoc} */
+ @Override
+ public boolean equals(Object object) {
+ if ((object == null) || !object.getClass().equals(getClass())) {
+ return false;
+ }
+ SetTrustJob updateJob = (SetTrustJob) object;
+ return updateJob.truster.equals(truster) && updateJob.trustee.equals(trustee);
+ }
+
+ /** {@inheritDoc} */
+ @Override
+ public int hashCode() {
+ return getClass().hashCode() ^ truster.hashCode() ^ trustee.hashCode();
+ }
+
+ /** {@inheritDoc} */
+ @Override
+ public String toString() {
+ return String.format("%s[truster=%s,trustee=%s]", getClass().getSimpleName(), truster.getId(), trustee.getId());
+ }
+
}
/**
*
* @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
*/
- private class WebOfTrustContextUpdateJob extends WebOfTrustUpdateJob {
+ @VisibleForTesting
+ class WebOfTrustContextUpdateJob extends WebOfTrustUpdateJob {
/** The own identity whose contexts to manage. */
protected final OwnIdentity ownIdentity;
* Creates a new context update job.
*
* @param ownIdentity
- * The own identity to update
+ * The own identity to update
* @param context
- * The context to update
+ * The context to update
*/
@SuppressWarnings("synthetic-access")
public WebOfTrustContextUpdateJob(OwnIdentity ownIdentity, String context) {
- Validation.begin().isNotNull("OwnIdentity", ownIdentity).isNotNull("Context", context).check();
- this.ownIdentity = ownIdentity;
- this.context = context;
+ this.ownIdentity = checkNotNull(ownIdentity, "ownIdentity must not be null");
+ this.context = checkNotNull(context, "context must not be null");
}
//
// OBJECT METHODS
//
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public boolean equals(Object object) {
if ((object == null) || !object.getClass().equals(getClass())) {
return updateJob.ownIdentity.equals(ownIdentity) && updateJob.context.equals(context);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public int hashCode() {
return getClass().hashCode() ^ ownIdentity.hashCode() ^ context.hashCode();
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public String toString() {
return String.format("%s[ownIdentity=%s,context=%s]", getClass().getSimpleName(), ownIdentity, context);
*
* @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
*/
- private class AddContextJob extends WebOfTrustContextUpdateJob {
+ @VisibleForTesting
+ class AddContextJob extends WebOfTrustContextUpdateJob {
/**
* Creates a new add-context job.
*
* @param ownIdentity
- * The own identity whose contexts to manage
+ * The own identity whose contexts to manage
* @param context
- * The context to add
+ * The context to add
*/
public AddContextJob(OwnIdentity ownIdentity, String context) {
super(ownIdentity, context);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
@SuppressWarnings("synthetic-access")
public void run() {
*
* @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
*/
- private class RemoveContextJob extends WebOfTrustContextUpdateJob {
+ @VisibleForTesting
+ class RemoveContextJob extends WebOfTrustContextUpdateJob {
/**
* Creates a new remove-context job.
*
* @param ownIdentity
- * The own identity whose contexts to manage
+ * The own identity whose contexts to manage
* @param context
- * The context to remove
+ * The context to remove
*/
public RemoveContextJob(OwnIdentity ownIdentity, String context) {
super(ownIdentity, context);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
@SuppressWarnings("synthetic-access")
public void run() {
}
/**
- * Base class for update jobs that deal with properties.
+ * WebOfTrust update job that sets a property on an {@link OwnIdentity}.
*
* @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
*/
- private class WebOfTrustPropertyUpdateJob extends WebOfTrustUpdateJob {
+ @VisibleForTesting
+ class SetPropertyJob extends WebOfTrustUpdateJob {
/** The own identity to update properties on. */
- protected final OwnIdentity ownIdentity;
+ private final OwnIdentity ownIdentity;
/** The name of the property to update. */
- protected final String propertyName;
-
- /**
- * Creates a new property update job.
- *
- * @param ownIdentity
- * The own identity to update the property on
- * @param propertyName
- * The name of the property to update
- */
- @SuppressWarnings("synthetic-access")
- public WebOfTrustPropertyUpdateJob(OwnIdentity ownIdentity, String propertyName) {
- this.ownIdentity = ownIdentity;
- this.propertyName = propertyName;
- }
-
- //
- // OBJECT METHODS
- //
-
- /**
- * {@inheritDoc}
- */
- @Override
- public boolean equals(Object object) {
- if ((object == null) || !object.getClass().equals(getClass())) {
- return false;
- }
- WebOfTrustPropertyUpdateJob updateJob = (WebOfTrustPropertyUpdateJob) object;
- return updateJob.ownIdentity.equals(ownIdentity) && updateJob.propertyName.equals(propertyName);
- }
-
- /**
- * {@inheritDoc}
- */
- @Override
- public int hashCode() {
- return getClass().hashCode() ^ ownIdentity.hashCode() ^ propertyName.hashCode();
- }
-
- /**
- * {@inheritDoc}
- */
- @Override
- public String toString() {
- return String.format("%s[ownIdentity=%s,propertyName=%s]", getClass().getSimpleName(), ownIdentity, propertyName);
- }
-
- }
-
- /**
- * WebOfTrust update job that sets a property on an {@link OwnIdentity}.
- *
- * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
- */
- private class SetPropertyJob extends WebOfTrustPropertyUpdateJob {
+ private final String propertyName;
/** The value of the property to set. */
private final String propertyValue;
* Creates a new set-property job.
*
* @param ownIdentity
- * The own identity to set the property on
+ * The own identity to set the property on
* @param propertyName
- * The name of the property to set
+ * The name of the property to set
* @param propertyValue
- * The value of the property to set
+ * The value of the property to set
*/
public SetPropertyJob(OwnIdentity ownIdentity, String propertyName, String propertyValue) {
- super(ownIdentity, propertyName);
+ this.ownIdentity = ownIdentity;
+ this.propertyName = propertyName;
this.propertyValue = propertyValue;
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
@SuppressWarnings("synthetic-access")
public void run() {
}
}
+ //
+ // OBJECT METHODS
+ //
+
+ /** {@inheritDoc} */
+ @Override
+ public boolean equals(Object object) {
+ if ((object == null) || !object.getClass().equals(getClass())) {
+ return false;
+ }
+ SetPropertyJob updateJob = (SetPropertyJob) object;
+ return updateJob.ownIdentity.equals(ownIdentity) && updateJob.propertyName.equals(propertyName);
+ }
+
+ /** {@inheritDoc} */
+ @Override
+ public int hashCode() {
+ return getClass().hashCode() ^ ownIdentity.hashCode() ^ propertyName.hashCode();
+ }
+
+ /** {@inheritDoc} */
+ @Override
+ public String toString() {
+ return String.format("%s[ownIdentity=%s,propertyName=%s]", getClass().getSimpleName(), ownIdentity, propertyName);
+ }
+
}
}
projects / Sone.git / blobdiff