Overview

Install

npm install strong-soap

Client

"use strict";varsoap=require('strong-soap').soap;// wsdl of the web service this client is going to invoke. For local wsdl you can use, url = './wsdls/stockquote.wsdl'varurl='http://www.webservicex.net/stockquote.asmx?WSDL';varrequestArgs={symbol:'IBM'};varoptions={};soap.createClient(url,options,function(err,client){varmethod=client['StockQuote']['StockQuoteSoap']['GetQuote'];method(requestArgs,function(err,result,envelope,soapHeader){//response envelopeconsole.log('Response Envelope: \n'+envelope);//'result' is the response bodyconsole.log('Result: \n'+JSON.stringify(result));});});

varsoap=require('strong-soap').soap;varWSDL=soap.WSDL;varurl='http://www.webservicex.net/stockquote.asmx?WSDL';// Pass in WSDL options if anyvaroptions={};WSDL.open(url,options,function(err,wsdl){// You should be able to get to any information of this WSDL from this object. Traverse// the WSDL tree to get  bindings, operations, services, portTypes, messages,// parts, and XSD elements/Attributes.// Set the wsdl object in the cache. The key (e.g. 'stockquotewsdl')// can be anything, but needs to match the parameter passed into soap.createClient()varclientOptions={WSDL_CACHE :{stockquotewsdl:wsdl}};soap.createClient('stockquotewsdl',clientOptions,function(err,client){varmethod=client['StockQuote']['StockQuoteSoap']['GetQuote'];method(requestArgs,function(err,result,envelope,soapHeader){//response envelopeconsole.log('Response Envelope: \n'+envelope);//'result' is the response bodyconsole.log('Result: \n'+JSON.stringify(result));});});});

<?xml version="1.0" encoding="UTF-8" standalone="yes"?><soap:Envelopexmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">  <soap:Header/>  <soap:Body>    <ns1:GetQuotexmlns:ns1="http://www.webserviceX.NET/">      <ns1:symbol>IBM</ns1:symbol>    </ns1:GetQuote>  </soap:Body></soap:Envelope>

Extra headers (optional)

