1 package iotruntime.master;
3 import java.util.ArrayList;
4 import java.util.HashMap;
5 import java.util.HashSet;
8 import java.util.Random;
11 /** Class CommunicationHandler is a class that maintains
12 * a data structure that preserves a collection of host name,
13 * port numbers, and objects that are running
14 * +-----------------+----+--------+------------------+--------------+----------------+
15 * | HOST-ADDRESS | ...|IN-PORT | RMIREGISTRY-PORT | RMISTUB-PORT | ACTIVE OBJECTS |
16 * +-----------------+----+--------+------------------+--------------+----------------+
17 * | XXX.XXX.XXX.XXX | | XXXXX | XXXXX | XXXXX | XXXXXXXXXXXXXX |
18 * | | | XXXXX | XXXXX | XXXXX | XXXXXXXXXXXXXX |
19 * | | | XXXXX | XXXXX | XXXXX | XXXXXXXXXXXXXX |
20 * | | ...| ... | ... | ... | ... |
21 * +-----------------+----+--------+------------------+--------------+----------------+
22 * In this case we use ACTIVE OBJECTS names as the key
23 * So ACTIVE OBJECTS maps to numbers and these numbers map to each other
24 * entry in hashmaps (HostAddress can be repetitive)
25 * e.g. ACTIVE OBJECTS ProximitySensorPS0 - 0
26 * ProximitySensorPS1 - 1
29 * IN-PORT / RMIREGISTRY-PORT / RMISTUB-PORT / HOST-ADDRESS: 0 - XXXXX
40 * We add a Set structure to handle all the other ports that are used by devices
41 * when communicating with their respective drivers
43 * @author Rahmadi Trimananda <rahmadi.trimananda @ uci.edu>
47 public final class CommunicationHandler {
50 * CommunicationHandler class properties
52 * Random, host name, port number, active objects
53 * HostAdd is the key to the table so we use it
54 * as a key to elements
55 * HostList gives a mapping from hostname to list of objects
57 private Random random;
58 private List<String> listActiveControllerObj;
59 private List<String> listFieldObjectID;
60 private List<ObjectCreationInfo> listObjCrtInfo;
61 private List<Object[]> listArrFieldValues;
62 private List<Class[]> listArrFieldClasses;
63 private Map<String, Integer> hmActiveObj;
64 private Map<Integer, String> hmHostAdd;
65 private Map<String, ArrayList<String> > hmHostList;
66 private Map<Integer, Integer> hmComPort;
67 private Map<Integer, Integer> hmRMIRegPort;
68 private Map<Integer, Integer> hmRMIStubPort;
69 private Set<Integer> hsDevicePort;
70 private Set<Integer> hsAllPorts;
71 private Map<Integer, Integer> hmAdditionalPort;
72 private int iNumOfObjects;
73 private int iNumOfHosts;
74 private boolean bVerbose;
77 * CommunicationHandler class constants
79 private final int INT_MAX_PORT = 65535;
80 private final int INT_MIN_PORT = 10000;
85 public CommunicationHandler(boolean _bVerbose) {
87 random = new Random();
88 listActiveControllerObj = new ArrayList<String>();
89 listFieldObjectID = new ArrayList<String>();
90 listObjCrtInfo = new ArrayList<ObjectCreationInfo>();
91 listArrFieldValues = new ArrayList<Object[]>();
92 listArrFieldClasses = new ArrayList<Class[]>();
93 hmActiveObj = new HashMap<String, Integer>();
94 hmHostAdd = new HashMap<Integer, String>();
95 hmHostList = new HashMap<String, ArrayList<String>>();
96 hmComPort = new HashMap<Integer, Integer>();
97 hmRMIRegPort = new HashMap<Integer, Integer>();
98 hmRMIStubPort = new HashMap<Integer, Integer>();
99 hsDevicePort = new HashSet<Integer>();
100 hsAllPorts = new HashSet<Integer>();
101 hmAdditionalPort = new HashMap<Integer, Integer>();
104 bVerbose = _bVerbose;
105 RuntimeOutput.print("CommunicationHandler: Creating a new CommunicationHandler object!", bVerbose);
109 * Method clearCommunicationHandler()
111 * Clear the data structure
115 public void clearCommunicationHandler() {
117 listActiveControllerObj.clear();
118 listFieldObjectID.clear();
119 listObjCrtInfo.clear();
120 listArrFieldValues.clear();
121 listArrFieldClasses.clear();
126 hmRMIRegPort.clear();
127 hmRMIStubPort.clear();
128 hsDevicePort.clear();
129 hmAdditionalPort.clear();
132 RuntimeOutput.print("CommunicationHandler: Clearing CommunicationHandler object's data structure!", bVerbose);
136 * Method addPortConnection()
138 * Add a new connection then generate new in-port and out-port numbers
140 * @param sHAddress String host address
141 * @param sAObject String active object name
144 public void addPortConnection(String sHAddress, String sAObject) {
146 // Increment counter first before we add objects as we start from 0
147 // Objects are named uniquely so we record this and match with the host
148 // Hostname occurrence can be repetitive as there can be more than
149 // one host on one compute node
151 // Add a new object in the list of objects
152 hmActiveObj.put(sAObject, iNumOfObjects);
154 // Check host existence in our data structure
155 // Add a new host and a new object
156 if(hmHostList.containsKey(sHAddress) == false) {
158 hmHostList.put(sHAddress, new ArrayList<String>());
160 hmHostList.get(sHAddress).add(sAObject);
162 // Map object to host
163 hmHostAdd.put(iNumOfObjects, sHAddress);
167 iComPort = random.nextInt(INT_MAX_PORT - INT_MIN_PORT + 1) + INT_MIN_PORT;
168 // Check port existence in HashMap
169 } while (portIsAvailable(iComPort) == false);
170 hmComPort.put(iNumOfObjects, iComPort);
171 // hsAllPorts tracks all the existing and used port numbers
172 hsAllPorts.add(iComPort);
176 iRMIRegPort = random.nextInt(INT_MAX_PORT - INT_MIN_PORT + 1) + INT_MIN_PORT;
177 // Check port existence in HashMap
178 } while (portIsAvailable(iRMIRegPort) == false);
179 hmRMIRegPort.put(iNumOfObjects, iRMIRegPort);
180 hsAllPorts.add(iRMIRegPort);
182 int iRMIStubPort = 0;
184 iRMIStubPort = random.nextInt(INT_MAX_PORT - INT_MIN_PORT + 1) + INT_MIN_PORT;
185 // Check port existence in HashMap
186 } while (portIsAvailable(iRMIStubPort) == false);
187 hmRMIStubPort.put(iNumOfObjects, iRMIStubPort);
188 hsAllPorts.add(iRMIStubPort);
194 * A private method to add a new active controller object
196 * @params strFieldObjectID String field object ID
197 * @params strObjName String object name
198 * @params strObjClassName String object class name
199 * @params strObjClassInterfaceName String object class interface name
200 * @params strIoTSlaveObjectHostAdd String IoTSlave host address
201 * @params arrFieldValues Array of field values
202 * @params arrFieldClasses Array of field classes
205 public void addActiveControllerObject(String strFieldObjectID, String strObjName, String strObjClassName,
206 String strObjClassInterfaceName, String strObjStubClsIntfaceName, String strIoTSlaveObjectHostAdd, Object[] arrFieldValues,
207 Class[] arrFieldClasses) {
209 listActiveControllerObj.add(strObjName);
210 listFieldObjectID.add(strFieldObjectID);
211 listArrFieldValues.add(arrFieldValues);
212 listArrFieldClasses.add(arrFieldClasses);
213 ObjectCreationInfo objCrtInfo = new ObjectCreationInfo(strIoTSlaveObjectHostAdd, strObjName,
214 strObjClassName, strObjClassInterfaceName, strObjStubClsIntfaceName);
215 listObjCrtInfo.add(objCrtInfo);
219 * Method addDevicePort()
221 * Add a port that is used by a device when communicating with its driver
222 * This port will be taken into account when checking for port availability
224 * @param iDevPort Device port number
227 public void addDevicePort(int iDevPort) {
229 hsDevicePort.add(iDevPort);
230 // Track this port number
231 hsAllPorts.add(iDevPort);
235 * Method addAdditionalPort()
237 * Add a new port for new connections for any objects in the program.
238 * This newly generated port number will be recorded.
240 * @return int One new port
242 public int addAdditionalPort(String sAObject) {
244 hmActiveObj.put(sAObject, iNumOfObjects);
246 int iAdditionalPort = 0;
248 iAdditionalPort = random.nextInt(INT_MAX_PORT - INT_MIN_PORT + 1) + INT_MIN_PORT;
249 // Check port existence in HashMap
250 } while (portIsAvailable(iAdditionalPort) == false);
251 hmAdditionalPort.put(iNumOfObjects, iAdditionalPort);
252 // Track this port number
253 hsAllPorts.add(iAdditionalPort);
257 return iAdditionalPort;
261 * Method portIsAvailable()
263 * Checks the availability of the newly generated port.
264 * If port number has been used in any of the lists then
265 * it is not available
267 * @param iPortNumber Device port number
270 public boolean portIsAvailable(int iPortNumber) {
272 /*if (hmComPort.containsValue(iPortNumber) == true) {
274 } else if (hmRMIRegPort.containsValue(iPortNumber) == true) {
276 } else if (hmRMIStubPort.containsValue(iPortNumber) == true) {
278 } else if (hmAdditionalPort.containsValue(iPortNumber) == true) {
280 } else if (hsDevicePort.contains(iPortNumber) == true) {
285 if (hsAllPorts.contains(iPortNumber)) {
293 * Method getNumOfObjects()
297 public int getNumOfObjects() {
299 return iNumOfObjects;
304 * Method getNumOfHosts()
308 public int getNumOfHosts() {
315 * Method objectExists()
317 * @param sObjName String object name
320 public boolean objectExists(String sObjName) {
322 return hmActiveObj.containsKey(sObjName);
327 * Method hostExists()
329 * @param sHostName String host name
332 public boolean hostExists(String sHostName) {
334 return hmHostList.containsKey(sHostName);
339 * Method getHostAddress()
341 * User finds HostAddress using Object name
343 * @param sAObject String active object name
346 public String getHostAddress(String sAObject) {
348 return hmHostAdd.get(hmActiveObj.get(sAObject));
355 * User gets the set of hostnames
359 public Set<String> getHosts() {
361 return hmHostList.keySet();
366 * Method getComPort()
368 * User finds In-Port number using Object name
370 * @param sAObject String active object name
373 public Integer getComPort(String sAObject) {
375 return hmComPort.get(hmActiveObj.get(sAObject));
379 * Method getAdditionalPort()
381 * User finds a port number using Object name
383 * @param sAObject String active object name
386 public Integer getAdditionalPort(String sAObject) {
388 return hmAdditionalPort.get(hmActiveObj.get(sAObject));
392 * Method getRMIRegPort()
394 * User finds Out-Port number using Object name
396 * @param sAObject String active object name
399 public Integer getRMIRegPort(String sAObject) {
401 return hmRMIRegPort.get(hmActiveObj.get(sAObject));
406 * Method getRMIStubPort()
408 * User finds Out-Port number using Object name
410 * @param sAObject String active object name
413 public Integer getRMIStubPort(String sAObject) {
415 return hmRMIStubPort.get(hmActiveObj.get(sAObject));
420 * Method getFieldObjectID()
422 * User finds field object ID using Object name
424 * @param sAObject String active object name
427 public String getFieldObjectID(String sAObject) {
429 return listFieldObjectID.get(listActiveControllerObj.indexOf(sAObject));
434 * Method getObjectCreationInfo()
436 * User finds ObjectCreationInfo using Object name
438 * @param sAObject String active object name
439 * @return ObjectCreationInfo
441 public ObjectCreationInfo getObjectCreationInfo(String sAObject) {
443 return listObjCrtInfo.get(listActiveControllerObj.indexOf(sAObject));
448 * Method getArrayFieldClasses()
450 * User finds array of field classes using Object name
452 * @param sAObject String active object name
455 public Class[] getArrayFieldClasses(String sAObject) {
457 return listArrFieldClasses.get(listActiveControllerObj.indexOf(sAObject));
462 * Method getArrayFieldValues()
464 * User finds array of field values using Object name
466 * @param sAObject String active object name
469 public Object[] getArrayFieldValues(String sAObject) {
471 return listArrFieldValues.get(listActiveControllerObj.indexOf(sAObject));
476 * Method getActiveControllerObjectList()
478 * @return List<String>
480 public List<String> getActiveControllerObjectList() {
482 return listActiveControllerObj;
487 * Method printLists()
491 public void printLists() {
493 // Iterate on HostAddress
494 for(String s : hmHostList.keySet()) {
496 for(String str : hmHostList.get(s)) {
498 int iIndex = hmActiveObj.get(str);
499 RuntimeOutput.print("Active Object: " + str, bVerbose);
500 RuntimeOutput.print("Communication Port: " + hmComPort.get(iIndex), bVerbose);
501 RuntimeOutput.print("RMI Registry Port: " + hmRMIRegPort.get(iIndex), bVerbose);
502 RuntimeOutput.print("RMI Stub Port: " + hmRMIStubPort.get(iIndex), bVerbose);
503 RuntimeOutput.print("\n", bVerbose);
507 for(int iPort : hsDevicePort) {
508 RuntimeOutput.print("Device Port: " + iPort, bVerbose);
510 RuntimeOutput.print("\n", bVerbose);