Split out the computer name resolving stuff. Should be easier to add new resolvers if/when ITS start using their random computer names in all labs.

mark.george / democall3

Browse code Split out the computer name resolving stuff. Should be easier to add new resolvers if/when ITS start using their random computer names in all labs. master
1 parent 33d3932 commit 926fc12c1a5a69db1ddabadf68b01d455b37bf84 Mark authored on 22 Sep 2012

Patch

Showing 6 changed files

Ignore Space Show notes View src/clients/StudentClient.java
package clients; import constants.Constants; import discovery.computername.ComputerNameResolver; import discovery.computername.InvalidComputerNameException; import discovery.computername.OtagoComputerNameResolver; import discovery.server.ServiceLocator; import java.awt.; import java.awt.event.ActionEvent; import java.awt.event.ActionListener; import java.util.Timer; import java.util.logging.Level; import java.util.logging.Logger; import network.MessageGenerator; import network.RequestSender; /* * The student's client for requesting help. * * It adds a system tray icon that has a pop-up menu that the student can use to * request help or cancel their request. Requests are automatically canceled * when the student clicks the "exit" menu item, or the client is terminated by * the OS (via a shutdown hook) meaning there should never be requests in the * queue for students who have gone home. * * This aims to be both simple and robust, therefor the StudentClient stores no * state relating to requests, uses no persistent connections to the server, * and receives no information from the server. * * The client uses a multi-cast broadcast to discover the IP of the server, * which it then uses to send requests to the server. * * The wire protocol is very simple. A string in the form "request 23" is a * request for from the machine with ID 23, and "cancel 23" will cancel that * request. Sending multiple "request" commands or multiple "cancel" commands to * the server should cause no duplication or problems on the server and are * effectively ignored. * * @author Mark / public class StudentClient { private static final Logger LOG = Logger.getLogger(StudentClient.class.getName()); private final PopupMenu trayPopopMenu = new PopupMenu(); private final Image trayIconImage = Toolkit.getDefaultToolkit().getImage(getClass().getResource("/icon.png")); private final TrayIcon systemTrayIcon = new TrayIcon(trayIconImage, "Demo Call " + Constants.VERSION, trayPopopMenu); private final MessageGenerator generator = new MessageGenerator(); private String machineId; private RequestSender requestSender; private boolean foundServer = false; private final Thread shutDownHook = new Thread() { @Override public void run() { cleanUp(); } }; public StudentClient(final ComputerNameResolver nameResolver) { try { createTrayMenu(); // not sure this is necessary but Windows is currently not exiting when the shutdown hook kicks in... this.shutDownHook.setDaemon(true); Runtime.getRuntime().addShutdownHook(this.shutDownHook); try { nameResolver.resolve(); } catch (InvalidComputerNameException ex) { this.systemTrayIcon.displayMessage("Whoops", ex.getMessage(), TrayIcon.MessageType.ERROR); // give user a chance to read message Thread.sleep(5000); // shutdown exit(); } final String lab = nameResolver.getLabName(); this.machineId = nameResolver.getMachineId(); // create a timer to cause a timeout if server IP not found within 5 seconds final Timer timer = new Timer(); timer.schedule(new TimeoutTask(this.systemTrayIcon), 5000); // find server IP (uses network multicast) final String serverIp = new ServiceLocator().locateServer(lab); // if we get to this point we got an IP so cancel timer timer.cancel(); this.foundServer = true; this.requestSender = new RequestSender(serverIp); } catch (Exception ex) { LOG.log(Level.SEVERE, null, ex); } } private void createTrayMenu() { try { this.systemTrayIcon.setImageAutoSize(true); MenuItem request = new MenuItem("Request Help"); request.addActionListener(new ActionListener() { public void actionPerformed(ActionEvent e) { makeRequest(); } }); final MenuItem cancel = new MenuItem("Cancel Request"); cancel.addActionListener(new ActionListener() { public void actionPerformed(ActionEvent e) { cancelRequest(); } }); MenuItem exit = new MenuItem("Exit"); exit.addActionListener(new ActionListener() { public void actionPerformed(ActionEvent e) { exit(); } }); this.trayPopopMenu.add(request); this.trayPopopMenu.add(cancel); this.trayPopopMenu.addSeparator(); this.trayPopopMenu.add(exit); SystemTray.getSystemTray().add(this.systemTrayIcon); } catch (Exception ex) { LOG.log(Level.SEVERE, null, ex); } } private void makeRequest() { try { requestSender.sendRequest(generator.requestHelp(machineId)); systemTrayIcon.displayMessage("Help is on the way", "Your request is now in the queue.", TrayIcon.MessageType.INFO); } catch (Exception ex) { systemTrayIcon.displayMessage("Whoops", "Failed to make request", TrayIcon.MessageType.ERROR); LOG.log(Level.SEVERE, "Error making request", ex); } } private void cancelRequest() { try { requestSender.sendRequest(generator.cancelRequest(machineId)); systemTrayIcon.displayMessage("Request removed", "Your request has been removed from the queue.", TrayIcon.MessageType.INFO); } catch (Exception ex) { systemTrayIcon.displayMessage("Whoops", "Failed to cancel request", TrayIcon.MessageType.ERROR); LOG.log(Level.SEVERE, "Error cancelling request", ex); } } private void exit() { this.cleanUp(); // force an exit since they are several threads lurking around that could keep the process running System.exit(0); } private void cleanUp() { // cancel any requests the student has made if(this.foundServer) { cancelRequest(); } // remove the tray icon from the system tray SystemTray.getSystemTray().remove(systemTrayIcon); } @SuppressWarnings("ResultOfObjectAllocationIgnored") public static void main(final String[] args) { final String name = "SBEASTCAL1-30"; // final String name = args.length > 0 ? args[0] : null; final ComputerNameResolver nameResolver = new OtagoComputerNameResolver(name, "COMPUTERNAME"); new StudentClient(nameResolver); } } package clients; import constants.Constants; import discovery.ComputerNameResolver; import discovery.ServiceLocator; import java.awt.; import java.awt.event.ActionEvent; import java.awt.event.ActionListener; import java.util.Timer; import java.util.logging.Level; import java.util.logging.Logger; import network.MessageGenerator; import network.RequestSender; /** * The student's client for requesting help. * * It adds a system tray icon that has a pop-up menu that the student can use to * request help or cancel their request. Requests are automatically canceled * when the student clicks the "exit" menu item, or the client is terminated by * the OS (via a shutdown hook) meaning there should never be requests in the * queue for students who have gone home. * * This aims to be both simple and robust, therefor the StudentClient stores no * state relating to requests, uses no persistent connections to the server, * and receives no information from the server. * * The client uses a multi-cast broadcast to discover the IP of the server, * which it then uses to send requests to the server. * * The wire protocol is very simple. A string in the form "request 23" is a * request for from the machine with ID 23, and "cancel 23" will cancel that * request. Sending multiple "request" commands or multiple "cancel" commands to * the server should cause no duplication or problems on the server and are * effectively ignored. * * @author Mark */ public class StudentClient { private static final Logger LOG = Logger.getLogger(StudentClient.class.getName()); private final PopupMenu trayPopopMenu = new PopupMenu(); private final Image trayIconImage = Toolkit.getDefaultToolkit().getImage(getClass().getResource("/icon.png")); private final TrayIcon systemTrayIcon = new TrayIcon(trayIconImage, "Demo Call " + Constants.VERSION, trayPopopMenu); private final MessageGenerator generator = new MessageGenerator(); private String serverIp; private String machineId; private RequestSender requestSender; private boolean foundServer = false; private final Thread shutDownHook = new Thread() { @Override public void run() { cleanUp(); } }; public StudentClient(String compName) { try { createTrayMenu(); // not sure this is necessary but Windows is currently not exiting when the shutdown hook kicks in... this.shutDownHook.setDaemon(true); Runtime.getRuntime().addShutdownHook(this.shutDownHook); if (compName == null) { this.systemTrayIcon.displayMessage("Whoops", "COMPUTERNAME environment variable is not set.", TrayIcon.MessageType.ERROR); // give user a chance to read message Thread.sleep(5000); // shutdown exit(); } // lab machines usually have a COMPUTERNAME in the form "labname-machineId", eg SB316-23 // process computer name to extract lab and machine ID String[] nameBits = compName.split("-"); if (nameBits.length < 2) { this.systemTrayIcon.displayMessage("Whoops", "COMPUTERNAME environment variable is not in the expected format.", TrayIcon.MessageType.ERROR); // give user a chance to read message Thread.sleep(5000); // shutdown exit(); } String lab = nameBits[0]; this.machineId = nameBits[1]; // create a timer to cause a timeout if server IP not found within 5 seconds Timer timer = new Timer(); timer.schedule(new TimeoutTask(this.systemTrayIcon), 5000); // find server IP (uses network multicast) this.serverIp = new ServiceLocator().locateServer(lab); // if we get to this point we got an IP so cancel timer timer.cancel(); this.foundServer = true; this.requestSender = new RequestSender(serverIp); } catch (Exception ex) { LOG.log(Level.SEVERE, null, ex); } } private void createTrayMenu() { try { this.systemTrayIcon.setImageAutoSize(true); MenuItem request = new MenuItem("Request Help"); request.addActionListener(new ActionListener() { public void actionPerformed(ActionEvent e) { makeRequest(); } }); final MenuItem cancel = new MenuItem("Cancel Request"); cancel.addActionListener(new ActionListener() { public void actionPerformed(ActionEvent e) { cancelRequest(); } }); MenuItem exit = new MenuItem("Exit"); exit.addActionListener(new ActionListener() { public void actionPerformed(ActionEvent e) { exit(); } }); this.trayPopopMenu.add(request); this.trayPopopMenu.add(cancel); this.trayPopopMenu.addSeparator(); this.trayPopopMenu.add(exit); SystemTray.getSystemTray().add(this.systemTrayIcon); } catch (Exception ex) { LOG.log(Level.SEVERE, null, ex); } } private void makeRequest() { try { requestSender.sendRequest(generator.requestHelp(machineId)); systemTrayIcon.displayMessage("Help is on the way", "Your request is now in the queue.", TrayIcon.MessageType.INFO); } catch (Exception ex) { systemTrayIcon.displayMessage("Whoops", "Failed to make request", TrayIcon.MessageType.ERROR); LOG.log(Level.SEVERE, "Error making request", ex); } } private void cancelRequest() { try { requestSender.sendRequest(generator.cancelRequest(machineId)); systemTrayIcon.displayMessage("Request removed", "Your request has been removed from the queue.", TrayIcon.MessageType.INFO); } catch (Exception ex) { systemTrayIcon.displayMessage("Whoops", "Failed to cancel request", TrayIcon.MessageType.ERROR); LOG.log(Level.SEVERE, "Error cancelling request", ex); } } private void exit() { this.cleanUp(); // force an exit since they are several threads lurking around that could keep the process running System.exit(0); } private void cleanUp() { // cancel any requests the student has made if(this.foundServer) { cancelRequest(); } // remove the tray icon from the system tray SystemTray.getSystemTray().remove(systemTrayIcon); } @SuppressWarnings("ResultOfObjectAllocationIgnored") public static void main(String[] args) throws Exception { String compName = ComputerNameResolver.getName(); if(args.length > 0) { compName = args[0]; } new StudentClient(compName); } }

Ignore Space Show notes View

src/clients/StudentClient.java

package clients;

import constants.Constants;
import discovery.computername.ComputerNameResolver;
import discovery.computername.InvalidComputerNameException;
import discovery.computername.OtagoComputerNameResolver;
import discovery.server.ServiceLocator;
import java.awt.*;
import java.awt.event.ActionEvent;
import java.awt.event.ActionListener;
import java.util.Timer;
import java.util.logging.Level;
import java.util.logging.Logger;
import network.MessageGenerator;
import network.RequestSender;

/**
 * The student's client for requesting help.
 * 
 * It adds a system tray icon that has a pop-up menu that the student can use to
 * request help or cancel their request. Requests are automatically canceled
 * when the student clicks the "exit" menu item, or the client is terminated by
 * the OS (via a shutdown hook) meaning there should never be requests in the
 * queue for students who have gone home.
 *
 * This aims to be both simple and robust, therefor the StudentClient stores no
 * state relating to requests, uses no persistent connections to the server,
 * and receives no information from the server.
 *
 * The client uses a multi-cast broadcast to discover the IP of the server,
 * which it then uses to send requests to the server.
 *
 * The wire protocol is very simple. A string in the form "request 23" is a
 * request for from the machine with ID 23, and "cancel 23" will cancel that
 * request. Sending multiple "request" commands or multiple "cancel" commands to
 * the server should cause no duplication or problems on the server and are
 * effectively ignored.
 *
 * @author Mark
 */
public class StudentClient {
   
   private static final Logger LOG = Logger.getLogger(StudentClient.class.getName());

private final PopupMenu trayPopopMenu = new PopupMenu();
   private final Image trayIconImage = Toolkit.getDefaultToolkit().getImage(getClass().getResource("/icon.png"));
   private final TrayIcon systemTrayIcon = new TrayIcon(trayIconImage, "Demo Call " + Constants.VERSION, trayPopopMenu);
   private final MessageGenerator generator = new MessageGenerator();

private String machineId;
   private  RequestSender requestSender;

private boolean foundServer = false;

private final Thread shutDownHook = new Thread() {

@Override
      public void run() {
         cleanUp();
      }

};

public StudentClient(final ComputerNameResolver nameResolver) {
      try {
         createTrayMenu();

// not sure this is necessary but Windows is currently not exiting when the shutdown hook kicks in...
         this.shutDownHook.setDaemon(true);

Runtime.getRuntime().addShutdownHook(this.shutDownHook);

try {
            nameResolver.resolve();
         } catch (InvalidComputerNameException ex) {
            this.systemTrayIcon.displayMessage("Whoops", ex.getMessage(), TrayIcon.MessageType.ERROR);

// give user a chance to read message
            Thread.sleep(5000);

// shutdown
            exit();
         }

final String lab = nameResolver.getLabName();
         this.machineId = nameResolver.getMachineId();

// create a timer to cause a timeout if server IP not found within 5 seconds
         final Timer timer = new Timer();
         timer.schedule(new TimeoutTask(this.systemTrayIcon), 5000);

// find server IP (uses network multicast)
         final String serverIp =  new ServiceLocator().locateServer(lab);

// if we get to this point we got an IP so cancel timer
         timer.cancel();

this.foundServer = true;

this.requestSender = new RequestSender(serverIp);

} catch (Exception ex) {
         LOG.log(Level.SEVERE, null, ex);
      }

}

private void createTrayMenu() {
      try {

this.systemTrayIcon.setImageAutoSize(true);

MenuItem request = new MenuItem("Request Help");
         request.addActionListener(new ActionListener() {

public void actionPerformed(ActionEvent e) {
               makeRequest();
            }

});

final MenuItem cancel = new MenuItem("Cancel Request");
         cancel.addActionListener(new ActionListener() {

public void actionPerformed(ActionEvent e) {
               cancelRequest();
            }

});

MenuItem exit = new MenuItem("Exit");
         exit.addActionListener(new ActionListener() {

public void actionPerformed(ActionEvent e) {
               exit();
            }

});

this.trayPopopMenu.add(request);
         this.trayPopopMenu.add(cancel);
         this.trayPopopMenu.addSeparator();
         this.trayPopopMenu.add(exit);

SystemTray.getSystemTray().add(this.systemTrayIcon);

} catch (Exception ex) {
         LOG.log(Level.SEVERE, null, ex);
      }
   }

private void makeRequest() {
      try {
         requestSender.sendRequest(generator.requestHelp(machineId));
         systemTrayIcon.displayMessage("Help is on the way", "Your request is now in the queue.", TrayIcon.MessageType.INFO);
      } catch (Exception ex) {
         systemTrayIcon.displayMessage("Whoops", "Failed to make request", TrayIcon.MessageType.ERROR);
         LOG.log(Level.SEVERE, "Error making request", ex);
      }
   }

private void cancelRequest() {
      try {
         requestSender.sendRequest(generator.cancelRequest(machineId));
         systemTrayIcon.displayMessage("Request removed", "Your request has been removed from the queue.", TrayIcon.MessageType.INFO);
      } catch (Exception ex) {
         systemTrayIcon.displayMessage("Whoops", "Failed to cancel request", TrayIcon.MessageType.ERROR);
         LOG.log(Level.SEVERE, "Error cancelling request", ex);
      }
   }

private void exit() {
      this.cleanUp();

// force an exit since they are several threads lurking around that could keep the process running
      System.exit(0);
   }

private void cleanUp() {
      // cancel any requests the student has made
      if(this.foundServer) {
         cancelRequest();
      }

// remove the tray icon from the system tray
      SystemTray.getSystemTray().remove(systemTrayIcon);
   }

@SuppressWarnings("ResultOfObjectAllocationIgnored")
   public static void main(final String[] args) {

final String name = "SBEASTCAL1-30";

//      final String name = args.length > 0 ? args[0] : null;

final ComputerNameResolver nameResolver = new OtagoComputerNameResolver(name, "COMPUTERNAME");

new StudentClient(nameResolver);
   }
   
}

package clients;

import constants.Constants;
import discovery.ComputerNameResolver;
import discovery.ServiceLocator;
import java.awt.*;
import java.awt.event.ActionEvent;
import java.awt.event.ActionListener;
import java.util.Timer;
import java.util.logging.Level;
import java.util.logging.Logger;
import network.MessageGenerator;
import network.RequestSender;

private String serverIp;
   private String machineId;
   private  RequestSender requestSender;

private boolean foundServer = false;

private final Thread shutDownHook = new Thread() {

@Override
      public void run() {
         cleanUp();
      }

};

public StudentClient(String compName) {
      try {
         createTrayMenu();

// not sure this is necessary but Windows is currently not exiting when the shutdown hook kicks in...
         this.shutDownHook.setDaemon(true);

Runtime.getRuntime().addShutdownHook(this.shutDownHook);

if (compName == null) {
            this.systemTrayIcon.displayMessage("Whoops", "COMPUTERNAME environment variable is not set.", TrayIcon.MessageType.ERROR);

// give user a chance to read message
            Thread.sleep(5000);

// shutdown
            exit();
         }

// lab machines usually have a COMPUTERNAME in the form "labname-machineId", eg SB316-23

// process computer name to extract lab and machine ID
         String[] nameBits = compName.split("-");

if (nameBits.length < 2) {
            this.systemTrayIcon.displayMessage("Whoops", "COMPUTERNAME environment variable is not in the expected format.", TrayIcon.MessageType.ERROR);

// give user a chance to read message
            Thread.sleep(5000);

// shutdown
            exit();
         }

String lab = nameBits[0];
         this.machineId = nameBits[1];

// create a timer to cause a timeout if server IP not found within 5 seconds
         Timer timer = new Timer();
         timer.schedule(new TimeoutTask(this.systemTrayIcon), 5000);

// find server IP (uses network multicast)
         this.serverIp =  new ServiceLocator().locateServer(lab);

// if we get to this point we got an IP so cancel timer
         timer.cancel();

this.foundServer = true;

this.requestSender = new RequestSender(serverIp);

} catch (Exception ex) {
         LOG.log(Level.SEVERE, null, ex);
      }

}

private void createTrayMenu() {
      try {

this.systemTrayIcon.setImageAutoSize(true);

MenuItem request = new MenuItem("Request Help");
         request.addActionListener(new ActionListener() {

public void actionPerformed(ActionEvent e) {
               makeRequest();
            }

});

final MenuItem cancel = new MenuItem("Cancel Request");
         cancel.addActionListener(new ActionListener() {

public void actionPerformed(ActionEvent e) {
               cancelRequest();
            }

});

MenuItem exit = new MenuItem("Exit");
         exit.addActionListener(new ActionListener() {

public void actionPerformed(ActionEvent e) {
               exit();
            }

});

this.trayPopopMenu.add(request);
         this.trayPopopMenu.add(cancel);
         this.trayPopopMenu.addSeparator();
         this.trayPopopMenu.add(exit);

SystemTray.getSystemTray().add(this.systemTrayIcon);

} catch (Exception ex) {
         LOG.log(Level.SEVERE, null, ex);
      }
   }

private void exit() {
      this.cleanUp();

// force an exit since they are several threads lurking around that could keep the process running
      System.exit(0);
   }

private void cleanUp() {
      // cancel any requests the student has made
      if(this.foundServer) {
         cancelRequest();
      }

// remove the tray icon from the system tray
      SystemTray.getSystemTray().remove(systemTrayIcon);
   }

@SuppressWarnings("ResultOfObjectAllocationIgnored")
   public static void main(String[] args) throws Exception {

String compName = ComputerNameResolver.getName();

if(args.length > 0) {
         compName = args[0];
      }

new StudentClient(compName);
   }
   
}

Ignore Space Show notes View src/clients/TutorClient.java
package clients; import constants.Constants; import discovery.computername.ComputerNameResolver; import discovery.computername.InvalidComputerNameException; import discovery.computername.OtagoComputerNameResolver; import discovery.server.ServiceLocator; import gui.Lab; import gui.LabRegistry; import gui.QueuePanel; import gui.processors.TutorLabelProcessor; import java.awt.BorderLayout; import java.util.Collection; import java.util.Timer; import java.util.TimerTask; import java.util.logging.Level; import java.util.logging.Logger; import javax.swing.JFrame; import javax.swing.JOptionPane; import javax.swing.JPanel; import network.RequestSender; /** * * @author Mark / public class TutorClient { private static final Logger LOG = Logger.getLogger(TutorClient.class.getName()); private String serverIp; @SuppressWarnings("rawtypes") public TutorClient(final ComputerNameResolver nameResolver) { JFrame frame = null; try { nameResolver.resolve(); String labName = nameResolver.getLabName(); final LabRegistry registry = new LabRegistry(); final Lab[] labs = registry.getLabs().toArray(new Lab[registry.getLabs().size()]); final Lab currentLab = registry.getLab(labName); final Lab lab = (Lab) JOptionPane.showInputDialog(null, "Which lab?", "Which lab?", JOptionPane.QUESTION_MESSAGE, null, labs, currentLab); if (lab == null) { System.exit(0); } else { labName = lab.getLabName(); } serverIp = new ServiceLocator().locateServer(labName); frame = new JFrame(); frame.setDefaultCloseOperation(JFrame.EXIT_ON_CLOSE); frame.setAlwaysOnTop(true); final JPanel mapPanel = lab.getPanel(); final TutorLabelProcessor processor = new TutorLabelProcessor(serverIp); processor.processLabels(mapPanel); frame.setTitle(String.format("Democall %1s - Tutor Client (%1s)", Constants.VERSION, lab.getLabDescription())); frame.setLayout(new BorderLayout()); frame.add(BorderLayout.NORTH, new QueuePanel()); frame.add(BorderLayout.CENTER, mapPanel); frame.pack(); frame.setVisible(true); final Timer timer = new Timer(true); timer.scheduleAtFixedRate(new TimerTask() { @Override public void run() { final Collection<Integer> queue = new RequestSender(serverIp).requestQueue(); processor.update(queue); } }, 0, Constants.TUTOR_CLIENT_POLL); } catch (InvalidComputerNameException ex) { JOptionPane.showMessageDialog(frame, ex.getMessage(), "Error getting computer name", JOptionPane.ERROR_MESSAGE); } catch (Exception ex) { LOG.log(Level.SEVERE, null, ex); } } @SuppressWarnings("ResultOfObjectAllocationIgnored") public static void main(final String[] args) { final String name = "SBEASTCAL1-31"; // final String name = args.length > 0 ? args[0] : null; final ComputerNameResolver nameResolver = new OtagoComputerNameResolver(name, "COMPUTERNAME"); new TutorClient(nameResolver); } } package clients; import constants.Constants; import discovery.ComputerNameResolver; import discovery.ServiceLocator; import gui.Lab; import gui.LabRegistry; import gui.QueuePanel; import gui.processors.TutorLabelProcessor; import java.awt.BorderLayout; import java.util.Collection; import java.util.Timer; import java.util.TimerTask; import java.util.logging.Level; import java.util.logging.Logger; import javax.swing.JFrame; import javax.swing.JOptionPane; import javax.swing.JPanel; import network.RequestSender; /* * * @author Mark */ public class TutorClient { private static final Logger LOG = Logger.getLogger(TutorClient.class.getName()); private String serverIp; @SuppressWarnings("rawtypes") public TutorClient(String compName) { try { String[] nameBits = compName.split("-"); String labName = nameBits[0]; LabRegistry registry = new LabRegistry(); Object[] labs = registry.getLabs().toArray(); Lab currentLab = registry.getLab(labName); Lab lab = (Lab) JOptionPane.showInputDialog(null, "Which lab?", "Which lab?", JOptionPane.QUESTION_MESSAGE, null, labs, currentLab); if(lab==null) { JOptionPane.showMessageDialog(null, "There is no map for this lab yet.", "No map", JOptionPane.ERROR_MESSAGE); System.exit(Constants.EXIT_NO_MAP_FOUND); } else { labName = lab.getLabName(); } serverIp = new ServiceLocator().locateServer(labName); JFrame frame = new JFrame(); frame.setDefaultCloseOperation(JFrame.EXIT_ON_CLOSE); frame.setAlwaysOnTop( true ); JPanel mapPanel = lab.getPanel(); final TutorLabelProcessor processor = new TutorLabelProcessor(serverIp); processor.processLabels(mapPanel); frame.setTitle(String.format("Democall %1s - Tutor Client (%1s)", Constants.VERSION, lab.getLabDescription())); frame.setLayout(new BorderLayout()); frame.add(BorderLayout.NORTH, new QueuePanel()); frame.add(BorderLayout.CENTER, mapPanel); frame.pack(); frame.setVisible(true); Timer timer = new Timer(true); timer.scheduleAtFixedRate(new TimerTask() { @Override public void run() { Collection<Integer> queue = new RequestSender(serverIp).requestQueue(); processor.update(queue); } }, 0, Constants.TUTOR_CLIENT_POLL); } catch (Exception ex) { LOG.log(Level.SEVERE, null, ex); } } @SuppressWarnings("ResultOfObjectAllocationIgnored") public static void main(String[] args) { String compName = ComputerNameResolver.getName(); if(args.length > 0) { compName = args[0]; } new TutorClient(compName); } }

Ignore Space Show notes View

src/clients/TutorClient.java

package clients;

import constants.Constants;
import discovery.computername.ComputerNameResolver;
import discovery.computername.InvalidComputerNameException;
import discovery.computername.OtagoComputerNameResolver;
import discovery.server.ServiceLocator;
import gui.Lab;
import gui.LabRegistry;
import gui.QueuePanel;
import gui.processors.TutorLabelProcessor;
import java.awt.BorderLayout;
import java.util.Collection;
import java.util.Timer;
import java.util.TimerTask;
import java.util.logging.Level;
import java.util.logging.Logger;
import javax.swing.JFrame;
import javax.swing.JOptionPane;
import javax.swing.JPanel;
import network.RequestSender;

/**
 *
 * @author Mark
 */
public class TutorClient {

private static final Logger LOG = Logger.getLogger(TutorClient.class.getName());
   
   private String serverIp;

@SuppressWarnings("rawtypes")
   public TutorClient(final ComputerNameResolver nameResolver) {

JFrame frame = null;

try {
         nameResolver.resolve();

String labName = nameResolver.getLabName();

final LabRegistry registry = new LabRegistry();
         final Lab[] labs = registry.getLabs().toArray(new Lab[registry.getLabs().size()]);
         final Lab currentLab = registry.getLab(labName);

final Lab lab = (Lab) JOptionPane.showInputDialog(null, "Which lab?", "Which lab?",  JOptionPane.QUESTION_MESSAGE, null, labs, currentLab);

if (lab == null) {
            System.exit(0);
         } else {
            labName = lab.getLabName();
         }

serverIp = new ServiceLocator().locateServer(labName);
         frame = new JFrame();
         frame.setDefaultCloseOperation(JFrame.EXIT_ON_CLOSE);
         frame.setAlwaysOnTop(true);
         final JPanel mapPanel = lab.getPanel();
         final TutorLabelProcessor processor = new TutorLabelProcessor(serverIp);
         processor.processLabels(mapPanel);
         frame.setTitle(String.format("Democall %1s - Tutor Client (%1s)", Constants.VERSION, lab.getLabDescription()));
         frame.setLayout(new BorderLayout());
         frame.add(BorderLayout.NORTH, new QueuePanel());
         frame.add(BorderLayout.CENTER, mapPanel);
         frame.pack();
         frame.setVisible(true);

final Timer timer = new Timer(true);
         timer.scheduleAtFixedRate(new TimerTask() {

@Override
            public void run() {
               final Collection<Integer> queue = new RequestSender(serverIp).requestQueue();
               processor.update(queue);
            }
         }, 0, Constants.TUTOR_CLIENT_POLL);

} catch (InvalidComputerNameException ex) {
         JOptionPane.showMessageDialog(frame, ex.getMessage(), "Error getting computer name", JOptionPane.ERROR_MESSAGE);
      } catch (Exception ex) {
         LOG.log(Level.SEVERE, null, ex);
      }
   }

@SuppressWarnings("ResultOfObjectAllocationIgnored")
   public static void main(final String[] args) {

final String name = "SBEASTCAL1-31";

//      final String name = args.length > 0 ? args[0] : null;

final ComputerNameResolver nameResolver = new OtagoComputerNameResolver(name, "COMPUTERNAME");

new TutorClient(nameResolver);
   }

}

package clients;

import constants.Constants;
import discovery.ComputerNameResolver;
import discovery.ServiceLocator;
import gui.Lab;
import gui.LabRegistry;
import gui.QueuePanel;
import gui.processors.TutorLabelProcessor;
import java.awt.BorderLayout;
import java.util.Collection;
import java.util.Timer;
import java.util.TimerTask;
import java.util.logging.Level;
import java.util.logging.Logger;
import javax.swing.JFrame;
import javax.swing.JOptionPane;
import javax.swing.JPanel;
import network.RequestSender;

/**
 *
 * @author Mark
 */
public class TutorClient {

private static final Logger LOG = Logger.getLogger(TutorClient.class.getName());
   
   private String serverIp;

@SuppressWarnings("rawtypes")
   public TutorClient(String compName) {

try {
         String[] nameBits = compName.split("-");
         String labName = nameBits[0];

LabRegistry registry = new LabRegistry();
         Object[] labs = registry.getLabs().toArray();
         Lab currentLab = registry.getLab(labName);

Lab lab = (Lab) JOptionPane.showInputDialog(null, "Which lab?", "Which lab?",  JOptionPane.QUESTION_MESSAGE, null, labs, currentLab);
         if(lab==null) {
            JOptionPane.showMessageDialog(null, "There is no map for this lab yet.", "No map", JOptionPane.ERROR_MESSAGE);
            System.exit(Constants.EXIT_NO_MAP_FOUND);
         } else {
            labName = lab.getLabName();
         }

serverIp = new ServiceLocator().locateServer(labName);
         JFrame frame = new JFrame();
         frame.setDefaultCloseOperation(JFrame.EXIT_ON_CLOSE);
         frame.setAlwaysOnTop( true );
         JPanel mapPanel = lab.getPanel();
         final TutorLabelProcessor processor = new TutorLabelProcessor(serverIp);
         processor.processLabels(mapPanel);
         frame.setTitle(String.format("Democall %1s - Tutor Client (%1s)", Constants.VERSION, lab.getLabDescription()));
         frame.setLayout(new BorderLayout());
         frame.add(BorderLayout.NORTH, new QueuePanel());
         frame.add(BorderLayout.CENTER, mapPanel);
         frame.pack();
         frame.setVisible(true);

Timer timer = new Timer(true);
         timer.scheduleAtFixedRate(new TimerTask() {

@Override
            public void run() {
               Collection<Integer> queue = new RequestSender(serverIp).requestQueue();
               processor.update(queue);
            }
         }, 0, Constants.TUTOR_CLIENT_POLL);

} catch (Exception ex) {
         LOG.log(Level.SEVERE, null, ex);
      }
   }

@SuppressWarnings("ResultOfObjectAllocationIgnored")
   public static void main(String[] args) {
      String compName = ComputerNameResolver.getName();

if(args.length > 0) {
         compName = args[0];
      }

new TutorClient(compName);
   }

}

Ignore Space Show notes View src/discovery/computername/ComputerNameResolver.java
package discovery.computername; /* * @author Mark / public interface ComputerNameResolver { String getComputerName(); String getLabName(); String getMachineId(); /* * Parses the computer name into it lab and machine ID parts. * * @throws InvalidComputerNameException if the name can not be resolved or * is not in the expected format. / void resolve(); } package discovery; /* * * @author Mark */ public class ComputerNameResolver { private ComputerNameResolver() { } public static String getName() { // return System.getenv("COMPUTERNAME"); // return "SBEASTCAL1-01"; return "SBEASTCAL1-30"; } }

Ignore Space Show notes View

src/discovery/computername/ComputerNameResolver.java

Ignore Space Show notes View src/discovery/computername/InvalidComputerNameException.java 0 → 100644
package discovery.computername; /* * @author Mark */ public class InvalidComputerNameException extends RuntimeException { public InvalidComputerNameException(final String message) { super(message); } }

Ignore Space Show notes View src/discovery/computername/OtagoComputerNameResolver.java
package discovery.computername; /** * @author Mark / public final class OtagoComputerNameResolver implements ComputerNameResolver { private final String computerName; private String labName; private String machineId; /* * <p>Otago University lab machines usually have a COMPUTERNAME environment * variable in the form "labname-machineId", eg SB316-23.</p> * * <p>If the name parameter is set then use that, otherwise use the envVar * parameter to get the name from an environment variable.</p> * * @param name the computer name to use (or null). * @param envVar the environment variable to use if name is not set. * / public OtagoComputerNameResolver(final String name, final String envVar) { super(); if (name == null) { computerName = System.getenv(envVar); } else { computerName = name; } } public void resolve() { if(computerName == null) { throw new InvalidComputerNameException("The computer name has not been provided via a recognisable method.\nTry setting the COMPUTERNAME environment variable, or passing the name as an argument when starting the application."); } final String[] nameBits = computerName.split("-"); if (nameBits.length < 2) { throw new InvalidComputerNameException("The computer name '" + computerName + "' is not in the expected format (eg SB316-01)"); } this.labName = nameBits[0]; this.machineId = nameBits[1]; } public String getComputerName() { return this.computerName; } public String getLabName() { return this.labName; } public String getMachineId() { return this.machineId; } } package discovery; /* * * @author Mark */ public class ComputerNameResolver { private ComputerNameResolver() { } public static String getName() { // return System.getenv("COMPUTERNAME"); // return "SBEASTCAL1-01"; return "SBEASTCAL1-30"; } }

Ignore Space Show notes View

src/discovery/computername/OtagoComputerNameResolver.java

package discovery.computername;

/**
 * @author Mark
 */
public final class OtagoComputerNameResolver implements ComputerNameResolver {

private final String computerName;
   private String labName;
   private String machineId;

/**
    * <p>Otago University lab machines usually have a COMPUTERNAME environment
    * variable in the form "labname-machineId", eg SB316-23.</p>
    *
    * <p>If the name parameter is set then use that, otherwise use the envVar
    * parameter to get the name from an environment variable.</p>
    *
    * @param name the computer name to use (or null).
    * @param envVar the environment variable to use if name is not set.
    *
    */
   public OtagoComputerNameResolver(final String name, final String envVar) {
      super();

if (name == null) {
         computerName = System.getenv(envVar);
      } else {
         computerName = name;
      }

}

public void resolve() {
      if(computerName == null) {
         throw new InvalidComputerNameException("The computer name has not been provided via a recognisable method.\nTry setting the COMPUTERNAME environment variable, or passing the name as an argument when starting the application.");
      }

final String[] nameBits = computerName.split("-");

if (nameBits.length < 2) {
         throw new InvalidComputerNameException("The computer name '" + computerName + "' is not in the expected format (eg SB316-01)");
      }

this.labName = nameBits[0];
      this.machineId = nameBits[1];
   }
   
   public String getComputerName() {
      return this.computerName;
   }

public String getLabName() {
      return this.labName;
   }

public String getMachineId() {
      return this.machineId;
   }
}

Ignore Space Show notes View src/server/Server.java
package server; import constants.Constants; import discovery.computername.ComputerNameResolver; import discovery.computername.OtagoComputerNameResolver; import discovery.server.BroadcastResponder; import gui.Lab; import gui.LabRegistry; import gui.QueuePanel; import gui.processors.LabelProcessor; import gui.processors.ServerLabelProcessor; import java.awt.BorderLayout; import java.io.IOException; import javax.swing.JFrame; import javax.swing.JOptionPane; import javax.swing.JPanel; /** * * @author Mark / public class Server { private Server() { } public static void main(String[] args) throws IOException { final String name = "SBEASTCAL1-01"; // final String name = args.length > 0 ? args[0] : null; final ComputerNameResolver nameResolver = new OtagoComputerNameResolver(name, "COMPUTERNAME"); nameResolver.resolve(); final String labName = nameResolver.getLabName(); if(args.length > 0) { compName = args[0]; } String[] nameBits = compName.split("-"); final String labName = nameBits[0]; JFrame frame = new JFrame(); frame.setLayout(new BorderLayout()); frame.setDefaultCloseOperation(JFrame.EXIT_ON_CLOSE); LabRegistry registry = new LabRegistry(); Lab lab = registry.getLab(labName); if(lab == null) { JOptionPane.showMessageDialog(frame, "There is no map for this lab yet.", "No map", JOptionPane.ERROR_MESSAGE); System.exit(Constants.EXIT_NO_MAP_FOUND); } JPanel mapPanel = lab.getPanel(); LabelProcessor processor = new ServerLabelProcessor(); processor.processLabels(mapPanel); frame.setTitle(String.format("Democall %1s - Server (%1s)",Constants.VERSION, lab.getLabDescription())); frame.add(BorderLayout.NORTH, new QueuePanel()); frame.add(BorderLayout.CENTER, mapPanel); frame.pack(); frame.setVisible(true); new ApplicationHandler(processor).start(); new BroadcastResponder(labName).start(); } } package server; import constants.Constants; import discovery.BroadcastResponder; import discovery.ComputerNameResolver; import gui.Lab; import gui.LabRegistry; import gui.QueuePanel; import gui.processors.LabelProcessor; import gui.processors.ServerLabelProcessor; import java.awt.BorderLayout; import java.io.IOException; import javax.swing.JFrame; import javax.swing.JOptionPane; import javax.swing.JPanel; /* * * @author Mark */ public class Server { private Server() { } public static void main(String[] args) throws IOException { String compName = ComputerNameResolver.getName(); if(args.length > 0) { compName = args[0]; } String[] nameBits = compName.split("-"); final String labName = nameBits[0]; JFrame frame = new JFrame(); frame.setLayout(new BorderLayout()); frame.setDefaultCloseOperation(JFrame.EXIT_ON_CLOSE); LabRegistry registry = new LabRegistry(); Lab lab = registry.getLab(labName); if(lab == null) { JOptionPane.showMessageDialog(frame, "There is no map for this lab yet.", "No map", JOptionPane.ERROR_MESSAGE); System.exit(Constants.EXIT_NO_MAP_FOUND); } JPanel mapPanel = lab.getPanel(); LabelProcessor processor = new ServerLabelProcessor(); processor.processLabels(mapPanel); frame.setTitle(String.format("Democall %1s - Server (%1s)",Constants.VERSION, lab.getLabDescription())); frame.add(BorderLayout.NORTH, new QueuePanel()); frame.add(BorderLayout.CENTER, mapPanel); frame.pack(); frame.setVisible(true); new ApplicationHandler(processor).start(); new BroadcastResponder(labName).start(); } }

Ignore Space Show notes View

src/server/Server.java

package server;

import constants.Constants;
import discovery.computername.ComputerNameResolver;
import discovery.computername.OtagoComputerNameResolver;
import discovery.server.BroadcastResponder;
import gui.Lab;
import gui.LabRegistry;
import gui.QueuePanel;
import gui.processors.LabelProcessor;
import gui.processors.ServerLabelProcessor;
import java.awt.BorderLayout;
import java.io.IOException;
import javax.swing.JFrame;
import javax.swing.JOptionPane;
import javax.swing.JPanel;

/**
 *
 * @author Mark
 */
public class Server {

private Server() {
   }   
   
   public static void main(String[] args) throws IOException {

final String name = "SBEASTCAL1-01";

//      final String name = args.length > 0 ? args[0] : null;

final ComputerNameResolver nameResolver = new OtagoComputerNameResolver(name, "COMPUTERNAME");

nameResolver.resolve();

final String labName = nameResolver.getLabName();

if(args.length > 0) {
         compName = args[0];
      }

String[] nameBits = compName.split("-");
      final String labName = nameBits[0];

JFrame frame = new JFrame();
      frame.setLayout(new BorderLayout());
      frame.setDefaultCloseOperation(JFrame.EXIT_ON_CLOSE);

LabRegistry registry = new LabRegistry();
      Lab lab = registry.getLab(labName);

if(lab == null) {
          JOptionPane.showMessageDialog(frame, "There is no map for this lab yet.", "No map", JOptionPane.ERROR_MESSAGE);
          System.exit(Constants.EXIT_NO_MAP_FOUND);
      }

JPanel mapPanel = lab.getPanel();

LabelProcessor processor = new ServerLabelProcessor();
      processor.processLabels(mapPanel);

frame.setTitle(String.format("Democall %1s - Server (%1s)",Constants.VERSION, lab.getLabDescription()));
      frame.add(BorderLayout.NORTH, new QueuePanel());
      frame.add(BorderLayout.CENTER, mapPanel);
      frame.pack();
      frame.setVisible(true);

new ApplicationHandler(processor).start();
      new BroadcastResponder(labName).start();
   }

}

package server;

import constants.Constants;
import discovery.BroadcastResponder;
import discovery.ComputerNameResolver;
import gui.Lab;
import gui.LabRegistry;
import gui.QueuePanel;
import gui.processors.LabelProcessor;
import gui.processors.ServerLabelProcessor;
import java.awt.BorderLayout;
import java.io.IOException;
import javax.swing.JFrame;
import javax.swing.JOptionPane;
import javax.swing.JPanel;

/**
 *
 * @author Mark
 */
public class Server {

private Server() {
   }   
   
   public static void main(String[] args) throws IOException {

String compName = ComputerNameResolver.getName();

if(args.length > 0) {
         compName = args[0];
      }

String[] nameBits = compName.split("-");
      final String labName = nameBits[0];

JFrame frame = new JFrame();
      frame.setLayout(new BorderLayout());
      frame.setDefaultCloseOperation(JFrame.EXIT_ON_CLOSE);

LabRegistry registry = new LabRegistry();
      Lab lab = registry.getLab(labName);

if(lab == null) {
          JOptionPane.showMessageDialog(frame, "There is no map for this lab yet.", "No map", JOptionPane.ERROR_MESSAGE);
          System.exit(Constants.EXIT_NO_MAP_FOUND);
      }

JPanel mapPanel = lab.getPanel();

LabelProcessor processor = new ServerLabelProcessor();
      processor.processLabels(mapPanel);

new ApplicationHandler(processor).start();
      new BroadcastResponder(labName).start();
   }

}

Show line notes below