001/* Tie.java --
002   Copyright (C) 2002, 2005 Free Software Foundation, Inc.
003
004This file is part of GNU Classpath.
005
006GNU Classpath is free software; you can redistribute it and/or modify
007it under the terms of the GNU General Public License as published by
008the Free Software Foundation; either version 2, or (at your option)
009any later version.
010
011GNU Classpath is distributed in the hope that it will be useful, but
012WITHOUT ANY WARRANTY; without even the implied warranty of
013MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
014General Public License for more details.
015
016You should have received a copy of the GNU General Public License
017along with GNU Classpath; see the file COPYING.  If not, write to the
018Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
01902110-1301 USA.
020
021Linking this library statically or dynamically with other modules is
022making a combined work based on this library.  Thus, the terms and
023conditions of the GNU General Public License cover the whole
024combination.
025
026As a special exception, the copyright holders of this library give you
027permission to link this library with independent modules to produce an
028executable, regardless of the license terms of these independent
029modules, and to copy and distribute the resulting executable under
030terms of your choice, provided that you also meet, for each linked
031independent module, the terms and conditions of the license of that
032module.  An independent module is a module which is not derived from
033or based on this library.  If you modify this library, you may extend
034this exception to your version of the library, but you are not
035obligated to do so.  If you do not wish to do so, delete this
036exception statement from your version. */
037
038package javax.rmi.CORBA;
039
040import java.rmi.NoSuchObjectException;
041import java.rmi.Remote;
042import org.omg.CORBA.ORB;
043import org.omg.CORBA.portable.InvokeHandler;
044
045/**
046 * <p>
047 * A Tie serves as a CORBA Servant or implementation base. It is connected to
048 * the ORB on a server side, providing the implementation of the required
049 * functionality. ORB access this implementation using {@link InvokeHandler}
050 * ._invoke(..). All such calls are finally delegated to the object, returned by
051 * {@link #getTarget()}.
052 * </p>
053 * <p>
054 * Ties are generated from implementations (name pattern *Impl) and have the
055 * name pattern _*Impl_Tie, for instance:<br>
056 * <code>rmic -keep -iiop -poa -always gnu.testlet.java.rmi.Remote.CalculatorImpl</code>
057 * </p>
058 * <p>
059 * Ties should normally be derived from the
060 * {@link org.omg.PortableServer.Servant}. Such ties are generated by
061 * <code>rmic</code> compiler using <code>-poa</code> key. Ties can be also
062 * derived from {@link org.omg.CORBA_2_3.portable.ObjectImpl}.
063 * </p>
064 *
065 * @author Audrius Meskauskas (AudriusA@Bioinformatics.org)
066 */
067public interface Tie
068  extends InvokeHandler
069{
070  /**
071   * Get the invocation target, where all method calls should be delegated.
072   *
073   * @return the object, implementing methods, defined in the interface being
074   * served by this Tie.
075   */
076  Remote getTarget();
077
078  /**
079   * Set the invocation target, where all method calls should be delegated.
080   *
081   * @param target the object, implementing methods, defined in the interface
082   * being served by this Tie. The code, produced by a typical rmic compiler
083   * usually requires the target to be an instance of the implementation from
084   * that the Tie was generated.
085   *
086   * @throws ClassCastException if the passed parameter is not an instance of
087   * the implementation from that the Tie was generated.
088   */
089  void setTarget(Remote target);
090
091  /**
092   * Get the ORB to that this Tie is connected.
093   *
094   * @see org.omg.PortableServer.Servant#_orb
095   */
096  ORB orb();
097
098  /**
099   * Connect this Tie to the given ORB.
100   */
101  void orb(ORB orb);
102
103  /**
104   * Get the object that delegates calls to this tie.
105   *
106   * @see org.omg.PortableServer.Servant#_this_object()
107   */
108  org.omg.CORBA.Object thisObject();
109
110  /**
111   * Deactivate this Tie. The tie is normally deactivated using POA mechanisms.
112   * Depending on the POA policies, it may be possible to activate the Tie
113   * again. The ties that are not derived from
114   * {@link org.omg.PortableServer.Servant} deactivate themselves by
115   * {@link ORB#disconnect}.
116   *
117   * @throws NoSuchObjectException if there are no objects served by this Tie,
118   * or if the these objects are already deactivated.
119   *
120   * @see org.omg.PortableServer.POAOperations#deactivate_object
121   */
122  void deactivate()
123    throws NoSuchObjectException;
124
125}