Class ApplicationSetup

Namespace

Tlabs.Config

Assembly

Tlabs.Core.dll

Comon application's setup

public record ApplicationSetup : IEquatable<ApplicationSetup>

Inheritance

object

ApplicationSetup

Implements

IEquatable<ApplicationSetup>

Inherited Members

object.GetType()

object.MemberwiseClone()

object.Equals(object, object)

object.ReferenceEquals(object, object)

Extension Methods

ConfigUtilsExtensions.ApplyConfigurators<T>(T, IConfiguration, string?)

Constructors

ApplicationSetup()

Default ctor

public ApplicationSetup()

ApplicationSetup(string, string, string, ConfigurationManager, ILoggerFactory, IServiceProvider, IAppTime)

Comon application's setup

public ApplicationSetup(string Name, string EnvironmentName, string ContentRoot, ConfigurationManager Configuration, ILoggerFactory LogFactory, IServiceProvider ServiceProv, IAppTime TimeInfo)

Parameters

Name string

App. name

EnvironmentName string

App. (hosting) environment name

ContentRoot string

App. content root path

Configuration ConfigurationManager

App. (root) configuration manager

LogFactory ILoggerFactory

App. ILoggerFactory

ServiceProv IServiceProvider

App. IServiceProvider

TimeInfo IAppTime

ApplicationSetup(ApplicationSetup)

protected ApplicationSetup(ApplicationSetup original)

Parameters

original ApplicationSetup

Fields

ASPNET_ENV_NAME

ASP.NET env. variable name to read the host environment

public const string ASPNET_ENV_NAME = "ASPNETCORE_ENVIRONMENT"

Field Value

string

DOTNET_ENV_NAME

.NET env. variable name to read the host environment

public const string DOTNET_ENV_NAME = "DOTNET_ENVIRONMENT"

Field Value

string

Default

Default application setup

public static readonly ApplicationSetup Default

Field Value

ApplicationSetup

Properties

Configuration

App. (root) configuration manager

public ConfigurationManager Configuration { get; init; }

Property Value

ConfigurationManager

ContentRoot

App. content root path

public string ContentRoot { get; init; }

Property Value

string

EnvironmentName

App. (hosting) environment name

public string EnvironmentName { get; init; }

Property Value

string

EqualityContract

protected virtual Type EqualityContract { get; }

Property Value

Type

IsDevelopmentEnv

True if development environemnt

public bool IsDevelopmentEnv { get; }

Property Value

bool

LogFactory

App. ILoggerFactory

public ILoggerFactory LogFactory { get; init; }

Property Value

ILoggerFactory

Name

App. name

public string Name { get; init; }

Property Value

string

ServiceProv

App. IServiceProvider

public IServiceProvider ServiceProv { get; init; }

Property Value

IServiceProvider

TimeInfo

public IAppTime TimeInfo { get; init; }

Property Value

IAppTime

Methods

ApplyMissingApplicationConfig(string[]?)

Apply application config settings only if current settings are empty

public static void ApplyMissingApplicationConfig(string[]? args = null)

Parameters

args string[]

optional cmd line args

Remarks

The actual setings are composed according to AddApplicationConfig(IConfigurationBuilder, string?, string?, string[]?, string?)...

CreateBasicConsoleLoggerFactory(CustomStdoutFormatterOptions?)

Create a console ILoggerFactory from options

public static ILoggerFactory CreateBasicConsoleLoggerFactory(CustomStdoutFormatterOptions? options = null)

Parameters

options CustomStdoutFormatterOptions

Returns

ILoggerFactory

CreateLogFactory(IConfigurationSection)

Create a ILoggerFactory from config section logConfig

public static ILoggerFactory CreateLogFactory(IConfigurationSection logConfig)

Parameters

logConfig IConfigurationSection

Returns

ILoggerFactory

Deconstruct(out string, out string, out string, out ConfigurationManager, out ILoggerFactory, out IServiceProvider, out IAppTime)

public void Deconstruct(out string Name, out string EnvironmentName, out string ContentRoot, out ConfigurationManager Configuration, out ILoggerFactory LogFactory, out IServiceProvider ServiceProv, out IAppTime TimeInfo)

Parameters

Name string

EnvironmentName string

ContentRoot string

Configuration ConfigurationManager

LogFactory ILoggerFactory

ServiceProv IServiceProvider

TimeInfo IAppTime

Equals(object?)

public override bool Equals(object? obj)

Parameters

obj object

Returns

bool

Equals(ApplicationSetup?)

public virtual bool Equals(ApplicationSetup? other)

Parameters

other ApplicationSetup

Returns

bool

GetHashCode()

public override int GetHashCode()

Returns

int

InitLog(Type)

Creates an application logger (and intital log output) for tp.

public static ILogger InitLog(Type tp)

Parameters

tp Type

Returns

ILogger

InitLog<T>()

Creates an application logger (and intital log output).

public static ILogger<T> InitLog<T>()

Returns

ILogger<T>

Type Parameters

T

Application type

PrintMembers(StringBuilder)

protected virtual bool PrintMembers(StringBuilder builder)

Parameters

builder StringBuilder

Returns

bool

SetupLogFactory(string)

Setup a LogFactory for a non-empty section with sectionName

public static void SetupLogFactory(string sectionName)

Parameters

sectionName string

ToString()

public override string ToString()

Returns

string

Operators

operator ==(ApplicationSetup?, ApplicationSetup?)

public static bool operator ==(ApplicationSetup? left, ApplicationSetup? right)

Parameters

left ApplicationSetup

right ApplicationSetup

Returns

bool

operator !=(ApplicationSetup?, ApplicationSetup?)

public static bool operator !=(ApplicationSetup? left, ApplicationSetup? right)

Parameters

left ApplicationSetup

right ApplicationSetup

Returns

bool