Pip-Services-Commons-Dotnet
Static Public Member Functions | List of all members
PipServices3.Commons.Config.NameResolver Class Reference

A helper class that allows to extract component name from configuration parameters. The name can be defined in "id", "name" parameters or inside a component descriptor. More...

Static Public Member Functions

static string Resolve (ConfigParams config, string defaultName=null)
 Resolves a component name from configuration parameters. The name can be stored in "id", "name" fields or inside a component descriptor.If name cannot be determined it returns a defaultName. More...
 

Detailed Description

A helper class that allows to extract component name from configuration parameters. The name can be defined in "id", "name" parameters or inside a component descriptor.

var config = ConfigParams.FromTuples( "descriptor", "myservice:connector:aws:connector1:1.0",
"param1", "ABC",
"param2", 123 );
var name = NameResolver.Resolve(config); // Result: connector1

Member Function Documentation

◆ Resolve()

static string PipServices3.Commons.Config.NameResolver.Resolve ( ConfigParams  config,
string  defaultName = null 
)
static

Resolves a component name from configuration parameters. The name can be stored in "id", "name" fields or inside a component descriptor.If name cannot be determined it returns a defaultName.

Parameters
configconfiguration parameters that may contain a component name.
defaultName(optional) a default component name.
Returns
resolved name or default name if the name cannot be determined.

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