KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > omg > PortableInterceptor > ORBInitInfoOperations


1 package org.omg.PortableInterceptor;
2
3
4 /**
5 * org/omg/PortableInterceptor/ORBInitInfoOperations.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    * Passed to each <code>ORBInitializer</code>, allowing it to
14    * to register interceptors and perform other duties while the ORB is
15    * initializing.
16    * <p>
17    * The <code>ORBInitInfo</code> object is only valid during
18    * <code>ORB.init</code>. If a service keeps a reference to its
19    * <code>ORBInitInfo</code> object and tries to use it after
20    * <code>ORB.init</code> returns, the object no longer exists and an
21    * <code>OBJECT_NOT_EXIST</code> exception shall be thrown.
22    *
23    * @see ORBInitializer
24    */

25 public interface ORBInitInfoOperations
26 {
27
28   /**
29      * Returns the arguments passed to <code>ORB.init</code>. They may or
30      * may not contain the ORB's arguments.
31      */

32   String JavaDoc[] arguments ();
33
34   /**
35      * Returns the ID of the ORB being initialized.
36      */

37   String JavaDoc orb_id ();
38
39   /**
40      * Returns the <code>IOP.CodecFactory</code>. The
41      * <code>CodecFactory</code> is normally obtained via a call to
42      * <code>ORB.resolve_initial_references( "CodecFactory" )</code>, but
43      * since the ORB is not yet available and Interceptors, particularly when
44      * processing service contexts, will require a <code>Codec</code>, a
45      * means of obtaining a <code>Codec</code> is necessary during ORB
46      * initialization.
47      */

48   org.omg.IOP.CodecFactory JavaDoc codec_factory ();
49
50   /**
51      * Identical to <code>ORB.register_initial_reference</code>. This same
52      * functionality exists here because the ORB, not yet fully initialized,
53      * is not yet available but initial references may need to be
54      * registered as part of Interceptor registration. The only difference
55      * is that the version of this operation on the ORB uses PIDL
56      * (<code>CORBA.ORB.ObjectId</code>) and
57      * (<code>CORBA.ORB.InvalidName</code>) whereas the version in this
58      * interface uses IDL defined in this interface; the semantics are
59      * identical.
60      */

61   void register_initial_reference (String JavaDoc id, org.omg.CORBA.Object JavaDoc obj) throws org.omg.PortableInterceptor.ORBInitInfoPackage.InvalidName JavaDoc;
62
63   /**
64      * Identical to <code>ORB.resolve_initial_references</code>. This same
65      * functionality exists here because the ORB, not yet fully initialized,
66      * is not yet available but initial references may be required from the
67      * ORB as part of Interceptor registration. The only difference is that
68      * the version of this operation on the ORB uses PIDL
69      * (<code>CORBA::ORB::ObjectId</code> and
70      * <code>CORBA::ORB::InvalidName</code>) whereas the version in this
71      * interface uses IDL defined in this interface; the semantics
72      * are identical.
73      * <p>
74      * This operation is only valid during post_init.
75      */

76   org.omg.CORBA.Object JavaDoc resolve_initial_references (String JavaDoc id) throws org.omg.PortableInterceptor.ORBInitInfoPackage.InvalidName JavaDoc;
77
78   /**
79      * Used to add a client-side request Interceptor to the list of
80      * client-side request Interceptors.
81      *
82      * @param interceptor The <code>ClientRequestInterceptor</code> to be
83      * added.
84      * @exception DuplicateName thrown if a client-side request Interceptor
85      * has already been registered with this Interceptor's name.
86      */

87   void add_client_request_interceptor (org.omg.PortableInterceptor.ClientRequestInterceptor JavaDoc interceptor) throws org.omg.PortableInterceptor.ORBInitInfoPackage.DuplicateName JavaDoc;
88
89   /**
90      * Used to add a server-side request Interceptor to the list of
91      * server-side request Interceptors.
92      *
93      * @param interceptor The ServerRequestInterceptor to be added.
94      * @exception DuplicateName thrown if a server-side request Interceptor
95      * has already been registered with this Interceptor's name
96      */

97   void add_server_request_interceptor (org.omg.PortableInterceptor.ServerRequestInterceptor JavaDoc interceptor) throws org.omg.PortableInterceptor.ORBInitInfoPackage.DuplicateName JavaDoc;
98
99   /**
100      * Used to add an IOR Interceptor to the list of IOR Interceptors.
101      *
102      * @param interceptor The IORInterceptor to be added.
103      * @exception DuplicateName thrown if an IOR Interceptor has already
104      * been registered with this Interceptor's name.
105      */

106   void add_ior_interceptor (org.omg.PortableInterceptor.IORInterceptor JavaDoc interceptor) throws org.omg.PortableInterceptor.ORBInitInfoPackage.DuplicateName JavaDoc;
107
108   /**
109      * Called to allocate a slot on <code>PortableInterceptor.Current</code>.
110      * <p>
111      * Note that while slot id's can be allocated within an ORB initializer,
112      * the slots themselves cannot be initialized.
113      *
114      * @return The index to the slot which has been allocated.
115      * @exception BAD_INV_ORDER thrown, with a standard minor code of 14, if
116      * <code>set_slot</code> or <code>get_slot</code> is called on the
117      * <code>PICurrent</code> within an ORB initializer.
118      * @see Current
119      */

120   int allocate_slot_id ();
121
122   /**
123      * Registers a <code>PolicyFactory</code> for the given
124      * <code>PolicyType</code>.
125      *
126      * @param type The policy type that the given <code>PolicyFactory</code>
127      * serves.
128      * @param policy_factory The factory for the given policy type.
129      * @exception BAD_INV_ORDER thrown, with a standard minor code of 16, if
130      * a <code>PolicyFactory</code> already exists for the given
131      * <code>PolicyType</code>.
132      */

133   void register_policy_factory (int type, org.omg.PortableInterceptor.PolicyFactory JavaDoc policy_factory);
134 } // interface ORBInitInfoOperations
135
Popular Tags