introduce EncounterManagerAdmin... a step to implement that large scale ad-hoc network.

Author: thsc42

src/main/java/net/sharksystem/asap/ASAPEncounterManagerImpl.java

@@ -9,7 +9,9 @@
 import java.io.*;
 import java.util.*;
 
-public class ASAPEncounterManagerImpl implements ASAPEncounterManager, ASAPConnectionListener {
+public class ASAPEncounterManagerImpl implements ASAPEncounterManager,
+        EncounterManagerAdmin,
+        ASAPConnectionListener {
     public static final long DEFAULT_WAIT_BEFORE_RECONNECT_TIME = 1000; // a second - debugging
     public static final long DEFAULT_WAIT_TO_AVOID_RACE_CONDITION = 500; // milliseconds - worked fine with BT.
 
@@ -47,6 +49,7 @@ public ASAPEncounterManagerImpl(ASAPConnectionHandler asapConnectionHandler, lon
         this.asapConnectionHandler = asapConnectionHandler;
         this.randomValue = new Random(System.currentTimeMillis()).nextInt();
         this.waitBeforeReconnect = waitingPeriod;
+        this.restoreDenyList();
     }
 
     private boolean coolDownOver(CharSequence id, EncounterConnectionType connectionType) {
@@ -293,6 +296,54 @@ public synchronized void asapConnectionTerminated(Exception terminatingException
         }
     }
 
+    ////////////////////////////////////////////////////////////////////////////////////////////////////////////////
+    //                                          EncounterManagerAdmin                                             //
+    ////////////////////////////////////////////////////////////////////////////////////////////////////////////////
+
+    private Set<CharSequence> denyList;
+
+    //// housekeeping
+    private void restoreDenyList() {
+        // TODO
+        this.denyList = new HashSet<>();
+        Log.writeLog(this, "need to implement restoreDenyList");
+    }
+
+    private void saveDenyList() {
+        // TODO
+        Log.writeLog(this, "need to implement saveDenyList");
+    }
+
+    ///// manage deny list
+    @Override
+    public void addToDenyList(CharSequence peerID) {
+        this.denyList.add(peerID);
+        this.saveDenyList();
+    }
+
+    @Override
+    public void removeFromDenyList(CharSequence peerID) {
+        this.denyList.remove(peerID);
+        this.saveDenyList();
+    }
+
+    @Override
+    public Set<CharSequence> getDenyList() {
+        return this.denyList;
+    }
+
+    @Override
+    public Set<CharSequence> getConnectedPeerIDs() {
+        return this.openStreamPairs.keySet();
+    }
+    @Override
+    public void cancelConnection(CharSequence peerID) {
+        StreamPair stream2Close = this.openStreamPairs.get(peerID);
+        if(stream2Close != null) {
+            stream2Close.close();
+        }
+    }
+
     ////////////////////////////////////////////////////////////////////////////////////////////////////////////////
     //                                                 utils                                                      //
     ////////////////////////////////////////////////////////////////////////////////////////////////////////////////
@@ -301,5 +352,4 @@ public String toString() {
         return this.asapConnectionHandler.toString();
     }
 
-
 }

src/main/java/net/sharksystem/asap/EncounterManagerAdmin.java

@@ -0,0 +1,48 @@
+package net.sharksystem.asap;
+
+import java.util.Set;
+
+/**
+ * That's the admin interface of an encounter manager. It allows <b>deny list management</b>.
+ * A deny list contains peerIDs. The encounter manager must not establish new connections to
+ * those peers. There can be several reasons (security (peer is not considered trustworthy),
+ * network topology (see considerations of a large scale ad-hoc network with limited
+ * connections on each peer).
+ *
+ * Future enhancements:
+ * <ul><li>define a point to point encryption policy.</li>
+ * <li>define what connections types are acceptable (Internet, Hub, Ad-hoc, Onion)</li></ul>
+ */
+public interface EncounterManagerAdmin {
+    /**
+     * @return set of ID to which an open connection exists right now.
+     */
+    public abstract Set<CharSequence> getConnectedPeerIDs();
+
+    /**
+     * Add a peerID to what no connection should be established.
+     * Note: Adding a peer to the deny list does not necessarily terminate an
+     * existing connection to that peer.
+     * @param peerID
+     */
+    public abstract void addToDenyList(CharSequence peerID);
+
+    /**
+     * Remove a peerID from deny list
+     * @param peerID
+     */
+    public abstract void removeFromDenyList(CharSequence peerID);
+
+    /**
+     * Get PeerID set to which no connection should be established
+     * @return
+     */
+    public abstract Set<CharSequence> getDenyList();
+
+    /**
+     * Cancel a connection to a peer. This method call does not change the deny list.
+     * @param peerID
+     */
+    public abstract void cancelConnection(CharSequence peerID);
+
+}