LabexBis.BisCommunicationSettings Class Reference

Holds settings used by the Labex - Bis communication module. More...

Inheritance diagram for LabexBis.BisCommunicationSettings:

Collaboration diagram for LabexBis.BisCommunicationSettings:

Public Member Functions
override string	ToString ()
void	ReadSettingsAppConfig ()
	Reads settindgs for communication with Bis from the application settings file. More...
string	IncomingFileName (string Id)
	Returns the name of the file in which incoming msg is stored. More...
string	IncomingFileName (string Id, bool AddGuid)
	Returns the name of the file in which incoming msg is stored. More...
string	OutgoingFileName (string Id)
	Returns the name of the file in which an outgoing msg is stored. More...
string	OutgoingFileName (string Id, bool AddGuid)
	Returns the file name for an outgoing msg with the specified Id. More...
string	NullifiedFileName (string Id)
	Returns the name of the file in which an nullified message is stored. More...
string	NullifiedFileName (string Id, bool AddGuid)
	Returns the file name for a nullified message with the specified Id. More...
string	ExampleFile (MessageType type)
	Returns filename of an example msg. More...
string	ForcedFileName (string Id)
	Returns the name of the file in which incoming msg should be stored for a file whose receipt confirmation was forced. More...
string	ForcedFileName (string Id, bool AddGuid)
	Returns the name of the file in which incoming msg should be stored for a file whose receipt confirmation was forced. More...
Public Member Functions inherited from IG.Lib.SettingsReaderAppConfig
override string	GetSetting (string settingname)
	Retrieves the specified setting from the current settings source. More...
override string	GetSetting (string settingname)
	Retrieves the specified setting from the current settings source. More...
Public Member Functions inherited from IG.Lib.SettingsReaderBase
virtual bool	GetBooleanSetting (string settingname)
	Retrieves the specified boolean setting from the current settings source. More...
virtual long	GetIntegerSetting (string settingname)
	Retrieves the specified integer setting from the current settings source. If the specific setting is not specified in the configuration then 0 is returned. More...
virtual long	GetIntegerSetting (string settingname, long defaultvalue)
	Retrieves the specified integer setting from the current settings source. More...
virtual bool	GetBooleanSetting (string settingname)
	Retrieves the specified boolean setting from the current settings source. More...
virtual long	GetIntegerSetting (string settingname)
	Retrieves the specified integer setting from the current settings source. If the specific setting is not specified in the configuration then 0 is returned. More...
virtual long	GetIntegerSetting (string settingname, long defaultvalue)
	Retrieves the specified integer setting from the current settings source. More...

Public Attributes
const string	SettingName_StartCalypsoReceiver = "StartCalypsoReceiver"
bool	StartCalypsoReceiver = false
int	MaxNumMessages = 0
string	MessageFile = null

Protected Member Functions
void	getsettings ()
	Common method used for retrieving the settings. Methods for reading settings form different sources call this method. More...
string	MessageFileName (string leader, string Id, bool AddGuid)
	Returns the name of the file where messages are stored. More...
Protected Member Functions inherited from IG.Lib.SettingsReaderAppConfig
virtual string	GetSettingAppConfig (string settingname)
virtual string	GetSettingAppConfig (string settingname)
Protected Member Functions inherited from IG.Lib.SettingsReaderBase
bool	ToBoolean (string strsetting)
	Converts a string representation of a boolean setting to boolean. Strings "true", "yes" and "on" (regardless of capitalization) or non-zero integer representations result to true, anything else (including null or empty string) result in false. More...
long	ToInt (string strsetting)
	Converts a string representation of an integer setting to an integer value. If the setting is not defined then 0 is returned. More...
long	ToInt (string strsetting, long defaultvalue)
	Converts a string representation of an integer setting to an integer value. More...

Protected Attributes
bool	settingsread = false
Protected Attributes inherited from IG.Lib.SettingsReaderBase
bool	_expandEnv = true

Properties
static MsgConst	Msg [get]
	Gets objects that contains all constants related to communication messages. More...
static IReporter	R [get]
	Reporter for this class. More...
Properties inherited from IG.Lib.SettingsReaderBase
object	Lock [get]
	ILockable.Lock, gets a public lock for the current object. More...
virtual bool	ExpandEnvironmentVariables [get, set]
Properties inherited from IG.Lib.ILockable
object	Lock [get]

Private Attributes
const string	SettingName_ForceMessageReceiptConfirmation = "ForceMessageReceiptConfirmation"
const string	SettingName_MaxNumMessages = "MaxNumMessages"
const string	SettingName_DebugCalypsoReceiver = "DebugCalypsoReceiver"
const string	SettingName_MessageFile = "MessageFile"
const string	SettingName_MessageSchemaDir = "MessageSchemaDir"
const string	SettingName_MessageIncomingDir = "MessageIncomingDir"
const string	SettingName_MessageOutgoingDir = "MessageOutgoingDir"
const string	SettingName_MessageServiceUrl = "MessageServiceUrl"
const string	SettingName_ModelFileObservationOrder = "ModelFileObservationOrder"
const string	SettingName_ModelFileObservationEvent = "ModelFileObservationEvent"
const string	SettingName_ModelFileFinancialTransaction = "ModelFileFinancialTransaction"
bool	ForceMessageReceiptConfirmation = false
bool	DebugCalypsoReceiver = false
string	MessageSchemaDir = null
string	MessageIncomingDir = null
string	ForcedIncomingReceiptsDirectory = "Forced"
string	MessageOutgoingDir = null
string	MessageServiceUrl = null
string	ModelFileObservationOrder
string	ModelFileObservationEvent
string	ModelFileFinancialTransaction

Static Private Attributes
static IReporter	_rep = new ReporterConsole()

Detailed Description

Holds settings used by the Labex - Bis communication module.

Member Function Documentation

override string LabexBis.BisCommunicationSettings.ToString ( )

inline

References LabexBis.BisCommunicationSettings.DebugCalypsoReceiver, LabexBis.BisCommunicationSettings.ForceMessageReceiptConfirmation, LabexBis.BisCommunicationSettings.MessageFile, LabexBis.BisCommunicationSettings.MessageIncomingDir, LabexBis.BisCommunicationSettings.MessageOutgoingDir, LabexBis.BisCommunicationSettings.MessageSchemaDir, LabexBis.BisCommunicationSettings.MessageServiceUrl, LabexBis.BisCommunicationSettings.SettingName_DebugCalypsoReceiver, LabexBis.BisCommunicationSettings.SettingName_ForceMessageReceiptConfirmation, LabexBis.BisCommunicationSettings.SettingName_MaxNumMessages, LabexBis.BisCommunicationSettings.SettingName_MessageFile, LabexBis.BisCommunicationSettings.SettingName_MessageIncomingDir, LabexBis.BisCommunicationSettings.SettingName_MessageOutgoingDir, LabexBis.BisCommunicationSettings.SettingName_MessageSchemaDir, LabexBis.BisCommunicationSettings.SettingName_MessageServiceUrl, LabexBis.BisCommunicationSettings.SettingName_ModelFileFinancialTransaction, LabexBis.BisCommunicationSettings.SettingName_ModelFileObservationEvent, LabexBis.BisCommunicationSettings.SettingName_ModelFileObservationOrder, LabexBis.BisCommunicationSettings.SettingName_StartCalypsoReceiver, and LabexBis.BisCommunicationSettings.StartCalypsoReceiver.

Referenced by IGTest.ProgramIGTest.ReceiveSpecimenObservationOrder(), IGTest.ProgramIGTest.TestCalypsoWs(), IGTest.ProgramIGTest.TestcalypsoWsSimple(), IGTest.ProgramIGTest.TestMsgFinancialTransaction(), and IGTest.ProgramIGTest.TestMsgObservationEvent().

void LabexBis.BisCommunicationSettings.getsettings ( )

inlineprotected

Common method used for retrieving the settings. Methods for reading settings form different sources call this method.

References LabexBis.BisCommunicationSettings.DebugCalypsoReceiver, LabexBis.BisCommunicationSettings.ForceMessageReceiptConfirmation, IG.Lib.SettingsReaderBase.GetBooleanSetting(), IG.Lib.SettingsReaderBase.GetIntegerSetting(), IG.Lib.SettingsReaderAppConfig.GetSetting(), LabexBis.BisCommunicationSettings.MessageFile, LabexBis.BisCommunicationSettings.MessageIncomingDir, LabexBis.BisCommunicationSettings.MessageOutgoingDir, LabexBis.BisCommunicationSettings.MessageSchemaDir, LabexBis.BisCommunicationSettings.MessageServiceUrl, LabexBis.BisCommunicationSettings.SettingName_DebugCalypsoReceiver, LabexBis.BisCommunicationSettings.SettingName_ForceMessageReceiptConfirmation, LabexBis.BisCommunicationSettings.SettingName_MaxNumMessages, LabexBis.BisCommunicationSettings.SettingName_MessageFile, LabexBis.BisCommunicationSettings.SettingName_MessageIncomingDir, LabexBis.BisCommunicationSettings.SettingName_MessageOutgoingDir, LabexBis.BisCommunicationSettings.SettingName_MessageSchemaDir, LabexBis.BisCommunicationSettings.SettingName_MessageServiceUrl, LabexBis.BisCommunicationSettings.SettingName_ModelFileFinancialTransaction, LabexBis.BisCommunicationSettings.SettingName_ModelFileObservationEvent, LabexBis.BisCommunicationSettings.SettingName_ModelFileObservationOrder, LabexBis.BisCommunicationSettings.SettingName_StartCalypsoReceiver, and LabexBis.BisCommunicationSettings.StartCalypsoReceiver.

Referenced by LabexBis.BisCommunicationSettings.ExampleFile(), LabexBis.BisCommunicationSettings.ForcedFileName(), LabexBis.BisCommunicationSettings.IncomingFileName(), LabexBis.BisCommunicationSettings.NullifiedFileName(), LabexBis.BisCommunicationSettings.OutgoingFileName(), and LabexBis.BisCommunicationSettings.ReadSettingsAppConfig().

void LabexBis.BisCommunicationSettings.ReadSettingsAppConfig ( )

inline

Reads settindgs for communication with Bis from the application settings file.

References LabexBis.BisCommunicationSettings.getsettings(), and IG.Lib.SettingsReaderBase.lockobj.

Referenced by IGTest.ProgramIGTest.ReceiveSpecimenObservationOrder(), IGTest.ProgramIGTest.TestCalypsoWs(), IGTest.ProgramIGTest.TestcalypsoWsSimple(), IGTest.ProgramIGTest.TestMsgFinancialTransaction(), IGTest.ProgramIGTest.TestMsgObservationEvent(), IGTest.ProgramIGTest.TestMsgObservationOrder(), IGTest.ProgramIGTest.TestMsgObservationOrderNullify(), and IGTest.ProgramIGTest.TestMsgObservationOrderNullifySend().

string LabexBis.BisCommunicationSettings.MessageFileName ( string  leader, string  Id, bool  AddGuid  )

inlineprotected

Returns the name of the file where messages are stored.

Parameters

leader	The leading string of the file name, such as "Incoming".
Id	Id incorporated in the file name.
AddGuid	If true then a global unique string is included in file name.

Returns

Composed file name.

References IG.Lib.IReporterBase.Depth, LabexBis.BisCommunicationSettings.Msg, LabexBis.BisCommunicationSettings.R, IG.Lib.IReporterBase.ReportInfo(), IG.Lib.MsgConst.TimeStamp(), and IG.Lib.IReporterBase.TreatInfo.

Referenced by LabexBis.BisCommunicationSettings.ForcedFileName(), LabexBis.BisCommunicationSettings.IncomingFileName(), LabexBis.BisCommunicationSettings.NullifiedFileName(), and LabexBis.BisCommunicationSettings.OutgoingFileName().

string LabexBis.BisCommunicationSettings.IncomingFileName ( string  Id )

inline

Returns the name of the file in which incoming msg is stored.

Parameters

Id	ID of the incoming msg.

Referenced by LabexBis.Calypso.GetMessage(), LabexBis.Calypso.SaveIncomingMessage(), and IGTest.ProgramIGTest.TestcalypsoWsSimple().

string LabexBis.BisCommunicationSettings.IncomingFileName ( string  Id, bool  AddGuid  )

inline

Returns the name of the file in which incoming msg is stored.

Parameters

Id	ID of the incoming msg.
AddGuid	Specifies whether or not a GUID is added to msg filenames.

References IG.Lib.IReporterBase.Depth, LabexBis.BisCommunicationSettings.getsettings(), LabexBis.BisCommunicationSettings.MessageFileName(), LabexBis.BisCommunicationSettings.MessageIncomingDir, LabexBis.BisCommunicationSettings.R, IG.Lib.IReporterBase.ReportInfo(), and IG.Lib.IReporterBase.TreatInfo.

string LabexBis.BisCommunicationSettings.OutgoingFileName ( string  Id )

inline

Returns the name of the file in which an outgoing msg is stored.

Parameters

Id	ID of the outgoing msg.

Referenced by LabexBis.Calypso.SendMessage().

string LabexBis.BisCommunicationSettings.OutgoingFileName ( string  Id, bool  AddGuid  )

inline

Returns the file name for an outgoing msg with the specified Id.

Parameters

Id	Id of the msg.

Returns

Name of the file where outgoing msg is stored.

References IG.Lib.IReporterBase.Depth, LabexBis.BisCommunicationSettings.getsettings(), LabexBis.BisCommunicationSettings.MessageFileName(), LabexBis.BisCommunicationSettings.MessageOutgoingDir, LabexBis.BisCommunicationSettings.R, IG.Lib.IReporterBase.ReportInfo(), and IG.Lib.IReporterBase.TreatInfo.

string LabexBis.BisCommunicationSettings.NullifiedFileName ( string  Id )

inline

Returns the name of the file in which an nullified message is stored.

Parameters

Id	ID of the outgoing msg.

string LabexBis.BisCommunicationSettings.NullifiedFileName ( string  Id, bool  AddGuid  )

inline

Returns the file name for a nullified message with the specified Id.

Parameters

Id	Id of the msg.

Returns

Name of the file where outgoing msg is stored.

References IG.Lib.IReporterBase.Depth, LabexBis.BisCommunicationSettings.getsettings(), LabexBis.BisCommunicationSettings.MessageFileName(), LabexBis.BisCommunicationSettings.MessageOutgoingDir, LabexBis.BisCommunicationSettings.R, IG.Lib.IReporterBase.ReportInfo(), and IG.Lib.IReporterBase.TreatInfo.

string LabexBis.BisCommunicationSettings.ExampleFile ( MessageType  type )

inline

Returns filename of an example msg.

References IG.Lib.IReporterBase.Depth, LabexBis.BisCommunicationSettings.getsettings(), LabexBis.BisCommunicationSettings.MessageSchemaDir, LabexBis.BisCommunicationSettings.R, IG.Lib.IReporterBase.ReportInfo(), and IG.Lib.IReporterBase.TreatInfo.

Referenced by IGTest.ProgramIGTest.TestMsgFinancialTransaction(), IGTest.ProgramIGTest.TestMsgObservationEvent(), IGTest.ProgramIGTest.TestMsgObservationOrder(), and IGTest.ProgramIGTest.TestMsgObservationOrderNullify().

string LabexBis.BisCommunicationSettings.ForcedFileName ( string  Id )

inline

Returns the name of the file in which incoming msg should be stored for a file whose receipt confirmation was forced.

Parameters

Id	ID of the incoming msg.

string LabexBis.BisCommunicationSettings.ForcedFileName ( string  Id, bool  AddGuid  )

inline

Returns the name of the file in which incoming msg should be stored for a file whose receipt confirmation was forced.

Parameters

Id	ID of the incoming msg.
AddGuid	Specifies whether or not a GUID is added to msg filenames.

References IG.Lib.IReporterBase.Depth, LabexBis.BisCommunicationSettings.ForcedIncomingReceiptsDirectory, LabexBis.BisCommunicationSettings.getsettings(), LabexBis.BisCommunicationSettings.MessageFileName(), LabexBis.BisCommunicationSettings.MessageIncomingDir, LabexBis.BisCommunicationSettings.R, IG.Lib.IReporterBase.ReportInfo(), and IG.Lib.IReporterBase.TreatInfo.

Member Data Documentation

IReporter LabexBis.BisCommunicationSettings._rep = new ReporterConsole()

staticprivate

const string LabexBis.BisCommunicationSettings.SettingName_StartCalypsoReceiver = "StartCalypsoReceiver"

Referenced by LabexBis.BisCommunicationSettings.getsettings(), and LabexBis.BisCommunicationSettings.ToString().

const string LabexBis.BisCommunicationSettings.SettingName_ForceMessageReceiptConfirmation = "ForceMessageReceiptConfirmation"

private

Referenced by LabexBis.BisCommunicationSettings.getsettings(), and LabexBis.BisCommunicationSettings.ToString().

const string LabexBis.BisCommunicationSettings.SettingName_MaxNumMessages = "MaxNumMessages"

private

Referenced by LabexBis.BisCommunicationSettings.getsettings(), and LabexBis.BisCommunicationSettings.ToString().

const string LabexBis.BisCommunicationSettings.SettingName_DebugCalypsoReceiver = "DebugCalypsoReceiver"

private

Referenced by LabexBis.BisCommunicationSettings.getsettings(), and LabexBis.BisCommunicationSettings.ToString().

const string LabexBis.BisCommunicationSettings.SettingName_MessageFile = "MessageFile"

private

Referenced by LabexBis.BisCommunicationSettings.getsettings(), and LabexBis.BisCommunicationSettings.ToString().

const string LabexBis.BisCommunicationSettings.SettingName_MessageSchemaDir = "MessageSchemaDir"

private

Referenced by LabexBis.BisCommunicationSettings.getsettings(), and LabexBis.BisCommunicationSettings.ToString().

const string LabexBis.BisCommunicationSettings.SettingName_MessageIncomingDir = "MessageIncomingDir"

private

Referenced by LabexBis.BisCommunicationSettings.getsettings(), and LabexBis.BisCommunicationSettings.ToString().

const string LabexBis.BisCommunicationSettings.SettingName_MessageOutgoingDir = "MessageOutgoingDir"

private

Referenced by LabexBis.BisCommunicationSettings.getsettings(), and LabexBis.BisCommunicationSettings.ToString().

const string LabexBis.BisCommunicationSettings.SettingName_MessageServiceUrl = "MessageServiceUrl"

private

Referenced by LabexBis.BisCommunicationSettings.getsettings(), and LabexBis.BisCommunicationSettings.ToString().

const string LabexBis.BisCommunicationSettings.SettingName_ModelFileObservationOrder = "ModelFileObservationOrder"

private

Referenced by LabexBis.BisCommunicationSettings.getsettings(), and LabexBis.BisCommunicationSettings.ToString().

const string LabexBis.BisCommunicationSettings.SettingName_ModelFileObservationEvent = "ModelFileObservationEvent"

