A lightweight wrapper of an
HttpClient(usingIHttpClientFactory) for POSTing messages that allows the user to send the SOAP Body and Header (if needed) without caring about the envelope.
- Replaced HttpClient with HttpClientFactory.
- Added support for Cancellation Tokens.
- Updated codebase.
- Migrated test project to .net core app.
- Fixed an error of SOAPAction not being sent.
- Updated to NetStandardLibrary 2.0
- Fixed a bug where an extension method was calling himself recursively
- Major refactor to the codebase.
- Added the functionality of adding more than one header and/or body in the envelope.
- The ctor will no longer determine the SoapVersion, since it is a message property and the API should be ignorant about this.
- [BREAKING CHANGE]: SoapVersion is now required for every message.
- [BREAKING CHANGE]: Removed methods where the endpoint was a string instead of an uri.
SoapClient()Initializes SoapClient with a default IHttpClientFactory that implements automatic decompression.
SoapClient(IHttpClientFactory httpClientFactory)Initializes SoapClient with a IHttpClientFactory provided by the caller.
The IHttpClientFactory is the new interface used to manage HttpClient introduced on .NET Core 2.1.
All Methods and Extension Methods returns a Task of
HttpResponseMessage
The interface makes the client implement the following method:
Task<HttpResponseMessage> PostAsync(
Uri endpoint,
SoapVersion soapVersion,
IEnumerable<XElement> bodies,
IEnumerable<XElement> headers = null,
string? action = null,
CancellationToken cancellationToken = CancellationToken.Default);Allowing us to send the following calls:
- Uri / Version / Bodies
- Uri / Version / Bodies / Headers
- Uri / Version / Bodies / Headers / Action
Then there are sugar sintax extension methods:
Task<HttpResponseMessage> PostAsync(
this ISoapClient client,
Uri endpoint,
SoapVersion soapVersion,
XElement body,
XElement header = null,
string? action = null,
CancellationToken cancellationToken = CancellationToken.Default);
Task<HttpResponseMessage> PostAsync(
this ISoapClient client,
Uri endpoint,
SoapVersion soapVersion,
IEnumerable<XElement> bodies,
XElement header,
string? action = null,
CancellationToken cancellationToken = CancellationToken.Default);
Task<HttpResponseMessage> PostAsync(
this ISoapClient client,
Uri endpoint,
SoapVersion soapVersion,
XElement body,
IEnumerable<XElement> headers,
string? action = null,
CancellationToken cancellationToken = CancellationToken.Default);Allowing us to send the following calls:
- Uri / Version / Body
- Uri / Version / Body / Header
- Uri / Version / Body / Header / Action
- Uri / Version / Bodies / Header
- Uri / Version / Bodies / Header / Action
- Uri / Version / Body / Headers
- Uri / Version / Body / Headers / Action
With all of these variants we can send a message with:
- 1 Body - 1 Header
- 1 Body - N Headers
- N Bodies - 1 Header
- N Bodies - N Headers
There are also extension methods for sync calls: However we always recommend using async programming when you are able.
Their method name is Post and their return type is
HttpResponseMessage
Finally, we have extensions methods for using bodies and headers as objects and using serialization the default or a custom IXElementSerializer to serialize those objects to XElement.
As the SoapHttpClient wraps a HttpClient you can control all aspects of the HTTP Request using a HttpMessageHandler:
public class ContentTypeChangingHandler : DelegatingHandler
{
public ContentTypeChangingHandler(HttpMessageHandler innerHandler) : base(innerHandler) { }
protected async override Task<HttpResponseMessage> SendAsync(
HttpRequestMessage request,
CancellationToken cancellationToken)
{
request.Content.Headers.ContentType = MediaTypeHeaderValue.Parse("text/xml; charset=utf-8");
return await base.SendAsync(request, cancellationToken);
}
}async Task CallNasaAsync()
{
var soapClient = new SoapClient();
var ns = XNamespace.Get("http://helio.spdf.gsfc.nasa.gov/");
var result =
await soapClient.PostAsync(
new Uri("http://sscweb.gsfc.nasa.gov:80/WS/helio/1/HeliocentricTrajectoriesService"),
SoapVersion.Soap11,
body: new XElement(ns.GetName("getAllObjects")));
result.StatusCode.Should().Be(HttpStatusCode.OK);
}<?xml version="1.0" encoding="UTF-8"?>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:getAllObjectsResponse xmlns:ns2="http://helio.spdf.gsfc.nasa.gov/">
<return>
<endDate>1993-01-01T00:00:00Z</endDate>
<id>0001</id>
<name>COMET GRIGG-SKJLP</name>
<startDate>1992-01-01T00:00:00Z</startDate>
</return>
<return>
<endDate>1996-03-02T00:00:00Z</endDate>
<id>0002</id>
<name>COMET H-M-P</name>
<startDate>1996-01-01T00:00:00Z</startDate>
</return>
<return>
<endDate>1997-12-31T00:00:00Z</endDate>
<id>0003</id>
<name>COMET HALE-BOPP</name>
<startDate>1997-01-01T00:00:00Z</startDate>
</return>
.
.
.
</ns2:getAllObjectsResponse>
</S:Body>
</S:Envelope>Soap Icon Created by Jakob Vogel from the Noun Project
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent