NTCPHack.java

Go to the documentation of this file.

package org.nees.ntcp.client;

import org.nees.ntcp.ntcpServer.ParameterType; 
import org.nees.ntcp.ntcpServer.ControlPointType; 
import org.nees.ntcp.ntcpServer.ControlPointParameterNameType; 
import org.nees.ntcp.ntcpServer.ControlPointGeomParameterType; 
import org.nees.ntcp.ntcpServer.GeomAxisType; 
import org.nees.ntcp.ntcpServer.TransactionType; 
import org.nees.ntcp.ntcpServer.TransactionStateType;
import org.nees.ntcp.server.util.NtcpHelper; 
import org.nees.ntcp.ntcpServer.NtcpServer; 

import java.math.BigInteger;
import java.util.Vector;
import java.util.*;

import com.rbnb.sapi.*;

import COM.Creare.Utility.ArgHandler; //for argument parsing

/*
 @note This is an alternative to System.exit, so we don't bring down servlet engine
*/
import COM.Creare.Utility.RBNBProcess; 

public class NTCPHack {

    String                 serverURL= "http://neespop.mcs.anl.gov:8090/";
    String                 instanceName = "NTCPServer";
    boolean                beSecure = false;
    NtcpServer             Server = null;
    String                 transName = "RedFish";
    ControlPointGeomParameterType move = new ControlPointGeomParameterType();
    Random                 ran = new Random();
    BigInteger             transNum = new BigInteger(16,ran);
    ControlPointType       ctrlPoint = new ControlPointType();
    ControlPointType       cpq = new ControlPointType();
    TransactionStateType   tstate;
    int                    timeout = 120;
    int                    memory = 300;
    TransactionType        trans = new TransactionType();;
    ControlPointType[]     cpArray;
    Vector                 osParams;
    
    Sink sink = null;
    int inputChannelIndex = -1;
    Source source = null;
    int outputChannelIndex = -1;
    
    private static final String MODE_TEST = "t";
    private static final String MODE_RBNB = "r";
    private static final String MODE_ONLY = "o";
    private String mode = null;

    private final static String DEFAULT_RBNB_SERVER = "localhost";
    private final static String DEFAULT_RBNB_PORT = "3333";
    private final static String DEFAULT_RBNB_OUTPUT_NAME = "CommandEcho";
    private final static String DEFAULT_RBNB_OUTPUT_CHANNEL = "echo";
    private final static String DEFAULT_RBNB_SINK_NAME = "NTCPHack";

    private String rbnbServerName = DEFAULT_RBNB_SERVER;
    private String rbnbServerPort = DEFAULT_RBNB_PORT;
    private String rbnbHostName = rbnbServerName + ":" + rbnbServerPort;
    private String rbnbSourceName = DEFAULT_RBNB_OUTPUT_NAME;
    private String rbnbSourceChannel = DEFAULT_RBNB_OUTPUT_CHANNEL;
    
    private String rbnbSinkName = DEFAULT_RBNB_SINK_NAME;
    
    private String rbnbInputPath = null; // required

    private static void printUsage()
    {
        System.out.println("Usage for NTCPHack...");
        System.out.println("  -v RBNB Sink (input command) path (required) ");
        System.out.println("  -m mode (required) " + MODE_TEST + "|" + MODE_RBNB + "|" + MODE_ONLY +"*");
        System.out.println("  [-r RBNB Server Name *"+ DEFAULT_RBNB_SERVER + "]");
        System.out.println("  [-p RBNB Server Port *" + DEFAULT_RBNB_PORT + "]");
        System.out.println("  [-s RBNB Source (output) Name *" + DEFAULT_RBNB_OUTPUT_NAME + "]");
        System.out.println("  [-c RBNB Source (output) Channel *" + DEFAULT_RBNB_OUTPUT_CHANNEL + "]");
        System.out.println("  * mode -m " + MODE_TEST + " -> NTCP connection only");
        System.out.println("    mode -m " + MODE_ONLY + " -> RBNB connection only");
        System.out.println("    mode -m " + MODE_RBNB + " -> both NTCP and RBNB connections");
    }

