Interceptors.idl revision 0
0N/A * Copyright 2000-2003 Sun Microsystems, Inc. All Rights Reserved. 0N/A * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 0N/A * This code is free software; you can redistribute it and/or modify it 0N/A * under the terms of the GNU General Public License version 2 only, as 0N/A * published by the Free Software Foundation. Sun designates this 0N/A * particular file as subject to the "Classpath" exception as provided 0N/A * by Sun in the LICENSE file that accompanied this code. 0N/A * This code is distributed in the hope that it will be useful, but WITHOUT 0N/A * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or 0N/A * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License 0N/A * version 2 for more details (a copy is included in the LICENSE file that 0N/A * accompanied this code). 0N/A * You should have received a copy of the GNU General Public License version 0N/A * 2 along with this work; if not, write to the Free Software Foundation, 0N/A * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. 0N/A * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara, 0N/A * CA 95054 USA or visit www.sun.com if you need additional information or 0N/A * have any questions. 0N/A * Differences from original: 0N/A * - do not include orb.idl 0N/A * - include IOP.idl, Messaging.idl and CORBAX.idl 0N/A * - renamed component parameter names to tagged_component (so that they 0N/A * do not conflict with the CORBA 3.0 "component" keyword). 0N/A * - javadocs added (synchronized with orbos/00-08-06) 0N/A * NOTE: After compilation of this IDL file, all Helper and Holder classes 0N/A * that are not needed are removed. 0N/A * <code>NVList</code> PIDL represented by <code>ParameterList</code> IDL. 0N/A * This exists in order to keep the Portable Interceptor IDL from becoming 0N/A * <code>NVList</code> PIDL represented by <code>ParameterList</code> IDL. 0N/A * This exists in order to keep the Portable Interceptor IDL from becoming 0N/A * <code>ContextList</code> PIDL represented by <code>ContextList</code> 0N/A * IDL. This exists in order to keep the Portable Interceptor IDL from 0N/A * <code>ExceptionList</code> PIDL represented by <code>ExceptionList</code> 0N/A * IDL. This exists in order to keep the Portable Interceptor IDL from 0N/A * <code>Context</code> PIDL represented by <code>RequestContext</code> 0N/A * IDL. This exists in order to keep the Portable Interceptor IDL from o 0N/A * <code>Context</code> objects are encoded as <code>String[]</code>. The 0N/A * <code>Strings</code> occur in pairs. The first <code>String</code> in 0N/A * each pair is the context property name and the second <code>String</code> 0N/A * in each pair is the associated value. 0N/A * All Portable Interceptors implement Interceptor. 0N/A * Returns the name of the interceptor. 0N/A * Each Interceptor may have a name that may be used administratively 0N/A * to order the lists of Interceptors. Only one Interceptor of a given 0N/A * name can be registered with the ORB for each Interceptor type. An 0N/A * Interceptor may be anonymous, i.e., have an empty string as the name 0N/A * attribute. Any number of anonymous Interceptors may be registered with 0N/A * @return the name of the interceptor. 0N/A // Added in ptc/00-08-06 0N/A * Provides an opportunity to destroy this interceptor. 0N/A * The destroy method is called during <code>ORB.destroy</code>. When an 0N/A * application calls <code>ORB.destroy</code>, the ORB: 0N/A * <li>waits for all requests in progress to complete</li> 0N/A * <li>calls the <code>Interceptor.destroy</code> operation for each 0N/A * <li>completes destruction of the ORB</li> 0N/A * Method invocations from within <code>Interceptor.destroy</code> on 0N/A * object references for objects implemented on the ORB being destroyed 0N/A * result in undefined behavior. However, method invocations on objects 0N/A * implemented on an ORB other than the one being destroyed are 0N/A * permitted. (This means that the ORB being destroyed is still capable 0N/A * of acting as a client, but not as a server.) 0N/A * The <code>ForwardRequest</code> exception is the means by which an 0N/A * Interceptor can indicate to the ORB that a retry of the request should 0N/A * occur with the new object given in the exception. This behavior of 0N/A * causing a retry only occurs if the ORB receives a ForwardRequest from 0N/A * an interceptor. If <code>ForwardRequest</code> is thrown anywhere else 0N/A * it is passed through the ORB as is normal for a user exception. 0N/A * If an Interceptor throws a <code>ForwardRequest</code> exception in 0N/A * response to a call of an interceptor, no other Interceptors are called 0N/A * for that interception point. The remaining Interceptors in the Flow Stack 0N/A * shall have their appropriate ending interception point called: 0N/A * <code>receive_other</code> on the client, or <code>send_other</code> on 0N/A * the server. The <code>reply_status</code> in the 0N/A * <code>receive_other</code> or <code>send_other</code> would be 0N/A * <code>LOCATION_FORWARD</code>. 0N/A * The new object to forward the request to. 0N/A// Change in ptc/00-08-06 0N/A// boolean permanent; 0N/A /** Reply status, represented as an int */ 0N/A // Valid reply_status values: 0N/A * Indicates a successful Reply Status. One possible value for 0N/A * <code>RequestInfo.reply_status</code>. 0N/A * @see RequestInfo#reply_status 0N/A * @see SYSTEM_EXCEPTION 0N/A * @see USER_EXCEPTION 0N/A * @see LOCATION_FORWARD 0N/A * @see TRANSPORT_RETRY 0N/A * Indicates a SystemException reply status. One possible value for 0N/A * <code>RequestInfo.reply_status</code>. 0N/A * @see RequestInfo#reply_status 0N/A * @see USER_EXCEPTION 0N/A * @see LOCATION_FORWARD 0N/A * @see TRANSPORT_RETRY 0N/A * Indicates a UserException reply status. One possible value for 0N/A * <code>RequestInfo.reply_status</code>. 0N/A * @see RequestInfo#reply_status 0N/A * @see SYSTEM_EXCEPTION 0N/A * @see LOCATION_FORWARD 0N/A * @see TRANSPORT_RETRY 0N/A * Indicates a LocationForward reply status. One possible value for 0N/A * <code>RequestInfo.reply_status</code>. 0N/A * @see RequestInfo#reply_status 0N/A * @see SYSTEM_EXCEPTION 0N/A * @see USER_EXCEPTION 0N/A * @see TRANSPORT_RETRY 0N/A// Changes in ptc/00-08-06 0N/A// const ReplyStatus LOCATION_FORWARD_PERMANENT = 4; 0N/A * Indicates a Transport Retry reply status. One possible value for 0N/A * <code>RequestInfo.reply_status</code>. 0N/A * @see RequestInfo#reply_status 0N/A * @see SYSTEM_EXCEPTION 0N/A * @see USER_EXCEPTION 0N/A * @see LOCATION_FORWARD 0N/A /** Slot id, represented as an int */ 0N/A * This exception is thrown when <code>get_slot</code> or 0N/A * <code>set_slot</code> is called on a slot that has not been allocated. 0N/A * Portable Interceptors Current (also known as <code>PICurrent</code>) 0N/A * is merely a slot table, the slots of which are used by each service to 0N/A * transfer their context data between their context and the request's or 0N/A * reply's service context. Each service which wishes to use PICurrent 0N/A * reserves a slot or slots at initialization time and uses those slots 0N/A * during the processing of requests and replies. 0N/A * Before an invocation is made, PICurrent is obtained via a call to 0N/A * <code>ORB.resolve_initial_references( "PICurrent" )</code>. From within 0N/A * the interception points, the data on PICurrent that has moved from the 0N/A * thread scope to the request scope is available via the 0N/A * <code>get_slot</code> operation on the <code>RequestInfo</code> object. 0N/A * A PICurrent can still be obtained via 0N/A * <code>resolve_initial_references</code>, but that is the Interceptor's 0N/A * thread scope PICurrent. 0N/A * Retrieves the slot data the application set in PICurrent via 0N/A * <code>get_slot</code>. The data is in the form of an Any. 0N/A * If the given slot has not been set, an Any containing a type code 0N/A * with a <code>TCKind</code> value of <code>tk_null</code> and no value 0N/A * @param id The <code>SlotId</code> of the slot from which the data will 0N/A * @return The data, in the form of an Any, of the given slot identifier. 0N/A * @exception InvalidSlot thrown if get_slot is called on a slot that 0N/A * has not been allocated. 0N/A * @exception BAD_INV_ORDER thrown if <code>get_slot</code> is called 0N/A * from within an ORB initializer 0N/A * Sets data in a slot. The data is in the form of an Any. If data 0N/A * already exists in that slot, it is overridden. 0N/A * @param id The <code>SlotId</code> of the slot to which the data will 0N/A * @param data The data, in the form of an Any, which will be set 0N/A * to the identified slot. 0N/A * @exception InvalidSlot thrown if <code>set_slot</code> is called on 0N/A * a slot that has not been allocated. 0N/A * @exception BAD_INV_ORDER thrown if <code>set_slot</code> is called 0N/A * from within an ORB initializer. 0N/A * Request Information, accessible to Interceptors. 0N/A * Each interception point is given an object through which the 0N/A * Interceptor can access request information. Client-side and server-side 0N/A * interception points are concerned with different information, so there 0N/A * are two information objects: <code>ClientRequestInfo</code> is passed 0N/A * to the client-side interception points and <code>ServerRequestInfo</code> 0N/A * is passed to the server-side interception points. But there is 0N/A * information that is common to both, so they both inherit from a common 0N/A * interface: <code>RequestInfo</code>. 0N/A * @see ClientRequestInfo 0N/A * @see ServerRequestInfo 0N/A * reused. Note that this id is not the same as the GIOP 0N/A * <code>request_id</code>. If GIOP is the transport mechanism used, 0N/A * then these IDs may very well be the same, but this is not guaranteed 0N/A * Returns the name of the operation being invoked. 0N/A * Returns an array of <code>Parameter</code> objects, containing the 0N/A * arguments on the operation being invoked. If there are no arguments, 0N/A * this attribute will be a zero length array. 0N/A * Not all environments provide access to the arguments. With the Java 0N/A * portable bindings, for example, the arguments are not available. 0N/A * In these environments, when this attribute is accessed, 0N/A * <code>NO_RESOURCES</code> will be thrown with a standard minor code 0N/A * <i>Note: Arguments are available for DSI/DII calls.</i> 0N/A * @exception NO_RESOURCES thrown if arguments are not available. 0N/A * <code>PortableInterceptor</code> package comments for 0N/A * limitations / unimplemented features</a> 0N/A * Returns an array of <code>TypeCode</code> objects describing the 0N/A * <code>TypeCode</code>s of the user exceptions that this operation 0N/A * invocation may throw. If there are no user exceptions, this 0N/A * will return a zero length array. 0N/A * Not all environments provide access to the exception list. With 0N/A * the Java portable bindings, for example, the exception list is 0N/A * not available. In these environments, when this attribute is 0N/A * accessed, <code>NO_RESOURCES</code> will be thrown with a 0N/A * standard minor code of 1. 0N/A * <i>Note: Exceptions are available for DSI/DII calls.</i> 0N/A * @exception NO_RESOURCES thrown if exceptions are not available. 0N/A * <code>PortableInterceptor</code> package comments for 0N/A * limitations / unimplemented features</a> 0N/A * Returns an array of <code>String</code> objects describing the 0N/A * contexts that may be passed on this operation invocation. If there 0N/A * are no contexts, this will return a zero length array. 0N/A * Not all environments provide access to the context list. With the 0N/A * Java portable bindings, for example, the context list is not 0N/A * available. In these environments, when this attribute is accessed, 0N/A * <code>NO_RESOURCES</code> will be thrown with a standard minor code 0N/A * <i>Note: Contexts are available for DSI/DII calls.</i> 0N/A * @exception NO_RESOURCES thrown if contexts are not available. 0N/A * <code>PortableInterceptor</code> package comments for 0N/A * limitations / unimplemented features</a> 0N/A * Returns an array of <code>String</code> objects containing the 0N/A * contexts being sent on the request. 0N/A * Not all environments provide access to the context. With the Java 0N/A * portable bindings, for example, the context is not available. In 0N/A * these environments, when this attribute is accessed, NO_RESOURCES will 0N/A * be thrown with standard minor code of 1. 0N/A * <i>Note: <code>operation_context</code> is available for 0N/A * @exception NO_RESOURCES thrown if operation context is not available. 0N/A * <code>PortableInterceptor</code> package comments for 0N/A * limitations / unimplemented features</a> 0N/A * Returns an any containing the result of the operation invocation. 0N/A * If the operation return type is void, this attribute will be an any 0N/A * containing a type code with a <code>TCKind</code> value of 0N/A * <code>tk_void</code> and no value. 0N/A * Not all environments provide access to the result. With the Java 0N/A * portable bindings, for example, the result is not available. In 0N/A * these environments, when this attribute is accessed, 0N/A * <code>NO_RESOURCES</code> will be thrown with a standard minor code of 0N/A * <i>Note: Result is available for DSI/DII calls.</i> 0N/A * @exception NO_RESOURCES thrown if result is not available. 0N/A * <code>PortableInterceptor</code> package comments for 0N/A * limitations / unimplemented features</a> 0N/A * Indicates whether a response is expected. 0N/A * On the client, a reply is not returned when 0N/A * <code>response_expected</code> is false, so <code>receive_reply</code> 0N/A * cannot be called. <code>receive_other</code> is called unless an 0N/A * exception occurs, in which case <code>receive_exception</code> is 0N/A * On the client, within <code>send_poll</code>, this attribute is true. 0N/A * Defines how far the request shall progress before control is returned 0N/A * to the client. This is defined in the Messaging specification, and 0N/A * is pertinent only when <code>response_expected</code> is false. If 0N/A * <code>response_expected</code> is true, the value of 0N/A * <code>sync_scope</code> is undefined. This attribute may have one of 0N/A * the following values: 0N/A * <li><code>Messaging.SYNC_NONE</code></li> 0N/A * <li><code>Messaging.SYNC_WITH_TRANSPORT</code></li> 0N/A * <li><code>Messaging.SYNC_WITH_SERVER</code></li> 0N/A * <li><code>Messaging.SYNC_WITH_TARGET</code></li> 0N/A * On the server, for all scopes, a reply will be created from the 0N/A * return of the target operation call, but the reply will not return 0N/A * to the client. Although it does not return to the client, it does 0N/A * occur, so the normal server-side interception points are 0N/A * followed (i.e., <code>receive_request_service_contexts</code>, 0N/A * <code>receive_request</code>, <code>send_reply</code> or 0N/A * <code>send_exception</code>). 0N/A * For <code>SYNC_WITH_SERVER</code> and <code>SYNC_WITH_TARGET</code>, 0N/A * the server does send an empty reply back to the client before the 0N/A * target is invoked. This reply is not intercepted by server-side 0N/A * <code>PortableInterceptor</code> package comments for 0N/A * limitations / unimplemented features</a> 0N/A * Describes the state of the result of the operation invocation. The 0N/A * return value can be one of the following: 0N/A * <li><code>PortableInterceptor.SUCCESSFUL</code></li> 0N/A * <li><code>PortableInterceptor.SYSTEM_EXCEPTION</code></li> 0N/A * <li><code>PortableInterceptor.USER_EXCEPTION</code></li> 0N/A * <li><code>PortableInterceptor.LOCATION_FORWARD</code></li> 0N/A * <li><code>PortableInterceptor.TRANSPORT_RETRY</code></li> 0N/A * <li>Within the <code>receive_reply</code> interception point, this 0N/A * will only return <code>SUCCESSFUL</code></li>. 0N/A * <li>Within the <code>receive_exception</code> interception point, 0N/A * this will be either <code>SYSTEM_EXCEPTION</code> or 0N/A * <code>USER_EXCEPTION</code>.</li> 0N/A * <li>Within the <code>receive_other</code> interception point, this 0N/A * will be any of: <code>SUCCESSFUL</code>, 0N/A * <code>LOCATION_FORWARD</code>, or <code>TRANSPORT_RETRY</code>. 0N/A * <code>SUCCESSFUL</code> means an asynchronous request returned 0N/A * successfully. <code>LOCATION_FORWARD</code> means that a reply 0N/A * came back with <code>LOCATION_FORWARD</code> as its status. 0N/A * <code>TRANSPORT_RETRY</code> means that the transport 0N/A * mechanism indicated a retry - a GIOP reply with a status of 0N/A * <code>NEEDS_ADDRESSING_MODE</code>, for instance. </li> 0N/A * <li>Within the <code>send_reply</code> interception point, this 0N/A * will only be <code>SUCCESSFUL</code>.</li> 0N/A * <li>Within the <code>send_exception</code> interception point, 0N/A * this will be either <code>SYSTEM_EXCEPTION</code> or 0N/A * <code>USER_EXCEPTION</code>.</li> 0N/A * <li>Within the <code>send_other</code> interception point, this 0N/A * attribute will be any of: <code>SUCCESSFUL</code>, or 0N/A * <code>LOCATION_FORWARD</code>. <code>SUCCESSFUL</code> means 0N/A * an asynchronous request returned successfully. 0N/A * <code>LOCATION_FORWARD</code> means that a reply came back 0N/A * with <code>LOCATION_FORWARD</code> as its status.</li> 0N/A * @see SYSTEM_EXCEPTION 0N/A * @see USER_EXCEPTION 0N/A * @see LOCATION_FORWARD 0N/A * @see TRANSPORT_RETRY 0N/A * Contains the object to which the request will be forwarded, if the 0N/A * <code>reply_status</code> attribute is <code>LOCATION_FORWARD</code>. 0N/A * It is indeterminate whether a forwarded request will actually occur. 0N/A * Returns the data from the given slot of the 0N/A * <code>PortableInterceptor.Current</code> that is in the scope of 0N/A * If the given slot has not been set, then an any containing a 0N/A * type code with a <code>TCKind</code> value of <code>tk_null</code> is 0N/A * @param id The <code>SlotId</code> of the slot which is to be 0N/A * @return The slot data, in the form of an any, obtained with the 0N/A * @exception InvalidSlot thrown if the ID does not define an 0N/A * Returns a copy of the service context with the given ID that 0N/A * is associated with the request. 0N/A * @param id The <code>IOP.ServiceId</code> of the service context 0N/A * which is to be returned. 0N/A * @return The <code>IOP.ServiceContext</code> obtained with the 0N/A * @exception BAD_PARAM thrown with a standard minor code of 26, if the 0N/A * request's service context does not contain an entry for that ID. 0N/A * Returns a copy of the service context with the given ID that 0N/A * is associated with the reply. 0N/A * @param id The <code>IOP.ServiceId</code> of the service context 0N/A * which is to be returned. 0N/A * @return The <code>IOP.ServiceContext</code> obtained with the given 0N/A * @exception BAD_PARAM thrown with a standard minor code of 26 if the 0N/A * request's service context does not contain an entry for that ID. 0N/A * Request Information, accessible to client-side request interceptors. 0N/A * Some attributes and operations on <code>ClientRequestInfo</code> are 0N/A * not valid at all interception points. The following table shows the 0N/A * validity of each attribute or operation. If it is not valid, attempting 0N/A * to access it will result in a <code>BAD_INV_ORDER</code> being thrown 0N/A * with a standard minor code of 14. 0N/A * <table border=1 summary="Shows the validity of each attribute or operation"> 0N/A * <th id="send_req">send_request</th> 0N/A * <th id="send_poll">send_poll</th> 0N/A * <th id="rec_reply">receive_reply</th> 0N/A * <th id="rec_ex">receive_exception</th> 0N/A * <th id="rec_oth">receive_other</th> 0N/A * <td id="ri" colspan=6><i>Inherited from RequestInfo:</i></td> 0N/A * <tr><th id="req_id"><p align="left">request_id</p></th> 0N/A * <td headers="ri req_id send_req">yes</td> 0N/A * <td headers="ri req_id send_poll">yes</td> 0N/A * <td headers="ri req_id rec_reply">yes</td> 0N/A * <td headers="ri req_id rec_ex">yes</td> 0N/A * <td headers="ri req_id rec_oth">yes</td></tr> 0N/A * <tr><th id="op"><p align="left">operation</p></th> 0N/A * <td headers="ri op send_req">yes</td> 0N/A * <td headers="ri op send_poll">yes</td> 0N/A * <td headers="ri op rec_reply">yes</td> 0N/A * <td headers="ri op rec_ex">yes</td> 0N/A * <td headers="ri op rec_oth">yes</td></tr> 0N/A * <tr><th id="arg"><p align="left">arguments</p></th> 0N/A * <td headers="ri arg send_req">yes<sub>1</sub></td> 0N/A * <td headers="ri arg send_poll">no </td> 0N/A * <td headers="ri arg rec_reply">yes</td> 0N/A * <td headers="ri arg rec_ex">no </td> 0N/A * <td headers="ri arg rec_oth">no </td></tr> 0N/A * <tr><th id="exc"><p align="left">exceptions</p></th> 0N/A * <td headers="ri exc send_req">yes</td> 0N/A * <td headers="ri exc send_poll">no </td> 0N/A * <td headers="ri exc rec_reply">yes</td> 0N/A * <td headers="ri exc rec_ex">yes</td> 0N/A * <td headers="ri exc rec_oth">yes</td></tr> 0N/A * <tr><th id="con"><p align="left">contexts</p></th> 0N/A * <td headers="ri con send_req">yes</td> 0N/A * <td headers="ri con send_poll">no </td> 0N/A * <td headers="ri con rec_reply">yes</td> 0N/A * <td headers="ri con rec_ex">yes</td> 0N/A * <td headers="ri con rec_oth">yes</td></tr> 0N/A * <tr><th id="op_con"><p align="left">operation_context</p></th> 0N/A * <td headers="ri op_con send_req">yes</td> 0N/A * <td headers="ri op_con send_poll">no </td> 0N/A * <td headers="ri op_con rec_reply">yes</td> 0N/A * <td headers="ri op_con rec_ex">yes</td> 0N/A * <td headers="ri op_con rec_oth">yes</td> 0N/A * <tr><th id="result"><p align="left">result</p></th> 0N/A * <td headers="ri result send_req">no </td> 0N/A * <td headers="ri result send_poll">no </td> 0N/A * <td headers="ri result rec_reply">yes</td> 0N/A * <td headers="ri result rec_ex">no </td> 0N/A * <td headers="ri result rec_oth">no </td> 0N/A * <tr><th id="res_exp"><p align="left">response_expected</p></th> 0N/A * <td headers="ri res_exp send_req">yes</td> 0N/A * <td headers="ri res_exp send_poll">yes</td> 0N/A * <td headers="ri res_exp rec_reply">yes</td> 0N/A * <td headers="ri res_exp rec_ex">yes</td> 0N/A * <td headers="ri res_exp rec_oth">yes</td></tr> 0N/A * <tr><th id="sync_sco"><p align="left">sync_scope</p></th> 0N/A * <td headers="ri sync_sco send_req">yes</td> 0N/A * <td headers="ri sync_sco send_poll">no </td> 0N/A * <td headers="ri sync_sco rec_reply">yes</td> 0N/A * <td headers="ri sync_sco rec_ex">yes</td> 0N/A * <td headers="ri sync_sco rec_oth">yes</td> 0N/A * <tr><th id="rep_stat"><p align="left">reply_status</p></th> 0N/A * <td headers="ri rep_stat send_req">no </td> 0N/A * <td headers="ri rep_stat send_poll">no </td> 0N/A * <td headers="ri rep_stat rec_reply">yes</td> 0N/A * <td headers="ri rep_stat rec_ex">yes</td> 0N/A * <td headers="ri rep_stat rec_oth">yes</td></tr> 0N/A * <tr><th id="for_ref"><p align="left">forward_reference</p></th> 0N/A * <td headers="ri for_ref send_req">no </td> 0N/A * <td headers="ri for_ref send_poll">no </td> 0N/A * <td headers="ri for_ref rec_reply">no </td> 0N/A * <td headers="ri for_ref rec_ex">no </td> 0N/A * <td headers="ri for_ref rec_oth">yes<sub>2</sub> 0N/A * <tr><th id="get_slot"><p align="left">get_slot</p></th> 0N/A * <td headers="ri get_slot send_req">yes</td> 0N/A * <td headers="ri get_slot send_poll">yes</td> 0N/A * <td headers="ri get_slot rec_reply">yes</td> 0N/A * <td headers="ri get_slot rec_ex">yes</td> 0N/A * <td headers="ri get_slot rec_oth">yes</td></tr> 0N/A * <tr><th id="grsc"><p align="left">get_request_service_context</p></th> 0N/A * <td headers="ri grsc send_req">yes</td> 0N/A * <td headers="ri grsc send_poll">no </td> 0N/A * <td headers="ri grsc rec_reply">yes</td> 0N/A * <td headers="ri grsc rec_ex">yes</td> 0N/A * <td headers="ri grsc rec_oth">yes</td></tr> 0N/A * <tr><th id="gpsc"><p align="left">get_reply_service_context</p></th> 0N/A * <td headers="ri gpsc send_req">no </td> 0N/A * <td headers="ri gpsc send_poll">no </td> 0N/A * <td headers="ri gpsc rec_reply">yes</td> 0N/A * <td headers="ri gpsc rec_ex">yes</td> 0N/A * <td headers="ri gpsc rec_oth">yes</td> 0N/A * <td id="cri" colspan=6><i>ClientRequestInfo-specific:</i></td> 0N/A * <tr><th id="target"><p align="left">target</p></th> 0N/A * <td headers="cri target send_req">yes</td> 0N/A * <td headers="cri target send_poll">yes</td> 0N/A * <td headers="cri target rec_reply">yes</td> 0N/A * <td headers="cri target rec_ex">yes</td> 0N/A * <td headers="cri target rec_oth">yes</td></tr> 0N/A * <tr><th id="eftarget"><p align="left">effective_target</p></th> 0N/A * <td headers="cri eftarget send_req">yes</td> 0N/A * <td headers="cri eftarget send_poll">yes</td> 0N/A * <td headers="cri eftarget rec_reply">yes</td> 0N/A * <td headers="cri eftarget rec_ex">yes</td> 0N/A * <td headers="cri eftarget rec_oth">yes</td> 0N/A * <tr><th id="efprof"><p align="left">effective_profile</p></th> 0N/A * <td headers="cri efprof send_req">yes</td> 0N/A * <td headers="cri efprof send_poll">yes</td> 0N/A * <td headers="cri efprof rec_reply">yes</td> 0N/A * <td headers="cri efprof rec_ex">yes</td> 0N/A * <td headers="cri efprof rec_oth">yes</td></tr> 0N/A * <tr><th id="rxp"><p align="left">received_exception</p></th> 0N/A * <td headers="cri rxp send_req">no </td> 0N/A * <td headers="cri rxp send_poll">no </td> 0N/A * <td headers="cri rxp rec_reply">no </td> 0N/A * <td headers="cri rxp rec_ex">yes</td> 0N/A * <td headers="cri rxp rec_oth">no </td></tr> 0N/A * <tr><th id="rei"><p align="left">received_exception_id</p></th> 0N/A * <td headers="cri rei send_req">no </td> 0N/A * <td headers="cri rei send_poll">no </td> 0N/A * <td headers="cri rei rec_reply">no </td> 0N/A * <td headers="cri rei rec_ex">yes</td> 0N/A * <td headers="cri rei rec_oth">no </td></tr> 0N/A * <tr><th id="gec"><p align="left">get_effective_component</p></th> 0N/A * <td headers="cri gec send_req">yes</td> 0N/A * <td headers="cri gec send_poll">no </td> 0N/A * <td headers="cri gec rec_reply">yes</td> 0N/A * <td headers="cri gec rec_ex">yes</td> 0N/A * <td headers="cri gec rec_oth">yes</td></tr> 0N/A * <tr><th id="gecs"><p align="left">get_effective_components</p></th> 0N/A * <td headers="cri gecs send_req">yes</td> 0N/A * <td headers="cri gecs send_poll">no </td> 0N/A * <td headers="cri gecs rec_reply">yes</td> 0N/A * <td headers="cri gecs rec_ex">yes</td> 0N/A * <td headers="cri gecs rec_oth">yes</td></tr> 0N/A * <tr><th id="grpcy"><p align="left">get_request_policy</p></th> 0N/A * <td headers="cri grpcy send_req">yes</td> 0N/A * <td headers="cri grpcy send_poll">no </td> 0N/A * <td headers="cri grpcy rec_reply">yes</td> 0N/A * <td headers="cri grpcy rec_ex">yes</td> 0N/A * <td headers="cri grpcy rec_oth">yes</td></tr> 0N/A * <tr><th id="arsc"><p align="left">add_request_service_context</p></th> 0N/A * <td headers="cri arsc send_req">yes</td> 0N/A * <td headers="cri arsc send_poll">no </td> 0N/A * <td headers="cri arsc rec_reply">no </td> 0N/A * <td headers="cri arsc rec_ex">no </td> 0N/A * <td headers="cri arsc rec_oth">no </td></tr> 0N/A * <li>When <code>ClientRequestInfo</code> is passed to 0N/A * <code>send_request</code>, there is an entry in the list for every 0N/A * argument, whether in, inout, or out. But only the in and inout 0N/A * arguments will be available.</li> 0N/A * <li>If the <code>reply_status</code> atribute is not 0N/A * <code>LOCATION_FORWARD</code>, accessing this attribute will 0N/A * throw <code>BAD_INV_ORDER</code> with a standard minor code of 0N/A * @see ClientRequestInterceptor 0N/A * Returns the object which the client called to perform the 0N/A * @see #effective_target 0N/A * Returns the actual object on which the operation will be invoked. 0N/A * If the <code>reply_status</code> is <code>LOCATION_FORWARD</code>, 0N/A * then on subsequent requests, <code>effective_target</code> will 0N/A * contain the forwarded IOR while target will remain unchanged. 0N/A * Returns the profile that will be used to send the request. If a 0N/A * location forward has occurred for this operation's object and 0N/A * that object's profile changed accordingly, then this profile will 0N/A * be that located profile. 0N/A * Returns an any which contains the exception to be returned to 0N/A * If the exception is a user exception which cannot be inserted 0N/A * into an any (e.g., it is unknown or the bindings don t provide 0N/A * the <code>TypeCode</code>), then this attribute will be an any 0N/A * containing the system exception <code>UNKNOWN</code> with a 0N/A * standard minor code of 1. However, the repository id of 0N/A * the exception is available in the <code>received_exception_id</code> 0N/A * @see #received_exception_id 0N/A * Returns the repository id of the exception to be returned to 0N/A * @see #received_exception 0N/A * <code>PortableInterceptor</code> package comments for 0N/A * limitations / unimplemented features</a> 0N/A * Returns the <code>IOP.TaggedComponent</code> with the given ID from 0N/A * the profile selected for this request. 0N/A * If there is more than one component for a given component ID, it 0N/A * is undefined which component this operation returns. If there is 0N/A * more than one component for a given component ID, 0N/A * <code>get_effective_components</code> should be called instead. 0N/A * @param id The component id of the component which 0N/A * is to be returned. 0N/A * @return The <code>IOP.TaggedComponent</code> obtained with the 0N/A * @exception BAD_PARAM thrown, with a standard minor code of 28, if 0N/A * no component exists for the given component ID. 0N/A * @see #get_effective_components 0N/A * Returns an array of all tagged components with the given ID from the 0N/A * profile selected for this request. 0N/A * @param id The component id of the components which are to be returned. 0N/A * @return An array of <code>TaggedComponent</code> objects, each of 0N/A * which contains the given identifier. 0N/A * @exception BAD_PARAM thrown, with a standard minor code of 28, if 0N/A * no component exists for the given component ID. 0N/A * @see #get_effective_component 0N/A * Returns the given policy in effect for this operation. 0N/A * @exception INV_POLICY thrown, with a standard minor code of 1, if the 0N/A * policy type is not valid either because the specified type is 0N/A * not supported by this ORB or because a policy object of that type 0N/A * is not associated with this Object 0N/A * @param type The policy type which specifies the policy to be 0N/A * @return The <code>CORBA.Policy</code> obtained with the given type. 0N/A * <code>PortableInterceptor</code> package comments for 0N/A * limitations / unimplemented features</a> 0N/A * Allows Interceptors to add service contexts to the request. 0N/A * There is no declaration of the order of the service contexts. 0N/A * They may or may not appear in the order that they are added. 0N/A * @param service_context The <code>IOP.ServiceContext</code> to be 0N/A * added to the request. 0N/A * @param replace Indicates the behavior of this operation when a 0N/A * service context already exists with the given ID. If false, 0N/A * then <code>BAD_INV_ORDER</code> with a standard minor code of 15 0N/A * is thrown. If true, then the existing service context is 0N/A * replaced by the new one. 0N/A // Should be type string 0N/A // This should actually be the CORBA::ORBid type once that is available 0N/A /** The name of an object adapter. This is unique only within 0N/A * the scope of the ORB that created the object adapter. 0N/A /** Type of an object id. This provides the identity of a particular 0N/A * object that was created by an object adapter. 0N/A * Request Information, accessible to server-side request interceptors. 0N/A * Some attributes and operations on <code>ServerRequestInfo</code> are not 0N/A * valid at all interception points. The following table shows the validity 0N/A * of each attribute or operation. If it is not valid, attempting to access 0N/A * it will result in a <code>BAD_INV_ORDER</code> being thrown with a 0N/A * standard minor code of 14. 0N/A * <table border=1 summary="Shows the validity of each attribute or operation"> 0N/A * <th id="rec_req_ser_con" valign="bottom">receive_request_<br>service_contexts</th> 0N/A * <th id="rec_req" valign="bottom">receive_request</th> 0N/A * <th id="send_rep" valign="bottom">send_reply</th> 0N/A * <th id="send_exc" valign="bottom">send_exception</th> 0N/A * <th id="send_oth" valign="bottom">send_other</th> 0N/A * <td id="ri" colspan=6><i>Inherited from RequestInfo:</i></td> 0N/A * <tr><th id="req_id"><p align="left">request_id</p></th> 0N/A * <td headers="ri req_id rec_req_ser_con">yes</td> 0N/A * <td headers="ri req_id rec_req">yes</td> 0N/A * <td headers="ri req_id send_rep">yes</td> 0N/A * <td headers="ri req_id send_exc">yes</td> 0N/A * <td headers="ri req_id send_oth">yes</td></tr> 0N/A * <tr><th id="op"><p align="left">operation</p></th> 0N/A * <td headers="ri op rec_req_ser_con">yes</td> 0N/A * <td headers="ri op rec_req">yes</td> 0N/A * <td headers="ri op send_rep">yes</td> 0N/A * <td headers="ri op send_exc">yes</td> 0N/A * <td headers="ri op send_oth">yes</td></tr> 0N/A * <tr><th id="args"><p align="left">arguments</p></th> 0N/A * <td headers="ri args rec_req_ser_con">no </td> 0N/A * <td headers="ri args rec_req">yes<sub>1</sub></td> 0N/A * <td headers="ri args send_rep">yes</td> 0N/A * <td headers="ri args send_exc">no<sub>2</sub></td> 0N/A * <td headers="ri args send_oth">no<sub>2</sub> 0N/A * <tr><th id="exps"><p align="left">exceptions</p></th> 0N/A * <td headers="ri exps rec_req_ser_con">no </td> 0N/A * <td headers="ri exps rec_req">yes</td> 0N/A * <td headers="ri exps send_rep">yes</td> 0N/A * <td headers="ri exps send_exc">yes</td> 0N/A * <td headers="ri exps send_oth">yes</td></tr> 0N/A * <tr><th id="contexts"><p align="left">contexts</p></th> 0N/A * <td headers="ri contexts rec_req_ser_con">no </td> 0N/A * <td headers="ri contexts rec_req">yes</td> 0N/A * <td headers="ri contexts send_rep">yes</td> 0N/A * <td headers="ri contexts send_exc">yes</td> 0N/A * <td headers="ri contexts send_oth">yes</td></tr> 0N/A * <tr><th id="op_con"><p align="left">operation_context</p></th> 0N/A * <td headers="ri op_con rec_req_ser_con">no </td> 0N/A * <td headers="ri op_con rec_req">yes</td> 0N/A * <td headers="ri op_con send_rep">yes</td> 0N/A * <td headers="ri op_con send_exc">no </td> 0N/A * <td headers="ri op_con send_oth">no </td> 0N/A * <tr><th id="result"><p align="left">result</p></th> 0N/A * <td headers="ri result rec_req_ser_con">no </td> 0N/A * <td headers="ri result rec_req">no </td> 0N/A * <td headers="ri result send_rep">yes</td> 0N/A * <td headers="ri result send_exc">no </td> 0N/A * <td headers="ri result send_oth">no </td> 0N/A * <tr><th id="res_ex"><p align="left">response_expected</p></th> 0N/A * <td headers="ri res_ex rec_req_ser_con">yes</td> 0N/A * <td headers="ri res_ex rec_req">yes</td> 0N/A * <td headers="ri res_ex send_rep">yes</td> 0N/A * <td headers="ri res_ex send_exc">yes</td> 0N/A * <td headers="ri res_ex send_oth">yes</td></tr> 0N/A * <tr><th id="syn_scp"><p align="left">sync_scope</p></th> 0N/A * <td headers="ri syn_scp rec_req_ser_con">yes</td> 0N/A * <td headers="ri syn_scp rec_req">yes</td> 0N/A * <td headers="ri syn_scp send_rep">yes</td> 0N/A * <td headers="ri syn_scp send_exc">yes</td> 0N/A * <td headers="ri syn_scp send_oth">yes</td></tr> 0N/A * <tr><td><b>request_id</b></td> 0N/A * <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td></tr> 0N/A * <tr><td><b>operation</b></td> 0N/A * <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td></tr> 0N/A * <tr><td><b>arguments</b></td> 0N/A * <td>no </td> <td>yes<sub>1</sub</td> 0N/A * <td>yes</td> <td>no<sub>2</sub></td> 0N/A * <td>no<sub>2</sub> 0N/A * <tr><td><b>exceptions</b></td> 0N/A * <td>no </td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td></tr> 0N/A * <tr><td><b>contexts</b></td> 0N/A * <td>no </td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td></tr> 0N/A * <tr><td><b>operation_context</b></td> 0N/A * <td>no </td> <td>yes</td> <td>yes</td> <td>no </td> <td>no </td></tr> 0N/A * <tr><td><b>result</b></td> 0N/A * <td>no </td> <td>no </td> <td>yes</td> <td>no </td> <td>no </td></tr> 0N/A * <tr><td><b>response_expected</b></td> 0N/A * <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td></tr> 0N/A * <tr><td><b>sync_scope</b></td> 0N/A * <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td></tr> 0N/A * <tr><td><b>reply_status</b></td> 0N/A * <td>no </td> <td>no </td> <td>yes</td> <td>yes</td> <td>yes</td></tr> 0N/A * <tr><td><b>forward_reference</b></td> 0N/A * <td>no </td> <td>no </td> <td>no </td> <td>no </td> <td>yes<sub>2</sub> 0N/A * <tr><td><b>get_slot</b></td> 0N/A * <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td></tr> 0N/A * <tr><td><b>get_request_service_context</b></td> 0N/A * <td>yes</td> <td>no </td> <td>yes</td> <td>yes</td> <td>yes</td></tr> 0N/A * <tr><td><b>get_reply_service_context</b></td> 0N/A * <td>no </td> <td>no </td> <td>yes</td> <td>yes</td> <td>yes</td></tr> 0N/A * <td colspan=6><i>ServerRequestInfo-specific:</i></td> 0N/A * <tr><td><b>sending_exception</b></td> 0N/A * <td>no </td> <td>no </td> <td>no </td> <td>yes</td> <td>no </td></tr> 0N/A * <tr><td><b>object_id</b></td> 0N/A * <td>no </td> <td>yes</td> <td>yes</td> <td>yes<sub>3</sub></td> 0N/A * <td>yes<sub>3</sub> 0N/A * <tr><td><b>adapter_id</b></td> 0N/A * <td>no </td> <td>yes</td> <td>yes</td> <td>yes<sub>3</sub></td> 0N/A * <td>yes<sub>3</sub> 0N/A * <tr><td><b>server_id</b></td> 0N/A * <td>no </td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td></tr> 0N/A * <tr><td><b>orb_id</b></td> 0N/A * <td>no </td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td></tr> 0N/A * <tr><td><b>adapter_name</b></td> 0N/A * <td>no </td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td></tr> 0N/A * <tr><td><b>target_most_derived_interface</b></td> 0N/A * <td>no </td> <td>yes</td> <td>no<sub>4</sub></td> 0N/A * <td>no<sub>4</sub></td> 0N/A * <td>no<sub>4</sub> 0N/A * <tr><td><b>get_server_policy</b></td> 0N/A * <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td></tr> 0N/A * <tr><td><b>set_slot</b></td> 0N/A * <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td></tr> 0N/A * <tr><td><b>target_is_a</b></td> 0N/A * <td>no </td> <td>yes</td> <td>no<sub>4</sub></td> 0N/A * <td>no<sub>4</sub></td> 0N/A * <td>no<sub>4</sub> 0N/A * <tr><td><b>add_reply_service_context</b></td> 0N/A * <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td></tr> 0N/A * <li>When <code>ServerRequestInfo</code> is passed to 0N/A * <code>receive_request</code>, there is an entry in the list for 0N/A * every argument, whether in, inout, or out. But only the in and 0N/A * inout arguments will be available.</li> 0N/A * <li>If the <code>reply_status</code> attribute is not 0N/A * <code>LOCATION_FORWARD</code>, accessing this attribute will throw 0N/A * <code>BAD_INV_ORDER</code> with a standard minor code of 14.</li> 0N/A * <li>If the servant locator caused a location forward, or thrown an 0N/A * interception point. <code>NO_RESOURCES</code> with a standard minor 0N/A * code of 1 will be thrown if it is not available.</li> 0N/A * <li>The operation is not available in this interception point because 0N/A * the necessary information requires access to the target object's 0N/A * servant, which may no longer be available to the ORB. For example, 0N/A * if the object's adapter is a POA that uses a 0N/A * <code>ServantLocator</code>, then the ORB invokes the interception 0N/A * point after it calls <code>ServantLocator.postinvoke()</code></li>. 0N/A * @see ServerRequestInterceptor 0N/A * Returns an any which contains the exception to be returned to 0N/A * If the exception is a user exception which cannot be inserted into 0N/A * an any (e.g., it is unknown or the bindings don't provide the 0N/A * <code>TypeCode</code>), then this attribute will be an any 0N/A * containing the system exception <code>UNKNOWN</code> with a 0N/A * standard minor code of 1. 0N/A * <code>PortableInterceptor</code> package comments for 0N/A * limitations / unimplemented features</a> 0N/A * Returns the opaque <code>object_id</code> describing the target of 0N/A * the operation invocation. 0N/A * Returns the opaque identifier for the object adapter. 0N/A * Returns the server ID that was specified on ORB::init using the -ORBServerId 0N/A * Returns the ID that was used to create the ORB. 0N/A * Returns the sequence of strings that identifies the object 0N/A * adapter instance that is handling this request. 0N/A * Returns the repository id for the most derived interface of the 0N/A * Returns the policy in effect for this operation for the given 0N/A * policy type. The returned <code>CORBA.Policy</code> object shall 0N/A * only be a policy whose type was registered via 0N/A * <code>register_policy_factory</code>. 0N/A * @param type The <code>CORBA.PolicyType</code> which specifies the 0N/A * policy to be returned. 0N/A * @return The <code>CORBA.Policy</code> obtained with the given 0N/A * @exception INV_POLICY thrown, with a standard minor code of 2, if 0N/A * a policy for the given type was not registered via 0N/A * <code>register_policy_factory</code>. 0N/A * @see ORBInitInfo#register_policy_factory 0N/A * Allows an Interceptor to set a slot in the 0N/A * <code>PortableInterceptor.Current</code> that is in the scope of 0N/A * the request. If data already exists in that slot, it will be 0N/A * @param id The id of the slot. 0N/A * @param data The data, in the form of an any, to store in that slot. 0N/A * @exception InvalidSlot thrown if the ID does not define an allocated 0N/A * Returns true if the servant is the given repository id, 0N/A * false if it is not. 0N/A * @param id The caller wants to know if the servant is this 0N/A * @return Is the servant the given RepositoryId? 0N/A * Allows Interceptors to add service contexts to the request. 0N/A * There is no declaration of the order of the service contexts. 0N/A * They may or may not appear in the order that they are added. 0N/A * @param service_context The <code>IOP.ServiceContext</code> to add to 0N/A * @param replace Indicates the behavior of this operation when a 0N/A * service context already exists with the given ID. If false, 0N/A * then <code>BAD_INV_ORDER</code> with a standard minor code of 15 0N/A * is thrown. If true, then the existing service context is 0N/A * replaced by the new one. 0N/A * @exception BAD_INV_ORDER thrown, with a standard minor code of 15, if 0N/A * replace is false and a service context already exists with the 0N/A * Client-side request interceptor. 0N/A * A request Interceptor is designed to intercept the flow of a 0N/A * services can query the request information and manipulate the service 0N/A * contexts which are propagated between clients and servers. The primary 0N/A * use of request Interceptors is to enable ORB services to transfer 0N/A * context information between clients and servers. There are two types 0N/A * of request Interceptors: client-side and server-side. 0N/A * To write a client-side Interceptor, implement the 0N/A * <code>ClientRequestInterceptor</code> interface. 0N/A * @see ClientRequestInfo 0N/A * Allows an Interceptor to query request information and modify the 0N/A * service context before the request is sent to the server. 0N/A * This interception point may throw a system exception. If it does, 0N/A * no other Interceptors' <code>send_request</code> operations are called. 0N/A * Those Interceptors on the Flow Stack are popped and their 0N/A * <code>receive_exception</code> interception points are called. This 0N/A * interception point may also throw a <code>ForwardRequest</code> 0N/A * exception. If an Interceptor throws this exception, no other 0N/A * Interceptors' <code>send_request</code> operations are 0N/A * called. Those Interceptors on the Flow Stack are popped and their 0N/A * <code>receive_other</code> interception points are called. 0N/A * Compliant Interceptors shall properly follow completion_status 0N/A * semantics if they throw a system exception from this interception 0N/A * point. The <code>completion_status</code> shall be 0N/A * <code>COMPLETED_NO</code>. 0N/A * @param ri Information about the current request being intercepted. 0N/A * @exception ForwardRequest If thrown, indicates to the ORB that a 0N/A * retry of the request should occur with the new object given in 0N/A * Allows an Interceptor to query information during a Time-Independent 0N/A * Invocation (TII) polling get reply sequence. 0N/A * With TII, an application may poll for a response to a request sent 0N/A * previously by the polling client or some other client. This poll is 0N/A * reported to Interceptors through the <code>send_poll</code> 0N/A * interception point and the response is returned through the 0N/A * <code>receive_reply</code> or <code>receive_exception</code> 0N/A * interception points. If the response is not available before the 0N/A * poll time-out expires, the system exception <code>TIMEOUT</code> is 0N/A * thrown and <code>receive_exception</code> is called with this 0N/A * This interception point may throw a system exception. If it does, 0N/A * no other Interceptors' <code>send_poll</code> operations are 0N/A * called. Those Interceptors on the Flow Stack are popped and their 0N/A * <code>receive_exception</code> interception points are called. 0N/A * Compliant Interceptors shall properly follow 0N/A * <code>completion_status</code> semantics if they throw a system 0N/A * exception from this interception point. The completion_status shall be 0N/A * <code>COMPLETED_NO</code>. 0N/A * @param ri Information about the current request being intercepted. 0N/A * @exception TIMEOUT thrown if the response is not available before 0N/A * the poll time-out expires 0N/A * Allows an Interceptor to query the information on a reply after it 0N/A * is returned from the server and before control is returned to the 0N/A * This interception point may throw a system exception. If it does, 0N/A * no other Interceptors' <code>receive_reply</code> operations are 0N/A * called. The remaining Interceptors in the Flow Stack shall have 0N/A * their <code>receive_exception</code> interception point called. 0N/A * Compliant Interceptors shall properly follow 0N/A * <code>completion_status</code> semantics if they throw a system 0N/A * exception from this interception point. The 0N/A * <code>completion_status</code> shall be <code>COMPLETED_YES</code>. 0N/A * @param ri Information about the current request being intercepted. 0N/A * Indicates to the interceptor that an exception occurred. Allows 0N/A * an Interceptor to query the exception's information before it is 0N/A * thrown to the client. 0N/A * This interception point may throw a system exception. This has the 0N/A * effect of changing the exception which successive Interceptors 0N/A * popped from the Flow Stack receive on their calls to 0N/A * <code>receive_exception</code>. The exception thrown to the client 0N/A * will be the last exception thrown by an Interceptor, or the original 0N/A * exception if no Interceptor changes the exception. 0N/A * This interception point may also throw a <code>ForwardRequest</code> 0N/A * exception. If an Interceptor throws this exception, no other 0N/A * Interceptors' <code>receive_exception</code> operations are called. 0N/A * The remaining Interceptors in the Flow Stack are popped and have their 0N/A * <code>receive_other</code> interception point called. 0N/A * If the <code>completion_status</code> of the exception is not 0N/A * <code>COMPLETED_NO</code>, then it is inappropriate for this 0N/A * interception point to throw a <code>ForwardRequest</code> exception. 0N/A * The request s at-most-once semantics would be lost. 0N/A * Compliant Interceptors shall properly follow 0N/A * <code>completion_status</code> semantics if they throw a system 0N/A * exception from this interception point. If the original exception is 0N/A * a system exception, the <code>completion_status</code> of the new 0N/A * exception shall be the same as on the original. If the original 0N/A * exception is a user exception, then the <code>completion_status</code> 0N/A * of the new exception shall be <code>COMPLETED_YES</code>. 0N/A * Under some conditions, depending on what policies are in effect, an 0N/A * exception (such as <code>COMM_FAILURE</code>) may result in a retry 0N/A * of the request. While this retry is a new request with respect to 0N/A * Interceptors, there is one point of correlation between the original 0N/A * request and the retry: because control has not returned to the 0N/A * client, the <code>PortableInterceptor.Current</code> for both the 0N/A * original request and the retrying request is the same. 0N/A * @param ri Information about the current request being intercepted. 0N/A * @exception ForwardRequest If thrown, indicates to the ORB that a 0N/A * retry of the request should occur with the new object given in 0N/A * Allows an Interceptor to query the information available when a 0N/A * request results in something other than a normal reply or an 0N/A * exception. For example, a request could result in a retry 0N/A * (e.g., a GIOP Reply with a <code>LOCATION_FORWARD</code> status was 0N/A * received); or on asynchronous calls, the reply does not immediately 0N/A * follow the request, but control shall return to the client and an 0N/A * ending interception point shall be called. 0N/A * For retries, depending on the policies in effect, a new request may or 0N/A * may not follow when a retry has been indicated. If a new request does 0N/A * follow, while this request is a new request, with respect to 0N/A * Interceptors, there is one point of correlation between the original 0N/A * request and the retry: because control has not returned to the client, 0N/A * the request scoped <code>PortableInterceptor.Current</code> for both 0N/A * the original request and the retrying request is the same. 0N/A * This interception point may throw a system exception. If it does, no 0N/A * other Interceptors' <code>receive_other</code> operations are called. 0N/A * The remaining Interceptors in the Flow Stack are popped and have 0N/A * their <code>receive_exception</code> interception point called. 0N/A * This interception point may also throw a <code>ForwardRequest</code> 0N/A * exception. If an Interceptor throws this exception, successive 0N/A * Interceptors' <code>receive_other</code> operations are called with 0N/A * the new information provided by the <code>ForwardRequest</code> 0N/A * Compliant Interceptors shall properly follow 0N/A * <code>completion_status</code> semantics if they throw a system 0N/A * exception from this interception point. The 0N/A * <code>completion_status</code> shall be <code>COMPLETED_NO</code>. 0N/A * If the target invocation had completed, this interception point 0N/A * would not be called. 0N/A * @param ri Information about the current request being intercepted. 0N/A * @exception ForwardRequest If thrown, indicates to the ORB that a 0N/A * retry of the request should occur with the new object given in 0N/A * Server-side request interceptor. 0N/A * A request Interceptor is designed to intercept the flow of a 0N/A * services can query the request information and manipulate the service 0N/A * contexts which are propagated between clients and servers. The primary 0N/A * use of request Interceptors is to enable ORB services to transfer 0N/A * context information between clients and servers. There are two types 0N/A * of request Interceptors: client-side and server-side. 0N/A * To write a server-side Interceptor, implement the 0N/A * ServerRequestInterceptor interface. 0N/A * @see ServerRequestInfo 0N/A * Allows the interceptor to process service context information. 0N/A * At this interception point, Interceptors must get their service 0N/A * context information from the incoming request transfer it to 0N/A * <code>PortableInterceptor.Current</code>'s slots. 0N/A * This interception point is called before the servant manager is called. 0N/A * Operation parameters are not yet available at this point. This 0N/A * interception point may or may not execute in the same thread as 0N/A * the target invocation. 0N/A * This interception point may throw a system exception. If it does, 0N/A * no other Interceptors' <code>receive_request_service_contexts</code> 0N/A * operations are called. Those Interceptors on the Flow Stack are 0N/A * popped and their <code>send_exception</code> interception points are 0N/A * This interception point may also throw a <code>ForwardRequest</code> 0N/A * exception. If an Interceptor throws this exception, no other 0N/A * Interceptors' <code>receive_request_service_contexts</code> operations 0N/A * are called. Those Interceptors on the Flow Stack are popped and 0N/A * their <code>send_other</code> interception points are called. 0N/A * Compliant Interceptors shall properly follow 0N/A * <code>completion_status</code> semantics if they throw a system 0N/A * exception from this interception point. The 0N/A * <code>completion_status</code> shall be COMPLETED_NO. 0N/A * @param ri Information about the current request being intercepted. 0N/A * @exception ForwardRequest If thrown, indicates to the ORB that a 0N/A * retry of the request should occur with the new object given in 0N/A * Allows an Interceptor to query request information after all the 0N/A * information, including operation parameters, are available. This 0N/A * interception point shall execute in the same thread as the target 0N/A * In the DSI model, since the parameters are first available when 0N/A * the user code calls <code>arguments</code>, <code>receive_request</code> 0N/A * is called from within <code>arguments</code>. It is possible that 0N/A * <code>arguments</code> is not called in the DSI model. The target 0N/A * may call <code>set_exception</code> before calling 0N/A * <code>arguments</code>. The ORB shall guarantee that 0N/A * <code>receive_request</code> is called once, either through 0N/A * <code>arguments</code> or through <code>set_exception</code>. If it 0N/A * is called through <code>set_exception</code>, requesting the 0N/A * arguments will result in <code>NO_RESOURCES</code> being thrown with 0N/A * a standard minor code of 1. 0N/A * This interception point may throw a system exception. If it does, no 0N/A * other Interceptors' <code>receive_request</code> operations are 0N/A * called. Those Interceptors on the Flow Stack are popped and their 0N/A * <code>send_exception</code> interception points are called. 0N/A * This interception point may also throw a <code>ForwardRequest</code> 0N/A * exception. If an Interceptor throws this exception, no other 0N/A * Interceptors' <code>receive_request</code> operations are called. 0N/A * Those Interceptors on the Flow Stack are popped and their 0N/A * <code>send_other</code> interception points are called. 0N/A * Compliant Interceptors shall properly follow 0N/A * <code>completion_status</code> semantics if they throw a system 0N/A * exception from this interception point. The 0N/A * <code>completion_status</code> shall be <code>COMPLETED_NO</code>. 0N/A * @param ri Information about the current request being intercepted. 0N/A * @exception ForwardRequest If thrown, indicates to the ORB that a 0N/A * retry of the request should occur with the new object given in 0N/A * Allows an Interceptor to query reply information and modify the 0N/A * reply service context after the target operation has been invoked 0N/A * and before the reply is returned to the client. This interception 0N/A * point shall execute in the same thread as the target invocation. 0N/A * This interception point may throw a system exception. If it does, 0N/A * no other Interceptors' <code>send_reply</code> operations are called. 0N/A * The remaining Interceptors in the Flow Stack shall have their 0N/A * <code>send_exception</code> interception point called. 0N/A * Compliant Interceptors shall properly follow 0N/A * <code>completion_status</code> semantics if they throw a 0N/A * system exception from this interception point. The 0N/A * <code>completion_status</code> shall be <code>COMPLETED_YES</code>. 0N/A * @param ri Information about the current request being intercepted. 0N/A * Allows an Interceptor to query the exception information and modify 0N/A * the reply service context before the exception is thrown to the client. 0N/A * When an exception occurs, this interception point is called. This 0N/A * interception point shall execute in the same thread as the target 0N/A * This interception point may throw a system exception. This has the 0N/A * effect of changing the exception which successive Interceptors 0N/A * popped from the Flow Stack receive on their calls to 0N/A * <code>send_exception</code>. The exception thrown to the client will 0N/A * be the last exception thrown by an Interceptor, or the original 0N/A * exception if no Interceptor changes the exception. 0N/A * This interception point may also throw a <code>ForwardRequest</code> 0N/A * exception. If an Interceptor throws this exception, no other 0N/A * Interceptors' <code>send_exception</code> operations are called. The 0N/A * remaining Interceptors in the Flow Stack shall have their 0N/A * <code>send_other</code> interception points called. 0N/A * If the <code>completion_status</code> of the exception is not 0N/A * <code>COMPLETED_NO</code>, then it is inappropriate for this 0N/A * interception point to throw a <code>ForwardRequest</code> exception. 0N/A * The request's at-most-once semantics would be lost. 0N/A * Compliant Interceptors shall properly follow 0N/A * <code>completion_status</code> semantics if they throw a system 0N/A * exception from this interception point. If the original exception 0N/A * is a system exception, the <code>completion_status</code> of the new 0N/A * exception shall be the same as on the original. If the original 0N/A * exception is a user exception, then the <code>completion_status</code> 0N/A * of the new exception shall be <code>COMPLETED_YES</code>. 0N/A * @param ri Information about the current request being intercepted. 0N/A * @exception ForwardRequest If thrown, indicates to the ORB that a 0N/A * retry of the request should occur with the new object given in 0N/A * Allows an Interceptor to query the information available when a 0N/A * request results in something other than a normal reply or an 0N/A * exception. For example, a request could result in a retry 0N/A * (e.g., a GIOP Reply with a <code>LOCATION_FORWARD</code> status was 0N/A * received). This interception point shall execute in the same thread 0N/A * as the target invocation. 0N/A * This interception point may throw a system exception. If it does, 0N/A * no other Interceptors' <code>send_other</code> operations are called. 0N/A * The remaining Interceptors in the Flow Stack shall have their 0N/A * <code>send_exception</code> interception points called. 0N/A * This interception point may also throw a <code>ForwardRequest</code> 0N/A * exception. If an Interceptor throws this exception, successive 0N/A * Interceptors' <code>send_other</code> operations are called with 0N/A * the new information provided by the <code>ForwardRequest</code> 0N/A * Compliant Interceptors shall properly follow 0N/A * <code>completion_status</code> semantics if they throw a system 0N/A * exception from this interception point. The 0N/A * <code>completion_status</code> shall be <code>COMPLETED_NO</code>. 0N/A * @param ri Information about the current request being intercepted. 0N/A * @exception ForwardRequest If thrown, indicates to the ORB that a 0N/A * retry of the request should occur with the new object given in 0N/A /** The object reference factory. This provides the capability of 0N/A * creating an object reference. 0N/A /** make_object creates a CORBA object reference according 0N/A * to the data in this template, with the given repository ID and 0N/A /** The object reference template. An instance of this must 0N/A * exist for each object adapter created in an ORB. The server_id, 0N/A * orb_id, and adapter_name attributes uniquely identify this template 0N/A * within the scope of an IMR. Note that adapter_id is similarly unique 0N/A * within the same scope, but it is opaque, and less useful in many 0N/A /** Sequence of object reference templates is used for reporting state 0N/A * changes that do not occur on the adapter manager. 0N/A /** Adapter manager identifier. Every object adapter has an adapter manager, 0N/A * indicated in this API only through the ID. A group of object adapter 0N/A * instances may share the same adapter manager, in which case state transitions 0N/A * reported for the adapter manager are observed by all object adapters with the 0N/A * same adapter manager ID. 0N/A /** Type of object adapter state. State changes are reported either to 0N/A * the object adapter or to the adapter manager. 0N/A /** Object adapter state that holds requests temporarily until the 0N/A /** Object adapter state that indicates normal request processing. 0N/A /** Object adapter state that causes all requests to be discarded. 0N/A /** Object adapter state that causes all requests to be discarded. 0N/A * This state indicates that the adapter is shutting down. 0N/A /** Object adapter state indicating that the adapter has been destroyed. 0N/A * Provides the server-side ORB service with access to the applicable 0N/A * policies during IOR construction and the ability to add components. 0N/A * The ORB passes an instance of its implementation of this interface as 0N/A * a parameter to <code>IORInterceptor.establish_components</code>. 0N/A * @see IORInterceptor 0N/A * Allows an ORB service implementation to determine what server side 0N/A * policy of a particular type is in effect for an IOR being 0N/A * constructed. When the IOR being constructed is for an object 0N/A * implemented using a POA, all Policy objects passed to the 0N/A * <code>PortableServer.POA.create_POA</code> call that created that 0N/A * POA are accessable via <code>get_effective_policy</code>. 0N/A * If a policy for the given type is not known to the ORB, then this 0N/A * operation will throw <code>INV_POLICY</code> with a standard minor 0N/A * @param type an int specifying the type of policy to return. 0N/A * @return The effective <code>CORBA.Policy</code> object of the 0N/A * requested type. If the given policy type is known, but no policy 0N/A * of that type is in effect, then this operation will return a 0N/A * nil object reference. 0N/A * A portable ORB service implementation calls 0N/A * <code>add_ior_component</code> from its implementation of 0N/A * <code>establish_components</code> to add a tagged component to the 0N/A * set which will be included when constructing IORs. The components in 0N/A * this set will be included in all profiles. 0N/A * Any number of components may exist with the same component ID. 0N/A * @param a_component The IOP.TaggedComponent to add. 0N/A * A portable ORB service implementation calls 0N/A * <code>add_ior_component_to_profile</code> from its implementation of 0N/A * <code>establish_components</code> to add a tagged component to the 0N/A * set which will be included when constructing IORs. The components in 0N/A * this set will be included in the specified profile. 0N/A * Any number of components may exist with the same component ID. 0N/A * @param a_component The <code>IOP.TaggedComponent</code> to add. 0N/A * @param profile_id The profile id of the profile to 0N/A * which this component will be added. 0N/A * @exception BAD_PARAM thrown, with a standard minor code of 29, if the 0N/A * given profile ID does not define a known profile or it is 0N/A * impossible to add components to that profile. 0N/A /** Return the adapter manager id of the object adapter 0N/A * that was just created and is running IOR interceptors. 0N/A /** Return the adapter state of the object adapter 0N/A * that was just created and is running IOR interceptors. 0N/A /** Return the object reference template of the object adapter 0N/A * that was just created and is running IOR interceptors. 0N/A /** On read, returns the current factory that will be used to create 0N/A * object references for the object adapter that was just created 0N/A * and is running IOR interceptors. By default, this factory is the same 0N/A * as the value of the adapter_template attribute. The current_factory 0N/A * may also be set to another object reference template inside an 0N/A * IORInterceptor_3_0. 0N/A * Interceptor used to establish tagged components in the profiles within 0N/A * In some cases, a portable ORB service implementation may need to add 0N/A * information describing the server's or object's ORB service related 0N/A * capabilities to object references in order to enable the ORB service 0N/A * implementation in the client to function properly. 0N/A * This is supported through the <code>IORInterceptor</code> and 0N/A * <code>IORInfo</code> interfaces. 0N/A * A server side ORB calls the <code>establish_components</code> 0N/A * operation on all registered <code>IORInterceptor</code> instances 0N/A * when it is assembling the list of components that will be included 0N/A * in the profile or profiles of an object reference. This operation 0N/A * is not necessarily called for each individual object reference. 0N/A * In the case of the POA, this operation is called each time POA::create_POA 0N/A * is called. In any case, <code>establish_components</code> is 0N/A * guaranteed to be called at least once for each distinct set of 0N/A * An implementation of <code>establish_components</code> must not 0N/A * throw exceptions. If it does, the ORB shall ignore the exception 0N/A * and proceed to call the next IOR Interceptor's 0N/A * <code>establish_components</code> operation. 0N/A * @param info The <code>IORInfo</code> instance used by the ORB 0N/A * service to query applicable policies and add components to be 0N/A * included in the generated IORs. 0N/A /** The components_established method is invoked on all registered 0N/A * IORInterceptor_3_0 instances after establish_components 0N/A * has been invoked on all registered IORInterceptor instances. 0N/A * The adapter_template is available in info during this call. 0N/A * The current_factory may be get or set in info during this call. 0N/A * Any exception thrown from this method is handled by the Object 0N/A * Adapter that called this interceptor. In the case of the POA, 0N/A * an exception results in a OBJ_ADAPTER exception with an OMG 0N/A * standard minor code of 6. 0N/A * @param info The IORInfo for the object adapter being created. 0N/A /** Called whenever the state of an adapter manager changes. 0N/A * For the POA, that is the POAManager. If the state change 0N/A * is reported through <code>adapter_manager_state_changed</code>, 0N/A * it is not reported through <code>adapter_state_changed</code>. 0N/A * @param id the adapter manager id of the adapter manager that 0N/A * @param state the new state of the adapter manager 0N/A /** Called whenever the state of an object adapter changes, and 0N/A * the state change is not caused by an adapter manager. Such 0N/A * changes are reported to all registered <code>IORInterceptor_3_0</code> 0N/A * @param templates the sequence of <code>ObjectReferenceTemplate</code> instances 0N/A * on which this state change occurred. 0N/A * @param state the new <code>AdapterState</code> shared by all of the templates. 0N/A * Enables policy types to be constructed using 0N/A * <code>CORBA.ORB.create_policy</code>. 0N/A * A portable ORB service implementation registers an instance of the 0N/A * <code>PolicyFactory</code> interface during ORB initialization in order 0N/A * to enable its policy types to be constructed using 0N/A * <code>CORBA.ORB.create_policy</code>. The POA is required to preserve 0N/A * any policy which is registered with <code>ORBInitInfo</code> in this 0N/A * @see ORBInitInfo#register_policy_factory 0N/A * Returns an instance of the appropriate interface derived from 0N/A * <code>CORBA.Policy</code> whose value corresponds to the 0N/A * The ORB calls <code>create_policy</code> on a registered 0N/A * <code>PolicyFactory</code> instance when 0N/A * <code>CORBA.ORB.create_policy</code> is called for the 0N/A * <code>PolicyType</code> under which the <code>PolicyFactory</code> has 0N/A * been registered. The <code>create_policy</code> operation then 0N/A * returns an instance of the appropriate interface derived from 0N/A * <code>CORBA.Policy</code> whose value corresponds to the specified 0N/A * any. If it cannot, it shall throw an exception as described for 0N/A * <code>CORBA.ORB.create_policy</code>. 0N/A * @param type An int specifying the type of policy being created. 0N/A * @param value An any containing data with which to construct the 0N/A * <code>CORBA.Policy</code>. 0N/A * @return A <code>CORBA.Policy<code> object of the specified type and 0N/A * Passed to each <code>ORBInitializer</code>, allowing it to 0N/A * to register interceptors and perform other duties while the ORB is 0N/A * The <code>ORBInitInfo</code> object is only valid during 0N/A * <code>ORB.init</code>. If a service keeps a reference to its 0N/A * <code>ORBInitInfo</code> object and tries to use it after 0N/A * <code>ORB.init</code> returns, the object no longer exists and an 0N/A * <code>OBJECT_NOT_EXIST</code> exception shall be thrown. 0N/A * @see ORBInitializer 0N/A /** Object id, represented as a String */ 0N/A * Only one Interceptor of a given name can be registered with the 0N/A * ORB for each Interceptor type. If an attempt is made to register a 0N/A * second Interceptor with the same name, DuplicateName is thrown. 0N/A * An Interceptor may be anonymous, i.e., have an empty string as the 0N/A * name attribute. Any number of anonymous Interceptors may be 0N/A * registered with the ORB so, if the Interceptor being registered 0N/A * is anonymous, the registration operation will not throw 0N/A * <code>DuplicateName</code>. 0N/A * The name for which there was already an interceptor registered. 0N/A * This exception is thrown by 0N/A * <code>register_initial_reference</code> and 0N/A * <code>resolve_initial_references</code>. 0N/A * <code>register_initial_reference</code> throws <code>InvalidName</code> 0N/A * <li>this operation is called with an empty string id; or</li> 0N/A * <li>this operation is called with an id that is already registered, 0N/A * including the default names defined by OMG.</li> 0N/A * <code>resolve_initial_references</code> throws 0N/A * <code>InvalidName</code> if the name to be resolved is invalid. 0N/A * Returns the arguments passed to <code>ORB.init</code>. They may or 0N/A * may not contain the ORB's arguments. 0N/A * Returns the ID of the ORB being initialized. 0N/A * Returns the <code>IOP.CodecFactory</code>. The 0N/A * <code>CodecFactory</code> is normally obtained via a call to 0N/A * <code>ORB.resolve_initial_references( "CodecFactory" )</code>, but 0N/A * since the ORB is not yet available and Interceptors, particularly when 0N/A * processing service contexts, will require a <code>Codec</code>, a 0N/A * means of obtaining a <code>Codec</code> is necessary during ORB 0N/A * Identical to <code>ORB.register_initial_reference</code>. This same 0N/A * functionality exists here because the ORB, not yet fully initialized, 0N/A * is not yet available but initial references may need to be 0N/A * registered as part of Interceptor registration. The only difference 0N/A * is that the version of this operation on the ORB uses PIDL 0N/A * (<code>CORBA.ORB.ObjectId</code>) and 0N/A * (<code>CORBA.ORB.InvalidName</code>) whereas the version in this 0N/A * interface uses IDL defined in this interface; the semantics are 0N/A // This was incorrectly returning void in orbos/99-12-02, correction 0N/A // from errata in orbos/00-01-01 0N/A * Identical to <code>ORB.resolve_initial_references</code>. This same 0N/A * functionality exists here because the ORB, not yet fully initialized, 0N/A * is not yet available but initial references may be required from the 0N/A * ORB as part of Interceptor registration. The only difference is that 0N/A * the version of this operation on the ORB uses PIDL 0N/A * (<code>CORBA::ORB::ObjectId</code> and 0N/A * <code>CORBA::ORB::InvalidName</code>) whereas the version in this 0N/A * interface uses IDL defined in this interface; the semantics 0N/A * This operation is only valid during post_init. 0N/A * Used to add a client-side request Interceptor to the list of 0N/A * client-side request Interceptors. 0N/A * @param interceptor The <code>ClientRequestInterceptor</code> to be 0N/A * @exception DuplicateName thrown if a client-side request Interceptor 0N/A * has already been registered with this Interceptor's name. 0N/A * Used to add a server-side request Interceptor to the list of 0N/A * server-side request Interceptors. 0N/A * @param interceptor The ServerRequestInterceptor to be added. 0N/A * @exception DuplicateName thrown if a server-side request Interceptor 0N/A * has already been registered with this Interceptor's name 0N/A * Used to add an IOR Interceptor to the list of IOR Interceptors. 0N/A * @param interceptor The IORInterceptor to be added. 0N/A * @exception DuplicateName thrown if an IOR Interceptor has already 0N/A * been registered with this Interceptor's name. 0N/A * Called to allocate a slot on <code>PortableInterceptor.Current</code>. 0N/A * Note that while slot id's can be allocated within an ORB initializer, 0N/A * the slots themselves cannot be initialized. 0N/A * @return The index to the slot which has been allocated. 0N/A * @exception BAD_INV_ORDER thrown, with a standard minor code of 14, if 0N/A * <code>set_slot</code> or <code>get_slot</code> is called on the 0N/A * <code>PICurrent</code> within an ORB initializer. 0N/A * Registers a <code>PolicyFactory</code> for the given 0N/A * <code>PolicyType</code>. 0N/A * @param type The policy type that the given <code>PolicyFactory</code> 0N/A * @param policy_factory The factory for the given policy type. 0N/A * @exception BAD_INV_ORDER thrown, with a standard minor code of 16, if 0N/A * a <code>PolicyFactory</code> already exists for the given 0N/A * <code>PolicyType</code>. 0N/A * Facilitates interceptor registration and ORB initialization. 0N/A * Interceptors are intended to be a means by which ORB services gain 0N/A * access to ORB processing, effectively becoming part of the ORB. 0N/A * Since Interceptors are part of the ORB, when <code>ORB.init</code> 0N/A * returns an ORB, the Interceptors shall have been registered. 0N/A * Interceptors cannot be registered on an ORB after it has been 0N/A * An Interceptor is registered by registering an associated 0N/A * <code>ORBInitializer</code> object which implements the 0N/A * <code>ORBInitializer</code> interface. When an ORB is initializing, 0N/A * it shall call each registered <code>ORBInitializer</code>, passing it 0N/A * an <code>ORBInitInfo</code> object which is used to register its 0N/A * <b>Registering ORB Initializers in Java</b> 0N/A * ORBInitializers are registered via Java ORB properties. 0N/A * The property names are of the form: 0N/A * <blockquote><code> 0N/A * org.omg.PortableInterceptor.ORBInitializerClass.<Service> 0N/A * </code></blockquote> 0N/A * where <code><Service></code> is the string name of a class 0N/A * <blockquote><code> 0N/A * org.omg.PortableInterceptor.ORBInitializer 0N/A * </code></blockquote> 0N/A * To avoid name collisions, the reverse DNS name convention should be 0N/A * used. For example, if company X has three initializers, it could define 0N/A * the following properties: 0N/A * During ORB.init, these ORB properties which begin with 0N/A * <code>org.omg.PortableInterceptor.ORBInitializerClass</code> shall be 0N/A * collected, the <code><Service></code> portion of each property 0N/A * shall be extracted, an object shall be instantiated with the 0N/A * <code><Service></code> string as its class name, and the 0N/A * <code>pre_init</code> and <code>post_init</code> methods shall be 0N/A * called on that object. If there are any exceptions, the ORB shall 0N/A * ignore them and proceed. 0N/A * <b><i>Example</i></b> 0N/A * A client-side logging service written by company X, for example, may 0N/A * have the following ORBInitializer implementation: 0N/A * package com.x.logging; 0N/A * import org.omg.PortableInterceptor.Interceptor; 0N/A * import org.omg.PortableInterceptor.ORBInitializer; 0N/A * import org.omg.PortableInterceptor.ORBInitInfo; 0N/A * public class LoggingService implements ORBInitializer { 0N/A * void pre_init( ORBInitInfo info ) { 0N/A * // Instantiate the Logging Service s Interceptor. 0N/A * Interceptor interceptor = new LoggingInterceptor(); 0N/A * // Register the Logging Service s Interceptor. 0N/A * info.add_client_request_interceptor( interceptor ); 0N/A * void post_init( ORBInitInfo info ) { 0N/A * // This service does not need two init points. 0N/A * To run a program called <code>MyApp</code> using this logging 0N/A * service, the user could type: 0N/A * <blockquote><code> 0N/A *-Dorg.omg.PortableInterceptor.ORBInitializerClass.com.x.Logging.LoggingService 0N/A * </code></blockquote> 0N/A * <b>Notes about Registering Interceptors</b> 0N/A * Request Interceptors are registered on a per-ORB basis. 0N/A * To achieve virtual per-object Interceptors, query the policies on the 0N/A * target from within the interception points to determine whether they 0N/A * should do any work. 0N/A * To achieve virtual per-POA Interceptors, instantiate each POA with a 0N/A * different ORB. While Interceptors may be ordered administratively, 0N/A * there is no concept of order with respect to the registration of 0N/A * Interceptors. Request Interceptors are concerned with service contexts. 0N/A * Service contexts have no order, so there is no purpose for request 0N/A * Interceptors to have an order. IOR Interceptors are concerned with 0N/A * tagged components. Tagged components also have no order, so there 0N/A * is no purpose for IOR Interceptors to have an order. 0N/A * Registration code should avoid using the ORB (i.e., calling 0N/A * <code>ORB.init</code> with the provided <code>orb_id</code>). Since 0N/A * registration occurs during ORB initialization, results of invocations 0N/A * on this ORB while it is in this state are undefined. 0N/A * Called during ORB initialization. If it is expected that initial 0N/A * services registered by an interceptor will be used by other 0N/A * interceptors, then those initial services shall be registered at 0N/A * this point via calls to 0N/A * <code>ORBInitInfo.register_initial_reference</code>. 0N/A * @param info provides initialization attributes and operations by 0N/A * which Interceptors can be registered. 0N/A * Called during ORB initialization. If a service must resolve initial 0N/A * references as part of its initialization, it can assume that all 0N/A * initial references will be available at this point. 0N/A * Calling the <code>post_init</code> operations is not the final 0N/A * task of ORB initialization. The final task, following the 0N/A * <code>post_init</code> calls, is attaching the lists of registered 0N/A * interceptors to the ORB. Therefore, the ORB does not contain the 0N/A * interceptors during calls to <code>post_init</code>. If an 0N/A * ORB-mediated call is made from within <code>post_init</code>, no 0N/A * request interceptors will be invoked on that call. 0N/A * Likewise, if an operation is performed which causes an IOR to be 0N/A * created, no IOR interceptors will be invoked. 0N/A * @param info provides initialization attributes and 0N/A * operations by which Interceptors can be registered.