NetFramework-SC 0.0.7

.NET Framework 4.6.1
dotnet add package NetFramework-SC --version 0.0.7
NuGet\Install-Package NetFramework-SC -Version 0.0.7
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="NetFramework-SC" Version="0.0.7" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add NetFramework-SC --version 0.0.7
#r "nuget: NetFramework-SC, 0.0.7"
#r directive can be used in F# Interactive, C# scripting and .NET Interactive. Copy this into the interactive tool or source code of the script to reference the package.
// Install NetFramework-SC as a Cake Addin
#addin nuget:?package=NetFramework-SC&version=0.0.7

// Install NetFramework-SC as a Cake Tool
#tool nuget:?package=NetFramework-SC&version=0.0.7

NetFramework-SC

<table> <tbody> <tr> <td><a href="#configuration">Configuration</a></td> <td><a href="#logging">Logging</a></td> </tr> <tr> <td><a href="#results">Results</a></td> </tr> </tbody> </table>

Configuration

Special Circumstances Newtonsoft.Json based configuration functionality.

#cctor

Default constructor.

Data

Contains active configuration data.

Debug(namespaceKey, formatting)

Static method for logging system environment information.

Name Description
namespaceKey System.String<br>NamespaceKey for configuration to log.
formatting Newtonsoft.Json.Formatting<br>Indented or no formating of configuration.

Entropy

Byte array to be used to increase the complexity of the encryption.

ExportNamespace(namespaceKey, targetDirectory)

Export a namespace configuration to target directory.

Name Description
namespaceKey System.String<br>Configuration to export.
targetDirectory System.String<br>Target directory.
Returns

boolean for results aggregation purposes.

Remarks

Configuration filename will be saved using namespace key.

ExportNamespaces(targetDirectory)

Export namespace configurations to target directory.

Name Description
targetDirectory System.String<br>Directory to export configurations to.

GetConfigurationByNamespace(namespaceKey)

For getting jObject containing configuration by namespace key.

Name Description
namespaceKey System.String<br>Namespace based key.
Returns

Desired configuration.

ImportFromDirectory(directory, overwrite)

Import Special Circumnstances namepsace configuration JSON files from a given Directory.

Name Description
directory System.String<br>Directory containing configuration files.
overwrite System.Boolean<br>Overwrite existing configurations.

ImportFromFile(fileName, overwrite)

Import configuration file.

Name Description
fileName System.String<br>Configuration filename.
overwrite System.Boolean<br>Overwrite existing configuration.
Returns

bool reflecting success of operation.

Initialize(System.String,System.String)

Static method that must be called first in any Special Circumstances data exploration.

Initialized

To validate we are configured.

ISF

IsolatedStorageFile property.

LoadConfigurationFromISF(configurationFileName)

Load configurationFileName from isolated storage.

Name Description
configurationFileName System.String<br>file to be loaded from isolated storage.
Returns

Logger

Local log4net logger.

Namespaces

Sorted list of configuration files found in ConfigurationRootFolder.

RemoveConfigurationByNameSpace(namespaceKey)

Remove configuration for a given namespaceKey from memory and IsolatedStorage.

Name Description
namespaceKey System.String<br>key for Configurtation to remove.

Save

Save all configurations to ConfigurationRootFolder.

SetConfigurationByNamespace(namespaceKey, jObject)

For setting jObject containing configuration by Namespace.

Name Description
namespaceKey System.String<br>Namespace based key.
jObject Newtonsoft.Json.Linq.JObject<br>desired configuration.

Logging

SC log4net based logging functionality.

ConfigurationFileName

Current ConfigurationFileName.

Debug

Logs Logging configuration.

DefaultSetup(enableFileAppender, fileAppenderFileName)

log4net setup programmatically.

Name Description
enableFileAppender System.Boolean<br>Enable file appender.
fileAppenderFileName System.String<br>File appender FileName.

DisableFileAppender

Disabling FileAppender

Remarks

If Logging is configured with a configuration file name this will return immediately.

EnableFileAppender(targetFileName)

Enabling FileAppender.

Name Description
targetFileName System.String<br>FileName store log files.
Remarks

If Logging is configured with a configuration file name this method will return without enabling DefaultFileAppender.

Initialize(configurationFileName)

Static method for configuring log4net fuctionality. If log4net.config file is found in the current working directory it will use it instead of the provided one.

Name Description
configurationFileName System.String<br>log4net configuration filename.

Logger

Local log4net Logger.

Results

Results aggregation.

Constructor

Default contructor.

CurrentStats

Current stats.

Errors

Errors count.

Log

Log current stats.

Logger

Local log4net logger.

Success

Success count.

Total

Total processing count.

Warnings

Warnings count.

Product Versions
.NET Framework net461 net462 net463 net47 net471 net472 net48
Compatible target framework(s)
Additional computed target framework(s)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (2)

Showing the top 2 NuGet packages that depend on NetFramework-SC:

Package Downloads
NetFramework-SC.Data

Data functionality for Special Circumstances play ground.

NetFramework-SC.AWS

AWS functionality for Special Circumstances play ground.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
0.0.7 1,047 7/19/2018
0.0.6 1,336 7/13/2018
0.0.5 745 7/10/2018
0.0.4 1,158 7/8/2018
0.0.3 1,345 7/3/2018
0.0.2 1,210 7/1/2018
0.0.1 1,213 6/17/2018
0.0.1-beta 914 5/25/2018
0.0.1-alpha 579 5/20/2018

Refactored logging functionality into separage class.