IORInfoOperations


1   package org.omg.PortableInterceptor;
2   
3   
4   /**
5   * org/omg/PortableInterceptor/IORInfoOperations.java .
6   * Generated by the IDL-to-Java compiler (portable), version "3.2"
7   * from ../../../../src/share/classes/org/omg/PortableInterceptor/Interceptors.idl
8   * Saturday, February 9, 2008 9:40:08 AM GMT
9   */
10  
11  
12  /**
13     * Provides the server-side ORB service with access to the applicable 
14     * policies during IOR construction and the ability to add components. 
15     * The ORB passes an instance of its implementation of this interface as 
16     * a parameter to <code>IORInterceptor.establish_components</code>.
17     *
18     * @see IORInterceptor
19     */
20  public interface IORInfoOperations 
21  {
22  
23    /**
24       * Allows an ORB service implementation to determine what server side 
25       * policy of a particular type is in effect for an IOR being 
26       * constructed.  When the IOR being constructed is for an object 
27       * implemented using a POA, all Policy objects passed to the 
28       * <code>PortableServer.POA.create_POA</code> call that created that 
29       * POA are accessable via <code>get_effective_policy</code>. 
30       * <p>
31       * If a policy for the given type is not known to the ORB, then this 
32       * operation will throw <code>INV_POLICY</code> with a standard minor 
33       * code of 2. 
34       * 
35       * @param type an int specifying the type of policy to return. 
36       * @return The effective <code>CORBA.Policy</code> object of the 
37       *     requested type. If the given policy type is known, but no policy 
38       *     of that type is in effect, then this operation will return a 
39       *     nil object reference.
40       */
41    org.omg.CORBA.Policy   get_effective_policy (int type);
42  
43    /**
44       * A portable ORB service implementation calls 
45       * <code>add_ior_component</code> from its implementation of 
46       * <code>establish_components</code> to add a tagged component to the 
47       * set which will be included when constructing IORs. The components in 
48       * this set will be included in all profiles. 
49       * <p>
50       * Any number of components may exist with the same component ID. 
51       * 
52       * @param a_component The IOP.TaggedComponent to add.
53       */
54    void add_ior_component (org.omg.IOP.TaggedComponent   tagged_component);
55  
56    /**
57       * A portable ORB service implementation calls 
58       * <code>add_ior_component_to_profile</code> from its implementation of 
59       * <code>establish_components</code> to add a tagged component to the 
60       * set which will be included when constructing IORs. The components in 
61       * this set will be included in the specified profile. 
62       * <p>
63       * Any number of components may exist with the same component ID. 
64       * 
65       * @param a_component The <code>IOP.TaggedComponent</code> to add. 
66       * @param profile_id The profile id of the profile to 
67       *     which this component will be added.
68       * @exception BAD_PARAM thrown, with a standard minor code of 29, if the 
69       *     given profile ID does not define a known profile or it is 
70       *     impossible to add components to that profile.
71       */
72    void add_ior_component_to_profile (org.omg.IOP.TaggedComponent   tagged_component, int profile_id);
73  
74    /** Return the adapter manager id of the object adapter
75       * that was just created and is running IOR interceptors.
76       */
77    int manager_id ();
78  
79    /** Return the adapter state of the object adapter
80       * that was just created and is running IOR interceptors.
81       */
82    short state ();
83  
84    /** Return the object reference template of the object adapter
85       * that was just created and is running IOR interceptors.
86       */
87    org.omg.PortableInterceptor.ObjectReferenceTemplate   adapter_template ();
88  
89    /** On read, returns the current factory that will be used to create
90       * object references for the object adapter that was just created
91       * and is running IOR interceptors.  By default, this factory is the same
92       * as the value of the adapter_template attribute.  The current_factory 
93       * may also be set to another object reference template inside an
94       * IORInterceptor_3_0.
95       */
96    org.omg.PortableInterceptor.ObjectReferenceFactory   current_factory ();
97  
98    /** On read, returns the current factory that will be used to create
99       * object references for the object adapter that was just created
100      * and is running IOR interceptors.  By default, this factory is the same
101      * as the value of the adapter_template attribute.  The current_factory 
102      * may also be set to another object reference template inside an
103      * IORInterceptor_3_0.
104      */
105   void current_factory (org.omg.PortableInterceptor.ObjectReferenceFactory   newCurrent_factory);
106 } // interface IORInfoOperations
107
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags