-
ClientRequestInfoOperations
-
target(): Object
-
effective_target(): Object
-
effective_profile(): TaggedProfile
-
received_exception(): Any
-
received_exception_id(): String
-
get_effective_component(int): TaggedComponent
-
get_effective_components(int): TaggedComponent[]
-
get_request_policy(int): Policy
-
add_request_service_context(ServiceContext, boolean): void
-
package org.omg.PortableInterceptor;
/**
* org/omg/PortableInterceptor/ClientRequestInfoOperations.java .
* Generated by the IDL-to-Java compiler (portable), version "3.2"
* from /var/lib/jenkins/jobs/openjdk/jobs/openjdk9/workspace/jdk9/corba/src/java.corba/share/classes/org/omg/PortableInterceptor/Interceptors.idl
* Sunday, February 14, 2021 4:59:56 PM UTC
*/
Request Information, accessible to client-side request interceptors.
Some attributes and operations on ClientRequestInfo are
not valid at all interception points. The following table shows the
validity of each attribute or operation. If it is not valid, attempting
to access it will result in a BAD_INV_ORDER being thrown
with a standard minor code of 14.
Shows the validity of each attribute or operation
send_request
send_poll
receive_reply
receive_exception
receive_other
Inherited from RequestInfo:
request_id
yes
yes
yes
yes
yes operation
yes
yes
yes
yes
yes arguments
yes1
no
yes
no
no exceptions
yes
no
yes
yes
yes contexts
yes
no
yes
yes
yes operation_context
yes
no
yes
yes
yes
result
no
no
yes
no
no
response_expected
yes
yes
yes
yes
yes sync_scope
yes
no
yes
yes
yes
reply_status
no
no
yes
yes
yes forward_reference
no
no
no
no
yes2
get_slot
yes
yes
yes
yes
yes get_request_service_context
yes
no
yes
yes
yes get_reply_service_context
no
no
yes
yes
yes
ClientRequestInfo-specific:
target
yes
yes
yes
yes
yes effective_target
yes
yes
yes
yes
yes
effective_profile
yes
yes
yes
yes
yes received_exception
no
no
no
yes
no received_exception_id
no
no
no
yes
no get_effective_component
yes
no
yes
yes
yes get_effective_components
yes
no
yes
yes
yes get_request_policy
yes
no
yes
yes
yes add_request_service_context
yes
no
no
no
no
- When
ClientRequestInfo is passed to
send_request, there is an entry in the list for every
argument, whether in, inout, or out. But only the in and inout
arguments will be available.
- If the
reply_status atribute is not
LOCATION_FORWARD, accessing this attribute will
throw BAD_INV_ORDER with a standard minor code of
14.
See Also: - ClientRequestInterceptor
/**
* Request Information, accessible to client-side request interceptors.
* <p>
* Some attributes and operations on <code>ClientRequestInfo</code> are
* not valid at all interception points. The following table shows the
* validity of each attribute or operation. If it is not valid, attempting
* to access it will result in a <code>BAD_INV_ORDER</code> being thrown
* with a standard minor code of 14.
*
* <table class="plain">
* <caption style="display:none">Shows the validity of each attribute or operation</caption>
* <thead>
* <tr>
* <th> </th>
* <th id="send_req">send_request</th>
* <th id="send_poll">send_poll</th>
* <th id="rec_reply">receive_reply</th>
* <th id="rec_ex">receive_exception</th>
* <th id="rec_oth">receive_other</th>
* </tr>
* </thead>
* <tbody>
*
* <tr>
* <td id="ri" colspan=6><i>Inherited from RequestInfo:</i></td>
* </tr>
*
* <tr><th id="req_id"><p style="text-align:left">request_id</p></th>
* <td headers="ri req_id send_req">yes</td>
* <td headers="ri req_id send_poll">yes</td>
* <td headers="ri req_id rec_reply">yes</td>
* <td headers="ri req_id rec_ex">yes</td>
* <td headers="ri req_id rec_oth">yes</td></tr>
*
* <tr><th id="op"><p style="text-align:left">operation</p></th>
* <td headers="ri op send_req">yes</td>
* <td headers="ri op send_poll">yes</td>
* <td headers="ri op rec_reply">yes</td>
* <td headers="ri op rec_ex">yes</td>
* <td headers="ri op rec_oth">yes</td></tr>
*
* <tr><th id="arg"><p style="text-align:left">arguments</p></th>
* <td headers="ri arg send_req">yes<sub>1</sub></td>
* <td headers="ri arg send_poll">no </td>
* <td headers="ri arg rec_reply">yes</td>
* <td headers="ri arg rec_ex">no </td>
* <td headers="ri arg rec_oth">no </td></tr>
*
* <tr><th id="exc"><p style="text-align:left">exceptions</p></th>
* <td headers="ri exc send_req">yes</td>
* <td headers="ri exc send_poll">no </td>
* <td headers="ri exc rec_reply">yes</td>
* <td headers="ri exc rec_ex">yes</td>
* <td headers="ri exc rec_oth">yes</td></tr>
*
* <tr><th id="con"><p style="text-align:left">contexts</p></th>
* <td headers="ri con send_req">yes</td>
* <td headers="ri con send_poll">no </td>
* <td headers="ri con rec_reply">yes</td>
* <td headers="ri con rec_ex">yes</td>
* <td headers="ri con rec_oth">yes</td></tr>
*
* <tr><th id="op_con"><p style="text-align:left">operation_context</p></th>
* <td headers="ri op_con send_req">yes</td>
* <td headers="ri op_con send_poll">no </td>
* <td headers="ri op_con rec_reply">yes</td>
* <td headers="ri op_con rec_ex">yes</td>
* <td headers="ri op_con rec_oth">yes</td>
* </tr>
*
* <tr><th id="result"><p style="text-align:left">result</p></th>
* <td headers="ri result send_req">no </td>
* <td headers="ri result send_poll">no </td>
* <td headers="ri result rec_reply">yes</td>
* <td headers="ri result rec_ex">no </td>
* <td headers="ri result rec_oth">no </td>
* </tr>
*
* <tr><th id="res_exp"><p style="text-align:left">response_expected</p></th>
* <td headers="ri res_exp send_req">yes</td>
* <td headers="ri res_exp send_poll">yes</td>
* <td headers="ri res_exp rec_reply">yes</td>
* <td headers="ri res_exp rec_ex">yes</td>
* <td headers="ri res_exp rec_oth">yes</td></tr>
*
* <tr><th id="sync_sco"><p style="text-align:left">sync_scope</p></th>
* <td headers="ri sync_sco send_req">yes</td>
* <td headers="ri sync_sco send_poll">no </td>
* <td headers="ri sync_sco rec_reply">yes</td>
* <td headers="ri sync_sco rec_ex">yes</td>
* <td headers="ri sync_sco rec_oth">yes</td>
* </tr>
*
* <tr><th id="rep_stat"><p style="text-align:left">reply_status</p></th>
* <td headers="ri rep_stat send_req">no </td>
* <td headers="ri rep_stat send_poll">no </td>
* <td headers="ri rep_stat rec_reply">yes</td>
* <td headers="ri rep_stat rec_ex">yes</td>
* <td headers="ri rep_stat rec_oth">yes</td></tr>
*
* <tr><th id="for_ref"><p style="text-align:left">forward_reference</p></th>
* <td headers="ri for_ref send_req">no </td>
* <td headers="ri for_ref send_poll">no </td>
* <td headers="ri for_ref rec_reply">no </td>
* <td headers="ri for_ref rec_ex">no </td>
* <td headers="ri for_ref rec_oth">yes<sub>2</sub>
* </td></tr>
*
* <tr><th id="get_slot"><p style="text-align:left">get_slot</p></th>
* <td headers="ri get_slot send_req">yes</td>
* <td headers="ri get_slot send_poll">yes</td>
* <td headers="ri get_slot rec_reply">yes</td>
* <td headers="ri get_slot rec_ex">yes</td>
* <td headers="ri get_slot rec_oth">yes</td></tr>
*
* <tr><th id="grsc"><p style="text-align:left">get_request_service_context</p></th>
* <td headers="ri grsc send_req">yes</td>
* <td headers="ri grsc send_poll">no </td>
* <td headers="ri grsc rec_reply">yes</td>
* <td headers="ri grsc rec_ex">yes</td>
* <td headers="ri grsc rec_oth">yes</td></tr>
*
* <tr><th id="gpsc"><p style="text-align:left">get_reply_service_context</p></th>
* <td headers="ri gpsc send_req">no </td>
* <td headers="ri gpsc send_poll">no </td>
* <td headers="ri gpsc rec_reply">yes</td>
* <td headers="ri gpsc rec_ex">yes</td>
* <td headers="ri gpsc rec_oth">yes</td>
* </tr>
*
* <tr>
* <td id="cri" colspan=6><i>ClientRequestInfo-specific:</i></td>
* </tr>
*
* <tr><th id="target"><p style="text-align:left">target</p></th>
* <td headers="cri target send_req">yes</td>
* <td headers="cri target send_poll">yes</td>
* <td headers="cri target rec_reply">yes</td>
* <td headers="cri target rec_ex">yes</td>
* <td headers="cri target rec_oth">yes</td></tr>
*
* <tr><th id="eftarget"><p style="text-align:left">effective_target</p></th>
* <td headers="cri eftarget send_req">yes</td>
* <td headers="cri eftarget send_poll">yes</td>
* <td headers="cri eftarget rec_reply">yes</td>
* <td headers="cri eftarget rec_ex">yes</td>
* <td headers="cri eftarget rec_oth">yes</td>
* </tr>
*
* <tr><th id="efprof"><p style="text-align:left">effective_profile</p></th>
* <td headers="cri efprof send_req">yes</td>
* <td headers="cri efprof send_poll">yes</td>
* <td headers="cri efprof rec_reply">yes</td>
* <td headers="cri efprof rec_ex">yes</td>
* <td headers="cri efprof rec_oth">yes</td></tr>
*
* <tr><th id="rxp"><p style="text-align:left">received_exception</p></th>
* <td headers="cri rxp send_req">no </td>
* <td headers="cri rxp send_poll">no </td>
* <td headers="cri rxp rec_reply">no </td>
* <td headers="cri rxp rec_ex">yes</td>
* <td headers="cri rxp rec_oth">no </td></tr>
*
* <tr><th id="rei"><p style="text-align:left">received_exception_id</p></th>
* <td headers="cri rei send_req">no </td>
* <td headers="cri rei send_poll">no </td>
* <td headers="cri rei rec_reply">no </td>
* <td headers="cri rei rec_ex">yes</td>
* <td headers="cri rei rec_oth">no </td></tr>
*
* <tr><th id="gec"><p style="text-align:left">get_effective_component</p></th>
* <td headers="cri gec send_req">yes</td>
* <td headers="cri gec send_poll">no </td>
* <td headers="cri gec rec_reply">yes</td>
* <td headers="cri gec rec_ex">yes</td>
* <td headers="cri gec rec_oth">yes</td></tr>
*
* <tr><th id="gecs"><p style="text-align:left">get_effective_components</p></th>
* <td headers="cri gecs send_req">yes</td>
* <td headers="cri gecs send_poll">no </td>
* <td headers="cri gecs rec_reply">yes</td>
* <td headers="cri gecs rec_ex">yes</td>
* <td headers="cri gecs rec_oth">yes</td></tr>
*
* <tr><th id="grpcy"><p style="text-align:left">get_request_policy</p></th>
* <td headers="cri grpcy send_req">yes</td>
* <td headers="cri grpcy send_poll">no </td>
* <td headers="cri grpcy rec_reply">yes</td>
* <td headers="cri grpcy rec_ex">yes</td>
* <td headers="cri grpcy rec_oth">yes</td></tr>
*
* <tr><th id="arsc"><p style="text-align:left">add_request_service_context</p></th>
* <td headers="cri arsc send_req">yes</td>
* <td headers="cri arsc send_poll">no </td>
* <td headers="cri arsc rec_reply">no </td>
* <td headers="cri arsc rec_ex">no </td>
* <td headers="cri arsc rec_oth">no </td></tr>
*
* </tbody>
* </table>
*
* <ol>
* <li>When <code>ClientRequestInfo</code> is passed to
* <code>send_request</code>, there is an entry in the list for every
* argument, whether in, inout, or out. But only the in and inout
* arguments will be available.</li>
* <li>If the <code>reply_status</code> atribute is not
* <code>LOCATION_FORWARD</code>, accessing this attribute will
* throw <code>BAD_INV_ORDER</code> with a standard minor code of
* 14.</li>
* </ol>
*
* @see ClientRequestInterceptor
*/
public interface ClientRequestInfoOperations extends org.omg.PortableInterceptor.RequestInfoOperations
{
Returns the object which the client called to perform the
operation.
See Also: - effective_target
/**
* Returns the object which the client called to perform the
* operation.
*
* @see #effective_target
*/
org.omg.CORBA.Object target ();
Returns the actual object on which the operation will be invoked.
If the reply_status is LOCATION_FORWARD,
then on subsequent requests, effective_target will
contain the forwarded IOR while target will remain unchanged.
See Also: - target
/**
* Returns the actual object on which the operation will be invoked.
* If the <code>reply_status</code> is <code>LOCATION_FORWARD</code>,
* then on subsequent requests, <code>effective_target</code> will
* contain the forwarded IOR while target will remain unchanged.
*
* @see #target
*/
org.omg.CORBA.Object effective_target ();
Returns the profile that will be used to send the request. If a
location forward has occurred for this operation's object and
that object's profile changed accordingly, then this profile will
be that located profile.
/**
* Returns the profile that will be used to send the request. If a
* location forward has occurred for this operation's object and
* that object's profile changed accordingly, then this profile will
* be that located profile.
*/
org.omg.IOP.TaggedProfile effective_profile ();
Returns an any which contains the exception to be returned to
the client.
If the exception is a user exception which cannot be inserted
into an any (e.g., it is unknown or the bindings don t provide
the TypeCode), then this attribute will be an any
containing the system exception UNKNOWN with a
standard minor code of 1. However, the repository id of
the exception is available in the received_exception_id
attribute.
See Also: - received_exception_id
/**
* Returns an any which contains the exception to be returned to
* the client.
* <p>
* If the exception is a user exception which cannot be inserted
* into an any (e.g., it is unknown or the bindings don t provide
* the <code>TypeCode</code>), then this attribute will be an any
* containing the system exception <code>UNKNOWN</code> with a
* standard minor code of 1. However, the repository id of
* the exception is available in the <code>received_exception_id</code>
* attribute.
*
* @see #received_exception_id
*/
org.omg.CORBA.Any received_exception ();
Returns the repository id of the exception to be returned to
the client.
See Also:
/**
* Returns the repository id of the exception to be returned to
* the client.
*
* @see #received_exception
* @see <a href="package-summary.html#unimpl">
* <code>PortableInterceptor</code> package comments for
* limitations / unimplemented features</a>
*/
String received_exception_id ();
Returns the IOP.TaggedComponent with the given ID from
the profile selected for this request.
If there is more than one component for a given component ID, it
is undefined which component this operation returns. If there is
more than one component for a given component ID,
get_effective_components should be called instead.
Params: - id – The component id of the component which
is to be returned.
Throws: - BAD_PARAM – thrown, with a standard minor code of 28, if
no component exists for the given component ID.
See Also: Returns: The IOP.TaggedComponent obtained with the
given identifier.
/**
* Returns the <code>IOP.TaggedComponent</code> with the given ID from
* the profile selected for this request.
* <p>
* If there is more than one component for a given component ID, it
* is undefined which component this operation returns. If there is
* more than one component for a given component ID,
* <code>get_effective_components</code> should be called instead.
*
* @param id The component id of the component which
* is to be returned.
* @return The <code>IOP.TaggedComponent</code> obtained with the
* given identifier.
* @exception BAD_PARAM thrown, with a standard minor code of 28, if
* no component exists for the given component ID.
* @see #get_effective_components
*/
org.omg.IOP.TaggedComponent get_effective_component (int id);
Returns an array of all tagged components with the given ID from the
profile selected for this request.
Params: - id – The component id of the components which are to be returned.
Throws: - BAD_PARAM – thrown, with a standard minor code of 28, if
no component exists for the given component ID.
See Also: Returns: An array of TaggedComponent objects, each of
which contains the given identifier.
/**
* Returns an array of all tagged components with the given ID from the
* profile selected for this request.
*
* @param id The component id of the components which are to be returned.
* @return An array of <code>TaggedComponent</code> objects, each of
* which contains the given identifier.
* @exception BAD_PARAM thrown, with a standard minor code of 28, if
* no component exists for the given component ID.
* @see #get_effective_component
*/
org.omg.IOP.TaggedComponent[] get_effective_components (int id);
Returns the given policy in effect for this operation.
Params: - type – The policy type which specifies the policy to be
returned.
Throws: - INV_POLICY – thrown, with a standard minor code of 1, if the
policy type is not valid either because the specified type is
not supported by this ORB or because a policy object of that type
is not associated with this Object
See Also: Returns: The CORBA.Policy obtained with the given type.
/**
* Returns the given policy in effect for this operation.
*
* @exception INV_POLICY thrown, with a standard minor code of 1, if the
* policy type is not valid either because the specified type is
* not supported by this ORB or because a policy object of that type
* is not associated with this Object
* @param type The policy type which specifies the policy to be
* returned.
* @return The <code>CORBA.Policy</code> obtained with the given type.
* @see <a href="package-summary.html#unimpl">
* <code>PortableInterceptor</code> package comments for
* limitations / unimplemented features</a>
*/
org.omg.CORBA.Policy get_request_policy (int type);
Allows Interceptors to add service contexts to the request.
There is no declaration of the order of the service contexts.
They may or may not appear in the order that they are added.
Params: - service_context – The
IOP.ServiceContext to be
added to the request. - replace – Indicates the behavior of this operation when a
service context already exists with the given ID. If false,
then
BAD_INV_ORDER with a standard minor code of 15
is thrown. If true, then the existing service context is
replaced by the new one.
/**
* Allows Interceptors to add service contexts to the request.
* <p>
* There is no declaration of the order of the service contexts.
* They may or may not appear in the order that they are added.
*
* @param service_context The <code>IOP.ServiceContext</code> to be
* added to the request.
* @param replace Indicates the behavior of this operation when a
* service context already exists with the given ID. If false,
* then <code>BAD_INV_ORDER</code> with a standard minor code of 15
* is thrown. If true, then the existing service context is
* replaced by the new one.
*/
void add_request_service_context (org.omg.IOP.ServiceContext service_context, boolean replace);
} // interface ClientRequestInfoOperations