Soap

A SOAP client and server for node.js.

This module lets you connect to web services using SOAP. It also provides a server that allows you to run your own SOAP services.

Features:

• Very simple API
• Handles both RPC and Document schema types
• Supports multiRef SOAP messages (thanks to @kaven276)
• Support for both synchronous and asynchronous method handlers
• WS-Security (currently only UsernameToken and PasswordText encoding is supported)

Install

Install with npm:

 npm install soap

Module

soap.createClient(url[, options], callback) - create a new SOAP client from a WSDL url. Also supports a local filesystem path.

varsoap=require('soap');varurl='http://example.com/wsdl?wsdl';varargs={name: 'value'};soap.createClient(url,function(err,client){client.MyFunction(args,function(err,result){console.log(result);});});

Within the options object you may provide an endpoint property in case you want to override the SOAP service's host specified in the .wsdl file.

soap.listen(server, path, services, wsdl) - create a new SOAP server that listens on path and provides services.

wsdl is an xml string that defines the service.

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})}}}}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);

server logging

If the log method is defined it will be called with 'received' and 'replied' along with data.

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

server security example using PasswordDigest

If server.authenticate is not defined no authentation will take place.

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

This is called prior to soap service method If the method is defined and returns false the incoming connection is terminated.

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

Client

An instance of Client is passed to the soap.createClient callback. It is used to execute methods on the soap service.

Client.describe() - description of services, ports and methods as a JavaScript object

client.describe()// returns{MyService: {MyPort: {MyFunction: {input: {name: 'string'}}}}}

Client.setSecurity(security) - use the specified security protocol

node-soap has several default security protocols. You can easily add your own as well. The interface is quite simple. Each protocol defines 2 methods:

• addOptions - a method that accepts an options arg that is eventually passed directly to request
• toXML - a method that reurns a string of XML.

By default there are 3 protocols:

####BasicAuthSecurity

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

####ClientSSLSecurity Note: If you run into issues using this protocol, consider passing these options as default request options to the constructor:

• rejectUnauthorized: false
• strictSSL: false
• secureOptions: constants.SSL_OP_NO_TLSv1_2//this is likely needed for node >= 10.0

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

####WSSecurity

client.setSecurity(newWSSecurity('username','password'))

Client.method(args, callback) - call method on the SOAP service.

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

Client.service.port.method(args, callback[, options]) - call a method using a specific service and port

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

+#### Options (optional)

• Accepts any option that the request module accepts, see here.
• For example, you could set a timeout of 5 seconds on the request like this:

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

Client.addSoapHeader(soapHeader[, name, namespace, xmlns]) - add soapHeader to soap:Header node

Options

• soapHeader Object({rootName: {name: "value"}}) or strict xml-string

Optional parameters when first arg is object :

• name Unknown parameter (it could just a empty string)
• namespace prefix of xml namespace
• xmlns URI

Client.lastRequest - the property that contains last full soap request for client logging

WSSecurity

WSSecurity implements WS-Security. UsernameToken and PasswordText/PasswordDigest is supported. An instance of WSSecurity is passed to Client.setSecurity.

newWSSecurity(username,password,passwordType)//'PasswordDigest' or 'PasswordText' default is PasswordText

Handling XML Attributes.

You can achieve attributes like:

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

By attaching an attributes object to a node.

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

However, "attributes" may be a reserved key for some systems that actually want a node

<attributes>
</attributes>

In this case you can configure the attributes key by passing in an options object to the createClient call like so.

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