com.sun.corba.se.impl.oa.poa

Class POAImpl

java.lang.Object

org.omg.CORBA.LocalObject

com.sun.corba.se.spi.oa.ObjectAdapterBase

com.sun.corba.se.impl.oa.poa.POAImpl

All Implemented Interfaces:

ObjectAdapter, Serializable, Object, IDLEntity, POA, POAOperations

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 Summary

Fields

Modifier and Type	Field and Description
protected ThreadLocal	isDestroying

Method Summary

Modifier and Type	Method and Description
void	activate_object_with_id(byte[] id, Servant servant) activate_object_with_id Section 3.3.8.15
byte[]	activate_object(Servant servant) activate_object Section 3.3.8.14
IdAssignmentPolicy	create_id_assignment_policy(IdAssignmentPolicyValue value) create_id_assignment_policy Section 3.3.8.5
IdUniquenessPolicy	create_id_uniqueness_policy(IdUniquenessPolicyValue value) create_id_uniqueness_policy Section 3.3.8.5
ImplicitActivationPolicy	create_implicit_activation_policy(ImplicitActivationPolicyValue value) create_implicit_activation_policy Section 3.3.8.5
LifespanPolicy	create_lifespan_policy(LifespanPolicyValue value) create_lifespan_policy Section 3.3.8.5
POA	create_POA(String name, POAManager theManager, Policy[] policies) create_POA Section 3.3.8.2
Object	create_reference_with_id(byte[] oid, String repId) create_reference_with_id 3.3.8.18
Object	create_reference(String repId) create_reference 3.3.8.17
RequestProcessingPolicy	create_request_processing_policy(RequestProcessingPolicyValue value) create_request_processing_policy Section 3.3.8.5
ServantRetentionPolicy	create_servant_retention_policy(ServantRetentionPolicyValue value) create_servant_retention_policy Section 3.3.8.5
ThreadPolicy	create_thread_policy(ThreadPolicyValue value) create_thread_policy Section 3.3.8.5
void	deactivate_object(byte[] id) deactivate_object 3.3.8.16
void	destroy(boolean etherealize, boolean wait_for_completion) destroy Section 3.3.8.4
void	enter() enter must be called before each request is invoked on a servant.
void	exit() exit must be called after each request has been completed.
POA	find_POA(String name, boolean activate) find_POA Section 3.3.8.3
ServantManager	get_servant_manager() get_servant_manager Section 3.3.8.10
Servant	get_servant() get_servant Section 3.3.8.12
Policy	getEffectivePolicy(int type)
String[]	getInterfaces(Object servant, byte[] objectId) Return the most derived interface for the given servant and objectId.
void	getInvocationServant(OAInvocationInfo info) Get the servant for the request given by the parameters.
Object	getLocalServant(byte[] objectId) Get the servant corresponding to the given objectId, if this is supported.
int	getManagerId() Return the ID of the AdapterManager for this object adapter.
protected ObjectCopierFactory	getObjectCopierFactory()
short	getState() Return the current state of this object adapter (see org.omg.PortableInterceptors for states.
Object	id_to_reference(byte[] id) id_to_reference 3.3.8.24
Servant	id_to_servant(byte[] id) id_to_servant 3.3.8.23
byte[]	id() id 11.3.8.26 in ptc/00-08-06
byte[]	reference_to_id(Object reference) reference_to_id 3.3.8.22
Servant	reference_to_servant(Object reference) reference_to_servant 3.3.8.21
void	returnServant() Called from the subcontract to let this POA cleanup after an invocation.
byte[]	servant_to_id(Servant servant) servant_to_id 3.3.8.19
Object	servant_to_reference(Servant servant) servant_to_reference 3.3.8.20
void	set_servant_manager(ServantManager servantManager) set_servant_manager Section 3.3.8.10
void	set_servant(Servant defaultServant) set_servant Section 3.3.8.13
AdapterActivator	the_activator() the_activator Section 3.3.8.9
void	the_activator(AdapterActivator activator) the_activator Section 3.3.8.9
POA[]	the_children() the_children
String	the_name() the_name Section 3.3.8.6
POA	the_parent() the_parent Section 3.3.8.7
POAManager	the_POAManager() the_POAManager Section 3.3.8.8
String	toString()

Methods inherited from class com.sun.corba.se.spi.oa.ObjectAdapterBase

getAdapterId, getAdapterTemplate, getCurrentFactory, getIORTemplate, getORB, initializeTemplate, invocationWrapper, iorWrapper, lifecycleWrapper, makeInvocationInfo, makeObject, omgInvocationWrapper, omgLifecycleWrapper, setCurrentFactory

Methods inherited from class org.omg.CORBA.LocalObject

_create_request, _create_request, _duplicate, _get_domain_managers, _get_interface_def, _get_interface, _get_policy, _hash, _invoke, _is_a, _is_equivalent, _is_local, _non_existent, _orb, _release, _releaseReply, _request, _request, _servant_postinvoke, _servant_preinvoke, _set_policy_override, validate_connection

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.omg.CORBA.Object

_create_request, _create_request, _duplicate, _get_domain_managers, _get_interface_def, _get_policy, _hash, _is_a, _is_equivalent, _non_existent, _release, _request, _set_policy_override

Field Detail

isDestroying

protected ThreadLocal isDestroying

Method Detail

toString

public String toString()

Overrides:

toString in class Object

create_POA

public POA create_POA(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.

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

public POA find_POA(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:

POA if one exists or is activated by the AdapterActivator.

Throws:

AdapterNonExistent

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.

create_thread_policy

public ThreadPolicy create_thread_policy(ThreadPolicyValue value)

create_thread_policy Section 3.3.8.5

Specified by:

create_thread_policy in interface POAOperations

Parameters:

value - policy type

Returns:

ThreadPolcy Object

create_lifespan_policy

public LifespanPolicy create_lifespan_policy(LifespanPolicyValue value)

create_lifespan_policy Section 3.3.8.5

Specified by:

create_lifespan_policy in interface POAOperations

Parameters:

value - policy type

Returns:

LifespanPolicy Object.

create_id_uniqueness_policy

public IdUniquenessPolicy create_id_uniqueness_policy(IdUniquenessPolicyValue value)

create_id_uniqueness_policy Section 3.3.8.5

Specified by:

create_id_uniqueness_policy in interface POAOperations

Parameters:

value - policy type

Returns:

IdUniquenessPolicy Object.

create_id_assignment_policy

public IdAssignmentPolicy create_id_assignment_policy(IdAssignmentPolicyValue value)

create_id_assignment_policy Section 3.3.8.5

Specified by:

create_id_assignment_policy in interface POAOperations

Parameters:

value - policy type

Returns:

IdAssignmentPolicy Object.

create_implicit_activation_policy

public ImplicitActivationPolicy create_implicit_activation_policy(ImplicitActivationPolicyValue value)

create_implicit_activation_policy Section 3.3.8.5

Specified by:

create_implicit_activation_policy in interface POAOperations

Parameters:

value - policy type

Returns:

ImplicitActivationPolicy Object.

create_servant_retention_policy

public ServantRetentionPolicy create_servant_retention_policy(ServantRetentionPolicyValue value)

create_servant_retention_policy Section 3.3.8.5

Specified by:

create_servant_retention_policy in interface POAOperations

Parameters:

value - policy type

Returns:

ServantRetentionPolicy Object.

create_request_processing_policy

public RequestProcessingPolicy create_request_processing_policy(RequestProcessingPolicyValue value)

create_request_processing_policy Section 3.3.8.5

Specified by:

create_request_processing_policy in interface POAOperations

Parameters:

value - policy type

Returns:

RequestProcessingPolicy Object.

the_name

public String the_name()

the_name Section 3.3.8.6

Specified by:

the_name in interface POAOperations

the_parent

public POA the_parent()

the_parent Section 3.3.8.7

Specified by:

the_parent in interface POAOperations

the_children

public POA[] the_children()

the_children

Specified by:

the_children in interface POAOperations

the_POAManager

public POAManager the_POAManager()

the_POAManager Section 3.3.8.8

Specified by:

the_POAManager in interface POAOperations

the_activator

public AdapterActivator the_activator()

the_activator Section 3.3.8.9

Specified by:

the_activator in interface POAOperations

the_activator

public void the_activator(AdapterActivator 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:

ServantManager associated with a POA or null if none exists.

Throws:

WrongPolicy - raised if the USE_SERVANT_MANAGER policy is not specified.

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.

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.

activate_object_with_id

public void activate_object_with_id(byte[] id,
                                    Servant servant)
                             throws ObjectAlreadyActive,
                                    ServantAlreadyActive,
                                    WrongPolicy

activate_object_with_id Section 3.3.8.15

Specified by:

activate_object_with_id in interface POAOperations

Parameters:

id - object id for the object to be activated.

servant - servant to be associated with the object.

Throws:

ObjectAlreadyActive - raised if the object is already active in the POA.

ServantAlreadyActive - raised if the POA has the UNIQUE_ID policy and the servant is already in the Active Object Map.

WrongPolicy - raised if the RETAIN policy is is 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(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,
                                       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_to_reference

public Object id_to_reference(byte[] id)
                       throws ObjectNotActive,
                              WrongPolicy

id_to_reference 3.3.8.24

Specified by:

id_to_reference in interface POAOperations

Parameters:

id - id of the object for which the reference is returned.

Returns:

the object reference

Throws:

ObjectNotActive - if the Object Id value is not active in the POA.

WrongPolicy - if the RETAIN policy is not present.

id

public byte[] id()

id 11.3.8.26 in ptc/00-08-06

Specified by:

id in interface POAOperations

getEffectivePolicy

public Policy getEffectivePolicy(int type)

Specified by:

getEffectivePolicy in interface ObjectAdapter

Specified by:

getEffectivePolicy in class ObjectAdapterBase

getManagerId

public int getManagerId()

Description copied from interface: ObjectAdapter

Return the ID of the AdapterManager for this object adapter.

Specified by:

getManagerId in interface ObjectAdapter

Specified by:

getManagerId in class ObjectAdapterBase

getState

public short getState()

Description copied from interface: ObjectAdapter

Return the current state of this object adapter (see org.omg.PortableInterceptors for states.

Specified by:

getState in interface ObjectAdapter

Specified by:

getState in class ObjectAdapterBase

getInterfaces

public String[] getInterfaces(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

getObjectCopierFactory

protected ObjectCopierFactory getObjectCopierFactory()

Specified by:

getObjectCopierFactory in class ObjectAdapterBase

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, there must always be a corresponding exit.

Specified by:

exit in interface ObjectAdapter

Specified by:

exit in class ObjectAdapterBase

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

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