Index

dkService

Purpose:

The dkService class provides a generic interface to service object functions. It must be subclassed for each datastore implementation.

Class summary:

class DKEXPORT dkService
 {
   public:
    dkService(const char* service_type,
              const char* service_name = "");
    virtual ~dkService();
    virtual void connect (const char* service_name,
                          const char* user_name = "",
                          const char* authentication = "",
                          const char* connect_string = "");
    virtual void disconnect();
    virtual DKBoolean isConnected();
    virtual DKString  serviceName() const;
    virtual DKString  serviceType() const;
    virtual DKString  serviceId() const;
    virtual DKString  serviceCategory() const;
    virtual DKString  userName() const;
    virtual DKHandle* connection();
    virtual dkExtension* getExtension(const char* extensionName);
    virtual void addExtension(const char* extensionName,
                              dkExtension* extensionObj);
    virtual void removeExtension(const char* extensionName);
    virtual DKString* listExtensionNames(long& arraySize);
    virtual void setServiceName(const char* serviceName);
    virtual void setUserName(const char* username);
 };

Members:

Constructors and destructor
dkService(const char* service_type,
const char* service_name = "");
virtual ~dkService(); 

Member functions

connect
Connects to the named service.
virtual void connect (const char* service_name,                                      const char* user_name = "",
const char* authentication = "",                const char* connect_string = "");

disconnect
Disconnects from the service.
virtual void disconnect();

isConnected
Returns the connection status of the service.
virtual DKBoolean isConnected();

serviceName
Returns the name of the service.
virtual DKString serviceName() const;

serviceType
Returns the type of the service.
virtual DKString serviceType() const;

serviceId
Returns the id of the service.
virtual DKString serviceId() const;

serviceCategory
Returns the category of the service.
virtual DKString serviceCategory() const;

userName
Returns the user name.
virtual DKString  userName() const;

connection
Returns the connection handle of the service.
virtual DKHandle* connection();

getExtension
Gets the extension object from a given extenstion name.
virtual dkExtension* getExtension(const char* extensionName);

addExtension
Adds a new extension object.
virtual void addExtension(const char* extensionName, dkExtension* extensionObj);

removeExtension
Removes an existing extension object.
virtual void removeExtension(const char* extensionName);

listExtensionNames
Gets the list of extension objects' names.
virtual DKString* listExtensionNames(long& arraySize);
 
The arraySize will contain the number of elements in the returned array.
 

setServiceName
Sets the name of the service.
virtual DKString serviceCategory() const;

setUserName
Sets the name of the user.
virtual void setUserName(const char* username);

(c) Copyright International Business Machines Corporation 1996, 2003. IBM Corp. All rights reserved.