[RFA/JDWP] transport: interface and socket impl

[Keith Seitz <keiths at redhat dot com>]

Hi,

So, now we're starting to get into the guts of the transport layer. The
two attached patches add a generic interface which defines the functions
of the transport, and also gives a concrete implementation for sockets.

There is no synchronization at this level. There is another level (the
connection layer) which addresses these issues.

As always, questions/comments/concerns?
Keith

ChangeLog
2005-06-02  Keith Seitz  <keiths@redhat.com>

        * gnu/classpath/jdwp/transport/ITransport.java: New file.
        * gnu/classpath/jdwp/transport/SocketTransport.java: New file.

Index: gnu/classpath/jdwp/transport/ITransport.java
===================================================================
RCS file: gnu/classpath/jdwp/transport/ITransport.java
diff -N gnu/classpath/jdwp/transport/ITransport.java
--- /dev/null	1 Jan 1970 00:00:00 -0000
+++ gnu/classpath/jdwp/transport/ITransport.java	2 Jun 2005 17:30:14 -0000
@@ -0,0 +1,84 @@
+/* ITransport.java -- An interface defining JDWP transports
+   Copyright (C) 2005 Free Software Foundation
+
+This file is part of GNU Classpath.
+
+GNU Classpath is free software; you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation; either version 2, or (at your option)
+any later version.
+
+GNU Classpath 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
+General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with GNU Classpath; see the file COPYING.  If not, write to the
+Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
+02111-1307 USA.
+
+Linking this library statically or dynamically with other modules is
+making a combined work based on this library.  Thus, the terms and
+conditions of the GNU General Public License cover the whole
+combination.
+
+As a special exception, the copyright holders of this library give you
+permission to link this library with independent modules to produce an
+executable, regardless of the license terms of these independent
+modules, and to copy and distribute the resulting executable under
+terms of your choice, provided that you also meet, for each linked
+terms of your choice, provided that you also meet, for each linked
+independent module, the terms and conditions of the license of that
+module.  An independent module is a module which is not derived from
+or based on this library.  If you modify this library, you may extend
+this exception to your version of the library, but you are not
+obligated to do so.  If you do not wish to do so, delete this
+exception statement from your version. */
+
+
+package gnu.classpath.jdwp.transport;
+
+import java.io.InputStream;
+import java.io.IOException;
+import java.io.OutputStream;
+import java.lang.IllegalArgumentException;
+import java.util.HashMap;
+
+/**
+ * A class representing a transport layer. This class serves as a generic
+ * interface for all transport types used in the JDWP back-end.
+ *
+ * @author Keith Seitz <keiths@redhat.com>
+ */
+public interface ITransport
+{
+  /**
+   * Configure the transport with the given properties
+   *
+   * @param   properties  properties of the transport configuration
+   * @throws  TransportException on configury error
+   */
+  public void configure (HashMap properties)
+    throws TransportException;
+
+  /**
+   * Initialize the transport
+   *
+   * @throws  TransportException on initialization error
+   */
+  public void initialize ()
+    throws TransportException;
+
+  /**
+   * Get the input stream for the transport
+   */
+  public InputStream getInputStream ()
+    throws IOException;
+
+  /**
+   * Get the output stream for the transport
+   */
+  public OutputStream getOutputStream ()
+    throws IOException;
+}
Index: gnu/classpath/jdwp/transport/SocketTransport.java
===================================================================
RCS file: gnu/classpath/jdwp/transport/SocketTransport.java
diff -N gnu/classpath/jdwp/transport/SocketTransport.java
--- /dev/null	1 Jan 1970 00:00:00 -0000
+++ gnu/classpath/jdwp/transport/SocketTransport.java	2 Jun 2005 17:56:41 -0000
@@ -0,0 +1,171 @@
+/* SocketTransport.java -- a socket transport
+   Copyright (C) 2005 Free Software Foundation
+
+This file is part of GNU Classpath.
+
+GNU Classpath is free software; you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation; either version 2, or (at your option)
+any later version.
+
+GNU Classpath 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
+General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with GNU Classpath; see the file COPYING.  If not, write to the
+Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
+02111-1307 USA.
+
+Linking this library statically or dynamically with other modules is
+making a combined work based on this library.  Thus, the terms and
+conditions of the GNU General Public License cover the whole
+combination.
+
+As a special exception, the copyright holders of this library give you
+permission to link this library with independent modules to produce an
+executable, regardless of the license terms of these independent
+modules, and to copy and distribute the resulting executable under
+terms of your choice, provided that you also meet, for each linked
+terms of your choice, provided that you also meet, for each linked
+independent module, the terms and conditions of the license of that
+module.  An independent module is a module which is not derived from
+or based on this library.  If you modify this library, you may extend
+this exception to your version of the library, but you are not
+obligated to do so.  If you do not wish to do so, delete this
+exception statement from your version. */
+
+
+package gnu.classpath.jdwp.transport;
+
+import gnu.classpath.jdwp.transport.ITransport;
+import gnu.classpath.jdwp.transport.TransportException;
+
+import java.io.InputStream;
+import java.io.IOException;
+import java.io.OutputStream;
+import java.net.ServerSocket;
+import java.net.Socket;
+import java.util.HashMap;
+
+import javax.net.ServerSocketFactory;
+import javax.net.SocketFactory;
+
+/**
+ * A socket-based transport. This transport uses
+ * configury string that looks like "name=dt_socket,
+ * address=localhost:1234,server=y".
+ *
+ * @author Keith Seitz <keiths@redhat.com>
+ */
+class SocketTransport
+  implements ITransport
+{
+  /**
+   * Name of this transport
+   */
+  public static final String NAME = "dt_socket";
+
+  // Configure properties
+  private static final String _PROPERTY_ADDRESS = "address";
+  private static final String _PROPERTY_SERVER = "server";
+
+  // Port number
+  private int _port;
+
+  // Host name
+  private String _host;
+   
+  // Are we acting as a server?
+  private boolean _server = false;
+
+  // Socket
+  private Socket _socket;
+
+  /**
+   * Setup the connection configuration from the given properties
+   *
+   * @param  properties  the properties of the JDWP session
+   * @throws TransportException for any configury errors
+   */
+  public void configure (HashMap properties)
+    throws TransportException
+  {
+    // Get address [form: "hostname:port"]
+    String p = (String) properties.get (_PROPERTY_ADDRESS);
+    if (p != null)
+      {
+	String[] s = p.split (":");
+	if (s.length == 2)
+	  {
+	    _host = s[0];
+	    _port = Integer.parseInt (s[1]);
+	  }
+      }
+
+    // Get server [form: "y" or "n"]
+    p = (String) properties.get (_PROPERTY_SERVER);
+    if (p != null)
+      {
+	if (p.toLowerCase().equals ("y"))
+	  _server = true;
+      }
+  }
+
+  /**
+   * Initialize this socket connection. This includes
+   * connecting to the host (or listening for it).
+   *
+   * @throws TransportException if a transport-related error occurs
+   */
+  public void initialize ()
+    throws TransportException
+  {
+    try
+      {
+	if (_server)
+	  {
+	    // Get a server socket
+	    ServerSocketFactory ssf = ServerSocketFactory.getDefault ();
+	    ServerSocket ss = ssf.createServerSocket (_port, 1);
+	    _socket = ss.accept ();
+	  }
+	else
+	  {
+	    // Get a client socket (the factory will connect it)
+	    SocketFactory sf = SocketFactory.getDefault ();
+	    _socket = sf.createSocket (_host, _port);
+	  }
+      }
+    catch (IOException ioe)
+      {
+	// This will grab UnknownHostException, too.
+	throw new TransportException (ioe);
+      }
+  }
+
+  /**
+   * Returns an <code>InputStream</code> for the transport
+   *
+   * @throws IOException if an I/O error occurs creating the stream
+   *                     or the socket is not connected
+   */
+  public InputStream getInputStream ()
+    throws IOException
+  {
+    return _socket.getInputStream ();
+  }
+
+  /**
+   * Returns an <code>OutputStream</code> for the transport
+   *
+   * @throws IOException if an I/O error occurs creating the stream
+   *                     or the socket is not connected
+   */
+  public OutputStream getOutputStream ()
+    throws IOException
+  {
+    return _socket.getOutputStream ();
+  }
+}