001/* IORInfoOperations.java --
002   Copyright (C) 2005 Free Software Foundation, Inc.
003
004This file is part of GNU Classpath.
005
006GNU Classpath is free software; you can redistribute it and/or modify
007it under the terms of the GNU General Public License as published by
008the Free Software Foundation; either version 2, or (at your option)
009any later version.
010
011GNU Classpath is distributed in the hope that it will be useful, but
012WITHOUT ANY WARRANTY; without even the implied warranty of
013MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
014General Public License for more details.
015
016You should have received a copy of the GNU General Public License
017along with GNU Classpath; see the file COPYING.  If not, write to the
018Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
01902110-1301 USA.
020
021Linking this library statically or dynamically with other modules is
022making a combined work based on this library.  Thus, the terms and
023conditions of the GNU General Public License cover the whole
024combination.
025
026As a special exception, the copyright holders of this library give you
027permission to link this library with independent modules to produce an
028executable, regardless of the license terms of these independent
029modules, and to copy and distribute the resulting executable under
030terms of your choice, provided that you also meet, for each linked
031independent module, the terms and conditions of the license of that
032module.  An independent module is a module which is not derived from
033or based on this library.  If you modify this library, you may extend
034this exception to your version of the library, but you are not
035obligated to do so.  If you do not wish to do so, delete this
036exception statement from your version. */
037
038
039package org.omg.PortableInterceptor;
040
041import org.omg.CORBA.Policy;
042import org.omg.IOP.TaggedComponent;
043
044/**
045 * The ORB service uses this interface to add the service specific components to
046 * the new IOR being constructed. The interface provides also possibility to get
047 * the POA policies the apply to the IOR being constructed.
048 *
049 * @author Audrius Meskauskas, Lithuania (AudriusA@Bioinformatics.org)
050 */
051public interface IORInfoOperations
052{
053  /**
054   * Adds a service-specific component to the IOR profile being constructed.
055   *
056   * @param tagged_component a tagged component being added.
057   *
058   * @param profile_id the IOR profile to that the component must be added.
059   * The 0 value ({@link org.omg.IOP.TAG_INTERNET_IOP#value}) adds to the
060   * Internet profile where host and port are stored by default.
061   */
062  void add_ior_component_to_profile(TaggedComponent tagged_component,
063    int profile_id
064  );
065
066  /**
067   * Adds a service-specific component to the IOR profile being constructed.
068   * The specified component will be included in all profiles, present in the
069   * IOR being constructed.
070   *
071   * @param tagged_component a tagged component being added.
072   */
073  void add_ior_component(TaggedComponent tagged_component);
074
075  /**
076   * Get the server side policy for an IOR being constructed. The method returns
077   * policies applying for POA where the object, represented by this IOR, is
078   * connected.
079   *
080   * @param policy_type the type of the policy.
081   *
082   * @return the policy of the given type that applies to the IOR being
083   * constructed.
084   *
085   * @see org.omg.PortableServer.POAOperations#create_POA
086   */
087  Policy get_effective_policy(int policy_type);
088
089  /**
090   * Get the adapter template that is associated with the object POA.
091   * The template is also a reference factory and can produce the new object
092   * references.
093   *
094   * @since 1.5
095   */
096  public ObjectReferenceTemplate adapter_template();
097
098  /**
099   * 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}