001 /* StubDelegate.java --
002 Copyright (C) 2002, 2005 Free Software Foundation, Inc.
003
004 This file is part of GNU Classpath.
005
006 GNU Classpath is free software; you can redistribute it and/or modify
007 it under the terms of the GNU General Public License as published by
008 the Free Software Foundation; either version 2, or (at your option)
009 any later version.
010
011 GNU Classpath is distributed in the hope that it will be useful, but
012 WITHOUT ANY WARRANTY; without even the implied warranty of
013 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
014 General Public License for more details.
015
016 You should have received a copy of the GNU General Public License
017 along with GNU Classpath; see the file COPYING. If not, write to the
018 Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
019 02110-1301 USA.
020
021 Linking this library statically or dynamically with other modules is
022 making a combined work based on this library. Thus, the terms and
023 conditions of the GNU General Public License cover the whole
024 combination.
025
026 As a special exception, the copyright holders of this library give you
027 permission to link this library with independent modules to produce an
028 executable, regardless of the license terms of these independent
029 modules, and to copy and distribute the resulting executable under
030 terms of your choice, provided that you also meet, for each linked
031 independent module, the terms and conditions of the license of that
032 module. An independent module is a module which is not derived from
033 or based on this library. If you modify this library, you may extend
034 this exception to your version of the library, but you are not
035 obligated to do so. If you do not wish to do so, delete this
036 exception statement from your version. */
037
038
039 package javax.rmi.CORBA;
040
041 import org.omg.CORBA.ORB;
042
043 import java.io.IOException;
044 import java.io.ObjectInputStream;
045 import java.io.ObjectOutputStream;
046
047 import java.rmi.RemoteException;
048
049 /**
050 * A delegate, implementing the functionality, provided by the {@link Stub}.
051 * The default delegate can be altered by setting the system property
052 * "javax.rmi.CORBA.StubClass" to the name of the alternative class that must
053 * implement StubDelegate.
054 *
055 * @author Audrius Meskauskas (AudriusA@Bioinformatics.org)
056 */
057 public interface StubDelegate
058 {
059 /**
060 * <p>
061 * Makes the stub ready for remote communication using the given ORB.
062 * </p>
063 * <p>
064 * It is frequently easier to call {@link PortableRemoteObject#connect} rather
065 * than this method.
066 * </p>
067 *
068 * @param orb the ORB where the Stub must be connected.
069 *
070 * @throws RemoteException if the stub is already connected to some other ORB.
071 * If the stub is already connected to the ORB that was passed as parameter,
072 * the method returns without action.
073 */
074 void connect(Stub self, ORB orb)
075 throws RemoteException;
076
077 /**
078 * The objects stubs are equal if they refer the same remote object.
079 */
080 boolean equals(Stub self, Object obj);
081
082 /**
083 * Get the hashcode fo this delegate.
084 */
085 int hashCode(Stub self);
086
087 /**
088 * Read this stub from the object input stream.
089 */
090 void readObject(Stub self, ObjectInputStream s)
091 throws IOException, ClassNotFoundException;
092
093 /**
094 * Write this stub to the object output stream.
095 */
096 void writeObject(Stub self, ObjectOutputStream s)
097 throws IOException;
098
099 /**
100 * Get the string representation of this stub.
101 */
102 String toString(Stub self);
103 }