Source for org.omg.PortableInterceptor.ORBInitInfoOperations

   1: /* ORBInitInfoOperations.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.PortableInterceptor;
  40: 
  41: import org.omg.CORBA.BAD_INV_ORDER;
  42: import org.omg.CORBA.ORB;
  43: import org.omg.IOP.CodecFactory;
  44: import org.omg.PortableInterceptor.ORBInitInfoPackage.DuplicateName;
  45: 
  46: /**
  47:  * Defines operations, applicable to {@link ORBInitInfo}. The
  48:  * {@link ORBInitInfo} is passed to the {@link ORBInitializer} that is
  49:  * reponsible for registering an {@link Interceptor}.
  50:  *
  51:  * @author Audrius Meskauskas, Lithuania (AudriusA@Bioinformatics.org)
  52:  */
  53: public interface ORBInitInfoOperations
  54: {
  55:   /**
  56:    * Register the client request interceptor.
  57:    *
  58:    * @param interceptor the interceptor to register.
  59:    *
  60:    * @throws DuplicateName if the interceptor name is not an empty string and an
  61:    * interceptor with this name is already registered with the ORB being
  62:    * created.
  63:    */
  64:   void add_client_request_interceptor(ClientRequestInterceptor interceptor)
  65:     throws DuplicateName;
  66: 
  67:   /**
  68:    * Register the IOR (object reference) interceptor. If the registered
  69:    * interceptor implements the extended {@link IORInterceptor_3_0} interface,
  70:    * ORB will call its additional methods, defined in the
  71:    * {@link IORInterceptor_3_0Operations}.
  72:    * 
  73:    * @param interceptor the interceptor to register.
  74:    * 
  75:    * @throws DuplicateName if the interceptor name is not an empty string and an
  76:    * interceptor with this name is already registered with the ORB being
  77:    * created.
  78:    */
  79:   void add_ior_interceptor(IORInterceptor interceptor)
  80:     throws DuplicateName;
  81: 
  82:   /**
  83:    * Register the server request interceptor.
  84:    *
  85:    * @param interceptor the interceptor to register.
  86:    *
  87:    * @throws DuplicateName if the interceptor name is not an empty string and an
  88:    * interceptor with this name is already registered with the ORB being
  89:    * created.
  90:    */
  91:   void add_server_request_interceptor(ServerRequestInterceptor interceptor)
  92:     throws DuplicateName;
  93: 
  94:   /**
  95:    * Allocate a slot on a {@link Current} of this interceptor. While slots can
  96:    * be allocated by this method, they cannot be initialized.
  97:    * {@link CurrentOperations#get_slot} and {@link CurrentOperations#set_slot}
  98:    * throw {@link org.omg.CORBA.BAD_INV_ORDER} while called from the interceptor
  99:    * initializer.
 100:    *
 101:    * @return the index to the slot that has been allocated.
 102:    */
 103:   int allocate_slot_id();
 104: 
 105:   /**
 106:    * Returns the arguments passed to the ORB.init.
 107:    *
 108:    * @return the first parameter, passed to the methods from the group
 109:    * org.omg.CORBA.ORB#init(String[], ...).
 110:    */
 111:   String[] arguments();
 112: 
 113:   /**
 114:    * Get the CodecFactory that may be needed during the interceptor
 115:    * initialization. The method ORB.resolve_initial_references ("CodecFactory")
 116:    * cannot be used during ORB initialization.
 117:    *
 118:    * @return the CodecFactory.
 119:    */
 120:   CodecFactory codec_factory();
 121: 
 122:   /**
 123:    * Returns the ID of the ORB being initialized.
 124:    *
 125:    * @return the ORB id that differs for each new ORB being created during the
 126:    * current run of the java virtual machine.
 127:    */
 128:   String orb_id();
 129: 
 130:   /**
 131:    * Register the initial reference. The registered object will be accessible by
 132:    * the {@link ORB#resolve_initial_references} under the object_name.
 133:    *
 134:    * @param object_name the name of the object to register.
 135:    * @param object the object to register.
 136:    *
 137:    * @throws org.omg.PortableInterceptor.ORBInitInfoPackage.InvalidName if the
 138:    * name being registered is assumed to be invalid.
 139:    */
 140:   void register_initial_reference(String object_name,
 141:     org.omg.CORBA.Object object
 142:   ) throws org.omg.PortableInterceptor.ORBInitInfoPackage.InvalidName;
 143: 
 144:   /**
 145:    * Identical to {@link org.omg.CORBA.ORB#resolve_initial_references}.
 146:    *
 147:    * This method can only be called from
 148:    * {@link ORBInitializerOperations#post_init} and not during
 149:    * {@link ORBInitializerOperations#pre_init}.
 150:    *
 151:    * @param object_name the name of the object to search.
 152:    *
 153:    * @return the object, accessible by the given name.
 154:    *
 155:    * @throws org.omg.PortableInterceptor.ORBInitInfoPackage.InvalidName if the
 156:    * given name is not associated with the known object.
 157:    *
 158:    * @see org.omg.CORBA.ORB#resolve_initial_references
 159:    */
 160:   org.omg.CORBA.Object resolve_initial_references(String object_name)
 161:     throws org.omg.PortableInterceptor.ORBInitInfoPackage.InvalidName;
 162: 
 163:   /**
 164:    * Registers a PolicyFactory for the given PolicyType.
 165:    *
 166:    * @param policy_type the type of policy for that the factory is being
 167:    * registered.
 168:    * @param policy_factory the policy factory to register.
 169:    *
 170:    * @throws BAD_INV_ORDER minor 16 if the policy of the given type already has
 171:    * the registered factory in this ORB.
 172:    */
 173:   void register_policy_factory(int policy_type, PolicyFactory policy_factory);