DSIDriver Class Reference

DSIDriver class. More...

Inherits Simba::DSI::IDriver.

List of all members.

Public Member Functions

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

Protected Member Functions

 DSIDriver ()
 Constructor.
void SetProperty (Simba::DSI::DSIDriverPropertyKey in_key, AttributeData *in_value)
 Sets a property value.

Protected Attributes

CriticalSection m_criticalsection
AutoPtr< ILoggerm_driverlog
DriverPropertyValueMap m_driverProperties
simba_handle m_instanceID
SharedPtr< DSIMessageSourcem_msgSrc

Detailed Description

DSIDriver class.


Constructor & Destructor Documentation

virtual ~DSIDriver (  )  [virtual]

Destructor.

DSIDriver (  )  [protected]

Constructor.


Member Function Documentation

virtual AutoPtr<ICredentialFactory> CreateCredentialFactory (  )  [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)

Implements IDriver.

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

Factory method for creating IEnvironments.

Returns:
New IEnvironment instance. (OWN)

Implements IDriver.

virtual AutoPtr<UtilityFactory> CreateUtilityFactory (  )  [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)

Implements IDriver.

virtual const simba_wstring& GetDriverLocation (  )  const [virtual]

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

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

Implements IDriver.

virtual ILogger* GetDriverLog (  )  [virtual]

Gets the driver-wide logging interface.

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

Implements IDriver.

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

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

GetEventHandler() will only be called to retrieve the DSIEventHandler, events will be signaled through the DSIEventHandler itself. The DSIEventHandler should inspect the given event ID to determine which actions, if any, should occur in response to the event.

This default implementation simply returns NULL to indicate no events are handled.

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

Implements IDriver.

virtual simba_handle GetInstanceID (  )  [virtual]

Gets instance ID.

Returns:
Instance ID.

Implements IDriver.

virtual SharedPtr<IMessageSource> GetMessageSource (  )  [virtual]

Gets the IMessageSource object.

This default implementation returns a DSIMessageSource.

Returns:
The message source associated with the DSIDriver. (NOT OWN)

Implements IDriver.

virtual const AttributeData* GetProperty ( Simba::DSI::DSIDriverPropertyKey  in_key  )  [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.

The default implementation returns a value from m_propertiesFromEngine.

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

Implements IDriver.

virtual bool IsDriverUnloading (  )  [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.

Implements IDriver.

virtual void SetDriverUnloadingFlag (  )  [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).

Implements IDriver.

virtual void SetInstanceID ( simba_handle  in_instanceID  )  [virtual]

Sets the instance ID.

Parameters:
in_instanceID Instance ID.

Implements IDriver.

void SetProperty ( Simba::DSI::DSIDriverPropertyKey  in_key,
AttributeData in_value 
) [protected]

Sets a property value.

Parameters:
in_key The driver property key supported by DSI.
in_value The driver property value to be set for the in_key. (OWN)

Member Data Documentation

AutoPtr<ILogger> m_driverlog [protected]
simba_handle m_instanceID [protected]

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