Gap client library.

  The gap client library allows you to execute gap commands in java.
  More information about gap can be found at: http://www.gap-system.org/

Building

  You can use ant to build a jar file from the source files.
  More information about ant can be found here: http://ant.apache.org/
  
API documentation

  API documentation of the gap client library can be automatically generated
  from the source files by running the following command in the directory that
  contains the ant build.xml file:
  
    ant javadoc
    
  This should generate javadoc html files in the build/javadoc directory.
  
Example

  The following java snippet will connect to a gap service on localhost, port
  1234 and execute the gap command '1+1':
  
      GapConnection connection = null;
      try {
          connection = new GapConnection("localhost", 1234);
          System.out.println( connection.execute("1+1;\n") );
      }
      finally {
          if (connection != null) {
              connection.close();
          }
      }
      
  This of course assumes that you have a gap server running at port 1234. In 
  order to run a gap server, you need the Socketservice program, and a working
  installation of gap. 

  Before you can run the gap service for the first time, you have to start gap 
  manually and create a workspace file. A workspace file can be created by
  entering 'SaveWorkspace("filename");' in gap, where 'filename' should be 
  replaced by the full path of the workspace file that you want to create. You 
  only need to do this once, and you can exit gap afterwards.

  You can then start a gap server by running the following command:
  
    java -jar socketservice.jar 1234 'gap -p -q -L filename'

  where 'filename' should again be replaced by the full path of the workspace 
  file.

  It is probably wise to take some security measures before you run a gap
  server, because anyone is allowed to connect to it and run any gap command, 
  including reading and writing of files!

Copyright information

  Copyright (C) 2005-2006 Technische Universiteit Eindhoven

  This library is free software; you can redistribute it and/or
  modify it under the terms of the GNU Lesser General Public
  License as published by the Free Software Foundation; either
  version 2.1 of the License, or (at your option) any later version.
  
  This library is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  Lesser General Public License for more details.