dw.svc
Class LocalServiceRegistry
dw.svc.LocalServiceRegistry
The LocalServiceRegistry is responsible for managing Service instances.
Typical usage involves several steps:
- The service is defined in the Business Manager and configured with necessary credentials.
- An instance of the service is created and configured in a script:
var myFTPService = LocalServiceRegistry.createService("MyFTPService", { mockExec : function(svc:FTPService, params) { return [ { "name": "file1", "timestamp": new Date(2011, 02, 21)}, { "name": "file2", "timestamp": new Date(2012, 02, 21)}, { "name": "file3", "timestamp": new Date(2013, 02, 21)} ]; }, createRequest: function(svc:FTPService, params) { svc.setOperation("list", "/"); }, parseResponse : function(svc:FTPService, listOutput) { var x : Array = []; var resp : Array = listOutput; for(var i = 0; i < resp.length; i++) { var f = resp[i]; x.push( { "name": f['name'], "timestamp": f['timestamp'] } ); } return x; } });
- The service is called in order to perform the operation:
var result : Result = myFTPService.call(); if(result.status == 'OK') { // The result.object is the object returned by the 'after' callback. } else { // Handle the error. See result.error for more information. }
See ServiceCallback for all the callback options, and individual Service classes for customization specific to a service type.
Constructor Summary
This class does not have a constructor, so you cannot create it directly.
Method Summary
static createService(serviceId
:
String, configObj
:
Object)
:
Service
Constructs and configures a service with a callback.
Methods inherited from class
Object
assign, create, create, defineProperties, defineProperty, entries, freeze, fromEntries, getOwnPropertyDescriptor, getOwnPropertyNames, getOwnPropertySymbols, getPrototypeOf, hasOwnProperty, is, isExtensible, isFrozen, isPrototypeOf, isSealed, keys, preventExtensions, propertyIsEnumerable, seal, setPrototypeOf, toLocaleString, toString, valueOf, values
Method Detail
createService
Constructs and configures a service with a callback.
Parameters:
serviceId
-
Unique Service ID.
configObj
-
Configuration callback. See ServiceCallback for a description of available callback methods.
Returns:
Associated Service, which can be used for further protocol-specific configuration.