Changed the root package from net.sf.briar to org.briarproject.

briar-api/src/org/briarproject/api/db/ContactExistsException.java

@@ -0,0 +1,10 @@
+package org.briarproject.api.db;
+
+/**
+ * Thrown when a duplicate contact is added to the database. This exception may
+ * occur due to concurrent updates and does not indicate a database error.
+ */
+public class ContactExistsException extends DbException {
+
+	private static final long serialVersionUID = -6658762011691502411L;
+}

briar-api/src/org/briarproject/api/db/DatabaseComponent.java

@@ -0,0 +1,357 @@
+package org.briarproject.api.db;
+
+import java.io.IOException;
+import java.util.Collection;
+import java.util.Map;
+
+import org.briarproject.api.Author;
+import org.briarproject.api.AuthorId;
+import org.briarproject.api.Contact;
+import org.briarproject.api.ContactId;
+import org.briarproject.api.LocalAuthor;
+import org.briarproject.api.TransportConfig;
+import org.briarproject.api.TransportId;
+import org.briarproject.api.TransportProperties;
+import org.briarproject.api.event.EventListener;
+import org.briarproject.api.messaging.Ack;
+import org.briarproject.api.messaging.Group;
+import org.briarproject.api.messaging.GroupId;
+import org.briarproject.api.messaging.GroupStatus;
+import org.briarproject.api.messaging.Message;
+import org.briarproject.api.messaging.MessageId;
+import org.briarproject.api.messaging.Offer;
+import org.briarproject.api.messaging.Request;
+import org.briarproject.api.messaging.RetentionAck;
+import org.briarproject.api.messaging.RetentionUpdate;
+import org.briarproject.api.messaging.SubscriptionAck;
+import org.briarproject.api.messaging.SubscriptionUpdate;
+import org.briarproject.api.messaging.TransportAck;
+import org.briarproject.api.messaging.TransportUpdate;
+import org.briarproject.api.transport.Endpoint;
+import org.briarproject.api.transport.TemporarySecret;
+
+/**
+ * Encapsulates the database implementation and exposes high-level operations
+ * to other components.
+ */
+public interface DatabaseComponent {
+
+	/** Opens the database and returns true if the database already existed. */
+	boolean open() throws DbException, IOException;
+
+	/** Waits for any open transactions to finish and closes the database. */
+	void close() throws DbException, IOException;
+
+	/** Adds a listener to be notified when database events occur. */
+	void addListener(EventListener d);
+
+	/** Removes a listener. */
+	void removeListener(EventListener d);
+
+	/**
+	 * Stores a contact associated with the given local and remote pseudonyms,
+	 * and returns an ID for the contact.
+	 */
+	ContactId addContact(Author remote, AuthorId local) throws DbException;
+
+	/** Stores an endpoint. */
+	void addEndpoint(Endpoint ep) throws DbException;
+
+	/**
+	 * Subscribes to a group, or returns false if the user already has the
+	 * maximum number of public subscriptions.
+	 */
+	boolean addGroup(Group g) throws DbException;
+
+	/** Stores a local pseudonym. */
+	void addLocalAuthor(LocalAuthor a) throws DbException;
+
+	/** Stores a local message. */
+	void addLocalMessage(Message m) throws DbException;
+
+	/**
+	 * Stores the given temporary secrets and deletes any secrets that have
+	 * been made obsolete.
+	 */
+	void addSecrets(Collection<TemporarySecret> secrets) throws DbException;
+
+	/**
+	 * Stores a transport and returns true if the transport was not previously
+	 * in the database.
+	 */
+	boolean addTransport(TransportId t, long maxLatency) throws DbException;
+
+	/**
+	 * Returns an acknowledgement for the given contact, or null if there are
+	 * no messages to acknowledge.
+	 */
+	Ack generateAck(ContactId c, int maxMessages) throws DbException;
+
+	/**
+	 * Returns a batch of raw messages for the given contact, with a total
+	 * length less than or equal to the given length, for transmission over a
+	 * transport with the given maximum latency. Returns null if there are no
+	 * sendable messages that fit in the given length.
+	 */
+	Collection<byte[]> generateBatch(ContactId c, int maxLength,
+			long maxLatency) throws DbException;
+
+	/**
+	 * Returns an offer for the given contact for transmission over a
+	 * transport with the given maximum latency, or null if there are no
+	 * messages to offer.
+	 */
+	Offer generateOffer(ContactId c, int maxMessages, long maxLatency)
+			throws DbException;
+
+	/**
+	 * Returns a request for the given contact, or null if there are no
+	 * messages to request.
+	 */
+	Request generateRequest(ContactId c, int maxMessages) throws DbException;
+
+	/**
+	 * Returns a batch of raw messages for the given contact, with a total
+	 * length less than or equal to the given length, for transmission over a
+	 * transport with the given maximum latency. Only messages that have been
+	 * requested by the contact are returned. Returns null if there are no
+	 * sendable messages that fit in the given length.
+	 */
+	Collection<byte[]> generateRequestedBatch(ContactId c, int maxLength,
+			long maxLatency) throws DbException;
+
+	/**
+	 * Returns a retention ack for the given contact, or null if no retention
+	 * ack is due.
+	 */
+	RetentionAck generateRetentionAck(ContactId c) throws DbException;
+
+	/**
+	 * Returns a retention update for the given contact, for transmission
+	 * over a transport with the given latency. Returns null if no update is
+	 * due.
+	 */
+	RetentionUpdate generateRetentionUpdate(ContactId c, long maxLatency)
+			throws DbException;
+
+	/**
+	 * Returns a subscription ack for the given contact, or null if no
+	 * subscription ack is due.
+	 */
+	SubscriptionAck generateSubscriptionAck(ContactId c) throws DbException;
+
+	/**
+	 * Returns a subscription update for the given contact, for transmission
+	 * over a transport with the given latency. Returns null if no update is
+	 * due.
+	 */
+	SubscriptionUpdate generateSubscriptionUpdate(ContactId c, long maxLatency)
+			throws DbException;
+
+	/**
+	 * Returns a batch of transport acks for the given contact, or null if no
+	 * transport acks are due.
+	 */
+	Collection<TransportAck> generateTransportAcks(ContactId c)
+			throws DbException;
+
+	/**
+	 * Returns a batch of transport updates for the given contact, for
+	 * transmission over a transport with the given latency. Returns null if no
+	 * updates are due.
+	 */
+	Collection<TransportUpdate> generateTransportUpdates(ContactId c,
+			long maxLatency) throws DbException;
+
+	/**
+	 * Returns the status of all groups to which the user subscribes or can
+	 * subscribe, excluding inbox groups.
+	 */
+	Collection<GroupStatus> getAvailableGroups() throws DbException;
+
+	/** Returns the configuration for the given transport. */
+	TransportConfig getConfig(TransportId t) throws DbException;
+
+	/** Returns the contact with the given ID. */
+	Contact getContact(ContactId c) throws DbException;
+
+	/** Returns all contacts. */
+	Collection<Contact> getContacts() throws DbException;
+
+	/** Returns the group with the given ID, if the user subscribes to it. */
+	Group getGroup(GroupId g) throws DbException;
+
+	/** Returns all groups to which the user subscribes. */
+	Collection<Group> getGroups() throws DbException;
+
+	/**
+	 * Returns the ID of the inbox group for the given contact, or null if no
+	 * inbox group has been set.
+	 */
+	GroupId getInboxGroupId(ContactId c) throws DbException;
+
+	/**
+	 * Returns the headers of all messages in the inbox group for the given
+	 * contact, or null if no inbox group has been set.
+	 */
+	Collection<MessageHeader> getInboxMessageHeaders(ContactId c)
+			throws DbException;
+
+	/**
+	 * Returns the time at which a connection to each contact was last opened
+	 * or closed.
+	 */
+	Map<ContactId, Long> getLastConnected() throws DbException;
+
+	/** Returns the local pseudonym with the given ID. */
+	LocalAuthor getLocalAuthor(AuthorId a) throws DbException;
+
+	/** Returns all local pseudonyms. */
+	Collection<LocalAuthor> getLocalAuthors() throws DbException;
+
+	/** Returns the local transport properties for all transports. */
+	Map<TransportId, TransportProperties> getLocalProperties()
+			throws DbException;
+
+	/** Returns the local transport properties for the given transport. */
+	TransportProperties getLocalProperties(TransportId t) throws DbException;
+
+	/** Returns the body of the message with the given ID. */
+	byte[] getMessageBody(MessageId m) throws DbException;
+
+	/** Returns the headers of all messages in the given group. */
+	Collection<MessageHeader> getMessageHeaders(GroupId g)
+			throws DbException;
+
+	/** Returns true if the given message is marked as read. */
+	boolean getReadFlag(MessageId m) throws DbException;
+
+	/** Returns all remote transport properties for the given transport. */
+	Map<ContactId, TransportProperties> getRemoteProperties(TransportId t)
+			throws DbException;
+
+	/** Returns all temporary secrets. */
+	Collection<TemporarySecret> getSecrets() throws DbException;
+
+	/** Returns the maximum latencies of all local transports. */
+	Map<TransportId, Long> getTransportLatencies() throws DbException;
+
+	/** Returns the number of unread messages in each subscribed group. */
+	Map<GroupId, Integer> getUnreadMessageCounts() throws DbException;
+
+	/** Returns the IDs of all contacts to which the given group is visible. */
+	Collection<ContactId> getVisibility(GroupId g) throws DbException;
+
+	/**
+	 * Increments the outgoing connection counter for the given endpoint
+	 * in the given rotation period and returns the old value, or -1 if the
+	 * counter does not exist.
+	 */
+	long incrementConnectionCounter(ContactId c, TransportId t, long period)
+			throws DbException;
+
+	/**
+	 * Merges the given configuration with existing configuration for the
+	 * given transport.
+	 */
+	void mergeConfig(TransportId t, TransportConfig c) throws DbException;
+
+	/**
+	 * Merges the given properties with the existing local properties for the
+	 * given transport.
+	 */
+	void mergeLocalProperties(TransportId t, TransportProperties p)
+			throws DbException;
+
+	/** Processes an ack from the given contact. */
+	void receiveAck(ContactId c, Ack a) throws DbException;
+
+	/** Processes a message from the given contact. */
+	void receiveMessage(ContactId c, Message m) throws DbException;
+
+	/** Processes an offer from the given contact. */
+	void receiveOffer(ContactId c, Offer o) throws DbException;
+
+	/** Processes a request from the given contact. */
+	void receiveRequest(ContactId c, Request r) throws DbException;
+
+	/** Processes a retention ack from the given contact. */
+	void receiveRetentionAck(ContactId c, RetentionAck a) throws DbException;
+
+	/** Processes a retention update from the given contact. */
+	void receiveRetentionUpdate(ContactId c, RetentionUpdate u)
+			throws DbException;
+
+	/** Processes a subscription ack from the given contact. */
+	void receiveSubscriptionAck(ContactId c, SubscriptionAck a)
+			throws DbException;
+
+	/** Processes a subscription update from the given contact. */
+	void receiveSubscriptionUpdate(ContactId c, SubscriptionUpdate u)
+			throws DbException;
+
+	/** Processes a transport ack from the given contact. */
+	void receiveTransportAck(ContactId c, TransportAck a) throws DbException;
+
+	/** Processes a transport update from the given contact. */
+	void receiveTransportUpdate(ContactId c, TransportUpdate u)
+			throws DbException;
+
+	/** Removes a contact (and all associated state) from the database. */
+	void removeContact(ContactId c) throws DbException;
+
+	/**
+	 * Unsubscribes from a group. Any messages belonging to the group
+	 * are deleted from the database.
+	 */
+	void removeGroup(Group g) throws DbException;
+
+	/**
+	 * Removes a local pseudonym (and all associated state) from the database.
+	 */
+	void removeLocalAuthor(AuthorId a) throws DbException;
+
+	/**
+	 * Removes a transport (and any associated configuration and local
+	 * properties) from the database.
+	 */
+	void removeTransport(TransportId t) throws DbException;
+
+	/**
+	 * Sets the connection reordering window for the given endpoint in the
+	 * given rotation period.
+	 */
+	void setConnectionWindow(ContactId c, TransportId t, long period,
+			long centre, byte[] bitmap) throws DbException;
+
+	/**
+	 * Makes a group visible to the given contact, adds it to the contact's
+	 * subscriptions, and sets it as the inbox group for the contact.
+	 */
+	public void setInboxGroup(ContactId c, Group g) throws DbException;
+
+	/**
+	 * Marks a message as read or unread.
+	 */
+	void setReadFlag(MessageId m, boolean read) throws DbException;
+
+	/**
+	 * Sets the remote transport properties for the given contact, replacing
+	 * any existing properties.
+	 */
+	void setRemoteProperties(ContactId c,
+			Map<TransportId, TransportProperties> p) throws DbException;
+
+	/**
+	 * Makes a group visible to the given set of contacts and invisible to any
+	 * other current or future contacts.
+	 */
+	void setVisibility(GroupId g, Collection<ContactId> visible)
+			throws DbException;
+
+	/**
+	 * Makes a group visible to all current and future contacts, or invisible
+	 * to future contacts.
+	 */
+	void setVisibleToAll(GroupId g, boolean all) throws DbException;
+}

