Source for org.omg.PortableServer.portable.Delegate

   1: /* DelegateOperations.java --
   2:    Copyright (C) 2005, 2006 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 org.omg.PortableServer.portable;
  40: 
  41: import org.omg.CORBA.ORB;
  42: import org.omg.PortableServer.POA;
  43: import org.omg.PortableServer.Servant;
  44: 
  45: /**
  46:  * Each {@link Servant} has an associated delegate, where the most of the calls
  47:  * are forwarded. The delegate is responsible for providing the actual
  48:  * functionality. This class is required to supports a conceptions of
  49:  * the CORBA 2.3.1 Servant.
  50:  *
  51:  * @author Audrius Meskauskas, Lithuania (AudriusA@Bioinformatics.org)
  52:  */
  53: public interface Delegate
  54: {
  55:   /**
  56:   * Returns the root POA of the ORB instance, associated with this servant.
  57:   * It is the same POA that would be returned by resolving the initial
  58:   * reference "RootPOA" for that orb. The default {@link Servant#_default_POA()}
  59:   * method forwards call to the delegate can be overridden to
  60:   * obtain the alternative default POA.
  61:   *
  62:   * @see ORB#resolve_initial_references
  63:   */
  64:   POA default_POA(Servant a_servant);
  65: 
  66:   /**
  67:   * Get the interface repository defintion
  68:   * <code>InterfaceDef</code> for this Object.
  69:   */
  70:   org.omg.CORBA.Object get_interface_def(Servant a_servant);
  71: 
  72:   /**
  73:   * Checks if the passed servant is an instance of the given CORBA IDL type.
  74:   *
  75:   * @param a_servant a servant to check.
  76:   * @param an_id a repository ID, representing an IDL type for that the
  77:   * servant must be checked.
  78:   *
  79:   * @return true if the servant is an instance of the given type, false
  80:   * otherwise.
  81:   */
  82:   boolean is_a(Servant a_servant, String an_id);
  83: 
  84:   /**
  85:    * Determines if the server object for this reference has already
  86:    * been destroyed.
  87:    *
  88:    * @return true if the object has been destroyed, false otherwise.
  89:    */
  90:   boolean non_existent(Servant a_servant);
  91: 
  92:   /**
  93:   * Return the invocation target object identifier as a byte array.
  94:   */
  95:   byte[] object_id(Servant a_servant);
  96: 
  97:   /**
  98:   * Returns the ORB that is directly associated with the given servant.
  99:   */
 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: }