IEnvironment Class Reference

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

Inherits Simba::DSI::IWarningSource.

Inherited by DSIEnvironment.

List of all members.

Public Types

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

Public Member Functions

virtual Simba::DSI::IConnectionCreateConnection (ICredentials *in_credentials)=0
virtual Simba::DSI::IConnectionCreateConnection ()=0
virtual ILoggerGetLog ()=0
 Retrieves the log used to log messages about the IEnvironment.
virtual SharedPtr< IMessageSourceGetMessageSource ()=0
 Retrieves the message source associated with the IEnvironment.
virtual Simba::DSI::IDriverGetParentDriver ()=0
 Returns a reference to the parent Driver.
virtual const AttributeDataGetProperty (Simba::DSI::DSIEnvPropertyKey in_key)=0
 Returns a environment property corresponding to the in_key.
virtual void RegisterWarningListener (IWarningListener *in_warningListener)=0
virtual void SetProperty (Simba::DSI::DSIEnvPropertyKey in_key, AttributeData *in_value)=0
 Allows the setting of a environment property whose value affects the DSII.
virtual ~IEnvironment ()
 Destructor.

Protected Member Functions

 IEnvironment ()
 Constructor.

Detailed Description

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


Member Typedef Documentation

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


Constructor & Destructor Documentation

virtual ~IEnvironment (  )  [inline, virtual]

Destructor.

IEnvironment (  )  [inline, protected]

Constructor.


Member Function Documentation

virtual Simba::DSI::IConnection* CreateConnection ( ICredentials in_credentials  )  [pure 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)

Implemented in DSIEnvironment.

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

Creates and returns a new IConnection instance.

Returns:
New IConnection instance. (OWN)

Implemented in DSIEnvironment.

virtual ILogger* GetLog (  )  [pure virtual]

Retrieves the log used to log messages about the IEnvironment.

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

Implemented in DSIEnvironment.

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

Retrieves the message source associated with the IEnvironment.

Returns:
The message source associated with the IEnvironment.

Implements IWarningSource.

Implemented in DSIEnvironment.

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

Returns a reference to the parent Driver.

Returns:
Parent driver instance. (NOT OWN)

Implemented in DSIEnvironment.

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

Implemented in DSIEnvironment.

virtual void RegisterWarningListener ( IWarningListener in_warningListener  )  [pure virtual]

Registers an IWarningListener*, which may be retrieved using GetWarningListener(). Should be called right after construction of the IEnvironment.

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

Implements IWarningSource.

Implemented in DSIEnvironment.

virtual void SetProperty ( Simba::DSI::DSIEnvPropertyKey  in_key,
AttributeData in_value 
) [pure 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)

Implemented in DSIEnvironment.


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