Class ProtoApplication

Namespace: ProtoTest.Core

Assembly: ProtoTest.Core.dll

Resolves the named application — a system under test with a base address and protocol descriptors — that a client or web session targets, and reads values from its ProtoTest:Applications:{app} section. A scope selects an application with its own Application setting, defaulting to the scope's own name, so a REST client, GraphQL client, and browser session can share one application.

public static class ProtoApplication

Inheritance: object

ProtoApplication

Inherited Members: object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Fields

SectionPath

The configuration prefix under which named applications are declared.

public const string SectionPath = "ProtoTest:Applications"

Field Value

string

Methods

BaseUrl(IConfiguration, string)

Returns the base address configured for an application, or null.

public static string? BaseUrl(IConfiguration configuration, string applicationName)

Parameters

configuration IConfiguration
applicationName string

Returns

string

Endpoint(IConfiguration, string, string)

Returns the relative path configured for a named endpoint of an application, or null.

public static string? Endpoint(IConfiguration configuration, string applicationName, string endpointName)

Parameters

configuration IConfiguration
applicationName string
endpointName string

Returns

string

MissingSettingMessage(string, string)

Returns the error message used when an application has no configured document.

public static string MissingSettingMessage(string applicationName, string setting)

Parameters

applicationName string
setting string

Returns

string

ResolveName(IConfiguration, string, string)

Returns the application a scope targets: its {scopeSection}:Application value, or fallback (normally the client or session name) when unset.

public static string ResolveName(IConfiguration configuration, string scopeSection, string fallback)

Parameters

configuration IConfiguration
scopeSection string
fallback string

Returns

string

Section(IConfiguration, string)

Returns the configuration section that describes an application.

public static IConfigurationSection Section(IConfiguration configuration, string applicationName)

Parameters

configuration IConfiguration
applicationName string

Returns

IConfigurationSection