Apac.Configuration.ProcessIdentityConfigSection Class Reference

This is a custom configuration section for retrieving process information from the app.config file. This information is intended to be set differently for each deployment of a given application (even on the same machine) so we can uniquely identify the running process during logging and auditing. More...

Inheritance diagram for Apac.Configuration.ProcessIdentityConfigSection:

Static Public Member Functions
static ProcessIdentityConfigSection	GetSection ()
	Gets the configured section for process identity information. It uses the AppSetting named ProcessIdentitySectionSettingName ('apac.process.section') to lookup the section name to use. If that setting is missing or empty it attempts to use the default section name defined in DefaultConfigSectionName. More...
static ProcessIdentityConfigSection	GetSection (string name)
	Gets the section requested by name and casts it as ProcessIdentityConfigSection. More...

Static Public Attributes
static readonly string	DefaultConfigSectionName = "apac.process"
	The default configuration section name to be assumed when retrieving this information from the configuration file. More...
static readonly string	ProcessIdentitySectionSettingName = "apac.process.section"
	A constant value used to denote the name of the AppSettings key that can be used to redirect this class to a configuration section by a name other than the default name (see DefaultConfigSectionName). More...

Properties
override ConfigurationPropertyCollection	Properties [get]
	Gets the configuration properties for this section. More...
string	Name [get, set]
	Gets or sets the name value for the process information configuration section. This is used as an identifier and should be compact yet unique. More...
string	DisplayName [get, set]
	Gets or sets the display name value for the process information configuration section. This is used as a visual identifier and should be pleasing to view in user interfaces and at least convey uniqueness. More...
string	Description [get, set]
	Gets or sets the description value for the process information configuration section. This is used to in displays and should be presentable. More...

Detailed Description

This is a custom configuration section for retrieving process information from the app.config file. This information is intended to be set differently for each deployment of a given application (even on the same machine) so we can uniquely identify the running process during logging and auditing.

This type of configuration will only be applicable to configuration files, not to database storage, so not extra care is taken to make it anything other than a simple configuration section.

Member Function Documentation

GetSection() [1/2]

static ProcessIdentityConfigSection Apac.Configuration.ProcessIdentityConfigSection.GetSection ( )

inlinestatic

Gets the configured section for process identity information. It uses the AppSetting named ProcessIdentitySectionSettingName ('apac.process.section') to lookup the section name to use. If that setting is missing or empty it attempts to use the default section name defined in DefaultConfigSectionName.

Returns

GetSection() [2/2]

static ProcessIdentityConfigSection Apac.Configuration.ProcessIdentityConfigSection.GetSection ( string  name )

inlinestatic

Gets the section requested by name and casts it as ProcessIdentityConfigSection.

Parameters

name	The name of the configuration section to retrieve.

Returns

The desired configuration section or null in the event that the section is missing or is not of the correct type.

Member Data Documentation

DefaultConfigSectionName

readonly string Apac.Configuration.ProcessIdentityConfigSection.DefaultConfigSectionName = "apac.process"

static

The default configuration section name to be assumed when retrieving this information from the configuration file.

ProcessIdentitySectionSettingName

readonly string Apac.Configuration.ProcessIdentityConfigSection.ProcessIdentitySectionSettingName = "apac.process.section"

static

A constant value used to denote the name of the AppSettings key that can be used to redirect this class to a configuration section by a name other than the default name (see DefaultConfigSectionName).

Property Documentation

Description

string Apac.Configuration.ProcessIdentityConfigSection.Description

getset

Gets or sets the description value for the process information configuration section. This is used to in displays and should be presentable.

DisplayName

string Apac.Configuration.ProcessIdentityConfigSection.DisplayName

getset

Gets or sets the display name value for the process information configuration section. This is used as a visual identifier and should be pleasing to view in user interfaces and at least convey uniqueness.

Name

string Apac.Configuration.ProcessIdentityConfigSection.Name

getset

Gets or sets the name value for the process information configuration section. This is used as an identifier and should be compact yet unique.

Properties

override ConfigurationPropertyCollection Apac.Configuration.ProcessIdentityConfigSection.Properties

getprotected

Gets the configuration properties for this section.

---

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

• /var/lib/jenkins/workspace/apac/APAC/APACCore/Configuration/ProcessIdentityConfigSection.cs