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> hsCallbackPort;
71 private int iNumOfObjects;
72 private int iNumOfHosts;
73 private boolean bVerbose;
76 * CommunicationHandler class constants
78 private final int INT_MAX_PORT = 65535;
79 private final int INT_MIN_PORT = 10000;
84 public CommunicationHandler(boolean _bVerbose) {
86 random = new Random();
87 listActiveControllerObj = new ArrayList<String>();
88 listFieldObjectID = new ArrayList<String>();
89 listObjCrtInfo = new ArrayList<ObjectCreationInfo>();
90 listArrFieldValues = new ArrayList<Object[]>();
91 listArrFieldClasses = new ArrayList<Class[]>();
92 hmActiveObj = new HashMap<String, Integer>();
93 hmHostAdd = new HashMap<Integer, String>();
94 hmHostList = new HashMap<String, ArrayList<String>>();
95 hmComPort = new HashMap<Integer, Integer>();
96 hmRMIRegPort = new HashMap<Integer, Integer>();
97 hmRMIStubPort = new HashMap<Integer, Integer>();
98 hsDevicePort = new HashSet<Integer>();
99 hsCallbackPort = new HashSet<Integer>();
102 bVerbose = _bVerbose;
103 RuntimeOutput.print("CommunicationHandler: Creating a new CommunicationHandler object!", bVerbose);
107 * Method addPortConnection()
109 * Add a new connection then generate new in-port and out-port numbers
111 * @param sHAddress String host address
112 * @param sAObject String active object name
115 public void addPortConnection(String sHAddress, String sAObject) {
117 // Increment counter first before we add objects as we start from 0
118 // Objects are named uniquely so we record this and match with the host
119 // Hostname occurrence can be repetitive as there can be more than
120 // one host on one compute node
122 // Add a new object in the list of objects
123 hmActiveObj.put(sAObject, iNumOfObjects);
125 // Check host existence in our data structure
126 // Add a new host and a new object
127 if(hmHostList.containsKey(sHAddress) == false) {
129 hmHostList.put(sHAddress, new ArrayList<String>());
131 hmHostList.get(sHAddress).add(sAObject);
133 // Map object to host
134 hmHostAdd.put(iNumOfObjects, sHAddress);
138 iComPort = random.nextInt(INT_MAX_PORT - INT_MIN_PORT + 1) + INT_MIN_PORT;
139 // Check port existence in HashMap
140 } while (portIsAvailable(iComPort) == false);
141 hmComPort.put(iNumOfObjects, iComPort);
145 iRMIRegPort = random.nextInt(INT_MAX_PORT - INT_MIN_PORT + 1) + INT_MIN_PORT;
146 // Check port existence in HashMap
147 } while (portIsAvailable(iRMIRegPort) == false);
148 hmRMIRegPort.put(iNumOfObjects, iRMIRegPort);
150 int iRMIStubPort = 0;
152 iRMIStubPort = random.nextInt(INT_MAX_PORT - INT_MIN_PORT + 1) + INT_MIN_PORT;
153 // Check port existence in HashMap
154 } while (portIsAvailable(iRMIStubPort) == false);
155 hmRMIStubPort.put(iNumOfObjects, iRMIStubPort);
161 * A private method to add a new active controller object
163 * @params strFieldObjectID String field object ID
164 * @params strObjName String object name
165 * @params strObjClassName String object class name
166 * @params strObjClassInterfaceName String object class interface name
167 * @params strIoTSlaveObjectHostAdd String IoTSlave host address
168 * @params arrFieldValues Array of field values
169 * @params arrFieldClasses Array of field classes
172 public void addActiveControllerObject(String strFieldObjectID, String strObjName, String strObjClassName,
173 String strObjClassInterfaceName, String strIoTSlaveObjectHostAdd, Object[] arrFieldValues,
174 Class[] arrFieldClasses) {
176 listActiveControllerObj.add(strObjName);
177 listFieldObjectID.add(strFieldObjectID);
178 listArrFieldValues.add(arrFieldValues);
179 listArrFieldClasses.add(arrFieldClasses);
180 ObjectCreationInfo objCrtInfo = new ObjectCreationInfo(strIoTSlaveObjectHostAdd, strObjName,
181 strObjClassName, strObjClassInterfaceName);
182 listObjCrtInfo.add(objCrtInfo);
187 * Method getCallbackPort()
189 * Get a new port for new connections for callback objects in the program.
190 * This newly generated port number will be recorded.
192 * @return int[] A set of callback ports
194 public int[] getCallbackPorts(int numOfPorts) {
196 int[] ports = new int[numOfPorts];
198 for(int i = 0; i < numOfPorts; i++) {
200 ports[i] = random.nextInt(INT_MAX_PORT - INT_MIN_PORT + 1) + INT_MIN_PORT;
201 // Check port existence in HashMap
202 } while (portIsAvailable(ports[i]) == false);
203 hsCallbackPort.add(ports[i]);
211 * Method addDevicePort()
213 * Add a port that is used by a device when communicating with its driver
214 * This port will be taken into account when checking for port availability
216 * @param iDevPort Device port number
219 public void addDevicePort(int iDevPort) {
221 hsDevicePort.add(iDevPort);
226 * Method portIsAvailable()
228 * Checks the availability of the newly generated port.
229 * If port number has been used in any of the lists then
230 * it is not available
232 * @param iPortNumber Device port number
235 public boolean portIsAvailable(int iPortNumber) {
237 if (hmComPort.containsValue(iPortNumber) == true) {
239 } else if (hmRMIRegPort.containsValue(iPortNumber) == true) {
241 } else if (hmRMIStubPort.containsValue(iPortNumber) == true) {
243 } else if (hsDevicePort.contains(iPortNumber) == true) {
245 } else if (hsCallbackPort.contains(iPortNumber) == true) {
253 * Method getNumOfObjects()
257 public int getNumOfObjects() {
259 return iNumOfObjects;
264 * Method getNumOfHosts()
268 public int getNumOfHosts() {
275 * Method objectExists()
277 * @param sObjName String object name
280 public boolean objectExists(String sObjName) {
282 return hmActiveObj.containsKey(sObjName);
287 * Method hostExists()
289 * @param sHostName String host name
292 public boolean hostExists(String sHostName) {
294 return hmHostList.containsKey(sHostName);
299 * Method getHostAddress()
301 * User finds HostAddress using Object name
303 * @param sAObject String active object name
306 public String getHostAddress(String sAObject) {
308 return hmHostAdd.get(hmActiveObj.get(sAObject));
315 * User gets the set of hostnames
319 public Set<String> getHosts() {
321 return hmHostList.keySet();
326 * Method getComPort()
328 * User finds In-Port number using Object name
330 * @param sAObject String active object name
333 public Integer getComPort(String sAObject) {
335 return hmComPort.get(hmActiveObj.get(sAObject));
339 * Method getRMIRegPort()
341 * User finds Out-Port number using Object name
343 * @param sAObject String active object name
346 public Integer getRMIRegPort(String sAObject) {
348 return hmRMIRegPort.get(hmActiveObj.get(sAObject));
353 * Method getRMIStubPort()
355 * User finds Out-Port number using Object name
357 * @param sAObject String active object name
360 public Integer getRMIStubPort(String sAObject) {
362 return hmRMIStubPort.get(hmActiveObj.get(sAObject));
367 * Method getFieldObjectID()
369 * User finds field object ID using Object name
371 * @param sAObject String active object name
374 public String getFieldObjectID(String sAObject) {
376 return listFieldObjectID.get(listActiveControllerObj.indexOf(sAObject));
381 * Method getObjectCreationInfo()
383 * User finds ObjectCreationInfo using Object name
385 * @param sAObject String active object name
386 * @return ObjectCreationInfo
388 public ObjectCreationInfo getObjectCreationInfo(String sAObject) {
390 return listObjCrtInfo.get(listActiveControllerObj.indexOf(sAObject));
395 * Method getArrayFieldClasses()
397 * User finds array of field classes using Object name
399 * @param sAObject String active object name
402 public Class[] getArrayFieldClasses(String sAObject) {
404 return listArrFieldClasses.get(listActiveControllerObj.indexOf(sAObject));
409 * Method getArrayFieldValues()
411 * User finds array of field values using Object name
413 * @param sAObject String active object name
416 public Object[] getArrayFieldValues(String sAObject) {
418 return listArrFieldValues.get(listActiveControllerObj.indexOf(sAObject));
423 * Method getActiveControllerObjectList()
425 * @return List<String>
427 public List<String> getActiveControllerObjectList() {
429 return listActiveControllerObj;
434 * Method printLists()
438 public void printLists() {
440 // Iterate on HostAddress
441 for(String s : hmHostList.keySet()) {
443 for(String str : hmHostList.get(s)) {
445 int iIndex = hmActiveObj.get(str);
446 RuntimeOutput.print("Active Object: " + str, bVerbose);
447 RuntimeOutput.print("Communication Port: " + hmComPort.get(iIndex), bVerbose);
448 RuntimeOutput.print("RMI Registry Port: " + hmRMIRegPort.get(iIndex), bVerbose);
449 RuntimeOutput.print("RMI Stub Port: " + hmRMIStubPort.get(iIndex), bVerbose);
453 for(int iPort : hsDevicePort) {
455 RuntimeOutput.print("Device Port: " + iPort, bVerbose);