libjava/gnu/classpath/jdwp/transport/ITransport.java

   1 /* ITransport.java -- An interface defining JDWP transports
   2    Copyright (C) 2005 Free Software Foundation
   3
   4 This file is part of GNU Classpath.
   5
   6 GNU Classpath is free software; you can redistribute it and/or modify
   7 it under the terms of the GNU General Public License as published by
   8 the Free Software Foundation; either version 2, or (at your option)
   9 any later version.
  10
  11 GNU Classpath is distributed in the hope that it will be useful, but
  12 WITHOUT ANY WARRANTY; without even the implied warranty of
  13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14 General Public License for more details.
  15
  16 You should have received a copy of the GNU General Public License
  17 along with GNU Classpath; see the file COPYING.  If not, write to the
  18 Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
  19 02111-1307 USA.
  20
  21 Linking this library statically or dynamically with other modules is
  22 making a combined work based on this library.  Thus, the terms and
  23 conditions of the GNU General Public License cover the whole
  24 combination.
  25
  26 As a special exception, the copyright holders of this library give you
  27 permission to link this library with independent modules to produce an
  28 executable, regardless of the license terms of these independent
  29 modules, and to copy and distribute the resulting executable under
  30 terms of your choice, provided that you also meet, for each linked
  31 terms of your choice, provided that you also meet, for each linked
  32 independent module, the terms and conditions of the license of that
  33 module.  An independent module is a module which is not derived from
  34 or based on this library.  If you modify this library, you may extend
  35 this exception to your version of the library, but you are not
  36 obligated to do so.  If you do not wish to do so, delete this
  37 exception statement from your version. */
  38
  39
  40 package gnu.classpath.jdwp.transport;
  41
  42 import java.io.InputStream;
  43 import java.io.IOException;
  44 import java.io.OutputStream;
  45 import java.lang.IllegalArgumentException;
  46 import java.util.HashMap;
  47
  48 /**
  49  * A class representing a transport layer. This class serves as a generic
  50  * interface for all transport types used in the JDWP back-end.
  51  *
  52  * @author Keith Seitz <keiths@redhat.com>
  53  */
  54 public interface ITransport
  55 {
  56   /**
  57    * Configure the transport with the given properties
  58    *
  59    * @param   properties  properties of the transport configuration
  60    * @throws  TransportException on configury error
  61    */
  62   public void configure (HashMap properties)
  63     throws TransportException;
  64
  65   /**
  66    * Initialize the transport
  67    *
  68    * @throws  TransportException on initialization error
  69    */
  70   public void initialize ()
  71     throws TransportException;
  72
  73   /**
  74    * Get the input stream for the transport
  75    */
  76   public InputStream getInputStream ()
  77     throws IOException;
  78
  79   /**
  80    * Get the output stream for the transport
  81    */
  82   public OutputStream getOutputStream ()
  83     throws IOException;
  84 }