1 files changed, 82 insertions, 19 deletions
diff --git a/libjava/classpath/javax/rmi/CORBA/Tie.java b/libjava/classpath/javax/rmi/CORBA/Tie.java
index 4b1984c58e9..b8611838822 100644
--- a/libjava/classpath/javax/rmi/CORBA/Tie.java
+++ b/libjava/classpath/javax/rmi/CORBA/Tie.java
@@ -1,5 +1,5 @@
-/* Tie.java -- 
-   Copyright (C) 2002 Free Software Foundation, Inc.
+/* Tie.java --
+   Copyright (C) 2002, 2005 Free Software Foundation, Inc.
 
 This file is part of GNU Classpath.
 
@@ -35,28 +35,91 @@ 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 javax.rmi.CORBA;
 
+import java.rmi.NoSuchObjectException;
 import java.rmi.Remote;
-//import org.omg.CORBA.ORB;
-//import org.omg.CORBA.portable.InvokeHandler;
+import org.omg.CORBA.ORB;
+import org.omg.CORBA.portable.InvokeHandler;
 
-public interface Tie // XXX extends InvokeHandler
+/**
+ * <p>
+ * A Tie serves as a CORBA Servant or implementation base. It is connected to
+ * the ORB on a server side, providing the implementation of the required
+ * functionality. ORB access this implementation using {@link InvokeHandler}
+ * ._invoke(..). All such calls are finally delegated to the object, returned by
+ * {@link #getTarget()}.
+ * </p>
+ * <p>
+ * Ties are generated from implementations (name pattern *Impl) and have the
+ * name pattern _*Impl_Tie, for instance:<br>
+ * <code>rmic -keep -iiop -poa -always gnu.testlet.java.rmi.Remote.CalculatorImpl</code>
+ * </p>
+ * <p>
+ * Ties should normally be derived from the
+ * {@link org.omg.PortableServer.Servant}. Such ties are generated by
+ * <code>rmic</code> compiler using <code>-poa</code> key. Ties can be also
+ * derived from {@link org.omg.CORBA_2_3.portable.ObjectImpl}.
+ * </p>
+ * 
+ * @author Audrius Meskauskas (AudriusA@Bioinformatics.org)
+ */
+public interface Tie
+  extends InvokeHandler
 {
-    
-  void deactivate();
-
+  /**
+   * Get the invocation target, where all method calls should be delegated.
+   * 
+   * @return the object, implementing methods, defined in the interface being
+   * served by this Tie.
+   */
   Remote getTarget();
 
-  // XXX javax.rmi.ORB -> org.omg.CORBA.ORB
-  javax.rmi.ORB orb();
-  
-  // XXX javax.rmi.ORB -> org.omg.CORBA.ORB
-  void orb(javax.rmi.ORB orb);
-  
+  /**
+   * Set the invocation target, where all method calls should be delegated.
+   * 
+   * @param target the object, implementing methods, defined in the interface
+   * being served by this Tie. The code, produced by a typical rmic compiler
+   * usually requires the target to be an instance of the implementation from
+   * that the Tie was generated.
+   * 
+   * @throws ClassCastException if the passed parameter is not an instance of
+   * the implementation from that the Tie was generated.
+   */
   void setTarget(Remote target);
- 
-  // XXX Object -> org.omg.CORBA.Object
-  Object thisObject();
-}
+
+  /**
+   * Get the ORB to that this Tie is connected.
+   * 
+   * @see org.omg.PortableServer.Servant#_orb
+   */
+  ORB orb();
+
+  /**
+   * Connect this Tie to the given ORB.
+   */
+  void orb(ORB orb);
+
+  /**
+   * Get the object that delegates calls to this tie.
+   * 
+   * @see org.omg.PortableServer.Servant#_this_object
+   */
+  org.omg.CORBA.Object thisObject();
+
+  /**
+   * Deactivate this Tie. The tie is normally deactivated using POA mechanisms.
+   * Depending on the POA policies, it may be possible to activate the Tie
+   * again. The ties that are not derived from
+   * {@link org.omg.PortableServer.Servant} deactivate themselves by
+   * {@link ORB.disconnect}.
+   * 
+   * @throws NoSuchObjectException if there are no objects served by this Tie,
+   * or if the these objects are already deactivated.
+   * 
+   * @see org.omg.PortableServer.POA#deactivate_object
+   */
+  void deactivate()
+    throws NoSuchObjectException;
+
+}
+\ No newline at end of file