Source for javax.rmi.CORBA.StubDelegate

   1: /* StubDelegate.java --
   2:    Copyright (C) 2002, 2005 Free Software Foundation, Inc.
   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: independent module, the terms and conditions of the license of that
  32: module.  An independent module is a module which is not derived from
  33: or based on this library.  If you modify this library, you may extend
  34: this exception to your version of the library, but you are not
  35: obligated to do so.  If you do not wish to do so, delete this
  36: exception statement from your version. */
  37: 
  38: 
  39: package javax.rmi.CORBA;
  40: 
  41: import org.omg.CORBA.ORB;
  42: 
  43: import java.io.IOException;
  44: import java.io.ObjectInputStream;
  45: import java.io.ObjectOutputStream;
  46: 
  47: import java.rmi.RemoteException;
  48: 
  49: /**
  50:  * A delegate, implementing the functionality, provided by the {@link Stub}.
  51:  * The default delegate can be altered by setting the system property
  52:  * "javax.rmi.CORBA.StubClass" to the name of the alternative class that must
  53:  * implement StubDelegate.
  54:  * 
  55:  * @author Audrius Meskauskas (AudriusA@Bioinformatics.org)
  56:  */
  57: public interface StubDelegate
  58: {
  59:   /**
  60:    * <p>
  61:    * Makes the stub ready for remote communication using the given ORB.
  62:    * </p>
  63:    * <p>
  64:    * It is frequently easier to call {@link PortableRemoteObject#connect} rather
  65:    * than this method.
  66:    * </p>
  67:    * 
  68:    * @param orb the ORB where the Stub must be connected.
  69:    * 
  70:    * @throws RemoteException if the stub is already connected to some other ORB.
  71:    * If the stub is already connected to the ORB that was passed as parameter,
  72:    * the method returns without action.
  73:    */
  74:   void connect(Stub self, ORB orb)
  75:     throws RemoteException;
  76: 
  77:   /**
  78:    * The objects stubs are equal if they refer the same remote object.
  79:    */
  80:   boolean equals(Stub self, Object obj);
  81: 
  82:   /**
  83:    * Get the hashcode fo this delegate.
  84:    */
  85:   int hashCode(Stub self);
  86: 
  87:   /**
  88:    * Read this stub from the object input stream.
  89:    */
  90:   void readObject(Stub self, ObjectInputStream s)
  91:     throws IOException, ClassNotFoundException;
  92: 
  93:   /**
  94:    * Write this stub to the object output stream.
  95:    */
  96:   void writeObject(Stub self, ObjectOutputStream s)
  97:     throws IOException;
  98: 
  99:   /**
 100:    * Get the string representation of this stub.
 101:    */
 102:   String toString(Stub self);