Reorganise validation code (no functional changes).

bramble-api/src/main/java/org/briarproject/bramble/api/client/BdfIncomingMessageHook.java

@@ -0,0 +1,64 @@
+package org.briarproject.bramble.api.client;
+
+import org.briarproject.bramble.api.FormatException;
+import org.briarproject.bramble.api.data.BdfDictionary;
+import org.briarproject.bramble.api.data.BdfList;
+import org.briarproject.bramble.api.data.MetadataParser;
+import org.briarproject.bramble.api.db.DatabaseComponent;
+import org.briarproject.bramble.api.db.DbException;
+import org.briarproject.bramble.api.db.Metadata;
+import org.briarproject.bramble.api.db.Transaction;
+import org.briarproject.bramble.api.nullsafety.NotNullByDefault;
+import org.briarproject.bramble.api.sync.InvalidMessageException;
+import org.briarproject.bramble.api.sync.Message;
+import org.briarproject.bramble.api.sync.validation.IncomingMessageHook;
+
+import javax.annotation.concurrent.Immutable;
+
+@Immutable
+@NotNullByDefault
+public abstract class BdfIncomingMessageHook implements IncomingMessageHook {
+
+	protected final DatabaseComponent db;
+	protected final ClientHelper clientHelper;
+	protected final MetadataParser metadataParser;
+
+	protected BdfIncomingMessageHook(DatabaseComponent db,
+			ClientHelper clientHelper, MetadataParser metadataParser) {
+		this.db = db;
+		this.clientHelper = clientHelper;
+		this.metadataParser = metadataParser;
+	}
+
+	/**
+	 * Called once for each incoming message that passes validation.
+	 *
+	 * @return whether or not this message should be shared
+	 * @throws DbException Should only be used for real database errors.
+	 * If this is thrown, delivery will be attempted again at next startup,
+	 * whereas if a FormatException is thrown, the message will be permanently
+	 * invalidated.
+	 * @throws FormatException Use this for any non-database error
+	 * that occurs while handling remotely created data.
+	 * This includes errors that occur while handling locally created data
+	 * in a context controlled by remotely created data
+	 * (for example, parsing the metadata of a dependency
+	 * of an incoming message).
+	 * Never rethrow DbException as FormatException!
+	 */
+	protected abstract boolean incomingMessage(Transaction txn, Message m,
+			BdfList body, BdfDictionary meta) throws DbException,
+			FormatException;
+
+	@Override
+	public boolean incomingMessage(Transaction txn, Message m, Metadata meta)
+			throws DbException, InvalidMessageException {
+		try {
+			BdfList body = clientHelper.toList(m);
+			BdfDictionary metaDictionary = metadataParser.parse(meta);
+			return incomingMessage(txn, m, body, metaDictionary);
+		} catch (FormatException e) {
+			throw new InvalidMessageException(e);
+		}
+	}
+}

bramble-api/src/main/java/org/briarproject/bramble/api/client/BdfMessageValidator.java

@@ -9,7 +9,7 @@ import org.briarproject.bramble.api.sync.Group;
 import org.briarproject.bramble.api.sync.InvalidMessageException;
 import org.briarproject.bramble.api.sync.Message;
 import org.briarproject.bramble.api.sync.MessageContext;
-import org.briarproject.bramble.api.sync.ValidationManager.MessageValidator;
+import org.briarproject.bramble.api.sync.validation.MessageValidator;
 import org.briarproject.bramble.api.system.Clock;
 
 import java.util.logging.Logger;

bramble-api/src/main/java/org/briarproject/bramble/api/db/DatabaseComponent.java

@@ -19,6 +19,7 @@ import org.briarproject.bramble.api.sync.MessageId;
 import org.briarproject.bramble.api.sync.MessageStatus;
 import org.briarproject.bramble.api.sync.Offer;
 import org.briarproject.bramble.api.sync.Request;
+import org.briarproject.bramble.api.sync.validation.MessageState;
 import org.briarproject.bramble.api.transport.KeySet;
 import org.briarproject.bramble.api.transport.KeySetId;
 import org.briarproject.bramble.api.transport.TransportKeys;
@@ -28,8 +29,6 @@ import java.util.Map;
 
 import javax.annotation.Nullable;
 
-import static org.briarproject.bramble.api.sync.ValidationManager.State;
-
 /**
  * Encapsulates the database implementation and exposes high-level operations
  * to other components.
@@ -374,12 +373,12 @@ public interface DatabaseComponent {
 	/**
 	 * Returns the IDs and states of all dependencies of the given message.
 	 * For missing dependencies and dependencies in other groups, the state
-	 * {@link State UNKNOWN} is returned.
+	 * {@link MessageState UNKNOWN} is returned.
 	 * <p/>
 	 * Read-only.
 	 */