briar-api/src/org/briarproject/api/db/DatabaseConfig.java

@@ -0,0 +1,16 @@
+package org.briarproject.api.db;
+
+import java.io.File;
+
+public interface DatabaseConfig {
+
+	boolean databaseExists();
+
+	File getDatabaseDirectory();
+
+	void setEncryptionKey(byte[] key);
+
+	byte[] getEncryptionKey();
+
+	long getMaxSize();
+}

briar-api/src/org/briarproject/api/db/DatabaseExecutor.java

@@ -0,0 +1,17 @@
+package org.briarproject.api.db;
+
+import static java.lang.annotation.ElementType.FIELD;
+import static java.lang.annotation.ElementType.METHOD;
+import static java.lang.annotation.ElementType.PARAMETER;
+import static java.lang.annotation.RetentionPolicy.RUNTIME;
+
+import java.lang.annotation.Retention;
+import java.lang.annotation.Target;
+
+import com.google.inject.BindingAnnotation;
+
+/** Annotation for injecting the executor for database tasks. */
+@BindingAnnotation
+@Target({ FIELD, METHOD, PARAMETER })
+@Retention(RUNTIME)
+public @interface DatabaseExecutor {}

briar-api/src/org/briarproject/api/db/DbClosedException.java

@@ -0,0 +1,7 @@
+package org.briarproject.api.db;
+
+/** Thrown when a database operation is attempted and the database is closed. */
+public class DbClosedException extends DbException {
+
+	private static final long serialVersionUID = -3679248177625310653L;
+}

