👁 Image
WcfClient.Dynamic 8.0.3

WcfClient.Dynamic

This package simplifies the process of consuming web endpoints of SOAP style, allowing dynamic (re)configuration of endpoint address, binding type, and all related data within appsettings. Incoming and outgoing messages, as well as other properties, can be configured using this package.

Installation

The package may be installed with the following commands:

• Using the .NET CLI:

dotnet add package WcfClient.Dynamic --latest

Configuration

In the startup.cs or in the program.cs class, add the following line of code to configure a WCF client for consuming the desired web service:

services.AddWcfGenericClient<WebServiceInterface, Settings>(configurationSectionName)

where Settings is a SoapSettings class or any other class that derives from it.

The configuration section in the appsettings file may take one of the following forms:

"ConfigurationSectionName": {
 "OutgoingMessageHeaders": {
 "Headers": [
 {
 "Key": "HeaderName",
 "Value": "HeaderValue",
 "Ns": "Namespace"
 }
 ]
 },
 "OutgoingMessageProperties": [
 {
 "Key": "CookieName",
 "Value": "CookieValue"
 }
 ],
 "SoapClient": {
 // Binding section here ...
 // ...
 "EndpointConfiguration": 1
 }
}

Note that OutgoingMessageHeaders and OutgoingMessageProperties sections are optional.

Allowed bindings

The following configuration shows allowed bindings for the WCF client:

{
 "SoapSettings": {
 "ServiceLifetime": "Transient",
 "OutgoingMessageHeaders": {
 "Headers": [
 {
 "Key": "HeaderName",
 "Value": "HeaderValue",
 "Ns": "Namespace"
 }
 ]
 },
 "OutgoingMessageProperties": [
 {
 "Key": "CookieName",
 "Value": "CookieValue"
 }
 ],
 "SoapClient": {
 "SoapHttpBinding": {
 "EndpointAddress": "https://example.com/service.svc",
 "CloseTimeout": 30,
 "Name": "MySoapHttpBinding",
 "NamespaceIdentifier": "http://tempuri.org/",
 "OpenTimeout": 30,
 "ReceiveTimeout": 60,
 "SendTimeout": 60,
 "AllowCookies": false,
 "BypassProxyOnLocal": true,
 "MaxBufferSize": 65536,
 "MaxBufferPoolSize": 524288,
 "MaxReceivedMessageSize": 65536,
 "TransferMode": "Buffered",
 "ClientCredentialType": "Windows",
 "ProxyCredentialType": "None",
 "MessageCredentialType": "UserName",
 "UseDefaultWebProxy": true,
 "HostNameComparisonMode": "StrongWildcard",
 "SecurityMode": "Transport",
 "MessageEncoding": "Text"
 },
 "SoapHttpsBinding": {
 "EndpointAddress": "https://secure.example.com/service.svc",
 "CloseTimeout": 30,
 "Name": "MySoapHttpsBinding",
 "NamespaceIdentifier": "http://tempuri.org/",
 "OpenTimeout": 30,
 "ReceiveTimeout": 60,
 "SendTimeout": 60,
 "AllowCookies": false,
 "BypassProxyOnLocal": true,
 "MaxBufferSize": 65536,
 "MaxBufferPoolSize": 524288,
 "MaxReceivedMessageSize": 65536,
 "TransferMode": "Buffered",
 "ClientCredentialType": "Certificate",
 "ProxyCredentialType": "None",
 "MessageCredentialType": "UserName",
 "UseDefaultWebProxy": true,
 "HostNameComparisonMode": "StrongWildcard",
 "BasicHttpsSecurityMode": "Transport",
 "MessageEncoding": "Text"
 },
 "SoapNetHttpBinding": {
 "EndpointAddress": "https://api.example.com/nethttp/service.svc",
 "CloseTimeout": 30,
 "Name": "MySoapNetHttpBinding",
 "NamespaceIdentifier": "http://tempuri.org/",
 "OpenTimeout": 30,
 "ReceiveTimeout": 60,
 "SendTimeout": 60,
 "AllowCookies": false,
 "BypassProxyOnLocal": true,
 "MaxBufferSize": 65536,
 "MaxBufferPoolSize": 524288,
 "MaxReceivedMessageSize": 65536,
 "TransferMode": "Buffered",
 "ClientCredentialType": "Windows",
 "ProxyCredentialType": "None",
 "MessageCredentialType": "UserName",
 "UseDefaultWebProxy": true,
 "HostNameComparisonMode": "StrongWildcard",
 "MessageEncoding": "Text",
 "SecurityMode": "Transport",
 "ReliableSessionEnabled": true
 },
 "SoapNetHttpsBinding": {
 "EndpointAddress": "https://secure.example.com/service.svc",
 "CloseTimeout": 30,
 "Name": "MySoapHttpsBinding",
 "NamespaceIdentifier": "http://tempuri.org/",
 "OpenTimeout": 30,
 "ReceiveTimeout": 60,
 "SendTimeout": 60,
 "AllowCookies": false,
 "BypassProxyOnLocal": true,
 "MaxBufferSize": 65536,
 "MaxBufferPoolSize": 524288,
 "MaxReceivedMessageSize": 65536,
 "TransferMode": "Buffered",
 "ClientCredentialType": "Certificate",
 "ProxyCredentialType": "None",
 "MessageCredentialType": "UserName",
 "UseDefaultWebProxy": true,
 "HostNameComparisonMode": "StrongWildcard",
 "BasicHttpsSecurityMode": "Transport",
 "MessageEncoding": "Text"
 },
 "SoapNetNamedPipeBinding": {
 "EndpointAddress": "net.pipe://localhost/MyService",
 "CloseTimeout": 30,
 "Name": "MySoapNetNamedPipeBinding",
 "NamespaceIdentifier": "http://tempuri.org/",
 "OpenTimeout": 30,
 "ReceiveTimeout": 60,
 "SendTimeout": 60,
 "SecurityMode": "Transport",
 "ProtectionLevel": "EncryptAndSign",
 "TransferMode": "Buffered",
 "MaxBufferPoolSize": 524288,
 "MaxBufferSize": 65536,
 "MaxConnections": 10,
 "MaxReceivedMessageSize": 65536
 },
 "SoapNetTcpBinding": {
 "EndpointAddress": "net.tcp://localhost:8080/MyService",
 "CloseTimeout": 30,
 "Name": "MySoapNetTcpBinding",
 "NamespaceIdentifier": "http://tempuri.org/",
 "OpenTimeout": 30,
 "ReceiveTimeout": 60,
 "SendTimeout": 60,
 "TransferMode": "Buffered",
 "MaxBufferPoolSize": 524288,
 "MaxBufferSize": 65536,
 "MaxConnections": 10,
 "MaxReceivedMessageSize": 65536,
 "SecurityMode": "Transport",
 "ReliableSessionEnabled": true,
 "ClientCredentialType": "Windows",
 "ProtectionLevel": "EncryptAndSign",
 "MessageCredentialType": "UserName"
 },
 "SoapWsHttpBinding": {
 "EndpointAddress": "https://example.com/wshttp/service.svc",
 "CloseTimeout": 30,
 "Name": "MySoapWsHttpBinding",
 "NamespaceIdentifier": "http://tempuri.org/",
 "OpenTimeout": 30,
 "ReceiveTimeout": 60,
 "SendTimeout": 60,
 "SecurityMode": "TransportWithMessageCredential",
 "ReliableSessionEnabled": true,
 "BypassProxyOnLocal": true,
 "TransactionFlow": false,
 "MaxBufferPoolSize": 524288,
 "MaxReceivedMessageSize": 65536,
 "MessageEncoding": "Text",
 "UseDefaultWebProxy": true,
 "ClientCredentialType": "Windows",
 "ProxyCredentialType": "None",
 "MessageCredentialType": "UserName",
 "EstablishSecurityContext": true,
 "NegotiateServiceCredential": true,
 "AllowCookies": false
 },
 "SoapWS2007HttpBinding": {
 "EndpointAddress": "https://example.com/wshttp2007/service.svc",
 "CloseTimeout": 30,
 "Name": "MySoapWsHttpBinding",
 "NamespaceIdentifier": "http://tempuri.org/",
 "OpenTimeout": 30,
 "ReceiveTimeout": 60,
 "SendTimeout": 60,
 "SecurityMode": "TransportWithMessageCredential",
 "ReliableSessionEnabled": true,
 "BypassProxyOnLocal": true,
 "TransactionFlow": false,
 "MaxBufferPoolSize": 524288,
 "MaxReceivedMessageSize": 65536,
 "MessageEncoding": "Text",
 "UseDefaultWebProxy": true,
 "ClientCredentialType": "Windows",
 "ProxyCredentialType": "None",
 "MessageCredentialType": "UserName",
 "EstablishSecurityContext": true,
 "NegotiateServiceCredential": true,
 "AllowCookies": false
 },
 "SoapWSFederationHttpBinding": {
 "EndpointAddress": "https://auth.example.com/wsfed/service.svc",
 "CloseTimeout": 30,
 "Name": "MySoapWSFederationHttpBinding",
 "NamespaceIdentifier": "http://tempuri.org/",
 "OpenTimeout": 30,
 "ReceiveTimeout": 60,
 "SendTimeout": 60,
 "SecurityMode": "TransportWithMessageCredential",
 "ReliableSessionEnabled": true,
 "BypassProxyOnLocal": true,
 "TransactionFlow": false,
 "MaxBufferPoolSize": 524288,
 "MaxReceivedMessageSize": 65536,
 "MessageEncoding": "Text",
 "UseDefaultWebProxy": true,
 "ClientCredentialType": "Windows",
 "ProxyCredentialType": "None",
 "MessageCredentialType": "UserName",
 "EstablishSecurityContext": true,
 "NegotiateServiceCredential": true,
 "AllowCookies": false,
 "WsTrustTokenParameters": {
 "IssuerAddress": "https://sts.example.com/issue",
 "IssuerBinding": "WSHttpBinding",
 "KeyType": "Bearer",
 "TokenType": "urn:oasis:names:tc:SAML:2.0:assertion",
 "Claims": [
 "email",
 "role",
 "name"
 ]
 }
 },
 "EndpointConfiguration": "SoapHttpBinding"
 }
 }
}

Usage

The WCF client may be injected into the specified service via:

1. IGenericWcfClient<WebServiceInterface> wcfClient;
2. Func<Settings, WcfClient<WebServiceInterface>> factoryMethod.

If you choose the second option, it will be necessary to inject the following lines into the constructor's declaration of your service implementation:

• Func<WcfClient<WebServiceInterface>, OperationContextScope> scopeSelector;
• IOptionsSnapshot<Settings> settings;

The consumption of the web service would look like this:

var result = await _wcfClient.CallAsync(x => 
{
 return x.Service.GetInfoAsync(new GetInfoRequest());
}

or

using (var client = _factoryMethod(_settings.Value))
{
 using (var scope = _scopeSelector(client))
 {
 // apply message's outgoing headers and properties here
 // ...

 return client.Service.GetInfoAsync(new GetInfoRequest());
 }
}