-	Map<MessageId, State> getMessageDependencies(Transaction txn, MessageId m)
-			throws DbException;
+	Map<MessageId, MessageState> getMessageDependencies(Transaction txn,
+			MessageId m) throws DbException;
 
 	/**
 	 * Returns the IDs and states of all dependents of the given message.
@@ -388,15 +387,16 @@ public interface DatabaseComponent {
 	 * <p/>
 	 * Read-only.
 	 */
-	Map<MessageId, State> getMessageDependents(Transaction txn, MessageId m)
-			throws DbException;
+	Map<MessageId, MessageState> getMessageDependents(Transaction txn,
+			MessageId m) throws DbException;
 
 	/**
 	 * Gets the validation and delivery state of the given message.
 	 * <p/>
 	 * Read-only.
 	 */
-	State getMessageState(Transaction txn, MessageId m) throws DbException;
+	MessageState getMessageState(Transaction txn, MessageId m)
+			throws DbException;
 
 	/**
 	 * Returns the status of the given delivered message with respect to the
@@ -543,7 +543,7 @@ public interface DatabaseComponent {
 	/**
 	 * Sets the validation and delivery state of the given message.
 	 */
-	void setMessageState(Transaction txn, MessageId m, State state)
+	void setMessageState(Transaction txn, MessageId m, MessageState state)
 			throws DbException;
 
 	/**

bramble-api/src/main/java/org/briarproject/bramble/api/sync/ValidationManager.java

@@ -1,87 +0,0 @@
-package org.briarproject.bramble.api.sync;
-
-import org.briarproject.bramble.api.crypto.SecretKey;
-import org.briarproject.bramble.api.db.DbException;
-import org.briarproject.bramble.api.db.Metadata;
-import org.briarproject.bramble.api.db.Transaction;
-import org.briarproject.bramble.api.lifecycle.LifecycleManager;
-import org.briarproject.bramble.api.nullsafety.NotNullByDefault;
-
-/**
- * Responsible for managing message validators and passing them messages to
- * validate.
- */
-@NotNullByDefault
-public interface ValidationManager {
-
-	enum State {
-
-		UNKNOWN(0), INVALID(1), PENDING(2), DELIVERED(3);
-
-		private final int value;
-
-		State(int value) {
-			this.value = value;
-		}
-
-		public int getValue() {
-			return value;
-		}
-
-		public static State fromValue(int value) {
-			for (State s : values()) if (s.value == value) return s;
-			throw new IllegalArgumentException();
-		}
-	}
-
-	/**
-	 * Registers the message validator for the given client. This method
-	 * should be called before
-	 * {@link LifecycleManager#startServices(SecretKey)}.
-	 */
-	void registerMessageValidator(ClientId c, int majorVersion,
-			MessageValidator v);
-
-	/**
-	 * Registers the incoming message hook for the given client. The hook will
-	 * be called once for each incoming message that passes validation. This
-	 * method should be called before
-	 * {@link LifecycleManager#startServices(SecretKey)}.
-	 */
-	void registerIncomingMessageHook(ClientId c, int majorVersion,
-			IncomingMessageHook hook);
-
-	interface MessageValidator {
-
-		/**
-		 * Validates the given message and returns its metadata and
-		 * dependencies.
-		 */
-		MessageContext validateMessage(Message m, Group g)
-				throws InvalidMessageException;
-	}
-
-	interface IncomingMessageHook {
-
-		/**
-		 * Called once for each incoming message that passes validation.
-		 *
-		 * @return whether or not this message should be shared
-		 * @throws DbException Should only be used for real database errors.
-		 * If this is thrown, delivery will be attempted again at next startup,
-		 * whereas if an InvalidMessageException is thrown,
-		 * the message will be permanently invalidated.
-		 * @throws InvalidMessageException for any non-database error
-		 * that occurs while handling remotely created data.
-		 * This includes errors that occur while handling locally created data
-		 * in a context controlled by remotely created data
-		 * (for example, parsing the metadata of a dependency
-		 * of an incoming message).
-		 * Throwing this will delete the incoming message and its metadata
-		 * marking it as invalid in the database.
-		 * Never rethrow DbException as InvalidMessageException!
-		 */
-		boolean incomingMessage(Transaction txn, Message m, Metadata meta)
-				throws DbException, InvalidMessageException;
-	}
-}

bramble-api/src/main/java/org/briarproject/bramble/api/sync/event/MessageStateChangedEvent.java

@@ -3,11 +3,10 @@ package org.briarproject.bramble.api.sync.event;
 import org.briarproject.bramble.api.event.Event;
 import org.briarproject.bramble.api.nullsafety.NotNullByDefault;
 import org.briarproject.bramble.api.sync.MessageId;
+import org.briarproject.bramble.api.sync.validation.MessageState;
 
 import javax.annotation.concurrent.Immutable;
 
