| |||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface POAOperations
A POA object manages the implementation of a collection of objects. The POA supports a name space for the objects, which are identified by Object Ids. A POA also provides a name space for POAs. A POA is created as a child of an existing POA, which forms a hierarchy starting with the root POA. A POA object must not be exported to other processes, or externalized with ORB::object_to_string.
Method Summary | |
---|---|
byte[] |
activate_object(Servant p_servant) This operation generates an Object Id and enters the Object Id and the specified servant in the Active Object Map. |
void |
activate_object_with_id(byte[] id, Servant p_servant) This operation enters an association between the specified Object Id and the specified servant in the Active Object Map. |
IdAssignmentPolicy |
These operations each return a reference to a policy object with the specified value. |
IdUniquenessPolicy |
These operations each return a reference to a policy object with the specified value. |
ImplicitActivationPolicy |
These operations each return a reference to a policy object with the specified value. |
LifespanPolicy |
These operations each return a reference to a policy object with the specified value. |
POA |
create_POA(String adapter_name, POAManager a_POAManager, Policy[] policies) This operation creates a new POA as a child of the target POA. |
Object |
create_reference(String intf) This operation creates an object reference that encapsulates a POA-generated Object Id value and the specified interface repository id. |
Object |
create_reference_with_id(byte[] oid, String intf) This operation creates an object reference that encapsulates the specified Object Id and interface repository Id values. |
RequestProcessingPolicy |
These operations each return a reference to a policy object with the specified value. |
ServantRetentionPolicy |
These operations each return a reference to a policy object with the specified value. |
ThreadPolicy |
These operations each return a reference to a policy object with the specified value. |
void |
deactivate_object(byte[] oid) This operation causes the ObjectId specified in the oid parameter to be deactivated. |
void |
destroy(boolean etherealize_objects, boolean wait_for_completion) This operation destroys the POA and all descendant POAs. |
POA |
If the target POA is the parent of a child POA with the specified name (relative to the target POA), that child POA is returned. |
Servant |
This operation returns the default servant associated with the POA. |
ServantManager |
If the ServantRetentionPolicy of the POA is RETAIN, then the ServantManager argument (imgr) shall support the ServantActivator interface. |
byte[] |
id() This returns the unique id of the POA in the process in which it is created. |
Object |
id_to_reference(byte[] oid) If an object with the specified Object Id value is currently active, a reference encapsulating the information used to activate the object is returned. |
Servant |
id_to_servant(byte[] oid) If the POA has the RETAIN policy and the specified ObjectId is in the Active Object Map, this operation returns the servant associated with that object in the Active Object Map. |
byte[] |
reference_to_id(Object reference) This operation returns the Object Id value encapsulated by the specified reference. |
Servant |
reference_to_servant(Object reference) If the POA has the RETAIN policy and the specified object is present in the Active Object Map, this operation returns the servant associated with that object in the Active Object Map. |
byte[] |
servant_to_id(Servant p_servant) This operation has four possible behaviors. |
Object |
servant_to_reference(Servant p_servant) This operation requires the RETAIN policy and either the UNIQUE_ID or IMPLICIT_ACTIVATION policies if invoked outside the context of an operation dispatched by this POA. |
void |
set_servant(Servant p_servant) This operation registers the specified servant with the POA as the default servant. |
void |
This operation sets the default servant manager associated with the POA. |
AdapterActivator |
This attribute identifies the adapter activator associated with the POA. |
void |
the_activator(AdapterActivator newThe_activator) This attribute identifies the adapter activator associated with the POA. |
POA[] |
This attribute identifies the current set of all child POAs of the POA. |
String |
the_name() This attribute identifies the POA relative to its parent. |
POA |
This attribute identifies the parent of the POA. |
POAManager |
This attribute identifies the POA manager associated with the POA. |
Method Detail |
---|
public byte[] activate_object(Servant p_servant) throws ServantAlreadyActive, WrongPolicy
p_servant
- servant to be associated with an
object to be activated.ServantAlreadyActive
WrongPolicy
public void activate_object_with_id(byte[] id, Servant p_servant) throws ServantAlreadyActive, ObjectAlreadyActive, WrongPolicy
id
- object id for the object to be activated.p_servant
- servant to be associated with the
object.ServantAlreadyActive
ObjectAlreadyActive
WrongPolicy
public IdAssignmentPolicy create_id_assignment_policy(IdAssignmentPolicyValue value)
value
- policy typepublic IdUniquenessPolicy create_id_uniqueness_policy(IdUniquenessPolicyValue value)
value
- policy typepublic ImplicitActivationPolicy create_implicit_activation_policy(ImplicitActivationPolicyValue value)
value
- policy typepublic LifespanPolicy create_lifespan_policy(LifespanPolicyValue value)
value
- policy typepublic POA create_POA(String adapter_name, POAManager a_POAManager, Policy[] policies) throws AdapterAlreadyExists, InvalidPolicy
adapter_name
- identifies the new POA with
respect to other POAs with the same parent POA.a_POAManager
- 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.AdapterAlreadyExists
InvalidPolicy
public Object create_reference(String intf) throws WrongPolicy
intf
- rep id for creating an object reference.WrongPolicy
public Object create_reference_with_id(byte[] oid, String intf)
oid
- object id for creating an objrefintf
- rep id for creating an objrefpublic RequestProcessingPolicy create_request_processing_policy(RequestProcessingPolicyValue value)
value
- policy typepublic ServantRetentionPolicy create_servant_retention_policy(ServantRetentionPolicyValue value)
value
- policy typepublic ThreadPolicy create_thread_policy(ThreadPolicyValue value)
value
- policy typepublic void deactivate_object(byte[] oid) throws ObjectNotActive, WrongPolicy
oid
- Object Id for the object to be deactivated.ObjectNotActive
WrongPolicy
public void destroy(boolean etherealize_objects, boolean wait_for_completion)
etherealize_objects
- 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.public POA find_POA(String adapter_name, boolean activate_it) throws AdapterNonExistent
adapter_name
- POA name to be found.activate_it
- 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.AdapterNonExistent
public Servant get_servant() throws NoServant, WrongPolicy
NoServant
WrongPolicy
public ServantManager get_servant_manager() throws WrongPolicy
WrongPolicy
public byte[] id()
This id is guaranteed unique for the life span of the POA in the process. For persistent POAs, this means that if a POA is created in the same path with the same name as another POA, these POAs are identical and, therefore, have the same id. For transient POAs, each POA is unique.
public Object id_to_reference(byte[] oid) throws ObjectNotActive, WrongPolicy
oid
- id of the object for which the
reference is returned.ObjectNotActive
WrongPolicy
public Servant id_to_servant(byte[] oid) throws ObjectNotActive, WrongPolicy
oid
- object id for the which the servant is
returned.ObjectNotActive
WrongPolicy
public byte[] reference_to_id(Object reference) throws WrongAdapter, WrongPolicy
reference
- the object reference from which the
object id needs to be returned.WrongAdapter
WrongPolicy
public Servant reference_to_servant(Object reference) throws ObjectNotActive, WrongPolicy, WrongAdapter
reference
- object reference for which the
servant is returned.ObjectNotActive
WrongPolicy
WrongAdapter
public byte[] servant_to_id(Servant p_servant) throws ServantNotActive, WrongPolicy
p_servant
- servant for which the object disi returned.ServantNotActive
WrongPolicy
public Object servant_to_reference(Servant p_servant) throws ServantNotActive, WrongPolicy
p_servant
- servant for which the object reference
needs to be obtained.ServantNotActive
WrongPolicy
public void set_servant(Servant p_servant) throws WrongPolicy
p_servant
- servant to be used as a default.WrongPolicy
public void set_servant_manager(ServantManager imgr) throws WrongPolicy
imgr
- servant manager to be used as a default.WrongPolicy
public AdapterActivator the_activator()
public void the_activator(AdapterActivator newThe_activator)
newThe_activator
public POA[] the_children()
public String the_name()
public POA the_parent()
public POAManager the_POAManager()
| |||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |