path: root/TAO/tao/poa.idl

// POA related IDL from "ORB Portability Joint Submission", orbos/97-04-14,
//    Section 3.4
//
// Changes to IDL in that section:
//   1.  Take out "..." in CORBA module which indicated "everything else
//       in the CORBA module".
//   2.  Add some definition from the full CORBA module which are needed
//       for compiling the PortableServer module.
//   3.  Add fake definitions of "native" since it does not yet exist
//       in IDL. These fake definitions allow the rest of the module to
//       compile as if "native" were indeed an IDL keyword.
//   4.  Took out an extra semi-colon accidentally added during last
//       editing pass
// These changes (except removal of "...") are marked with beginning and
//   ending comment lines containing "****change****".

// IDL
#pragma prefix "omg.org"
module PortableServer
{
  typedef string Identifier;
  typedef string RepositoryId;
  interface CurrentBase{};
  // ****change**** end   definitions from CORBA needed for standalone compile

  // basic Policy definition
  interface Policy
    {
      Policy copy( );
      void destroy( );
    };

  typedef sequence <Policy>  PolicyList;

  // forward reference
  interface POA;

  native Servant;
  typedef sequence<octet> ObjectId;

  exception ForwardRequest
    {
      Object forward_reference;
    };

  // **********************************************
  //
  // Policy interfaces
  //
  // **********************************************
  enum ThreadPolicyValue {
    ORB_CTRL_MODEL,
    SINGLE_THREAD_MODEL
  };
  interface ThreadPolicy : Policy
    {
      readonly attribute ThreadPolicyValue value;
    };

  enum LifespanPolicyValue {
    TRANSIENT,
    PERSISTENT
  };
  interface LifespanPolicy : Policy
    {
      readonly attribute LifespanPolicyValue value;
    };

  enum IdUniquenessPolicyValue {
    UNIQUE_ID,
    MULTIPLE_ID
  };
  interface IdUniquenessPolicy : Policy
    {
      readonly attribute IdUniquenessPolicyValue value;
    };

  enum IdAssignmentPolicyValue {
    USER_ID,
    SYSTEM_ID
  };
  interface IdAssignmentPolicy : Policy
    {
      readonly attribute IdAssignmentPolicyValue value;
    };

  enum ImplicitActivationPolicyValue {
    IMPLICIT_ACTIVATION,
    NO_IMPLICIT_ACTIVATION
  };
  interface ImplicitActivationPolicy : Policy
    {
      readonly attribute ImplicitActivationPolicyValue value;
    };

  enum ServantRetentionPolicyValue {
    RETAIN,
    NON_RETAIN
  };
  interface ServantRetentionPolicy : Policy
    {
      readonly attribute ServantRetentionPolicyValue value;
    };

  enum RequestProcessingPolicyValue {
    USE_ACTIVE_OBJECT_MAP_ONLY,
    USE_DEFAULT_SERVANT,
    USE_SERVANT_MANAGER
  };
  interface RequestProcessingPolicy : Policy
    {
      readonly attribute RequestProcessingPolicyValue value;
    };

  // **************************************************
  //
  // POAManager interface
  //
  // **************************************************

  interface POAManager
    {
      exception AdapterInactive{};

      void activate()
	raises(AdapterInactive);
      void hold_requests(in boolean wait_for_completion)
	raises(AdapterInactive);
      void discard_requests(in boolean wait_for_completion)
	raises(AdapterInactive);
      // ****change**** begin take out semi-colon after parameter list in 97-04-14
      void deactivate(	in boolean etherealize_objects,
			in boolean wait_for_completion)
	raises(AdapterInactive);
      // ****change**** end   take out semi-colon after parameter list in 97-04-14
    };

  // **************************************************
  //
  // AdapterActivator interface
  //
  // **************************************************

  interface AdapterActivator
    {
      boolean unknown_adapter(in POA parent, in string name);
    };

  // **************************************************
  //
  // ServantManager interface
  //
  // **************************************************

  interface ServantManager
    { };

  interface ServantActivator : ServantManager {
    Servant incarnate (
		       in ObjectId 	oid,
		       in POA 	adapter )
      raises (ForwardRequest);

    void etherealize (
		      in ObjectId 	oid,
		      in POA 	adapter,
		      in Servant 	serv,
		      in boolean	cleanup_in_progress,
		      in boolean 	remaining_activations );
  };

  interface ServantLocator : ServantManager {
    native 	Cookie;

    Servant preinvoke(
		      in ObjectId	oid,
		      in POA	adapter,
		      in Identifier	operation,
		      out Cookie	the_cookie )
      raises (ForwardRequest);

