POAOperations (Java 2 Platform SE 5.0)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

Java^TM 2 Platform
Standard Ed. 5.0

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.omg.PortableServer
Interface POAOperations

All Known Subinterfaces:: POA

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
`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.
`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.
`IdAssignmentPolicy`	`create_id_assignment_policy(IdAssignmentPolicyValue value)` These operations each return a reference to a policy object with the specified value.
`IdUniquenessPolicy`	`create_id_uniqueness_policy(IdUniquenessPolicyValue value)` These operations each return a reference to a policy object with the specified value.
`ImplicitActivationPolicy`	`create_implicit_activation_policy(ImplicitActivationPolicyValue value)` These operations each return a reference to a policy object with the specified value.
`LifespanPolicy`	`create_lifespan_policy(LifespanPolicyValue value)` 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_with_id(byte[] oid, String intf)` This operation creates an object reference that encapsulates the specified Object Id and interface repository Id values.
`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.
`RequestProcessingPolicy`	`create_request_processing_policy(RequestProcessingPolicyValue value)` These operations each return a reference to a policy object with the specified value.
`ServantRetentionPolicy`	`create_servant_retention_policy(ServantRetentionPolicyValue value)` These operations each return a reference to a policy object with the specified value.
`ThreadPolicy`	`create_thread_policy(ThreadPolicyValue value)` 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`	`find_POA(String adapter_name, boolean activate_it)` 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.
`ServantManager`	`get_servant_manager()` If the ServantRetentionPolicy of the POA is RETAIN, then the ServantManager argument (imgr) shall support the ServantActivator interface.
`Servant`	`get_servant()` This operation returns the default servant associated with the POA.
`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[]`	`id()` This returns the unique id of the POA in the process in which it is created.
`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_manager(ServantManager imgr)` This operation sets the default servant manager associated with the POA.
`void`	`set_servant(Servant p_servant)` This operation registers the specified servant with the POA as the default servant.
`AdapterActivator`	`the_activator()` 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[]`	`the_children()` 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`	`the_parent()` This attribute identifies the parent of the POA.
`POAManager`	`the_POAManager()` This attribute identifies the POA manager associated with the POA.

Method Detail

create_POA

POA create_POA(String adapter_name,
               POAManager a_POAManager,
               Policy[] policies)
               throws AdapterAlreadyExists,
                      InvalidPolicy

This operation creates a new POA as a child of the target POA.

Parameters:: 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.
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.

find_POA

POA find_POA(String adapter_name,
             boolean activate_it)
             throws AdapterNonExistent

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.

Parameters:: 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.
Returns:: POA if one exists or is activated by the AdapterActivator.
Throws:: AdapterNonExistent

destroy

void destroy(boolean etherealize_objects,
             boolean wait_for_completion)

This operation destroys the POA and all descendant POAs. All descendant POAs are destroyed (recursively) before the destruction of the containing POA. The POA so destroyed (that is, the POA with its name) may be re-created later in the same process.

Parameters:: 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.