Class POAImpl

  • All Implemented Interfaces:
    ObjectAdapter, java.io.Serializable, Object, IDLEntity, POA, POAOperations

    @ManagedObject
    public class POAImpl
    extends ObjectAdapterBase
    implements POA
    POAImpl is the implementation of the Portable Object Adapter. It contains an implementation of the POA interfaces specified in COBRA 2.3.1 chapter 11 (formal/99-10-07). This implementation is moving to comply with CORBA 3.0 due to the many clarifications that have been made to the POA semantics since CORBA 2.3.1. Specific comments have been added where 3.0 applies, but note that we do not have the new 3.0 APIs yet.
    See Also:
    Serialized Form
    • Field Detail

      • state

        private int state
      • numLevels

        private final int numLevels
      • poaName

        private final java.lang.String poaName
      • uniquePOAId

        private final int uniquePOAId
      • children

        private final java.util.Map<java.lang.String,​POAImpl> children
      • invocationCount

        private final java.util.concurrent.atomic.AtomicInteger invocationCount
      • poaMutex

        final java.util.concurrent.locks.ReadWriteLock poaMutex
      • adapterActivatorCV

        private final java.util.concurrent.locks.Condition adapterActivatorCV
      • invokeCV

        private final java.util.concurrent.locks.Condition invokeCV
      • beingDestroyedCV

        private final java.util.concurrent.locks.Condition beingDestroyedCV
      • isDestroying

        private final java.lang.ThreadLocal<java.lang.Boolean> isDestroying
      • momLock

        private static final java.lang.Object momLock
    • Constructor Detail

      • POAImpl

        private POAImpl​(java.lang.String name,
                        POAImpl parent,
                        ORB orb,
                        int initialState)
    • Method Detail

      • stateToString

        private java.lang.String stateToString()
      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object
      • getDisplayState

        @ManagedAttribute(id="POAState")
        @Description("The current state of the POA")
        private java.lang.String getDisplayState()
      • getMediator

        @ManagedAttribute
        @Description("The POA\'s mediator")
        POAPolicyMediator getMediator()
      • getObjectAdapterId

        @ManagedAttribute
        @Description("The ObjectAdapterId for this POA")
        private ObjectAdapterId getObjectAdapterId()
      • registerMBean

        private static void registerMBean​(ORB orb,
                                          java.lang.Object obj)
      • makeRootPOA

        static POAImpl makeRootPOA​(ORB orb)
      • getPOAId

        @ManagedAttribute
        @Description("The unique ID for this POA")
        int getPOAId()
      • thisPoa

        @InfoMethod
        private void thisPoa​(POAImpl p)
      • acquireLockWaiting

        @InfoMethod
        private void acquireLockWaiting​(int count)
      • acquireLock

        private void acquireLock​(java.util.concurrent.locks.Lock lock)
      • lock

        void lock()
      • unlock

        void unlock()
      • readLock

        void readLock()
      • readUnlock

        void readUnlock()
      • makeCondition

        final java.util.concurrent.locks.Condition makeCondition()
      • newPOACreated

        private void newPOACreated​(java.lang.String name,
                                   java.lang.String parentName)
      • getName

        @NameValue
        private java.lang.String getName()
      • initializingPoa

        @InfoMethod
        private void initializingPoa​(int scid,
                                     int serverid,
                                     java.lang.String orbid,
                                     ObjectAdapterId poaId)
      • interruptedAwait

        @InfoMethod
        private void interruptedAwait​(java.lang.InterruptedException exc)
      • waitUntilRunning

        private boolean waitUntilRunning()
      • destroyIfNotInitDone

        private boolean destroyIfNotInitDone()
      • etherealizeAll

        void etherealizeAll()
      • newPOA

        @InfoMethod
        private void newPOA​(POAImpl poa)
      • create_POA

        public POA create_POA​(java.lang.String name,
                              POAManager theManager,
                              Policy[] policies)
                       throws AdapterAlreadyExists,
                              InvalidPolicy
        create_POA Section 3.3.8.2
        Specified by:
        create_POA in interface POAOperations
        Parameters:
        name - identifies the new POA with respect to other POAs with the same parent POA.
        theManager - specifies the POA Manager to be associated with the new POA.
        policies - specifies policy objects to be associated with the POA to control its behavior.
        Returns:
        the new POA
        Throws:
        AdapterAlreadyExists - specifies that the target POA already has a child POA with the specified name.
        InvalidPolicy - is raised if any of the policy objects are not valid for the ORB, or are in conflict, or require an administrative action that has not been performed.
      • foundPOA

        @InfoMethod
        private void foundPOA​(POAImpl poa)
      • createdPOA

        @InfoMethod
        private void createdPOA​(POAImpl poa)
      • noPOA

        @InfoMethod
        private void noPOA()
      • callingAdapterActivator

        @InfoMethod
        private void callingAdapterActivator()
      • adapterActivatorResult

        @InfoMethod
        private void adapterActivatorResult​(boolean result)
      • find_POA

        public POA find_POA​(java.lang.String name,
                            boolean activate)
                     throws AdapterNonExistent
        find_POA Section 3.3.8.3
        Specified by:
        find_POA in interface POAOperations
        Parameters:
        name - POA name to be found.
        activate - if a POA with the specified name does not exist and the value of the activate_it parameter is TRUE, the target POA's AdapterActivator, if one exists, is invoked.
        Returns:
        org.omg.PortableServer.POAPackage.POA if one exists or is activated by the AdapterActivator.
        Throws:
        AdapterNonExistent - is raised if POA with a specified name cannot be found or activated using AdapaterActivator.
      • lockAndWaitUntilRunning

        private void lockAndWaitUntilRunning()
      • locksWereHeld

        @InfoMethod
        private void locksWereHeld()
      • cleanUpLocks

        private void cleanUpLocks​(POAImpl child,
                                  boolean readLocked,
                                  boolean writeLocked,
                                  boolean childReadLocked)
      • destroy

        public void destroy​(boolean etherealize,
                            boolean wait_for_completion)
        destroy Section 3.3.8.4
        Specified by:
        destroy in interface POAOperations
        Parameters:
        etherealize - flag to indicate whether etherealize operation on servant manager needs to be called.
        wait_for_completion - flag to indicate whether POA and its children need to wait for active requests and the etherealization to complete.
      • the_name

        @ManagedAttribute(id="POAName")
        @Description("The name of this POA")
        public java.lang.String the_name()
        the_name Section 3.3.8.6
        Specified by:
        the_name in interface POAOperations
        Returns:
        name of the POA
      • the_parent

        @ManagedAttribute(id="POAParent")
        @Description("The parent of this POA")
        public POA the_parent()
        the_parent Section 3.3.8.7
        Specified by:
        the_parent in interface POAOperations
        Returns:
        the parent of the POA
      • children

        @ManagedAttribute(id="POAChildren")
        @Description("The children of this POA")
        private java.util.List<POAImpl> children()
        the_children
      • the_children

        public POA[] the_children()
        Description copied from interface: POAOperations
        This attribute identifies the current set of all child POAs of the POA. The set of child POAs includes only the POA's immediate children, and not their descendants.
        Specified by:
        the_children in interface POAOperations
        Returns:
        the children of the POA
      • getPOAManager

        @ManagedAttribute(id="POAManager")
        @Description("The POAManager of this POA")
        private POAManagerImpl getPOAManager()
      • the_activator

        @ManagedAttribute(id="Activator")
        @Description("The AdapterActivator of this POA")
        public AdapterActivator the_activator()
        the_activator Section 3.3.8.9
        Specified by:
        the_activator in interface POAOperations
      • get_servant_manager

        public ServantManager get_servant_manager()
                                           throws WrongPolicy
        get_servant_manager Section 3.3.8.10
        Specified by:
        get_servant_manager in interface POAOperations
        Returns:
        org.omg.PortableServer.POAPackage.ServantManager associated with a POA or null if none exists.
        Throws:
        WrongPolicy - raised if the USE_SERVANT_MANAGER policy is not specified.
      • servantManager

        @ManagedAttribute
        @Description("The servant manager of this POA (may be null)")
        private ServantManager servantManager()
      • set_servant_manager

        public void set_servant_manager​(ServantManager servantManager)
                                 throws WrongPolicy
        set_servant_manager Section 3.3.8.10
        Specified by:
        set_servant_manager in interface POAOperations
        Parameters:
        servantManager - servant manager to be used as a default.
        Throws:
        WrongPolicy - raised if the USE_SERVANT_MANAGER policy is not specified.
      • get_servant

        public Servant get_servant()
                            throws NoServant,
                                   WrongPolicy
        get_servant Section 3.3.8.12
        Specified by:
        get_servant in interface POAOperations
        Returns:
        p_servant default servant associated with a POA.
        Throws:
        NoServant - raised if no default servant is associated with the POA.
        WrongPolicy - raised if the USE_DEFAULT_SERVANT policy is not specified.
      • servant

        @ManagedAttribute
        @Description("The default servant of this POA (may be null)")
        private Servant servant()
      • set_servant

        public void set_servant​(Servant defaultServant)
                         throws WrongPolicy
        set_servant Section 3.3.8.13
        Specified by:
        set_servant in interface POAOperations
        Parameters:
        defaultServant - servant to be used as a default.
        Throws:
        WrongPolicy - raised if the USE_DEFAULT_SERVANT policy is not specified.
      • activate_object

        public byte[] activate_object​(Servant servant)
                               throws ServantAlreadyActive,
                                      WrongPolicy
        activate_object Section 3.3.8.14
        Specified by:
        activate_object in interface POAOperations
        Parameters:
        servant - servant to be associated with an object to be activated.
        Returns:
        POA generated object id.
        Throws:
        ServantAlreadyActive - is raised if the POA has UNIQUE_ID policy and servant is is already in the Active Object Map.
        WrongPolicy - raised if the SYSTEM_ID and RETAIN policies are not specified.
      • deactivate_object

        public void deactivate_object​(byte[] id)
                               throws ObjectNotActive,
                                      WrongPolicy
        deactivate_object 3.3.8.16
        Specified by:
        deactivate_object in interface POAOperations
        Parameters:
        id - Object Id for the object to be deactivated.
        Throws:
        ObjectNotActive - if the object with the specified oid is not in the Active Object Map.
        WrongPolicy - raised if the RETAIN policy is is not specified.
      • create_reference

        public Object create_reference​(java.lang.String repId)
                                throws WrongPolicy
        create_reference 3.3.8.17
        Specified by:
        create_reference in interface POAOperations
        Parameters:
        repId - rep id for creating an object reference.
        Returns:
        object reference created using intf.
        Throws:
        WrongPolicy - if SYSTEM_ID policy is not specified.
      • create_reference_with_id

        public Object create_reference_with_id​(byte[] oid,
                                               java.lang.String repId)
        create_reference_with_id 3.3.8.18
        Specified by:
        create_reference_with_id in interface POAOperations
        Parameters:
        oid - object id for creating an objref
        repId - rep id for creating an objref
        Returns:
        object reference created using oid and intf
      • servant_to_id

        public byte[] servant_to_id​(Servant servant)
                             throws ServantNotActive,
                                    WrongPolicy
        servant_to_id 3.3.8.19
        Specified by:
        servant_to_id in interface POAOperations
        Parameters:
        servant - servant for which the object disi returned.
        Returns:
        object id associated with the servant.
        Throws:
        ServantNotActive - if the above rules and policy combination is not met.
        WrongPolicy - if the USE_DEFAULT_SERVANT policy or a combination of the RETAIN policy and either the UNIQUE_ID or IMPLICIT_ACTIVATION policies are not present.
      • servant_to_reference

        public Object servant_to_reference​(Servant servant)
                                    throws ServantNotActive,
                                           WrongPolicy
        servant_to_reference 3.3.8.20
        Specified by:
        servant_to_reference in interface POAOperations
        Parameters:
        servant - servant for which the object reference needs to be obtained.
        Returns:
        object reference associated with the servant.
        Throws:
        ServantNotActive - if the above specified policies and rules are not met.
        WrongPolicy - if the operation is not invoked in the context of executing a request on the specified servant and the required policies are not present.
      • reference_to_servant

        public Servant reference_to_servant​(Object reference)
                                     throws ObjectNotActive,
                                            WrongPolicy,
                                            WrongAdapter
        reference_to_servant 3.3.8.21
        Specified by:
        reference_to_servant in interface POAOperations
        Parameters:
        reference - object reference for which the servant is returned.
        Returns:
        servant associated with the reference.
        Throws:
        ObjectNotActive - if the servant is not present in the Active Object Map (for RETAIN) or no default servant is registered (for USE_DEFAULT_POLICY).
        WrongPolicy - if neither the RETAIN policy or the USE_DEFAULT_SERVANT policy is present.
        WrongAdapter - if reference was not created by this POA instance.
      • reference_to_id

        public byte[] reference_to_id​(Object reference)
                               throws WrongAdapter,
                                      WrongPolicy
        reference_to_id 3.3.8.22
        Specified by:
        reference_to_id in interface POAOperations
        Parameters:
        reference - the object reference from which the object id needs to be returned.
        Returns:
        object id encapsulated in the reference.
        Throws:
        WrongAdapter - if the reference was not created by the POA specified in the reference.
        WrongPolicy - declared to allow future extensions.
      • id_to_servant

        public Servant id_to_servant​(byte[] id)
                              throws ObjectNotActive,
                                     WrongPolicy
        id_to_servant 3.3.8.23
        Specified by:
        id_to_servant in interface POAOperations
        Parameters:
        id - object id for the which the servant is returned.
        Returns:
        servant associated with oid.
        Throws:
        ObjectNotActive - is raised if ObjectId is is not in the Active Object Map (for RETAIN policy), or no default servant is registered (for USE_DEFAULT_SERVANT policy).
        WrongPolicy - is raised if the RETAIN policy or the USE_DEFAULT_SERVANT policy is not present.
      • id

        public byte[] id()
        id 11.3.8.26 in ptc/00-08-06
        Specified by:
        id in interface POAOperations
        Returns:
        the unique id
      • getInterfaces

        public java.lang.String[] getInterfaces​(java.lang.Object servant,
                                                byte[] objectId)
        Description copied from interface: ObjectAdapter
        Return the most derived interface for the given servant and objectId.
        Specified by:
        getInterfaces in interface ObjectAdapter
        Specified by:
        getInterfaces in class ObjectAdapterBase
        Parameters:
        servant - servant object
        objectId - byte array forming the objectId
        Returns:
        list of derived interfaces
      • enter

        public void enter()
                   throws OADestroyed
        Description copied from interface: ObjectAdapter
        enter must be called before each request is invoked on a servant.
        Specified by:
        enter in interface ObjectAdapter
        Specified by:
        enter in class ObjectAdapterBase
        Throws:
        OADestroyed - is thrown when an OA has been destroyed, which requires a retry in the case where an AdapterActivator is present.
      • exit

        public void exit()
        Description copied from interface: ObjectAdapter
        exit must be called after each request has been completed. If enter is called and completes normally, there must always be a corresponding exit. If enter throw OADestroyed, exit must NOT be called.
        Specified by:
        exit in interface ObjectAdapter
        Specified by:
        exit in class ObjectAdapterBase
      • getInvocationCount

        @ManagedAttribute
        @Description("The current invocation count of this POA")
        private int getInvocationCount()
      • getInvocationServant

        public void getInvocationServant​(OAInvocationInfo info)
        Description copied from interface: ObjectAdapter
        Get the servant for the request given by the parameters. info must contain a valid objectId in this call. The servant is set in the InvocationInfo argument that is passed into this call.
        Specified by:
        getInvocationServant in interface ObjectAdapter
        Specified by:
        getInvocationServant in class ObjectAdapterBase
        Parameters:
        info - is the InvocationInfo object for the object reference
      • getLocalServant

        public Object getLocalServant​(byte[] objectId)
        Description copied from interface: ObjectAdapter
        Get the servant corresponding to the given objectId, if this is supported. This method is only used for models where the servant is an ObjectImpl, which allows the servant to be used directly as the stub. This allows an object reference to be replaced by its servant when it is unmarshalled locally. Such objects are not ORB mediated.
        Specified by:
        getLocalServant in interface ObjectAdapter
        Specified by:
        getLocalServant in class ObjectAdapterBase
        Parameters:
        objectId - byte array representing the object ID
        Returns:
        corresponding servant
      • returnServant

        public void returnServant()
        Called from the subcontract to let this POA cleanup after an invocation. Note: If getServant was called, then returnServant MUST be called, even in the case of exceptions. This may be called multiple times for a single request.
        Specified by:
        returnServant in interface ObjectAdapter
        Specified by:
        returnServant in class ObjectAdapterBase