ActiveSocket Toolkit Add network capabilities to any Windows or .NET application

Quicklinks

ColdFusion SFTP Client Sample Source Code

ActiveSocket provides an easy-to-use development interface to a variety of IP protocols. By using ActiveSocket, you can very easily create or enhance applications with network features.

ActiveSocket features the following: DNS, FTP, HTTP, HTTPs, ICMP Ping, IP-to-Country, MSN, NTP, RSH, SCP, SFTP, SNMP v1/v2c (Get, GetNext, Set), SNMP Traps, SNMP MIB, SSH, TCP, Telnet, TFTP, UDP, Telnet, Wake-On-LAN and more.

ActiveSocket can be well integrated into ColdFusion environments.

This document describes how the ActiveSocket SFtp object can be integrated into ColdFusion code.

The most important functions of the SFtp object are:

  • Connect - connect to the (remote) FTP server on port 22 or any alternate port;
  • Disconnect - to diconnect after a connect call;
  • GetCurrentDir - retrieve the current directory;
  • ChangeDir - change the current directory;
  • CreateDir - create a new directory;
  • RenameDir - rename a directory;
  • DeleteDir - delete a directory;
  • FindFile - find a specific file in the current directory;
  • FindFirstFile - iterate over all files in the current directory; find the first file;
  • FindNextFile - iterate over all files in the current directory; find the next file;
  • RenameFile - rename a file in the current directory;
  • DeleteFile - delete a file in the current directory;
  • GetFile - get (download) a file;
  • PutFile - put (upload) a file;

Step 1: Download and install the ActiveSocket Toolkit

Download the ActiveSocket Toolkit from the ActiveXperts Download Site and start the installation. The installation guides you through the installation process.

Step 2: Create a new ColdFusion document

Create a new blank webdocument with the ".cfm" extention. First of all we are going to build the form whitch commands and properties of the device can be filled in. Then we are going to make a source code that connects to the device.

Step 3: Implementation

Establishing the connection and listing the files can be done in three steps:

  • Collect the ftp-server-address, the username and the password from the user
  • Establish the connection
  • List the files

Collecting the information can be done using a form. We've made our form look like this:

(Click on the picture to enlarge)

When we've got this information, we're ready to establish a connection to a server. First of all we need an object witch creates a connection between ColdFusion and the ActiveXperts software. To do that, use the following code: 

 <cfobject class="ActiveXperts.SFtp" type="com" name="objSFtp" Action="Create">

Once the object is created, we're able to use the toolkit. We need to establish a connection, so we're going to use the ActiveSocket method "connect()". Use the following code: 

objSFtp.Host = "strHost";
objSFtp.UserName = "strUsername";
objSFtp.Password = "strPassword";
objSFtp.Connect();

Now we need to list the files. The ActiveSocket toolkit is able to get the first file in the folder using the "FindFirstFile()" method and then the next file using the "FindNextFile()" method. So we're going to list the first file in the folder first, then the next file (the second file) and than the next file (the third file) and so on. Use the following code: 

   objFiles = objSFtp.FindFirstFile(".");
			
   do{
     writeoutput ("<tr>");
     writeoutput ("<td width=100>");				
     if(objFiles.IsDirectory()){
        writeoutput("Directory:");
     }
     else{
        writeoutput("File:");				
     }
     writeoutput ("</td>");
     writeoutput ("<td>");
     writeoutput(objFiles.Name & "<br>");				
     writeoutput ("</td>");
     writeoutput ("</tr>");																
     objFiles = objFtp.FindNextFile();				
   }
   while(objSFtp.LastError eq 0);

Perhaps you would like to show the content of another folder. Paste the following code, before the listing code. 

  objSFtp.ChangeDir(strDirectory);

We're displaying the results of the process using the "LastError" method of the ActiveSocket toolkit. The method "LastError" displays a number. It's helpfull to know "0" means success. To get the error description use the "GetErrorDescription()" method. In our code we've used these methodes this way: 

strResult = objSFtp.LastError & " : " & objSFtp.GetErrorDescription(objSFtp.LastError);

It can be very helpfull to check for errors before executing some code. Applying this can be done easily:

 if(objSFtp.LastError eq "0"){
    Some code
 }

There are many working samples included with the product. You can also find them on the ActiveXperts FTP site: ftp.activexperts-labs.com/samples/network-component.