IDriver Class Reference

This class exposes an interface to interact with the customer DSII for driver details. More...

Inherited by DSIDriver.

List of all members.

Public Types

typedef DSIDriverPropertyKey PropertyKeyType
 Typedef for a common name for the Enum for property keys in DSI interface classes.

Public Member Functions

virtual AutoPtr
< ICredentialFactory
CreateCredentialFactory ()=0
 Creates a credential factory for integrated security (Kerberos) credentials.
virtual Simba::DSI::IEnvironmentCreateEnvironment ()=0
 Factory method for creating IEnvironments.
virtual AutoPtr< UtilityFactoryCreateUtilityFactory ()=0
 Creates the UtilityFactory.
virtual const simba_wstringGetDriverLocation () const =0
 Gets the location of the driver DLL in the file system.
virtual ILoggerGetDriverLog ()=0
 Gets the driver-wide logging interface.
virtual Simba::DSI::DSIEventHandler GetEventHandler ()=0
 Return an event handler that will be invoked at different occasions as identified by the given event ID.
virtual simba_handle GetInstanceID ()=0
 Gets instance ID.
virtual SharedPtr< IMessageSourceGetMessageSource ()=0
 Gets the IMessageSource object.
virtual const AttributeDataGetProperty (Simba::DSI::DSIDriverPropertyKey in_key)=0
 Returns a driver property corresponding to the in_key.
virtual bool IsDriverUnloading ()=0
 Checks if the driver unloading flag has been set by a call to SetDriverUnloadingFlag().
virtual void SetDriverUnloadingFlag ()=0
 Sets a flag to indicate that the driver is being unloaded.
virtual void SetInstanceID (simba_handle in_instanceID)=0
 Sets instance ID.
virtual ~IDriver ()
 Destructor.

Protected Member Functions

 IDriver ()
 constructor.

Detailed Description

This class exposes an interface to interact with the customer DSII for driver details.


Member Typedef Documentation

Typedef for a common name for the Enum for property keys in DSI interface classes.


Constructor & Destructor Documentation

virtual ~IDriver (  )  [inline, virtual]

Destructor.

IDriver (  )  [inline, protected]

constructor.


Member Function Documentation

virtual AutoPtr<ICredentialFactory> CreateCredentialFactory (  )  [pure virtual]

Creates a credential factory for integrated security (Kerberos) credentials.

A new Credential Factory may be created per connection to construct new Credentials each time. This is only called if the DSI_DRIVER_SUPPORTS_INTEGRATED_SECURITY DSI Driver Property has been set.

Returns:
An ICredentialFactory. (OWN)

Implemented in DSIDriver.

virtual Simba::DSI::IEnvironment* CreateEnvironment (  )  [pure virtual]

Factory method for creating IEnvironments.

Returns:
New IEnvironment instance. (OWN)

Implemented in DSIDriver.

virtual AutoPtr<UtilityFactory> CreateUtilityFactory (  )  [pure virtual]

Creates the UtilityFactory.

The DSII must override DSIDriver::CreateUtilityFactory() to return their own UtilityFactory class if custom data types or data type behaviour is to be supported.

Returns:
A new UtilityFactory. (OWN)

Implemented in DSIDriver.

virtual const simba_wstring& GetDriverLocation (  )  const [pure virtual]

Gets the location of the driver DLL in the file system.

Returns:
The location of the driver DLL in the file system.

Implemented in DSIDriver.

virtual ILogger* GetDriverLog (  )  [pure virtual]

Gets the driver-wide logging interface.

Returns:
The driver-wide logging interface. (NOT OWN)

Implemented in DSIDriver.

virtual Simba::DSI::DSIEventHandler GetEventHandler (  )  [pure virtual]

Return an event handler that will be invoked at different occasions as identified by the given event ID.

The EventHandler should inspect the given event ID to determine which actions, if any should happen.

Returns:
An event handler, or NULL if no events should be handled.

Implemented in DSIDriver.

virtual simba_handle GetInstanceID (  )  [pure virtual]

Gets instance ID.

Returns:
Instance ID.

Implemented in DSIDriver.

virtual SharedPtr<IMessageSource> GetMessageSource (  )  [pure virtual]

Gets the IMessageSource object.

Returns:
The message source associated with the IDriver.

Implemented in DSIDriver.

virtual const AttributeData* GetProperty ( Simba::DSI::DSIDriverPropertyKey  in_key  )  [pure virtual]

Returns a driver property corresponding to the in_key.

Please refer to the DSI Design and Implementation Guide for detailed information on the supported properties.

Parameters:
in_key Driver property key supported by DSI
Returns:
The driver property corresponding to the in_key. (NOT OWN)

Implemented in DSIDriver.

virtual bool IsDriverUnloading (  )  [pure virtual]

Checks if the driver unloading flag has been set by a call to SetDriverUnloadingFlag().

Returns:
True if the driver is being unloaded; false otherwise.

Implemented in DSIDriver.

virtual void SetDriverUnloadingFlag (  )  [pure virtual]

Sets a flag to indicate that the driver is being unloaded.

This should only be called by the owner of the driver (In the ODBC layer during Driver destruction).

Implemented in DSIDriver.

virtual void SetInstanceID ( simba_handle  in_instanceID  )  [pure virtual]

Sets instance ID.

Parameters:
in_instanceID Instance ID.

Implemented in DSIDriver.


The documentation for this class was generated from the following file:

Generated on Wed May 17 14:21:15 2017 for SimbaEngine 10.1.3.1011 by simba