-import static org.briarproject.bramble.api.sync.ValidationManager.State;
-
 /**
  * An event that is broadcast when a message state changed.
  */
@@ -17,10 +16,10 @@ public class MessageStateChangedEvent extends Event {
 
 	private final MessageId messageId;
 	private final boolean local;
-	private final State state;
+	private final MessageState state;
 
 	public MessageStateChangedEvent(MessageId messageId, boolean local,
-			State state) {
+			MessageState state) {
 		this.messageId = messageId;
 		this.local = local;
 		this.state = state;
@@ -34,7 +33,7 @@ public class MessageStateChangedEvent extends Event {
 		return local;
 	}
 
-	public State getState() {
+	public MessageState getState() {
 		return state;
 	}
 

bramble-api/src/main/java/org/briarproject/bramble/api/sync/validation/IncomingMessageHook.java

@@ -0,0 +1,31 @@
+package org.briarproject.bramble.api.sync.validation;
+
+import org.briarproject.bramble.api.db.DbException;
+import org.briarproject.bramble.api.db.Metadata;
+import org.briarproject.bramble.api.db.Transaction;
+import org.briarproject.bramble.api.sync.InvalidMessageException;
+import org.briarproject.bramble.api.sync.Message;
+
+public interface IncomingMessageHook {
+
+	/**
+	 * Called once for each incoming message that passes validation.
+	 *
+	 * @return whether or not this message should be shared
+	 * @throws DbException Should only be used for real database errors.
+	 * If this is thrown, delivery will be attempted again at next startup,
+	 * whereas if an InvalidMessageException is thrown,
+	 * the message will be permanently invalidated.
+	 * @throws InvalidMessageException for any non-database error
+	 * that occurs while handling remotely created data.
+	 * This includes errors that occur while handling locally created data
+	 * in a context controlled by remotely created data
+	 * (for example, parsing the metadata of a dependency
+	 * of an incoming message).
+	 * Throwing this will delete the incoming message and its metadata
+	 * marking it as invalid in the database.
+	 * Never rethrow DbException as InvalidMessageException!
+	 */
+	boolean incomingMessage(Transaction txn, Message m, Metadata meta)
+			throws DbException, InvalidMessageException;
+}

bramble-api/src/main/java/org/briarproject/bramble/api/sync/validation/MessageState.java

@@ -0,0 +1,21 @@
+package org.briarproject.bramble.api.sync.validation;
+
+public enum MessageState {
+
+	UNKNOWN(0), INVALID(1), PENDING(2), DELIVERED(3);
+
+	private final int value;
+
+	MessageState(int value) {
+		this.value = value;
+	}
+
+	public int getValue() {
+		return value;
+	}
+
+	public static MessageState fromValue(int value) {
+		for (MessageState s : values()) if (s.value == value) return s;
+		throw new IllegalArgumentException();
+	}
+}

bramble-api/src/main/java/org/briarproject/bramble/api/sync/validation/MessageValidator.java

@@ -0,0 +1,16 @@
+package org.briarproject.bramble.api.sync.validation;
+
+import org.briarproject.bramble.api.sync.Group;
+import org.briarproject.bramble.api.sync.InvalidMessageException;
+import org.briarproject.bramble.api.sync.Message;
+import org.briarproject.bramble.api.sync.MessageContext;
+
+public interface MessageValidator {
+
+	/**
+	 * Validates the given message and returns its metadata and
+	 * dependencies.
+	 */
+	MessageContext validateMessage(Message m, Group g)
+			throws InvalidMessageException;
+}

bramble-api/src/main/java/org/briarproject/bramble/api/sync/validation/ValidationManager.java

@@ -0,0 +1,31 @@
+package org.briarproject.bramble.api.sync.validation;
+
+import org.briarproject.bramble.api.crypto.SecretKey;
+import org.briarproject.bramble.api.lifecycle.LifecycleManager;
+import org.briarproject.bramble.api.nullsafety.NotNullByDefault;
+import org.briarproject.bramble.api.sync.ClientId;
+
+/**
+ * Responsible for managing message validators and passing them messages to
+ * validate.
+ */
+@NotNullByDefault
+public interface ValidationManager {
+
+	/**
+	 * Registers the {@link MessageValidator} for the given client. This method
+	 * should be called before
+	 * {@link LifecycleManager#startServices(SecretKey)}.
+	 */
+	void registerMessageValidator(ClientId c, int majorVersion,
+			MessageValidator v);
+
+	/**
+	 * Registers the {@link IncomingMessageHook} for the given client. The hook
+	 * will be called once for each incoming message that passes validation.
+	 * This method should be called before
+	 * {@link LifecycleManager#startServices(SecretKey)}.
+	 */
+	void registerIncomingMessageHook(ClientId c, int majorVersion,
+			IncomingMessageHook hook);
+}