    public NTCPHack(String[] args)
    {
        //parse args
        try {
            ArgHandler ah=new ArgHandler(args);
            if (ah.checkFlag('h')) {
                printUsage();
                RBNBProcess.exit(0);                
            }
            if (ah.checkFlag('r')) {
                String a=ah.getOption('r');
                if (a!=null) rbnbServerName=a;
            }
            if (ah.checkFlag('p')) {
                String a=ah.getOption('p');
                if (a!=null) rbnbServerPort=a;
            }
            if (ah.checkFlag('s')) {
                String a=ah.getOption('s');
                if (a!=null) rbnbSourceName=a;
            }
            if (ah.checkFlag('c')) {
                String a=ah.getOption('c');
                if (a!=null) rbnbSourceChannel=a;
            }
            if (ah.checkFlag('v')) {
                String a=ah.getOption('v');
                if (a!=null) rbnbInputPath=a;
            }
            if (ah.checkFlag('m')) {
                String a=ah.getOption('m');
                if (a!=null) mode=a;
            }
        } catch (Exception e) {
            System.err.println("NTCPHack argument exception "+e.getMessage());
            e.printStackTrace();
            printUsage();
            RBNBProcess.exit(0);
        }

        if (rbnbInputPath == null)
        {
            System.err.println("The source/channel path for the video source is required. "
                + "Use NTCPHack -h for help");
            printUsage();
            RBNBProcess.exit(0);
        }

        if ((mode==null) 
            || !(mode.equals(MODE_TEST) 
                || mode.equals(MODE_ONLY) 
                || mode.equals(MODE_RBNB)
                ))
        {
            System.err.println("mode = " + mode + " is incorrect.");
            printUsage();
            RBNBProcess.exit(0);
        }
        
        rbnbHostName = rbnbServerName + ":" + rbnbServerPort;
        
    }
    
    public static void main (String[] args)
    {
        (new NTCPHack(args)).doIt();
    }
    
    private void doIt () {

        try
        {
            if (mode.equals(MODE_TEST) || mode.equals(MODE_RBNB))
            {
                // Create CP - ANCO
                ctrlPoint.setControlPointName("ANCO");
                
                // Create parameter for opensession
                osParams = new Vector();
                osParams.add(NtcpHelper.getParameter("OneFish", "TwoFish"));
                
                // Set up the move - displacement along X axis, 10mm
                move.setName(ControlPointParameterNameType.displacement);
                move.setAxis(GeomAxisType.x);
                move.setValue(new Float(10.0));
                
                // set the type
                ctrlPoint.setControlPointType(new ControlPointGeomParameterType[] {move});

                // Create the 1-element array
                cpArray = new ControlPointType[] {ctrlPoint};

            }
            
            if (mode.equals(MODE_TEST))
            {
                openConnection();
            doMove();
                // queryControlPoint();
                shutdown();
            }
            else if (mode.equals(MODE_ONLY))
            {
                String message = "Starting...";
                startRBNB();
                while(!message.equals("stop"))
                {
                    message = getRBNBMessage();
                    System.out.println("Message from RBNB: " + message);
                    sendRBNBMessageResponse("Got message: " + message);
                }
                stopRBNB();
            }
            else if (mode.equals(MODE_RBNB))
            {
                String message = "Starting...";
                openConnection();
                startRBNB();
                while(!message.equals("stop"))
                {
                    message = getRBNBMessage();
                    System.out.println("Message from RBNB: " + message);
                    if (message.equals("shake"))
                    {
                        doMove();
                    }
                    sendRBNBMessageResponse("Got message: " + message);
                }
                stopRBNB();
                shutdown();         
            }
        }
        catch (Exception e)
        {
            System.out.println("Oops: " + e);
            e.printStackTrace();
        }
    }

    private void openConnection() throws Exception
    {        
        // Try and open a connection to the server
        System.out.println("Opening connection to NTCP server at " + serverURL);
        if(beSecure == true)
        {
            System.out.println("with security enabled");
        }
        else
        {
            System.out.println("in insecure mode");
        }
        
        try
        {
            Server = NtcpHelper.activateNtcpServer(serverURL, 
                                                   "ogsa/services/nees/ntcp/" + instanceName,
                                                   beSecure);
        } catch (Exception e) 
        {
            if(beSecure == true)
            {
                System.out.println("Unable to open connection to NTCP server at " + serverURL + " with security enabled");
            }
            else
            {
                System.out.println("Unable to open connection to NTCP server at " + serverURL + " in insecure mode");
            }
            throw e;
        } 
        
        // Open session
        System.out.println("Connection opened OK, now sending openSession");
        try 
        {
            NtcpHelper.openSession(Server, (ParameterType[]) osParams.toArray(new ParameterType[osParams.size()]));
        }
        catch(Exception e)
        {
            System.out.println("Error opening session with server");
            throw e;
        }
    }
    