briar-api/src/org/briarproject/api/db/DbException.java

@@ -0,0 +1,12 @@
+package org.briarproject.api.db;
+
+public class DbException extends Exception {
+
+	private static final long serialVersionUID = 3706581789209939441L;
+
+	public DbException() {}
+
+	public DbException(Throwable t) {
+		super(t);
+	}
+}

briar-api/src/org/briarproject/api/db/LocalAuthorExistsException.java

@@ -0,0 +1,10 @@
+package org.briarproject.api.db;
+
+/**
+ * Thrown when a duplicate pseudonym is added to the database. This exception
+ * may occur due to concurrent updates and does not indicate a database error.
+ */
+public class LocalAuthorExistsException extends DbException {
+
+	private static final long serialVersionUID = -1483877298070151673L;
+}

briar-api/src/org/briarproject/api/db/MessageHeader.java

@@ -0,0 +1,68 @@
+package org.briarproject.api.db;
+
+import org.briarproject.api.Author;
+import org.briarproject.api.messaging.GroupId;
+import org.briarproject.api.messaging.MessageId;
+
+public class MessageHeader {
+
+	private final MessageId id, parent;
+	private final GroupId groupId;
+	private final Author author;
+	private final String contentType;
+	private final long timestamp;
+	private final boolean read;
+
+	public MessageHeader(MessageId id, MessageId parent, GroupId groupId,
+			Author author, String contentType, long timestamp, boolean read) {
+		this.id = id;
+		this.parent = parent;
+		this.groupId = groupId;
+		this.author = author;
+		this.contentType = contentType;
+		this.timestamp = timestamp;
+		this.read = read;
+	}
+
+	/** Returns the message's unique identifier. */
+	public MessageId getId() {
+		return id;
+	}
+
+	/**
+	 * Returns the message's parent, or null if this is the first message in a
+	 * thread.
+	 */
+	public MessageId getParent() {
+		return parent;
+	}
+
+	/**
+	 * Returns the unique identifier of the group to which the message belongs.
+	 */
+	public GroupId getGroupId() {
+		return groupId;
+	}
+
+	/**
+	 * Returns the message's author, or null if this is an  anonymous message.
+	 */
+	public Author getAuthor() {
+		return author;
+	}
+
+	/** Returns the message's content type. */
+	public String getContentType() {
+		return contentType;
+	}
+
+	/** Returns the timestamp created by the message's author. */
+	public long getTimestamp() {
+		return timestamp;
+	}
+
+	/** Returns true if the message has been read. */
+	public boolean isRead() {
+		return read;
+	}
+}

