org.omg.PortableInterceptor
Interface ClientRequestInfoOperations

All Superinterfaces:
RequestInfoOperations sample code for org.omg.PortableInterceptor.RequestInfoOperations definition code for org.omg.PortableInterceptor.RequestInfoOperations
All Known Subinterfaces:
ClientRequestInfo sample code for org.omg.PortableInterceptor.ClientRequestInfo definition code for org.omg.PortableInterceptor.ClientRequestInfo

public interface ClientRequestInfoOperations
extends RequestInfoOperations sample code for org.omg.PortableInterceptor.RequestInfoOperations definition code for org.omg.PortableInterceptor.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.

See Also:
ClientRequestInterceptor sample code for org.omg.PortableInterceptor.ClientRequestInterceptor definition code for org.omg.PortableInterceptor.ClientRequestInterceptor

Method Summary
 void add_request_service_context sample code for org.omg.PortableInterceptor.ClientRequestInfoOperations.add_request_service_context(org.omg.IOP.ServiceContext, boolean) definition code for org.omg.PortableInterceptor.ClientRequestInfoOperations.add_request_service_context(org.omg.IOP.ServiceContext, boolean) (ServiceContext sample code for org.omg.IOP.ServiceContext definition code for org.omg.IOP.ServiceContext  service_context, boolean replace)
          Allows Interceptors to add service contexts to the request.
 TaggedProfile sample code for org.omg.IOP.TaggedProfile definition code for org.omg.IOP.TaggedProfile effective_profile sample code for org.omg.PortableInterceptor.ClientRequestInfoOperations.effective_profile() definition code for org.omg.PortableInterceptor.ClientRequestInfoOperations.effective_profile() ()
          Returns the profile that will be used to send the request.
 Object sample code for org.omg.CORBA.Object definition code for org.omg.CORBA.Object effective_target sample code for org.omg.PortableInterceptor.ClientRequestInfoOperations.effective_target() definition code for org.omg.PortableInterceptor.ClientRequestInfoOperations.effective_target() ()
          Returns the actual object on which the operation will be invoked.
 TaggedComponent sample code for org.omg.IOP.TaggedComponent definition code for org.omg.IOP.TaggedComponent get_effective_component sample code for org.omg.PortableInterceptor.ClientRequestInfoOperations.get_effective_component(int) definition code for org.omg.PortableInterceptor.ClientRequestInfoOperations.get_effective_component(int) (int id)
          Returns the IOP.TaggedComponent with the given ID from the profile selected for this request.
 TaggedComponent sample code for org.omg.IOP.TaggedComponent definition code for org.omg.IOP.TaggedComponent [] get_effective_components sample code for org.omg.PortableInterceptor.ClientRequestInfoOperations.get_effective_components(int) definition code for org.omg.PortableInterceptor.ClientRequestInfoOperations.get_effective_components(int) (int id)
          Returns an array of all tagged components with the given ID from the profile selected for this request.
 Policy sample code for org.omg.CORBA.Policy definition code for org.omg.CORBA.Policy get_request_policy sample code for org.omg.PortableInterceptor.ClientRequestInfoOperations.get_request_policy(int) definition code for org.omg.PortableInterceptor.ClientRequestInfoOperations.get_request_policy(int) (int type)
          Returns the given policy in effect for this operation.
 String sample code for java.lang.String definition code for java.lang.String received_exception_id sample code for org.omg.PortableInterceptor.ClientRequestInfoOperations.received_exception_id() definition code for org.omg.PortableInterceptor.ClientRequestInfoOperations.received_exception_id() ()
          Returns the repository id of the exception to be returned to the client.
 Any sample code for org.omg.CORBA.Any definition code for org.omg.CORBA.Any received_exception sample code for org.omg.PortableInterceptor.ClientRequestInfoOperations.received_exception() definition code for org.omg.PortableInterceptor.ClientRequestInfoOperations.received_exception() ()
          Returns an any which contains the exception to be returned to the client.
 Object sample code for org.omg.CORBA.Object definition code for org.omg.CORBA.Object target sample code for org.omg.PortableInterceptor.ClientRequestInfoOperations.target() definition code for org.omg.PortableInterceptor.ClientRequestInfoOperations.target() ()
          Returns the object which the client called to perform the operation.
 
