Javascript proxy classes for accessing the "Symantec DLP Incident Reporting and Update API WSDL" provided by Enforce server versions 14.5 to 15.5.
Checkout the repo:
git clone https://github.com/epreston/sym-dlp-iru.js.git
cd sym-dlp-iru.js
npm installFor reference, these library dependencies are installed with the commands above.
npm install request xml2json-temporary lodashFollow the API documentation to create the pre-requisites for WSDL access.
- API user created with access permissions applicable to intended usage of the API.
- API report(s) defined and accessible to the API User
You will need to know:
- The current data and time
- The network address (or fully qualified name) and configured port of the Enforce Server.
- The index number of the reports configured for API reporting.
123is used as an example. Default reports do not work.
./DLP/
|
| // This holds one file per defined Element within the WSDL
├── Element
│ ├── SomeDefinedElement.js
| └── ...
|
| // This is where mock data goes from [myService].Settings.createMock
├── Mocks
│ ├── WsdlOperationName.js
| └── ...
|
| // This holds one file per defined Type within the WSDL
└── Type
| ├── SomeDefinedType.js
| └── ...
|
| // This is the main file which handles requests, JSON->XML->JSON, etc
├── index.js
|
| // This library provides strong typing, it's used in each Element/Type
├── Modeler.js
|
| // This file defines the top level functionality found within the WSDL
├── ServiceDefinition.js
Start by including the generated code:
var DLP = require("lib/DLP");This is how we create a new request:
// var someRequest = new Service.[WSDL-Binding-Name].[WSDL-Operation-Name]();
var assignRequest = new DLP.IncidentServicePort.updateIncidents(...);Setting basic properties is trivial
someRequest.someSimpleProperty = 1;Most requests consist of several complex types, they are all found within our service object:
someRequest.someElementProperty = new Service.Elements.[WSDL-Element-Name]();
someRequest.someTypeProperty = new Service.Types.[WSDL-Type-Name]();Populating Requests/Elements/Types can be done one at a time:
someRequest.someNumber = 1;
someRequest.someString = "1";We can also populate directly from a JSON object:
var json = { someNumber: 1, someString: "1" };
someRequest = new Service.TestRequest(json);
// someRequest.someNumber == 1
// someRequest.someString == "1"Trying to set a property's value to an invalid type will be discarded:
someRequest.PersonElement = null;
someRequest.PersonElement = new SomeRandomObject();
// someRequest.PersonElement == null;If we have an array of objects there's a helper function to save typing:
someRequest.PeopleList = new Service.Types.ArrayOfPeople;
someRequest.PeopleList.newChild({ firstname: "Oli", age: 24 });
// is the equivalent of:
someRequest.PeopleList = new Service.Types.ArrayOfPeople;
var newPerson = new Service.Types.Person();
newPerson.firstname = "Oli";
newPerson.age = 24;
someRequest.PeopleList.push(newPerson);Making the request is trivial:
someRequest.request(function(err, response) {
// 'response' is a modeled object, it WILL conform to the WSDL.
});Once we have a request and we want to edit it by adding properties not found in the WDSL, we must first extract the data from the response:
someRequest.request(function(err, response) {
response.SomeInvalidProperty = "testing";
// response.SomeInvalidProperty == null
var myResponse = response.extract();
myResponse.SomeInvalidProperty = "testing";
// myResponse.SomeInvalidProperty == "testing"
});List the custom attributes defined in this system.
// code hereList the incidents from report 123 since the date specified.
// code hereRetrieve the details of an incident.
// code hereRetrieve the details of multiple incidents.
// code hereRetrieve incident attachments.
// code hereUpdate an incident.
// code hereUpdate multiple incidents
// code herevar Service = require("path/to/generated/code");
// Change the duration (in milliseconds) the library will wait for the
// service to respond before timing out
// default: 15000 (15 seconds)
Service.Settings.timeout = 5000;
// Enable debugging for ALL soap requests
// It will print out the request start and end times, how long the
// request took, xml that was sent and received as well as the
// json received and the output provided by the library
// default: false
Service.Settings.debugSoap = true;
// Override the default (stdout) logging provided.
// The function will receive a json object.
// default: stdout
Service.Settings.logger = function(data) {
fs.createWriteStream('./test').write(JSON.stringify(data));
};
// Enable benchmarking for ALL soap requests
// It prints to stdout the name of each request and its duration in ms
// default: true
Service.Settings.benchmark = true;
// Store the most recent request of each type to file
// It outputs to [/path/to/generated/code]/Mocks/[request-name]
// default: false
Service.Settings.createMock = true;
// Use saved mock requests instead of real requests
// default: false
Service.Settings.useMock = true;
// Debug single SOAP requests by using the .debug() function, which is
// a property of every request and response object
var additionRequest = new Service.MathService.AdditionFunction(json);
additionRequest.debug(); // Watch your console output
additionRequest.request(function(err, response) {
response.debug(); // Watch your console output
if (err || !response) {
return callback(err || "No response?");
}
});Run the following command:
npm lintTesting Requirements TBA
Command:
npm test![dependabot[bot] avatar](https://avatars.githubusercontent.com/in/29110?v=4 "dependabot[bot]")
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent