NetFramework-SC
0.0.5
See the version list below for details.
dotnet add package NetFramework-SC --version 0.0.5
NuGet\Install-Package NetFramework-SC -Version 0.0.5
<PackageReference Include="NetFramework-SC" Version="0.0.5" />
paket add NetFramework-SC --version 0.0.5
#r "nuget: NetFramework-SC, 0.0.5"
// Install NetFramework-SC as a Cake Addin #addin nuget:?package=NetFramework-SC&version=0.0.5 // Install NetFramework-SC as a Cake Tool #tool nuget:?package=NetFramework-SC&version=0.0.5
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.
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. |
GetSubConfigurationByNamespace(key)
For getting jObject containing configuration Namespace.
Name | Description |
---|---|
key | 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)
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
Log(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. |
Logger
Local log4net logger.
Namespaces
Sorted list of configuration files found in ConfigurationRootFolder.
Save
Save all configurations to ConfigurationRootFolder.
SetSubConfigurationByNamespace(key, jObject)
For setting jObject containing configuration by Namespace.
Name | Description |
---|---|
key | System.String<br>Namespace based key. |
jObject | Newtonsoft.Json.Linq.JObject<br>desired configuration. |
Logging
SC log4net based logging functionality.
ConfigurationFileName
Current ConfigurationFileName.
DefaultLoggingDirectory
Default directory for storing log files when RollingFileAppender is enabled.
DefaultSetup
log4net setup programmatically.
DisableRollingFileAppender
Disabling RollingFileAppender
EnableRollingFileAppender(targetDirectory)
Enabling RollingFileAppender.
Name | Description |
---|---|
targetDirectory | System.String<br>Directory to use to store log files. |
Remarks
if parameter targetDirectory is null will use Logging.DefaultLoggingDirectory.
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.
PatternLayout
log4net patern layout.
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 Compatible and additional computed target framework versions. |
---|---|
.NET Framework | net461 is compatible. net462 was computed. net463 was computed. net47 was computed. net471 was computed. net472 was computed. net48 was computed. net481 was computed. |
-
- log4net (>= 2.0.8)
- Newtonsoft.Json (>= 11.0.2)
- System.Security.Cryptography.ProtectedData (>= 4.5.0)
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,774 | 7/19/2018 |
0.0.6 | 2,096 | 7/13/2018 |
0.0.5 | 1,283 | 7/10/2018 |
0.0.4 | 1,989 | 7/8/2018 |
0.0.3 | 2,188 | 7/3/2018 |
0.0.2 | 2,046 | 7/1/2018 |
0.0.1 | 2,051 | 6/17/2018 |
0.0.1-beta | 1,488 | 5/25/2018 |
0.0.1-alpha | 1,144 | 5/20/2018 |
Refactored logging functionality into separage class.