Methods inherited from interface org.omg.PortableInterceptor.RequestInfoOperations sample code for org.omg.PortableInterceptor.RequestInfoOperations definition code for org.omg.PortableInterceptor.RequestInfoOperations
arguments sample code for org.omg.PortableInterceptor.RequestInfoOperations.arguments() definition code for org.omg.PortableInterceptor.RequestInfoOperations.arguments() , contexts sample code for org.omg.PortableInterceptor.RequestInfoOperations.contexts() definition code for org.omg.PortableInterceptor.RequestInfoOperations.contexts() , exceptions sample code for org.omg.PortableInterceptor.RequestInfoOperations.exceptions() definition code for org.omg.PortableInterceptor.RequestInfoOperations.exceptions() , forward_reference sample code for org.omg.PortableInterceptor.RequestInfoOperations.forward_reference() definition code for org.omg.PortableInterceptor.RequestInfoOperations.forward_reference() , get_reply_service_context sample code for org.omg.PortableInterceptor.RequestInfoOperations.get_reply_service_context(int) definition code for org.omg.PortableInterceptor.RequestInfoOperations.get_reply_service_context(int) , get_request_service_context sample code for org.omg.PortableInterceptor.RequestInfoOperations.get_request_service_context(int) definition code for org.omg.PortableInterceptor.RequestInfoOperations.get_request_service_context(int) , get_slot sample code for org.omg.PortableInterceptor.RequestInfoOperations.get_slot(int) definition code for org.omg.PortableInterceptor.RequestInfoOperations.get_slot(int) , operation_context sample code for org.omg.PortableInterceptor.RequestInfoOperations.operation_context() definition code for org.omg.PortableInterceptor.RequestInfoOperations.operation_context() , operation sample code for org.omg.PortableInterceptor.RequestInfoOperations.operation() definition code for org.omg.PortableInterceptor.RequestInfoOperations.operation() , reply_status sample code for org.omg.PortableInterceptor.RequestInfoOperations.reply_status() definition code for org.omg.PortableInterceptor.RequestInfoOperations.reply_status() , request_id sample code for org.omg.PortableInterceptor.RequestInfoOperations.request_id() definition code for org.omg.PortableInterceptor.RequestInfoOperations.request_id() , response_expected sample code for org.omg.PortableInterceptor.RequestInfoOperations.response_expected() definition code for org.omg.PortableInterceptor.RequestInfoOperations.response_expected() , result sample code for org.omg.PortableInterceptor.RequestInfoOperations.result() definition code for org.omg.PortableInterceptor.RequestInfoOperations.result() , sync_scope sample code for org.omg.PortableInterceptor.RequestInfoOperations.sync_scope() definition code for org.omg.PortableInterceptor.RequestInfoOperations.sync_scope()
 

Method Detail

target sample code for org.omg.PortableInterceptor.ClientRequestInfoOperations.target() definition code for org.omg.PortableInterceptor.ClientRequestInfoOperations.target()

Object sample code for org.omg.CORBA.Object definition code for org.omg.CORBA.Object  target()
Returns the object which the client called to perform the operation.

See Also:
effective_target() sample code for org.omg.PortableInterceptor.ClientRequestInfoOperations.effective_target() definition code for org.omg.PortableInterceptor.ClientRequestInfoOperations.effective_target()

effective_target sample code for org.omg.PortableInterceptor.ClientRequestInfoOperations.effective_target() definition code for org.omg.PortableInterceptor.ClientRequestInfoOperations.effective_target()