briar-api/src/org/briarproject/api/db/NoSuchContactException.java

@@ -0,0 +1,11 @@
+package org.briarproject.api.db;
+
+/**
+ * Thrown when a database operation is attempted for a contact that is not in
+ * the database. This exception may occur due to concurrent updates and does
+ * not indicate a database error.
+ */
+public class NoSuchContactException extends DbException {
+
+	private static final long serialVersionUID = -7048538231308207386L;
+}

briar-api/src/org/briarproject/api/db/NoSuchLocalAuthorException.java

@@ -0,0 +1,11 @@
+package org.briarproject.api.db;
+
+/**
+ * Thrown when a database operation is attempted for a pseudonym that is not in
+ * the database. This exception may occur due to concurrent updates and does
+ * not indicate a database error.
+ */
+public class NoSuchLocalAuthorException extends DbException {
+
+	private static final long serialVersionUID = 494398665376703860L;
+}

briar-api/src/org/briarproject/api/db/NoSuchMessageException.java

@@ -0,0 +1,11 @@
+package org.briarproject.api.db;
+
+/**
+ * Thrown when a database operation is attempted for a message that is not in
+ * the database. This exception may occur due to concurrent updates and does
+ * not indicate a database error.
+ */
+public class NoSuchMessageException extends DbException {
+
+	private static final long serialVersionUID = 9191508339698803848L;
+}

briar-api/src/org/briarproject/api/db/NoSuchSubscriptionException.java

@@ -0,0 +1,12 @@
+package org.briarproject.api.db;
+
+/**
+ * Thrown when a database operation is attempted for a group to which the user
+ * does not subscribe. This exception may occur due to concurrent updates and
+ * does not indicate a database error.
+ */
+public class NoSuchSubscriptionException extends DbException {
+
+	private static final long serialVersionUID = -5494178507342571697L;
+
+}

briar-api/src/org/briarproject/api/db/NoSuchTransportException.java

@@ -0,0 +1,11 @@
+package org.briarproject.api.db;
+
+/**
+ * Thrown when a database operation is attempted for a transport that is not in
+ * the database. This exception may occur due to concurrent updates and does
+ * not indicate a database error.
+ */
+public class NoSuchTransportException extends DbException {
+
+	private static final long serialVersionUID = -6274982612759573100L;
+}