This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.


org.omg.PortableInterceptor
interface ClientRequestInfoOperations

All Superinterfaces:
RequestInfoOperations

public interface ClientRequestInfoOperations
extends RequestInfoOperations

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.

  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
  1. 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.
  2. If the reply_status atribute is not LOCATION_FORWARD, accessing this attribute will throw BAD_INV_ORDER with a standard minor code of 14.


Method Summary
 void
add_request_service_context(ServiceContext service_context, boolean replace)

          Allows Interceptors to add service contexts to the request.
 TaggedProfile

          Returns the profile that will be used to send the request.
 Object

          Returns the actual object on which the operation will be invoked.
 TaggedComponent

          Returns the IOP.TaggedComponent with the given ID from the profile selected for this request.
 TaggedComponent[]

          Returns an array of all tagged components with the given ID from the profile selected for this request.
 Policy

          Returns the given policy in effect for this operation.
 Any

          Returns an any which contains the exception to be returned to the client.
 String

          Returns the repository id of the exception to be returned to the client.
 Object

          Returns the object which the client called to perform the operation.
 
Methods inherited from class org.omg.PortableInterceptor.RequestInfoOperations
arguments, contexts, exceptions, forward_reference, get_reply_service_context, get_request_service_context, get_slot, operation, operation_context, reply_status, request_id, response_expected, result, sync_scope
 

Method Detail

add_request_service_context

public void add_request_service_context(ServiceContext service_context,
                                        boolean replace)
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.

Parameters:
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.

effective_profile

public TaggedProfile effective_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.


effective_target

public Object effective_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.


get_effective_component

public TaggedComponent get_effective_component(int 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.

Parameters:
id - The component id of the component which is to be returned.
Returns:
The IOP.TaggedComponent obtained with the given identifier.

get_effective_components

public TaggedComponent[] get_effective_components(int id)
Returns an array of all tagged components with the given ID from the profile selected for this request.

Parameters:
id - The component id of the components which are to be returned.
Returns:
An array of TaggedComponent objects, each of which contains the given identifier.

get_request_policy

public Policy get_request_policy(int type)
Returns the given policy in effect for this operation.

Parameters:
type - The policy type which specifies the policy to be returned.
Returns:
The CORBA.Policy obtained with the given type.

received_exception

public Any received_exception()
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.


received_exception_id

public String received_exception_id()
Returns the repository id of the exception to be returned to the client.


target

public Object target()
Returns the object which the client called to perform the operation.



This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.
This page displays the Jadeite version of the documention, which is derived from the offical documentation that contains this copyright notice:
Copyright 2008 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.
The official Sun™ documentation can be found here at http://java.sun.com/javase/6/docs/api/.