Source for org.omg.PortableInterceptor.IORInfoOperations

   1: /* IORInfoOperations.java --
   2:    Copyright (C) 2005 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.Policy;
  42: import org.omg.IOP.TaggedComponent;
  43: 
  44: /**
  45:  * The ORB service uses this interface to add the service specific components to
  46:  * the new IOR being constructed. The interface provides also possibility to get
  47:  * the POA policies the apply to the IOR being constructed.
  48:  *
  49:  * @author Audrius Meskauskas, Lithuania (AudriusA@Bioinformatics.org)
  50:  */
  51: public interface IORInfoOperations
  52: {
  53:   /**
  54:    * Adds a service-specific component to the IOR profile being constructed.
  55:    *
  56:    * @param tagged_component a tagged component being added.
  57:    *
  58:    * @param profile_id the IOR profile to that the component must be added.
  59:    * The 0 value ({@link org.omg.IOP.TAG_INTERNET_IOP#value}) adds to the
  60:    * Internet profile where host and port are stored by default.
  61:    */
  62:   void add_ior_component_to_profile(TaggedComponent tagged_component,
  63:     int profile_id
  64:   );
  65: 
  66:   /**
  67:    * Adds a service-specific component to the IOR profile being constructed.
  68:    * The specified component will be included in all profiles, present in the
  69:    * IOR being constructed.
  70:    *
  71:    * @param tagged_component a tagged component being added.
  72:    */
  73:   void add_ior_component(TaggedComponent tagged_component);
  74: 
  75:   /**
  76:        * Get the server side policy for an IOR being constructed. The method returns
  77:    * policies applying for POA where the object, represented by this IOR, is
  78:    * connected.
  79:    *
  80:    * @param policy_type the type of the policy.
  81:    *
  82:    * @return the policy of the given type that applies to the IOR being
  83:    * constructed.
  84:    *
  85:    * @see org.omg.PortableServer.POAOperations#create_POA
  86:    */
  87:   Policy get_effective_policy(int policy_type);