Interface OCI::ConFactory

interface ConFactory

A factory for Connector objects.

See Also:
Connector
ConFactoryRegistry


Attribute Index

tag
The profile id tag.

Operation Index

consider_with_policies
Determines whether this Connector factory can create a Connector for a given IOR and a given list of policies.
create
Creates a new Connector for a given IOR.
create_with_policies
Creates a new Connector for a given IOR, satisfing a list of policies.
equivalent
Checks whether two IORs are equivalent, taking only profiles into account matching this Connector factory.
get_info
Returns the information object associated with the Connector factory.
hash
Calculates a hash value for an IOR.

Attributes

tag
readonly attribute ProfileId tag;

The profile id tag.



Operations

consider_with_policies
boolean consider_with_policies(in IOR ior,
                               in CORBA::PolicyList policies);

Determines whether this Connector factory can create a Connector for a given IOR and a given list of policies.

Parameters:
ior - The IOR to consider.
policies - The policies that must be satisfied.
Returns:
TRUE if a Connector can be created for the IOR and the policies can be satisfied, FALSE otherwise.

create
Connector create(in IOR ior);

Creates a new Connector for a given IOR. All connection specific data is taken from an IOR profile that matches this Connector factory. If more than one profile matches, then which of these profiles is used is implementation specific.

Parameters:
ior - The IOR from which the profile and connection data are extracted.
Returns:
The new Connector. A nil object reference is returned if the IOR does not contain a profile which matches this Connector factory.

create_with_policies
Connector create_with_policies(in IOR ior,
                               in CORBA::PolicyList policies);

Creates a new Connector for a given IOR, satisfing a list of policies. Like create, all connection specific data is taken from an IOR profile that matches this Connector factory, and if more than one profile matches, then which of these profiles is used is implementation specific.

Parameters:
ior - The IOR from which the profile and connection data are extracted.
policies - The policies that must be satisfied.
Returns:
The new Connector. A nil object reference is returned if the IOR does not contain a profile which matches this Connector factory or if the policies cannot be satisfied.

equivalent
boolean equivalent(in IOR ior1,
                   in IOR ior2);

Checks whether two IORs are equivalent, taking only profiles into account matching this Connector factory.

Parameters:
ior1 - The first IOR to check for equivalence.
ior2 - The second IOR to check for equivalence.
Returns:
TRUE if the IORs are equivalent, FALSE otherwise.

get_info
ConFactoryInfo get_info();

Returns the information object associated with the Connector factory.

Returns:
The Connnector factory information object.

hash
unsigned long hash(in IOR ior,
                   in unsigned long maximum);

Calculates a hash value for an IOR.

Parameters:
ior - The IOR to calculate a hash value for.
maximum - The maximum value of the hash value.
Returns:
The hash value.


Generated by the ORBacus IDL-to-HTML translator (non-commercial)