org.omg.PortableInterceptor.ClientRequestInfoHelper Maven / Gradle / Ivy

package org.omg.PortableInterceptor;


/**
* org/omg/PortableInterceptor/ClientRequestInfoHelper.java .
* Generated by the IDL-to-Java compiler (portable), version "3.2"
* from /home/jenkins/agent/workspace/orb-release-build/omgapi/src/main/idl/Interceptors.idl
* Sunday, February 14, 2021 7:42:42 PM GMT
*/


/**
   * 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.
   * 
   * 
   * 
   *   
   *     
   *       
   *       
   *       
   *       
   *       
   *       
   *     
   *   
   *  
   * 
   *    
   *      
   *    
   * 
   *    
   *    
   * 
   *    
   *    
   * 
   *    
   *     
   *            
   * 
   *    
   *    
   * 
   *    
   *    
   * 
   *    
   *    
   * 
   *    
   *    
   * 
   *    
   *    
   * 
   *    
   *    
   * 
   *    
   *    
   * 
   *    
   *    
   * 
   *    
   *    
   * 
   *    
   *    
   * 
   *    
   *    
   * 
   *    
   *      
   *    
   * 
   *    
   *    
   * 
   *    
   *    
   * 
   *    
   *    
   * 
   *    
   *    
   * 
   *    
   *    
   * 
   *    
   *    
   * 
   *    
   *    
   * 
   *    
   *    
   * 
   *    
   *    
   * 
   *   
   * Request information  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 yes₁ 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  yes₂
   *                                                            
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 ClientRequestInterceptor
   */
abstract public class ClientRequestInfoHelper
{
  private static String  _id = "IDL:omg.org/PortableInterceptor/ClientRequestInfo:1.0";

  public static void insert (org.omg.CORBA.Any a, org.omg.PortableInterceptor.ClientRequestInfo that)
  {
    org.omg.CORBA.portable.OutputStream out = a.create_output_stream ();
    a.type (type ());
    write (out, that);
    a.read_value (out.create_input_stream (), type ());
  }

  public static org.omg.PortableInterceptor.ClientRequestInfo extract (org.omg.CORBA.Any a)
  {
    return read (a.create_input_stream ());
  }

  private static org.omg.CORBA.TypeCode __typeCode = null;
  synchronized public static org.omg.CORBA.TypeCode type ()
  {
    if (__typeCode == null)
    {
      __typeCode = org.omg.CORBA.ORB.init ().create_interface_tc (org.omg.PortableInterceptor.ClientRequestInfoHelper.id (), "ClientRequestInfo");
    }
    return __typeCode;
  }

  public static String id ()
  {
    return _id;
  }

  public static org.omg.PortableInterceptor.ClientRequestInfo read (org.omg.CORBA.portable.InputStream istream)
  {
      throw new org.omg.CORBA.MARSHAL ();
  }

  public static void write (org.omg.CORBA.portable.OutputStream ostream, org.omg.PortableInterceptor.ClientRequestInfo value)
  {
      throw new org.omg.CORBA.MARSHAL ();
  }

  public static org.omg.PortableInterceptor.ClientRequestInfo narrow (org.omg.CORBA.Object obj)
  {
    if (obj == null)
      return null;
    else if (obj instanceof org.omg.PortableInterceptor.ClientRequestInfo)
      return (org.omg.PortableInterceptor.ClientRequestInfo)obj;
    else
      throw new org.omg.CORBA.BAD_PARAM ();
  }

  public static org.omg.PortableInterceptor.ClientRequestInfo unchecked_narrow (org.omg.CORBA.Object obj)
  {
    if (obj == null)
      return null;
    else if (obj instanceof org.omg.PortableInterceptor.ClientRequestInfo)
      return (org.omg.PortableInterceptor.ClientRequestInfo)obj;
    else
      throw new org.omg.CORBA.BAD_PARAM ();
  }

}

	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	yes₁	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	yes₂ *
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