    private void doMove() throws Exception
    {
        
        transNum = new BigInteger(16,ran);
        transName = "TR" + ran.nextInt();
        
        // Propose the move/trigger
        try 
        {
            tstate = NtcpHelper.propose(Server, 
                                        transName, 
                                        transNum, 
                                        cpArray,
                                        timeout, 
                                        timeout,
                                        memory);
        }
        catch(Exception e)
        {
            System.out.println("Error proposing move " + e);
            throw e;
        }
        
        // Check the return value
        if(tstate == org.nees.ntcp.ntcpServer.TransactionStateType.accepted)
        {
            System.out.println("Transaction proposal accepted. Excellent.");
        }
        else
        {
            System.out.println("Transaction rejected! Why? Why!?");
            throw new Exception("Trasnaction rejected, no additional information :-(");
        }
        
        // Do it.
        try
        {
            NtcpHelper.execute(Server, transName);
        }
        catch(Exception e) 
        {
            System.out.println("Exception during execution, state of ANCO unknown!");
            // TODO: timeout exception here! which we are ignoring...
            //          throw e;
        }
        
        // Check the results
        try
        {
            trans = NtcpHelper.getTransaction(Server, transName);
        }
        catch(Exception e)
        {
            System.out.println("Exception during getTransaciton = " + e);
            throw e;
        }
        // System.out.println("Transaction state: + " trans.getState());
        
    }
    
    private void queryControlPoint() throws Exception
    {        
        // Just for fun, query the control point
        try 
        {  
            cpq = NtcpHelper.getControlPoint(Server, transName);
        }
        catch(Exception e)
        {
            System.out.println("Error querying the control point!");
            throw e;
        }
    }

    private void shutdown() throws Exception
    {  
        // Shut down the ntcp connection
        try
        {
            System.out.println("Closing NTCP session");
            NtcpHelper.closeSession(Server);

        }
        catch(Exception e)
        {
            System.out.println("Error closing the session = " + e);
            throw e;
        }

        System.out.println("Done.");
    }

    private void startRBNB() throws Exception
    {
        // Create a sink and connect:
        sink=new Sink();
        sink.OpenRBNBConnection(rbnbHostName, rbnbSinkName);
        ChannelMap reqmap = new ChannelMap();
        inputChannelIndex = reqmap.Add(rbnbInputPath);
        sink.Subscribe(reqmap,"newest");
        
        // create soruce (to send responses)
        // connect to RBNB server as source
        source = new Source(10, "none", 0);
        source.OpenRBNBConnection(rbnbHostName, rbnbSourceName);

        System.out.println("Source and Sink created.");             
    }

    private String getRBNBMessage() throws SAPIException {
        // see if any data is available from source
        ChannelMap m = sink.Fetch(-1);
        if (m == null)
        {
            System.out.println("Data fetch failed.");
            return "";
        }
        
        // no data received, skip
        if (m.GetIfFetchTimedOut()) {
            System.err.println("Data request timed out, retrying.");        
            return "";
        }
        
        String[] st = m.GetDataAsString(inputChannelIndex);
        System.out.println("Command(s) Received: ");
        for (int i = 0; i < st.length; i++)
        {
            System.out.println(i + ": " + st[i]);
        }
                        
        return st[0];
    }

    private void sendRBNBMessageResponse(String message) throws SAPIException
    {

        // select channel to output data to
        ChannelMap cmap = new ChannelMap();
        try {
            outputChannelIndex = cmap.Add(rbnbSourceChannel);
        } catch (SAPIException e) {
            System.err.println("Failed to add output channel to channel map.");
            throw e;
        }

        // put data in channel map, preserving original time stamp
        try {
            cmap.PutDataAsString(outputChannelIndex, message);
            source.Flush(cmap, true);
        } catch (SAPIException e) {
            System.err.println("Failed to flush output data to server, skipping.");
            throw e;
        }   
    }

    private void stopRBNB() {
        // TODO Auto-generated method stub
    }

}

---