TAO/tao/IORInterceptor/IORInfo.h

   1 // -*- C++ -*-
   2
   3 // ===================================================================
   4 /**
   5  *  @file   IORInfo.h
   6  *
   7  *  @author Ossama Othman <ossama@uci.edu>
   8  */
   9 // ===================================================================
  10
  11 #ifndef TAO_IOR_INFO_H
  12 #define TAO_IOR_INFO_H
  13
  14 #include /**/ "ace/pre.h"
  15
  16 #include "tao/IORInterceptor/IORInfoC.h"
  17
  18 #if !defined (ACE_LACKS_PRAGMA_ONCE)
  19 # pragma once
  20 #endif /* ACE_LACKS_PRAGMA_ONCE */
  21
  22 #include "tao/LocalObject.h"
  23
  24 // This is to remove "inherits via dominance" warnings from MSVC.
  25 // MSVC is being a little too paranoid.
  26 #if defined(_MSC_VER)
  27 #pragma warning(push)
  28 #pragma warning(disable:4250)
  29 #endif /* _MSC_VER */
  30
  31
  32 TAO_BEGIN_VERSIONED_NAMESPACE_DECL
  33
  34 /// Forward declarations.
  35 class TAO_Root_POA;
  36
  37 /**
  38  * @class TAO_IORInfo
  39  *
  40  * @brief This class exposes an interface that allows IORInterceptors add
  41  * tagged components to IORs.
  42  */
  43 class TAO_IORInfo
  44   : public virtual PortableInterceptor::IORInfo,
  45     public virtual ::CORBA::LocalObject
  46 {
  47 public:
  48   /// Constructor.
  49   TAO_IORInfo (TAO_Root_POA *poa);
  50
  51   /**
  52    * @name PortableInterceptor::IORInfo Methods
  53    *
  54    * Methods exposed by the PortableInterceptor::IORInfo interface.
  55    */
  56   //@{
  57   /// Return the policy matching the given policy type that is in
  58   /// effect for the object whose IOR is being created.
  59   virtual CORBA::Policy_ptr get_effective_policy (CORBA::PolicyType type);
  60
  61   /// Add the given tagged component to all profiles.
  62   virtual void add_ior_component (const IOP::TaggedComponent & component);
  63
  64   /// Add the given tagged component to all profiles matching the given
  65   /// ProfileId.
  66   virtual void add_ior_component_to_profile (
  67       const IOP::TaggedComponent & component,
  68       IOP::ProfileId profile_id);
  69
  70   virtual char * manager_id ();
  71
  72   virtual PortableInterceptor::AdapterState state ();
  73
  74   virtual PortableInterceptor::ObjectReferenceTemplate *adapter_template ();
  75
  76   virtual PortableInterceptor::ObjectReferenceFactory *current_factory ();
  77
  78   virtual void current_factory (
  79       PortableInterceptor::ObjectReferenceFactory * current_factory);
  80
  81   //@}
  82
  83   /// Invalidate this IORInfo instance.
  84   /**
  85    * Once the IOR interception points have been invoked, this IORInfo
  86    * instance is no longer valid.
  87    */
  88   void invalidate ();
  89
  90   /// Inform the this IORInfo object that the
  91   /// IORInterceptor::components_established() interception point has
  92   /// been called.
  93   /**
  94    * This method is used to inform the IORInfo object when the
  95    * add_ior_component() and add_ior_component_to_profile() methods
  96    * are invalid.  They are only valid in the
  97    * IORInterceptor::establish_components() interception point.
  98    */
  99   void components_established ();
 100
 101 protected:
 102   /// Protected destructor to enforce proper memory management through
 103   /// the reference counting mechanism.
 104   ~TAO_IORInfo ();
 105
 106   /// Check if this IORInfo instance is valid.
 107   /**
 108    * Once all IORInterceptor interception points have been called,
 109    * this IORInfo object is no longer valid.  Throw an exception in
 110    * that case.
 111    */
 112   void check_validity ();
 113
 114 private:
 115   TAO_IORInfo (const TAO_IORInfo &) = delete;
 116   void operator= (const TAO_IORInfo &) = delete;
 117
 118 private:
 119   /// Pointer to POA
 120   TAO_Root_POA * poa_;
 121
 122   /// True if the IORInterceptor::components_established()
 123   /// interception point was called.  False otherwise.
 124   /**
 125    * This flag is used to prevent the add_ior_component() and
 126    * add_ior_component_to_profile() methods from being incorrectly
 127    * called after the IORInterceptor::establish_components()
 128    * interception point has been called.
 129    */
 130   CORBA::Boolean components_established_;
 131 };
 132
 133 TAO_END_VERSIONED_NAMESPACE_DECL
 134
 135 #if defined (__ACE_INLINE__)
 136 # include "tao/IORInterceptor/IORInfo.inl"
 137 #endif /* __ACE_INLINE__ */
 138
 139 #if defined(_MSC_VER)
 140 #pragma warning(pop)
 141 #endif /* _MSC_VER */
 142
 143 #include /**/ "ace/post.h"
 144
 145 #endif /* TAO_IOR_INFO_H */