private

Referenced by LabexBis.BisCommunicationSettings.getsettings(), and LabexBis.BisCommunicationSettings.ToString().

const string LabexBis.BisCommunicationSettings.SettingName_ModelFileFinancialTransaction = "ModelFileFinancialTransaction"

private

Referenced by LabexBis.BisCommunicationSettings.getsettings(), and LabexBis.BisCommunicationSettings.ToString().

bool LabexBis.BisCommunicationSettings.StartCalypsoReceiver = false

Referenced by LabexBis.BisCommunicationSettings.getsettings(), and LabexBis.BisCommunicationSettings.ToString().

bool LabexBis.BisCommunicationSettings.ForceMessageReceiptConfirmation = false

private

Referenced by LabexBis.BisCommunicationSettings.getsettings(), and LabexBis.BisCommunicationSettings.ToString().

bool LabexBis.BisCommunicationSettings.DebugCalypsoReceiver = false

private

Referenced by LabexBis.BisCommunicationSettings.getsettings(), and LabexBis.BisCommunicationSettings.ToString().

int LabexBis.BisCommunicationSettings.MaxNumMessages = 0

string LabexBis.BisCommunicationSettings.MessageFile = null

Referenced by LabexBis.BisCommunicationSettings.getsettings(), IGTest.ProgramIGTest.TestCalypsoWs(), and LabexBis.BisCommunicationSettings.ToString().

string LabexBis.BisCommunicationSettings.MessageSchemaDir = null

private

Referenced by LabexBis.BisCommunicationSettings.ExampleFile(), LabexBis.BisCommunicationSettings.getsettings(), and LabexBis.BisCommunicationSettings.ToString().

string LabexBis.BisCommunicationSettings.MessageIncomingDir = null

private

Referenced by LabexBis.BisCommunicationSettings.ForcedFileName(), LabexBis.BisCommunicationSettings.getsettings(), LabexBis.BisCommunicationSettings.IncomingFileName(), and LabexBis.BisCommunicationSettings.ToString().

string LabexBis.BisCommunicationSettings.ForcedIncomingReceiptsDirectory = "Forced"

private

Referenced by LabexBis.BisCommunicationSettings.ForcedFileName().

string LabexBis.BisCommunicationSettings.MessageOutgoingDir = null

private

Referenced by LabexBis.BisCommunicationSettings.getsettings(), LabexBis.BisCommunicationSettings.NullifiedFileName(), LabexBis.BisCommunicationSettings.OutgoingFileName(), and LabexBis.BisCommunicationSettings.ToString().

string LabexBis.BisCommunicationSettings.MessageServiceUrl = null

private

Referenced by LabexBis.BisCommunicationSettings.getsettings(), and LabexBis.BisCommunicationSettings.ToString().

string LabexBis.BisCommunicationSettings.ModelFileObservationOrder

private

string LabexBis.BisCommunicationSettings.ModelFileObservationEvent

private

string LabexBis.BisCommunicationSettings.ModelFileFinancialTransaction

private

bool LabexBis.BisCommunicationSettings.settingsread = false

protected

Property Documentation

MsgConst LabexBis.BisCommunicationSettings.Msg

staticgetprotected

Gets objects that contains all constants related to communication messages.

Referenced by LabexBis.BisCommunicationSettings.MessageFileName().

IReporter LabexBis.BisCommunicationSettings.R

staticget

Reporter for this class.

Referenced by LabexBis.BisCommunicationSettings.ExampleFile(), LabexBis.BisCommunicationSettings.ForcedFileName(), LabexBis.BisCommunicationSettings.IncomingFileName(), LabexBis.BisCommunicationSettings.MessageFileName(), LabexBis.BisCommunicationSettings.NullifiedFileName(), and LabexBis.BisCommunicationSettings.OutgoingFileName().

---

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

• igtest/tmp_prem/prlab/LabexBis/WSBis.cs