Class IConfigurationExtensions

Namespace

Steeltoe.Connector

Assembly

Steeltoe.Connector.ConnectorBase.dll

public static class IConfigurationExtensions

Inheritance

object

IConfigurationExtensions

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Methods

AddConnectionStrings(IConfigurationBuilder)

Adds a configuration provider that uses Connector logic to fulfill requests for GetConnectionString("serviceType") or GetConnectionString("serviceBindingName")

public static IConfigurationBuilder AddConnectionStrings(this IConfigurationBuilder builder)

Parameters

builder IConfigurationBuilder

IConfigurationBuilder

Returns

IConfigurationBuilder

IConfigurationBuilder with ConnectionStringConfigurationSource added

GetRequiredServiceInfo<TServiceInfo>(IConfiguration, string)

Get info for a named service

public static TServiceInfo GetRequiredServiceInfo<TServiceInfo>(this IConfiguration configuration, string serviceName) where TServiceInfo : class

Parameters

configuration IConfiguration

Configuration to retrieve service info from

serviceName string

Name of the service

Returns

TServiceInfo

Information requried to connect to provisioned service

Type Parameters

TServiceInfo

Type of Service Info to return

Exceptions

ConnectorException

Thrown when service info isn't found

GetServiceInfo(IConfiguration, string)

Get service info when you know the Id

public static IServiceInfo GetServiceInfo(this IConfiguration configuration, string id)

Parameters

configuration IConfiguration

Configuration to search

id string

Id of service

Returns

IServiceInfo

Requested implementation of IServiceInfo

GetServiceInfo<TServiceInfo>(IConfiguration, string)

Get service info of a given type when you know the Id

public static TServiceInfo GetServiceInfo<TServiceInfo>(this IConfiguration configuration, string id) where TServiceInfo : class

Parameters

configuration IConfiguration

Configuration to search

id string

Id of service

Returns

TServiceInfo

Requested implementation of IServiceInfo

Type Parameters

TServiceInfo

Service info type you're looking for

GetServiceInfos(IConfiguration, Type)

Get configuration info for all services of a given service type

public static IEnumerable<IServiceInfo> GetServiceInfos(this IConfiguration configuration, Type infoType)

Parameters

configuration IConfiguration

Configuration to search

infoType Type

Type to search for

Returns

IEnumerable<IServiceInfo>

A list of relevant IServiceInfo

GetServiceInfos<TServiceInfo>(IConfiguration)

Get configuration info for all services of a given service type

public static IEnumerable<TServiceInfo> GetServiceInfos<TServiceInfo>(this IConfiguration configuration) where TServiceInfo : class

Parameters

configuration IConfiguration

Configuration to search

Returns

IEnumerable<TServiceInfo>

List of service infos

Type Parameters

TServiceInfo

Service info type you're looking for

GetSingletonServiceInfo<TServiceInfo>(IConfiguration)

Get Service Info from IConfiguration

public static TServiceInfo GetSingletonServiceInfo<TServiceInfo>(this IConfiguration config) where TServiceInfo : class

Parameters

config IConfiguration

Configuration to retrieve service info from

Returns

TServiceInfo

Information requried to connect to provisioned service

Type Parameters

TServiceInfo

Type of Service Info to return

Exceptions

ConnectorException

Thrown when multple matching services are found

HasCloudFoundryServiceConfigurations(IConfiguration)

Evaluate whether an IConfiguration contains services bound by Cloud Foundry

public static bool HasCloudFoundryServiceConfigurations(this IConfiguration configuration)

Parameters

configuration IConfiguration

Application Configuration

Returns

bool

true if vcap:services found in config, otherwise false

HasKubernetesServiceBindings(IConfiguration)

Evaluate whether an IConfiguration contains Kubernetes service bindings.

public static bool HasKubernetesServiceBindings(this IConfiguration configuration)

Parameters

configuration IConfiguration

Application Configuration.

Returns

bool

true if k8s:bindings found in configuration, otherwise false.