gomp-20050608-branch/libjava/classpath/org/omg/PortableInterceptor/IORInfoOperations.java

   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);
  88
  89   /**
  90    * Get the adapter template that is associated with the object POA.
  91    * The template is also a reference factory and can produce the new object
  92    * references.
  93    *
  94    * @since 1.5
  95    */
  96   public ObjectReferenceTemplate adapter_template();
  97
  98   /**
  99    * The current_factory is the factory, used by the adapter to create
 100    * object references. This factory is initially the same as the
 101    * adapter_template.
 102    *
 103    * @since 1.5
 104    */
 105   public ObjectReferenceFactory current_factory();
 106
 107   /**
 108    * Set the current object reference factory, used to produce the new objects.
 109    *
 110    * The current factory can only be set during the call to the
 111    * {@link IORInterceptor_3_0Operations#components_established(IORInfo)}.
 112    *
 113    * @since 1.5
 114    */
 115   public void current_factory(ObjectReferenceFactory factory);
 116
 117   /**
 118    * Get the POA manager Id.
 119    *
 120    * @return Id that uniquely refers to the poa manager, used by this POA.
 121    *
 122    * @since 1.5
 123    *
 124    * @see IORInterceptor_3_0Operations#adapter_manager_state_changed
 125    */
 126   public int manager_id();
 127
 128   /**
 129    * Get the state of the adapter manager.
 130    *
 131    * @since 1.5
 132    *
 133    * @return the state of the adapters to that the IOR being created belongs.
 134    * One of the {@link HOLDING#value}, {@link DISCARDING#value},
 135    * {@link INACTIVE#value} or {@link NON_EXISTENT#value}.
 136    */
 137   short state();
 138 }