001    /* DelegateOperations.java --
002       Copyright (C) 2005, 2006 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 org.omg.PortableServer.portable;
040    
041    import org.omg.CORBA.ORB;
042    import org.omg.PortableServer.POA;
043    import org.omg.PortableServer.Servant;
044    
045    /**
046     * Each {@link Servant} has an associated delegate, where the most of the calls
047     * are forwarded. The delegate is responsible for providing the actual
048     * functionality. This class is required to supports a conceptions of
049     * the CORBA 2.3.1 Servant.
050     *
051     * @author Audrius Meskauskas, Lithuania (AudriusA@Bioinformatics.org)
052     */
053    public interface Delegate
054    {
055      /**
056      * Returns the root POA of the ORB instance, associated with this servant.
057      * It is the same POA that would be returned by resolving the initial
058      * reference "RootPOA" for that orb. The default {@link Servant#_default_POA()}
059      * method forwards call to the delegate can be overridden to
060      * obtain the alternative default POA.
061      *
062      * @see ORB#resolve_initial_references
063      */
064      POA default_POA(Servant a_servant);
065    
066      /**
067      * Get the interface repository defintion
068      * <code>InterfaceDef</code> for this Object.
069      */
070      org.omg.CORBA.Object get_interface_def(Servant a_servant);
071    
072      /**
073      * Checks if the passed servant is an instance of the given CORBA IDL type.
074      *
075      * @param a_servant a servant to check.
076      * @param an_id a repository ID, representing an IDL type for that the
077      * servant must be checked.
078      *
079      * @return true if the servant is an instance of the given type, false
080      * otherwise.
081      */
082      boolean is_a(Servant a_servant, String an_id);
083    
084      /**
085       * Determines if the server object for this reference has already
086       * been destroyed.
087       *
088       * @return true if the object has been destroyed, false otherwise.
089       */
090      boolean non_existent(Servant a_servant);
091    
092      /**
093      * Return the invocation target object identifier as a byte array.
094      */
095      byte[] object_id(Servant a_servant);
096    
097      /**
098      * Returns the ORB that is directly associated with the given servant.
099      */
100      ORB orb(Servant a_servant);
101    
102      /**
103      * Get POA that is directly associated with the given servant.
104      */
105      POA poa(Servant a_servant);
106    
107      /**
108      * Obtains the CORBA object reference that is an invocation target for the
109      * given servant.
110      */
111      org.omg.CORBA.Object this_object(Servant a_servant);
112    }