Configuring a FTP Connection Cache Service

In this section:

Reference:

The FTP Connection Cache service caches a single FTP connection (both control and data channels) to an FTP server. When the connection cache is started, an existing connection from the cache is utilized for an FTP agent within the iSM process flow that connects to an FTP server with the same address and authentication credentials (user ID and password)

To configure a FTP Connection Cache service:

  1. Perform the steps as described in Configuring Services.
  2. Ensure that you select FTP Connection Cache {com.ibi.agents.XDNFTPConnectionCacheAgent} as the service type you are configuring.

    For a complete description of the configuration parameters that are available for the FTP Connection Cache service, see FTP Connection Cache Service Parameters.

    For a complete description of the edges that are returned by the FTP Connection Cache service, see FTP Connection Cache Service Edges.


Top of page

x
Reference: FTP Connection Cache Service Parameters

The following table lists and describes parameters for the FTP Connection Cache service.

Parameter

Description

Configuration parameters for FTP Direct transfer to disk service

Host Name (required)

The DNS name (or IP address) of the FTP server that you want to connect to. Use the host:port format if the standard port is not 21.

Remote Port

The port to connect to on the FTP site. Leave it blank for default port 21.

User Name (required)

A valid user ID for the FTP server.

Password (required)

A valid password for the FTP server.

Account Name

A valid account for the FTP server.

Use Passive Command

If set to true, a PASV command is used. Otherwise, the PORT command is used. Select one of the following options from the drop-down list:

  • true. Use PASV.
  • false. Use Active.

Timeout

The timeout interval (in seconds) for the socket.

Retry Interval

The retry interval (in seconds) for the socket. The xxhxxmxxs format can be used for this value. Specify a value of zero (0) for no retry interval.

Connection Retry

The number of retry attempts that were made after failed connections to the FTP server.

Agent Parameters

Connection Caching (required)

If set to start, the referenced connection is cached until stopped. If set to stop, the cached connection is closed. Select one of the following options from the drop-down list:

  • start. Starts the connection caching for this thread.
  • stop. Stops the connection caching on this thread.

SSL Parameters

Use SSL

If set, the connection is secured through the Secure Sockets Layer (SSL) protocol. Select one of the following options from the drop-down list:

  • true. Use SSL.
  • false. Do not use SSL.

Security Protocol

Determines the security protocol to be used. Select one of the following options from the drop-down list:

  • SSL. Supports some version of SSL.
  • SSLv2. Supports SSL version 2.
  • SSLv3. Supports SSL version 3.
  • TLS. Supports some version of TLS.
  • TLSv1. Supports TLS version 1.

Secure Data Connection

Use a secure data connection (for example, to transfer data securely). This parameter is used in conjunction with Secure Control Connection. Select one of the following options from the drop-down list:

  • true. Use SSL with the data connection.
  • false. Do not use SSL with the data connection.

Use 128-bit Encryption

Enforces the use of 128-bit encryption. Select one of the following options from the drop-down list:

  • true. Use 128-bit encryption.
  • false. Do not use 128-bit encryption.

SSL Security (required)

Determines the FTP server connection type. Select one of the following options from the drop-down list:

  • Unknown. Initially attempts Explicit Security then fails over to Implicit Security. (default).
  • Explicit. In order to establish the SSL link, Explicit Security requires that the FTP client issue a specific command to the FTP server after establishing a connection. The default FTP server port is used.
  • Implicit. Implicit security automatically begins with an SSL connection as soon as the FTP client connects to an FTP server. In implicit security, the FTP server defines a specific port for the client (typically 990) to be used for secure connections.

Keystore File or Keystore Security Provider

Keystore file or keystore security provider full path to the keystore file, which provides certificate material to be used for a SSL connection. Specify the name of a keystore security provider, or leave blank to use the configured default keystore security provider.

Keystore Password

The password to access the Keystore file. This value is not required if the keystore file or keystore security provider is the name of a keystore security provider.

Keystore Type

The type of keystore. This value is not required if the keystore file or keystore security provider is the name of a keystore security provider.


Top of page

x
Reference: FTP Connection Cache Service Edges

The following table lists and describes the edges that are returned by the FTP Connection Cache service.

Edge

Description

success

Operation completed successfully.

fail_parse

Failed to properly parse the input parameters of the service.

fail_connect

Failed to connect to FTP host for any one of the following reasons:

  • The host name (IP) is invalid.
  • The User ID is invalid.
  • The password of the user is invalid.
  • The connection failed.

fail_operation

Invalid parameters or other error.


Top of page

x
FTP Connection Cache Service Example

The following is an example Process flow for the FTP Connection Cache service.

iSM Object

Description

Start

Start of process flow.

Start Cache

Calls the XDNFTPConnectionCacheAgent for the server to connect to.

FTP Directory

XDNFTPDirListAgent uses the connection that was created in Start Cache to create a document containing the files within a directory.

Iterator

Loops through the document returned by FTP Directory using the expression /dir/item to retrieve each entry in the document.

XDSREGAgent

Creates Special Registers with the File name and Directory extracted via XPATH from the document segment created by the Iterator.

FTP Read

XDNPFFTPReadAgent uses the connection that was created in Start Cache to read the file from the directory.

wait 15 seconds

Uses the XDCopyAgent to delay processing for 15 seconds simulates processing that may occur.

loop

Loops back to the Iterator to get next file value.

ERROR

If XDNPFFTPReadAgent is unsuccessful, the FTP Read exits ($error, $fail, etc…)

EXIT

Called after either the ERROR, or loop completes.

Stop Cache

Calls the XDNFTPConnectionCacheAgent to close the connection to the server.

End

Terminates the process flow.


iWay Software