CORBA Programming Reference

Tobj::Factoryfinder::list_factories

Synopsis

Obtains a list of factory objects currently registered with the FactoryFinder.

C++ Mapping

virtual FactoryListing * list_factories() = 0;

Java Mapping

public com.beasys.Tobj.FactoryComponent[] list_factories()
  throws
      com.beasys.Tobj.CannotProceed,
       com.beasys.Tobj.RegistrarNotAvailable;

Exception

Indicates that the FactoryFinder or NameManager encountered an internal error while attempting to locate a reference for a factory object.

Error information is written to the user log.

Indicates that the FactoryFinder could not communicate with the NameManager.

Error information is written to the user log.

Description

The list_factories method is called by an application to obtain a list of the factory objects currently registered with the FactoryFinder. The method returns both the key used to register the factory, as well as a reference to the factory object.

The number of factories returned by list_factories will be one more than the ones registered by the user. For example, if the user registered four factories then the number of factories returned by list_factories will be five.

Note: This change in behavior is because the OMG Transaction Service specification version 1.1 in section 2.1.2 specifies that the Transaction Factory is located using the FactoryFinder interface of the Life Cycle Service. Hence the Transaction factory is registered internally by the product with the FactoryFinder.

Return Values

An unbounded sequence of Tobj::FactoryComponent. Each occurrence of a Tobj::FactoryComponent in the sequence contains a reference to the registered factory object, as well as the CosLifeCycle::Key that was used to register that factory object.

If the operation raises an exception, the return value is invalid and does not need to be released by the caller.

Automation Methods

This section describes the DITobj_FactoryFinder Automation methods.

DI

exceptionInfo

An optional input argument that enables the application to get additional exception data if an error occurred.