Salesforce B2C Commerce 24.7 > B2C Commerce API > B2C Commerce Script > dw.svc
dw.svc
Class FTPServiceDefinition
Object
dw.svc.ServiceDefinition
dw.svc.FTPServiceDefinition
Represents an FTP or SFTP Service Definition.

There are two basic styles of configuration for this service.

In the first style, createRequest is implemented to call the setOperation method on the Service. This will cause the single operation to be performed and returned as the data object in the parseResponse method. Any error status is set automatically based on the returned value of the operation.

In the second style, execute is implemented to perform one or more operations using the serviceClient available on the Service object. This serviceClient will be either an FTPClient or an SFTPClient. The return value of execute will be passed as the data object in the parseResponse method.

API Versioned:
No longer available as of version 19.10.
Deprecated:
This class is only used with the deprecated ServiceRegistry. Use the LocalServiceRegistry instead, which allows configuration on the FTPService directly.
Properties
autoDisconnect  :  boolean
The status of whether the underlying FTP connection will be disconnected after the service call.
Constructor Summary
This class does not have a constructor, so you cannot create it directly.
Method Summary
isAutoDisconnect() : boolean
Returns the status of whether the underlying FTP connection will be disconnected after the service call.
setAutoDisconnect(b : boolean) : FTPServiceDefinition
Sets the auto-disconnect flag.
Methods inherited from class ServiceDefinition
configure, getConfiguration, getServiceName, isMock, isThrowOnError, setMock, setThrowOnError
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
isAutoDisconnect
isAutoDisconnect() : boolean
Returns the status of whether the underlying FTP connection will be disconnected after the service call.
Returns:
The auto-disconnect flag.
setAutoDisconnect
setAutoDisconnect(b : boolean) : FTPServiceDefinition
Sets the auto-disconnect flag.

If true, the underlying FTP connection will be disconnected after the service call. If false then it will remain open. The default value is true.

Parameters:
b - true to enable auto-disconnect, false otherwise.
Returns:
this FTP or SFTP Service Definition.

Infocenter Retirement: On June 30, 2023, the Infocenter was retired, and documentation currently hosted on the Infocenter will be published to Salesforce Help, Commerce Cloud Developer Center, and Salesforce B2C Commerce Developer Documentation Resources. For more information, see the release note.