Object sample code for org.omg.CORBA.Object definition code for org.omg.CORBA.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.

See Also:
target() sample code for org.omg.PortableInterceptor.ClientRequestInfoOperations.target() definition code for org.omg.PortableInterceptor.ClientRequestInfoOperations.target()

effective_profile sample code for org.omg.PortableInterceptor.ClientRequestInfoOperations.effective_profile() definition code for org.omg.PortableInterceptor.ClientRequestInfoOperations.effective_profile()

TaggedProfile sample code for org.omg.IOP.TaggedProfile definition code for org.omg.IOP.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.


received_exception sample code for org.omg.PortableInterceptor.ClientRequestInfoOperations.received_exception() definition code for org.omg.PortableInterceptor.ClientRequestInfoOperations.received_exception()

Any sample code for org.omg.CORBA.Any definition code for org.omg.CORBA.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.

See Also:
received_exception_id() sample code for org.omg.PortableInterceptor.ClientRequestInfoOperations.received_exception_id() definition code for org.omg.PortableInterceptor.ClientRequestInfoOperations.received_exception_id()

received_exception_id sample code for org.omg.PortableInterceptor.ClientRequestInfoOperations.received_exception_id() definition code for org.omg.PortableInterceptor.ClientRequestInfoOperations.received_exception_id()

String sample code for java.lang.String definition code for java.lang.String  received_exception_id()
Returns the repository id of the exception to be returned to the client.

See Also:
received_exception() sample code for org.omg.PortableInterceptor.ClientRequestInfoOperations.received_exception() definition code for org.omg.PortableInterceptor.ClientRequestInfoOperations.received_exception() , PortableInterceptor package comments for limitations / unimplemented features

get_effective_component sample code for org.omg.PortableInterceptor.ClientRequestInfoOperations.get_effective_component(int) definition code for org.omg.PortableInterceptor.ClientRequestInfoOperations.get_effective_component(int)

TaggedComponent sample code for org.omg.IOP.TaggedComponent definition code for org.omg.IOP.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.
Throws:
BAD_PARAM - thrown, with a standard minor code of 28, if no component exists for the given component ID.
See Also:
get_effective_components(int) sample code for org.omg.PortableInterceptor.ClientRequestInfoOperations.get_effective_components(int) definition code for org.omg.PortableInterceptor.ClientRequestInfoOperations.get_effective_components(int)

get_effective_components sample code for org.omg.PortableInterceptor.ClientRequestInfoOperations.get_effective_components(int) definition code for org.omg.PortableInterceptor.ClientRequestInfoOperations.get_effective_components(int)

TaggedComponent sample code for org.omg.IOP.TaggedComponent definition code for org.omg.IOP.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.
Throws:
BAD_PARAM - thrown, with a standard minor code of 28, if no component exists for the given component ID.
See Also:
get_effective_component(int) sample code for org.omg.PortableInterceptor.ClientRequestInfoOperations.get_effective_component(int) definition code for org.omg.PortableInterceptor.ClientRequestInfoOperations.get_effective_component(int)

get_request_policy sample code for org.omg.PortableInterceptor.ClientRequestInfoOperations.get_request_policy(int) definition code for org.omg.PortableInterceptor.ClientRequestInfoOperations.get_request_policy(int)

Policy sample code for org.omg.CORBA.Policy definition code for org.omg.CORBA.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.
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:
PortableInterceptor package comments for limitations / unimplemented features

add_request_service_context sample code for org.omg.PortableInterceptor.ClientRequestInfoOperations.add_request_service_context(org.omg.IOP.ServiceContext, boolean) definition code for org.omg.PortableInterceptor.ClientRequestInfoOperations.add_request_service_context(org.omg.IOP.ServiceContext, boolean)

void add_request_service_context(ServiceContext sample code for org.omg.IOP.ServiceContext definition code for org.omg.IOP.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.