    void postinvoke(
		    in ObjectId 	oid,
		    in POA 	adapter,
		    in Identifier 	operation,
		    in Cookie 	the_cookie,
		    in Servant	the_servant	);
  };


  // **************************************************
  //
  // POA interface
  //
  // **************************************************

  interface POA
    {
      exception AdapterAlreadyExists {};
      exception AdapterInactive {};
      exception AdapterNonExistent {};
      exception InvalidPolicy { unsigned short index; };
      exception NoServant {};
      exception ObjectAlreadyActive {};
      exception ObjectNotActive {};
      exception ServantAlreadyActive {};
      exception ServantNotActive {};
      exception WrongAdapter {};
      exception WrongPolicy {};

      //--------------------------------------------------
      //
      // POA creation and destruction
      //
      //--------------------------------------------------

      POA create_POA(in string adapter_name,
		     in POAManager a_POAManager,
		     in PolicyList policies)
	raises (AdapterAlreadyExists, InvalidPolicy);

      POA find_POA(in string adapter_name,  in boolean activate_it)
	raises (AdapterNonExistent);

      void destroy(	in boolean etherealize_objects,
			in boolean wait_for_completion);

      // **************************************************
      //
      // Factories for Policy objects
      //
      // **************************************************
      ThreadPolicy
	create_thread_policy(in ThreadPolicyValue value);
      LifespanPolicy
	create_lifespan_policy(in LifespanPolicyValue value);
      IdUniquenessPolicy
	create_id_uniqueness_policy
	(in IdUniquenessPolicyValue value);
      IdAssignmentPolicy
	create_id_assignment_policy
	(in IdAssignmentPolicyValue value);
      ImplicitActivationPolicy
	create_implicit_activation_policy
	(in ImplicitActivationPolicyValue value);
      ServantRetentionPolicy
	create_servant_retention_policy
	(in ServantRetentionPolicyValue value);
      RequestProcessingPolicy
	create_request_processing_policy
	(in RequestProcessingPolicyValue value);

      //--------------------------------------------------
      //
      // POA attributes
      //
      //--------------------------------------------------

      readonly attribute string the_name;
      readonly attribute POA the_parent;
      readonly attribute POAManager the_POAManager;
      attribute AdapterActivator the_activator;


      //--------------------------------------------------
      //
      // Servant Manager registration:
      //
      //--------------------------------------------------

      ServantManager get_servant_manager()
	raises (WrongPolicy);

      void set_servant_manager( in ServantManager imgr)
	raises (WrongPolicy);

      //--------------------------------------------------
      //
      // operations for the USE_DEFAULT_SERVANT policy
      //
      //--------------------------------------------------

      Servant get_servant()
	raises (NoServant, WrongPolicy);

      void set_servant(	in Servant p_servant)
	raises (WrongPolicy);

      // **************************************************
      //
      // object activation and deactivation
      //
      // **************************************************

      ObjectId activate_object( in Servant p_servant )
	raises (ServantAlreadyActive, WrongPolicy);

      void activate_object_with_id(
				   in ObjectId id,
				   in Servant p_servant)
	raises (ServantAlreadyActive, ObjectAlreadyActive,
		WrongPolicy);

      void deactivate_object(in ObjectId oid)
	raises (ObjectNotActive, WrongPolicy);

      // **************************************************
      //
      // reference creation operations
      //
      // **************************************************

      Object create_reference (
			       in RepositoryId intf )
	raises (WrongPolicy);

      Object create_reference_with_id (
				       in ObjectId oid,
				       in RepositoryId intf )
	raises (WrongPolicy);


      //--------------------------------------------------
      //
      // Identity mapping operations:
      //
      //--------------------------------------------------

      ObjectId servant_to_id(in Servant p_servant)
	raises (ServantNotActive, WrongPolicy);

      Object servant_to_reference(in Servant p_servant)
	raises (ServantNotActive, WrongPolicy);

      Servant reference_to_servant(in Object reference)
	raises (ObjectNotActive, WrongAdapter, WrongPolicy);

      ObjectId reference_to_id(in Object reference)
	raises (WrongAdapter, WrongPolicy);

      Servant id_to_servant(in ObjectId oid)
	raises (ObjectNotActive, WrongPolicy);

      Object id_to_reference(in ObjectId oid)
	raises (ObjectNotActive, WrongPolicy);

    };


  // **************************************************
  //
  // Current interface
  //
  // **************************************************

  interface Current : CurrentBase
    {
      exception NoContext { };

      POA get_POA() raises (NoContext);
      ObjectId get_object_id() raises (NoContext);
    };

};