DSIEnvironment Class Reference

Base class for environment details. More...

Inherits Simba::DSI::IEnvironment.

List of all members.

Public Member Functions

virtual Simba::DSI::IConnectionCreateConnection (ICredentials *in_credentials)
virtual Simba::DSI::IConnectionCreateConnection ()=0
 Creates and returns a new IConnection instance.
virtual ILoggerGetLog ()
 Retrieves the log used to log messages about the DSIEnvironment.
virtual SharedPtr< IMessageSourceGetMessageSource ()
 Retrieves the message source associated with the DSIEnvironment.
Simba::DSI::IDriverGetParentDriver ()
 Returns a reference to the parent Driver.
virtual const AttributeDataGetProperty (Simba::DSI::DSIEnvPropertyKey in_key)
 Returns a environment property corresponding to the in_key.
virtual void RegisterWarningListener (IWarningListener *in_warningListener)
 Registers an IWarningListener*, which may be retrieved using GetWarningListener().
virtual void SetProperty (Simba::DSI::DSIEnvPropertyKey in_key, AttributeData *in_value)
 Allows the setting of a environment property whose value affects the DSII.
virtual ~DSIEnvironment ()
 Destructor.

Protected Member Functions

 DSIEnvironment (Simba::DSI::IDriver *in_driver)
 Constructor.
IWarningListenerGetWarningListener ()
 Retrieves the warning listener associated with the DSIEnvironment.

Protected Attributes

CriticalSection m_criticalSection
EnvPropertyValueMap m_environmentProperties

Detailed Description

Base class for environment details.

This class exposes an interface to interact with the customer DSII for environment details and informs the DSI of the beginning and ending of environment scopes in case it wants to perform operations at such time.


Constructor & Destructor Documentation

virtual ~DSIEnvironment (  )  [virtual]

Destructor.

DSIEnvironment ( Simba::DSI::IDriver in_driver  )  [protected]

Constructor.

Parameters:
in_driver The IDriver associated with this DSIEnvironment instance. (NOT OWN)

Member Function Documentation

virtual Simba::DSI::IConnection* CreateConnection ( ICredentials in_credentials  )  [virtual]

Creates and returns a new IConnection instance with established credentials.

This will only be called when integrated security is turned on via the DSIDriverPropertyKey::DSI_DRIVER_SUPPORTS_INTEGRATED_SECURITY driver property. See the documentation for that property for details on how this method gets called.

Parameters:
in_credentials Credentials established by integrated security. (NOT OWN)
Returns:
New IConnection instance. (OWN)

Implements IEnvironment.

virtual Simba::DSI::IConnection* CreateConnection (  )  [pure virtual]

Creates and returns a new IConnection instance.

Returns:
New IConnection instance. (OWN)

Implements IEnvironment.

virtual ILogger* GetLog (  )  [virtual]

Retrieves the log used to log messages about the DSIEnvironment.

Returns:
The log that logs messages about the DSIEnvironment. (NOT OWN)

Implements IEnvironment.

virtual SharedPtr<IMessageSource> GetMessageSource (  )  [virtual]

Retrieves the message source associated with the DSIEnvironment.

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

Implements IEnvironment.

Simba::DSI::IDriver* GetParentDriver (  )  [virtual]

Returns a reference to the parent Driver.

Returns:
Parent driver instance. (NOT OWN)

Implements IEnvironment.

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

Returns a environment property corresponding to the in_key.

This function should be thread-safe.

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

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

Implements IEnvironment.

IWarningListener* GetWarningListener (  )  [protected, virtual]

Retrieves the warning listener associated with the DSIEnvironment.

Returns:
The warning listener associated with the DSIEnvironment. (NOT OWN)

Implements IWarningSource.

virtual void RegisterWarningListener ( IWarningListener in_warningListener  )  [virtual]

Registers an IWarningListener*, which may be retrieved using GetWarningListener().

Should be called right after construction of the DSIEnvironment. If this is overridden by a derived class, that implementation MUST call up to the base DSIEnvironment::RegisterWarningListener.

Parameters:
in_warningListener A listener which may be used to post warnings. (NOT OWN)

Implements IEnvironment.

virtual void SetProperty ( Simba::DSI::DSIEnvPropertyKey  in_key,
AttributeData in_value 
) [virtual]

Allows the setting of a environment property whose value affects the DSII.

This function should be thread-safe.

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

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

Implements IEnvironment.


Member Data Documentation


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