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