Source for gnu.classpath.jdwp.transport.ITransport

   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., 51 Franklin Street, Fifth Floor, Boston, MA
  19: 02110-1301 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.util.HashMap;
  46: 
  47: /**
  48:  * A class representing a transport layer. This class serves as a generic
  49:  * interface for all transport types used in the JDWP back-end.
  50:  *
  51:  * @author Keith Seitz (keiths@redhat.com)
  52:  */
  53: public interface ITransport
  54: {
  55:   /**
  56:    * Configure the transport with the given properties
  57:    *
  58:    * @param   properties  properties of the transport configuration
  59:    * @throws  TransportException on configury error
  60:    */
  61:   public void configure (HashMap properties)
  62:     throws TransportException;
  63: 
  64:   /**
  65:    * Initialize the transport
  66:    *
  67:    * @throws  TransportException on initialization error
  68:    */
  69:   public void initialize ()
  70:     throws TransportException;
  71: 
  72:   /**
  73:    * Shutdown the transport
  74:    */
  75:   public void shutdown ();
  76: 
  77:   /**
  78:    * Get the input stream for the transport
  79:    */
  80:   public InputStream getInputStream ()
  81:     throws IOException;
  82: 
  83:   /**
  84:    * Get the output stream for the transport
  85:    */
  86:   public OutputStream getOutputStream ()
  87:     throws IOException;
  88: }