varclientOptions={};soap.createClient(url,clientOptions,function(err,client){varcustomRequestHeader={customheader1:'test1'};// Custom request headerclient.GetQuote(requestArgs,function(err,result,envelope){// Result in SOAP envelope body which is the wrapper element.// In this case, result object corresponds to GetCityForecastByZIPResponse.console.log(JSON.stringify(result));},null,customRequestHeader);});

Client.describe()

// Describes the entire WSDL in a JSON tree object form.vardescription=client.describe();// Inspect GetQuote operation. You can inspect Service: {Port: {operation: {console.log(JSON.stringify(description.StockQuote.StockQuoteSoap.GetQuote));

Client.setSecurity(security)

Client.method(args, callback)

client.MyFunction({name:'value'},function(err,result,envelope,soapHeader){// Result is a javascript object// Envelope is the response envelope from the Web Service// soapHeader is the response soap header as a JavaScript object})

client.MyFunction({name:'value'}).then(function({result, envelope, soapHeader}){// ...},function(err){// ...});// in async/await flavortry{const{result, envelope, soapHeader}=awaitclient.MyFunction({name:'value'});}catch(err){// handle error}

Client.service.port.method(args, callback[, options[, extraHeaders]])

client.MyService.MyPort.MyFunction({name:'value'},function(err,result){// Result is a JavaScript object})

Options (optional)

client.MyService.MyPort.MyFunction({name:'value'},function(err,result){// result is a javascript object},{timeout:5000})

client.MyService.MyPort.MyFunction({name:'value'},function(err,result){// client.lastElapsedTime - the elapsed time of the last request in milliseconds},{time:true})

Alternative method call using callback-last pattern

client.MyService.MyPort.MyFunction({name:'value'},options,function(err,result){// result is a javascript object})client.MyService.MyPort.MyFunction({name:'value'},options,extraHeaders,function(err,result){// result is a javascript object})

Client.lastRequest

Client.setEndpoint(url)

Client events

soap.createClient(__dirname+'/wsdl/default_namespace.wsdl',function(err,client){vardidEmitEvent=false;client.on('soapError',function(err){didEmitEvent=true;assert.ok(err.root.Envelope.Body.Fault);});client.MyOperation({},function(err,result){assert.ok(didEmitEvent);done();});},baseUrl);

Security

BasicAuthSecurity

client.setSecurity(newsoap.BasicAuthSecurity('username','password'));

BearerSecurity

client.setSecurity(newsoap.BearerSecurity('token'));

ClientSSLSecurity

client.setSecurity(newsoap.ClientSSLSecurity('/path/to/key','/path/to/cert',{/*default request options*/}));

WSSecurity

varwsSecurity=newWSSecurity(username,password,options)//the 'options' object is optional and contains properties://passwordType: 'PasswordDigest' or 'PasswordText' default is PasswordText//hasTimeStamp: true or false, default is true//hasTokenCreated: true or false, default is trueclient.setSecurity(wsSecurity);

WSSecurityCert

varprivateKey=fs.readFileSync(privateKeyPath);varpublicKey=fs.readFileSync(publicKeyPath);varpassword='';// optional passwordvarwsSecurity=newsoap.WSSecurityCert(privateKey,publicKey,password,'utf8');client.setSecurity(wsSecurity);

ClientSSLSecurityPFX

constpfxSecurity=newsoap.ClientSSLSecurityPFX(pathToPfxOrFileBuffer,passphrase)client.setSecurity(pfxSecurity)

XML attributes

Handling XML attributes, value, and XML (wsdlOptions)

varwsdlOptions={attributesKey:'theAttrs',valueKey:'theVal',xmlKey:'theXml'}

Overriding the value key

varwsdlOptions={valueKey:'theVal'};soap.createClient(__dirname+'/wsdl/default_namespace.wsdl',wsdlOptions,function(err,client){// your code});

Overriding the xml key

dom={$xml:'<parentnode type="type"><childnode></childnode></parentnode>'};

<tns:dom>    <parentnodetype="type">          <childnode></childnode>    </parentnode></tns:dom>

varwsdlOptions={xmlKey:'theXml'};soap.createClient(__dirname+'/wsdl/default_namespace.wsdl',wsdlOptions,function(err,client){// your code});

Overriding the attributes key

<parentnode>  <childnodename="childsname">  </childnode></parentnode>

{parentnode:{childnode:{$attributes:{name:'childsname'}}}}

<attributes></attributes>

varwsdlOptions={attributesKey:'$attributes'};

soap.createClient(__dirname+'/wsdl/default_namespace.wsdl',wsdlOptions,function(err,client){client.*method*({parentnode:{childnode:{$attributes:{$xsiType:"{xmlnsTy}Ty"}}}});});

soap.createClient(__dirname+'/wsdl/default_namespace.wsdl',wsdlOptions,function(err,client){client.*method*({parentnode:{childnode:{$attributes:{}}}});});

XMLHandler

varsoap=require('..').soap;varXMLHandler=soap.XMLHandler;varxmlHandler=newXMLHandler();varutil=require('util');varurl='http://www.webservicex.net/stockquote.asmx?WSDL';varrequestArgs={symbol:'IBM'};varoptions={};varclientOptions={};soap.createClient(url,clientOptions,function(err,client){varcustomRequestHeader={customheader1:'test1'};client.GetQuote(requestArgs,function(err,result,envelope,soapHeader){// Convert 'result' JSON object to XMLvarnode=xmlHandler.jsonToXml(null,null,XMLHandler.createSOAPEnvelopeDescriptor('soap'),result);varxml=node.end({pretty:true});console.log(xml);// Convert XML to JSON objectvarroot=xmlHandler.xmlToJson(null,xml,null);console.log('%s',util.inspect(root,{depth:null}));},options,customRequestHeader);});

varroot=XMLHandler.parseXml(null,xmlString);

WSDL

wsdl.open(wsdlURL, options, callback(err, wsdl))

varsoap=require('..').soap;varWSDL=soap.WSDL;varpath=require('path');// Pass in WSDL options if anyvaroptions={};WSDL.open('./wsdls/stockquote.wsdl',options,function(err,wsdl){// You should be able to get to any information of this WSDL from this object. Traverse// the WSDL tree to get  bindings, operations, services, portTypes, messages,// parts, and XSD elements/Attributes.vargetQuoteOp=wsdl.definitions.bindings.StockQuoteSoap.operations.GetQuote;// print operation nameconsole.log(getQuoteOp.$name);varservice=wsdl.definitions.services['StockQuote'];//print service nameconsole.log(service.$name);});

wsdl.openSync(wsdlURL, options)

Server

soap.listen(server,path,services,wsdl)

varmyService={MyService:{MyPort:{MyFunction:function(args){return{name:args.name};},// This is how to define an asynchronous function.MyAsyncFunction:function(args,callback){// do some workcallback({name:args.name});},// This is how to receive incoming headersHeadersAwareFunction:function(args,cb,headers){return{name:headers.Token};},// You can also inspect the original `req`reallyDetailedFunction:function(args,cb,headers,req){console.log('SOAP `reallyDetailedFunction` request from '+req.connection.remoteAddress);return{name:headers.Token};}}}};varxml=require('fs').readFileSync('myservice.wsdl','utf8'),server=http.createServer(function(request,response){response.end("404: Not Found: "+request.url);});server.listen(8000);soap.listen(server,'/wsdl',myService,xml);

Options

varxml=require('fs').readFileSync('myservice.wsdl','utf8');soap.listen(server,{// Server options.path:'/wsdl',services:myService,xml:xml,// WSDL options.attributesKey:'theAttrs',valueKey:'theVal',xmlKey:'theXml'});

Server logging

server=soap.listen(...)server.log=function(type,data){// type is 'received' or 'replied'};

Server events

test.soapServer.on('request',functionrequestManager(request,methodName){assert.equal(methodName,'GetLastTradePrice');done();});

SOAP Fault

test.service={DocLiteralWrappedService:{DocLiteralWrappedPort:{myMethod:function(args,cb,soapHeader){throw{Fault:{faultcode:"sampleFaultCode",faultstring:"sampleFaultString",detail:{myMethodFault:{errorMessage:'MyMethod Business Exception message',value:10}}}}}}}}

test.service={DocLiteralWrappedService:{DocLiteralWrappedPort:{myMethod:function(args,cb,soapHeader){throw{Fault:{Code:{Value:"soap:Sender",Subcode:{Value:"rpc:BadArguments"}},Reason:{Text:"Processing Error"},Detail:{myMethodFault2:{errorMessage2:'MyMethod Business Exception message',value2:10}}}}}}}}

Server security example using PasswordDigest

server=soap.listen(...)server.authenticate=function(security){varcreated,nonce,password,user,token;token=security.UsernameToken,user=token.Username,password=token.Password,nonce=token.Nonce,created=token.Created;returnuser==='user'&&password===soap.passwordDigest(nonce,created,'password');};

Server connection authorization

server=soap.listen(...)server.authorizeConnection=function(req){returntrue;// or false};

SOAP headers

Received SOAP headers

{HeadersAwareFunction:function(args,cb,headers){return{name:headers.Token};}}

server=soap.listen(...)server.on('headers',function(headers,methodName){// It is possible to change the value of the headers// before they are handed to the service method.// It is also possible to throw a SOAP Fault});

Outgoing SOAP headers

addSoapHeader(value, qname)

addSoapHeader(value, qname, options);

changeSoapHeader(index, value, qname)

getSoapHeaders()

clearSoapHeaders()

soap-stub

Example

varsinon=require('sinon');varsoapStub=require('strong-soap/soap-stub');varurlMyApplicationWillUseWithCreateClient='./example/stockquote.wsdl';varclientStub={SomeOperation:sinon.stub()};clientStub.SomeOperation.respondWithError=soapStub.createRespondingStub({error:'error'});clientStub.SomeOperation.respondWithSuccess=soapStub.createRespondingStub({success:'success'});// or if you are using promisesclientStub.SomeOperation.respondWithError=soapStub.createRespondingStubAsync({error:'error'});clientStub.SomeOperation.respondWithSuccess=soapStub.createRespondingStubAsync({success:'success'});soapStub.registerClient('my client alias',urlMyApplicationWillUseWithCreateClient,clientStub);varfs=require('fs'),assert=require('assert'),request=require('@cypress/request'),http=require('http'),lastReqAddress;describe('myService',function(){varclientStub;varmyService;beforeEach(function(){clientStub=soapStub.getStub('my client alias');soapStub.reset();myService=clientStub;});describe('failures',function(){beforeEach(function(){clientStub.SomeOperation.respondWithError();});it('should handle error responses',function(){myService.SomeOperation(function(err,response){// handle the error response.});});});});

Contributors