Storing XTC files in Config DB

The following classes were created:

• BdbConfigTestXTC.[ ddl | cc ] - Persistent class to store the data from odfTestXTC
• BdbConfigTestXTCTransient.[ hh | cc ] - Transient class
• BdbConfigTestXTCTCProxy.[ hh | cc ] - A TC proxy class. Returns an XTC object from a persistent object
• BdbConfigTestXTCTCProxyLoader.[ hh | cc ] - A class to load the TC Proxy in the corresponding proxy dict.

Create persistent class

• Create a ddl file similar to BdbConfigTests/BdbConfigTestXTC.ddl to store the data of the XTC class.
• Inherit from BdbConfigObject:

    class BdbConfigTestXTC : public BdbConfigObject {

• provide create static method:

    // factory method
    static 
    BdbHandle(BdbConfigTestXTC) create(const BdbConfigTestXTCTransient& transient,
                                       BdbConfigWriter* theDatabase,
                                       const char* secKey = 0);

• provide a copy method:

    // Copy object 
    virtual BdbStatus copy(const BdbHandle(BdbConfigContObj)& containerH,
                           BdbHandle(BdbConfigObject)& newObjectH);

• Provide a method to return a transient class:

    // create transient copy
    BdbConfigTestXTCTransient* transient() const;

Create transient class

• Create a transient class based on the persistent-capable class. It is needed by the transient method of the persistent class.

Create TC Proxy class

• Inherit from BdbConfigTCProxy base class:

    class BdbConfigTestXTCTCProxy
    : public BdbConfigTCProxy< odfTestXTC, BdbConfigTestXTC > 
    {

• Provide the following constructor:

    //  Constructor takes a pointer to BdbConfigCache; ownership is taken
    //  The size for the arena can be supplied too
    //
    BdbConfigTestXTCTCProxy(BdbConfigCache* theCache,
                            size_t arenaSize = 10240);

• Provide a fillXTC method to create and return the XTC class from the persistent class:

    /**
    *  This method allocates XTC inside the Arena. XTC must be the first and
    *  only datum inside the arena, i.e.:
    *    - XTC pointer must match arena's base()
    *    - XTC's extent must match arena's used()
    */
    virtual odfTestXTC* fillXTC(const BdbHandle(BdbConfigTestXTC)& pObject, 
                                const RdfConfigKey& rdfKey,
                                odfArena& theArena);

Create TC Proxy Loader class

• Inherit from BdbTCProxyLoader base class:

    /** The purpose of BdbConfigTestXTCTCProxyLoader is to instantiate all
    * persistent objects that are going to be accessed by the
    * application in vtables() method (to ensure that vtables are
    * loaded), and to register all necessary proxies (such as proxies
    * for the tagged containers) in the proxies() method
    * */

    class BdbConfigTestXTCTCProxyLoader : public BdbTCProxyLoader
    {

• Provide proxies method:

    /**
    * load proxies
    */
    virtual bool proxies( BdbTCProxyDict* dict );

Instantiate new class to load vtables

• In BdbConfigTestsInstantiate.cc add:

#include "BdbConfigTests/BdbConfigTestXTC.hh"

...

    BdbConfigTestXTC temp;

Modify BdbTCServer to load new Proxy

• Add the new class in BdbTCAppBuild.cc

#include "BdbConfigTests/BdbConfigTestXTCTCProxyLoader.hh"

...

  // loads config TCs for odfTestXTC
  forWho->add(new BdbConfigTestXTCTCProxyLoader() );

• Add package (if new) in link_BdbTCServer.mk and bin_BdbTCServer.mk

Write application to store objects in the Configuration database

• See BdbConfigWriteTestXTC.cc.

To test the new class:

• Build the createFileTable application in BdbTCServer
• Run createFileTable to create an XTC file from your configuration object.