[api] Add interface for adding contacts remotely

bramble-api/src/main/java/org/briarproject/bramble/api/contact/ContactManager.java

@@ -13,6 +13,8 @@ import java.util.Collection;
 
 import javax.annotation.Nullable;
 
+import static org.briarproject.bramble.api.contact.PendingContact.PendingContactState.FAILED;
+
 @NotNullByDefault
 public interface ContactManager {
 
@@ -52,6 +54,35 @@ public interface ContactManager {
 			long timestamp, boolean alice, boolean verified, boolean active)
 			throws DbException;
 
+	/**
+	 * Returns the static link that needs to be sent to the contact to be added.
+	 */
+	String getRemoteContactLink();
+
+	/**
+	 * Returns true if the given link is syntactically valid.
+	 */
+	boolean isValidRemoteContactLink(String link);
+
+	/**
+	 * Requests a new contact to be added via the given {@code link}.
+	 *
+	 * @param link The link received from the contact we want to add.
+	 * @param alias The alias the user has given this contact.
+	 * @return A PendingContact representing the contact to be added.
+	 */
+	PendingContact addRemoteContactRequest(String link, String alias);
+
+	/**
+	 * Returns a list of {@link PendingContact}s.
+	 */
+	Collection<PendingContact> getPendingContacts();
+
+	/**
+	 * Removes a {@link PendingContact} that is in state {@link FAILED}.
+	 */
+	void removePendingContact(PendingContact pendingContact);
+
 	/**
 	 * Returns the contact with the given ID.
 	 */

bramble-api/src/main/java/org/briarproject/bramble/api/contact/PendingContact.java

@@ -0,0 +1,54 @@
+package org.briarproject.bramble.api.contact;
+
+import org.briarproject.bramble.api.nullsafety.NotNullByDefault;
+
+import javax.annotation.concurrent.Immutable;
+
+@Immutable
+@NotNullByDefault
+public class PendingContact {
+
+	public enum PendingContactState {
+		WAITING_FOR_CONNECTION,
+		CONNECTED,
+		ADDING_CONTACT,
+		FAILED
+	}
+
+	private final PendingContactId id;
+	private final String alias;
+	private final PendingContactState state;
+	private final long timestamp;
+
+	public PendingContact(PendingContactId id, String alias,
+			PendingContactState state, long timestamp) {
+		this.id = id;
+		this.alias = alias;
+		this.state = state;
+		this.timestamp = timestamp;
+	}
+
+	public String getAlias() {
+		return alias;
+	}
+
+	public PendingContactState getState() {
+		return state;
+	}
+
+	public long getTimestamp() {
+		return timestamp;
+	}
+
+	@Override
+	public int hashCode() {
+		return id.hashCode();
+	}
+
+	@Override
+	public boolean equals(Object o) {
+		return o instanceof PendingContact &&
+				id.equals(((PendingContact) o).id);
+	}
+
+}

bramble-api/src/main/java/org/briarproject/bramble/api/contact/PendingContactId.java

@@ -0,0 +1,11 @@
+package org.briarproject.bramble.api.contact;
+
+import org.briarproject.bramble.api.UniqueId;
+
+public class PendingContactId extends UniqueId {
+
+	public PendingContactId(byte[] id) {
+		super(id);
+	}
+
+}

bramble-api/src/main/java/org/briarproject/bramble/api/contact/event/PendingContactStateChangedEvent.java

@@ -0,0 +1,34 @@
+package org.briarproject.bramble.api.contact.event;
+
+import org.briarproject.bramble.api.contact.PendingContact.PendingContactState;
+import org.briarproject.bramble.api.contact.PendingContactId;
+import org.briarproject.bramble.api.event.Event;
+import org.briarproject.bramble.api.nullsafety.NotNullByDefault;
+
+import javax.annotation.concurrent.Immutable;
+
+/**
+ * An event that is broadcast when a pending contact's state is changed.
+ */
+@Immutable
+@NotNullByDefault
+public class PendingContactStateChangedEvent extends Event {
+
+	private final PendingContactId id;
+	private final PendingContactState state;
+
+	public PendingContactStateChangedEvent(PendingContactId id,
+			PendingContactState state) {
+		this.id = id;
+		this.state = state;
+	}
+
+	public PendingContactId getId() {
+		return id;
+	}
+
+	public PendingContactState getPendingContactState() {
+		return state;
+	}
+
+}