VisiBroker for Java

org.omg.PortableInterceptor
Interface IORInfoOperations

All Known Subinterfaces:
IORInfo

public interface IORInfoOperations

Provides the server-side ORB service with access to the applicable policies during IOR construction and the ability to add components. The ORB passes an instance of its implementation of this interface as a parameter to IORInterceptor::establish_components().

The table below defines the validity of each attribute or method in IORInfo in the methods defined in the IORInterceptor.

establish_components components_established
get_effective_policy yes yes
add_component yes no
add_component_to_profile yes no
manager_id yes yes
state yes yes
adapter_template no yes
current_factory no yes


Method Summary
 ObjectReferenceTemplate adapter_template()
          This method returns the attribute that provides a means to obtain an object reference template whenever an IOR interceptor is invoked.
 void add_ior_component_to_profile(TaggedComponent a_component, int profile_id)
          This method is called from establish_components() to add a tagged component to the set which will be included when constructing IORs.
 void add_ior_component(TaggedComponent a_component)
          This method is called from establish_components() to add a tagged component to the set which will be included when constructing IORs.
 ObjectReferenceFactory current_factory()
          This method returns/sets the attribute, provides access to the factory that will be used by the adapter to create object references.
 void current_factory(ObjectReferenceFactory arg0)
          This method returns/sets the attribute, provides access to the factory that will be used by the adapter to create object references.
 Policy get_effective_policy(int type)
          An ORB service implementation may determine what server side policy of a particular type is in effect for an IOR being constructed by calling the get_effective_policy() method.
 java.lang.String manager_id()
          This method returns the attribute that provides an opaque handle to the manager of the adapter.
 short state()
          This method returns the current state of the adapter.
 

Method Detail

add_ior_component_to_profile

void add_ior_component_to_profile(TaggedComponent a_component,
                                  int profile_id)
This method is called from establish_components() to add a tagged component to the set which will be included when constructing IORs. The components in this set will be included in the specified profile. Any number of components may exist with the same component ID.

If the given profile ID does not define a known profile or it is impossible to add components to that profile, BAD_PARAM is raised with a standard minor code of 29.

Parameters:
a_component - The IOP::TaggedComponent to be added.
profile_id - The IOP::ProfileId of the profile to which this component will be added.

add_ior_component

void add_ior_component(TaggedComponent a_component)
This method is called from establish_components() to add a tagged component to the set which will be included when constructing IORs. The components in this set will be included in all profiles. Any number of components may exist with the same component ID.

Parameters:
a_component - The IOP::TaggedComponent to be added.

current_factory

ObjectReferenceFactory current_factory()
This method returns/sets the attribute, provides access to the factory that will be used by the adapter to create object references. current_factory() initially has the same value as the adapter_template attribute, but this can be changed by setting current_factory to another factory. All object references created by the object adapter must be created by calling the make_object() method on current_factory.


current_factory

void current_factory(ObjectReferenceFactory arg0)
This method returns/sets the attribute, provides access to the factory that will be used by the adapter to create object references. current_factory() initially has the same value as the adapter_template attribute, but this can be changed by setting current_factory to another factory. All object references created by the object adapter must be created by calling the make_object() method on current_factory.


adapter_template

ObjectReferenceTemplate adapter_template()
This method returns the attribute that provides a means to obtain an object reference template whenever an IOR interceptor is invoked. There is no standard way to directly create an object reference template. The value of adapter_template() returns is the template created for the adapter policies and IOR interceptor calls to add_component() and add_component_to_profile(). The value of the adapter_template() returns is never changed for the lifetime of the object adapter.

Returns:
object reference template

state

short state()
This method returns the current state of the adapter. This must be one of HOLDING, ACTIVE, DISCARDING, INACTIVE, NON_EXISTENT.

Returns:
state of the adapter

manager_id

java.lang.String manager_id()
This method returns the attribute that provides an opaque handle to the manager of the adapter. This is used for reporting state changes in adapters managed by the same adapter manager.


get_effective_policy

Policy get_effective_policy(int type)
An ORB service implementation may determine what server side policy of a particular type is in effect for an IOR being constructed by calling the get_effective_policy() method. When the IOR being constructed is for an object implemented using a POA, all Policy objects passed to the PortableServer::POA::create_POA() call that created that POA are accessible through get_effective_policy.

If a policy for the given type is not known to the ORB, then this method will raise INV_POLICY with a standard minor code of 3.

Parameters:
type - The CORBA::PolicyType specifying the type of policy to return.
Returns:
CORBA::Policy

Borland Software Corporation
http://www.borland.com
100 Enterprise Way
Scotts Valley, CA 95066
Voice: (831) 431-1000
pubsweb@borland.com

Read the latest documentation online