FTPClient (JanosRuntime JavaDOC)

java.lang.Object
- com.integpg.net.FTPClient

```
public class FTPClient
extends Object
```

Constructor Summary

Constructors
Constructor and Description

FTPClient()

Constructors
Constructor and Description
`FTPClient()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`auth()` Establish a secure connection.
`String`	`cdup()` Issues CDUP command.
`void`	`close()` Closes the FTP connection.
`String`	`command(String cmd)` Issues supplied command and logs the response.
`boolean`	`connect(String server)` Establishes the FTP connection.
`String`	`cwd(String dir)` Change working directory
`boolean`	`delete(String file)` Deletes the given file on the remote host.
`String`	`dir(boolean nlst)` Obtain the directory.
`void`	`enableLog(boolean enable)` Enables the cumulative log.
`String`	`feat()` Issues FEAT command
`String`	`getLog()` Obtains the cumulative log content.
`boolean`	`isConnected()` Check if client connected to server
`String`	`list(boolean nlst)` Issues the LIST command.
`boolean`	`login(String user, String pass)` Perform user login.
`String`	`mdtm(String file)` Returns the last-modified time of the given file on the remote host.
`String`	`mfmt(String file, String filedate)` Set remote file last modified timestamp
`boolean`	`mkdir(String dir)` Creates the named directory on the remote host.
`String`	`mlsd(String dir)` Return standardized facts for contents of the directory.
`String`	`mlst(String file)` Return standardized facts about a single item.
`String`	`noop()` Issues NOOP command
`FileEntry[]`	`parseDir(String listing)` Returns an array of FileEntry containing the details for each file or folder in the directory.
`int[]`	`pasv()` Issue PASV command and retrieve connect parameters
`String`	`port(InetAddress addr, int portnum)` Issue PORT command.
`String`	`pwd()` Issues PWD command.
`String`	`quit()` Issues QUIT command
`boolean`	`rename(String from, String to)` Renames a remote file.
`void`	`resetLog()` Resets the cumulative log.
`int`	`responseCode(String response)` Returns the response code in the reply.
`int`	`responsePurpose(String response)` Returns the purpose of the reply.
`int`	`responseStatus(String response)` Returns the status of the reply.
`boolean`	`retrieve(String dstfile, String remotefile)` Transfers file content from a remote host.
`boolean`	`rmdir(String dir)` Deletes the named directory on the remote host.
`void`	`setPassive(boolean mode)` Used to set passive or active mode.
`void`	`setSoTimeout(int to)` Sets timeout in milliseconds used during data transfers.
`int`	`size(String file)` Returns the size of the remote file.
`boolean`	`store(String srcfile, String remotefile)` Transfers file content to a remote host.
`String`	`syst()` Issues SYST command
`String`	`type(String stype)` Issues TYPE command with the provided parameter.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - FTPClient
```
public FTPClient()
```
- Method Detail
  - connect
```
public boolean connect(String server)
```
    Establishes the FTP connection. This retains the banner announcement.
    
    Parameters:
    
    server - URL or IP address of the target FTP Server
    
    Returns:
    
    TRUE if the connection is properly established.
  - close
```
public void close()
```
    Closes the FTP connection.
  - setSoTimeout
```
public void setSoTimeout(int to)
```
    Sets timeout in milliseconds used during data transfers. Default is 10 seconds (10000).
    
    Parameters:
    
    to - timeout in milliseconds
  - setPassive
```
public void setPassive(boolean mode)
```
    Used to set passive or active mode. By default active transfers are used.
    
    Parameters:
    
    mode - true if passive transfers are to be used.
  - resetLog
```
public void resetLog()
```
    Resets the cumulative log. This creates a new instance of the log.
  - enableLog
```
public void enableLog(boolean enable)
```
    Enables the cumulative log. This releases an existing log and if logging is enabled creates a new instance. Logging is disabled by default.
    
    Parameters:
    
    enable - set true if logging is to be enabled
  - getLog
```
public String getLog()
```
    Obtains the cumulative log content.
    
    Returns:
    
    string containing the log
  - login
```
public boolean login(String user,
                     String pass)
```
    Perform user login.
    
    Parameters:
    
    user - username
    
    pass - password
    
    Returns:
    
    TRUE if the user has successfully logged in
  - auth
```
public boolean auth()
```
    Establish a secure connection. This issues the AUTH TLS command and negotiates a TLS secured connection if a positive response is received.
    
    Returns:
    
    true if a secure connection is at least attempted
  - cdup
```
public String cdup()
```
    Issues CDUP command. Makes the parent of the current directory the working directory.
    
    Returns:
    
    server's response
  - cwd
```
public String cwd(String dir)
```
    Change working directory
    
    Parameters:
    
    dir - string containing the directory
    
    Returns:
    
    server's response
  - delete
```
public boolean delete(String file)
```
    Deletes the given file on the remote host.
    
    Parameters:
    
    file - remote filename
    
    Returns:
    
    true if successful
  - feat
```
public String feat()
```
    Issues FEAT command
    
    Returns:
    
    server's response
  - list
```
public String list(boolean nlst)
```
    Issues the LIST command.
    
    Parameters:
    
    nlst - set true to return list of files only
    
    Returns:
    
    server's response
  - mdtm
```
public String mdtm(String file)
```
    Returns the last-modified time of the given file on the remote host. The format is "YYYYMMDDhhmmss": YYYY is the four-digit year, MM is the month from 01 to 12, DD is the day of the month from 01 to 31, hh is the hour from 00 to 23, mm is the minute from 00 to 59, and ss is the second from 00 to 59.
    
    Parameters:
    
    file - name of the remote file
    
    Returns:
    
    string containing the server's response
  - mfmt
```
public String mfmt(String file,
                   String filedate)
```
    Set remote file last modified timestamp
    
    Parameters:
    
    file - filename on the remote system
    
    filedate - timestamp in YYYYMMDDHHMMSS format
    
    Returns:
    
    response string
  - mkdir
```
public boolean mkdir(String dir)
```
    Creates the named directory on the remote host.
    
    Parameters:
    
    dir - directory name
    
    Returns:
    
    true if successful
  - mlsd
```
public String mlsd(String dir)
```
    Return standardized facts for contents of the directory.
    
    Parameters:
    
    dir - remote directory
    
    Returns:
    
    response string
  - mlst
```
public String mlst(String file)
```
    Return standardized facts about a single item.
    
    Parameters:
    
    file - the item of interest (current directory if absent).
    
    Returns:
    
    server's response in its entirety.
  - noop
```
public String noop()
```
    Issues NOOP command
    
    Returns:
    
    server's response
  - pwd
```
public String pwd()
```
    Issues PWD command.
    
    Returns:
    
    current working directory
  - port
```
public String port(InetAddress addr,
                   int portnum)
```
    Issue PORT command.
    
    Parameters:
    
    addr - local IP address
    
    portnum - local port number
    
    Returns:
    
    server's response
  - quit
```
public String quit()
```
    Issues QUIT command
    
    Returns:
    
    server's response
  - rename
```
public boolean rename(String from,
                      String to)
```
    Renames a remote file.
    
    Parameters:
    
    from - remote file to be renamed
    
    to - new name for the file
    
    Returns:
    
    true if successful
  - rmdir
```
public boolean rmdir(String dir)
```
    Deletes the named directory on the remote host.
    
    Parameters:
    
    dir - directory name
    
    Returns:
    
    true if successful
  - size
```
public int size(String file)
```
    Returns the size of the remote file. Syntax: SIZE remote-filename
    
    Parameters:
    
    file - the remote filename
    
    Returns:
    
    integer size or 0 on error
  - syst
```
public String syst()
```
    Issues SYST command
    
    Returns:
    
    server's response
  - type
```
public String type(String stype)
```
    Issues TYPE command with the provided parameter.
    
    Parameters:
    
    stype - ASCII type character ("I: for binary)
    
    Returns:
    
    server's response
  - pasv
```
public int[] pasv()
```
    Issue PASV command and retrieve connect parameters
    
    Returns:
    
    byte array containing addressing octets
  - dir
```
public String dir(boolean nlst)
```
    Obtain the directory. Since FTP serves can provide vastly differing directory list formats this method returns the listing in its entirety. This may be parsed as needed subsequently.
    
    Parameters:
    
    nlst - set true to return list of filenames only
    
    Returns:
    
    string containing the directory listing in its entirety
  - parseDir
```
public FileEntry[] parseDir(String listing)
```
    Returns an array of FileEntry containing the details for each file or folder in the directory.
    
    Parameters:
    
    listing - The directory listing text
    
    Returns:
    
    array of file entries
  - retrieve
```
public boolean retrieve(String dstfile,
                        String remotefile)
```
    Transfers file content from a remote host.
    
    Parameters:
    
    dstfile - destination file on the local system
    
    remotefile - source filename on the remote host
    
    Returns:
    
    true is the transfer succeeds
  - store
```
public boolean store(String srcfile,
                     String remotefile)
```
    Transfers file content to a remote host.
    
    Parameters:
    
    srcfile - source file on the local system
    
    remotefile - destination filename on the remote host
    
    Returns:
    
    true if the transfer succeeds
  - command
```
public String command(String cmd)
```
    Issues supplied command and logs the response. The response is not interpreted.
    
    Parameters:
    
    cmd - string containing the complete command.
    
    Returns:
    
    string containing the server's response
  - responseCode
```
public int responseCode(String response)
```
    Returns the response code in the reply.
    
    Parameters:
    
    response - the response string returned by the FTP Server
    
    Returns:
    
    value of 3-digit response code
  - responseStatus
```
public int responseStatus(String response)
```
    Returns the status of the reply. 1xx Positive Preliminary reply 2xx Positive Completion reply 3xx Positive Intermediate reply 4xx Transient Negative Completion reply 5xx Permanent Negative Completion reply 6xx Protected reply
    
    Parameters:
    
    response - the response string returned by the FTP Server
    
    Returns:
    
    value of the first digit of the response code
  - responsePurpose
```
public int responsePurpose(String response)
```
    Returns the purpose of the reply. x0x Syntax x1x Information x2x Connections x3x Authentication and accounting x4x Unspecified as of RFC 959. x5x File system
    
    Parameters:
    
    response - the response string returned by the FTP Server
    
    Returns:
    
    value of the second digit of the response code
  - isConnected
```
public boolean isConnected()
```
    Check if client connected to server
    
    Returns:
    
    true if connected

Class FTPClient

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

FTPClient

Method Detail

connect

close

setSoTimeout

setPassive

resetLog

enableLog

getLog

login

auth

cdup

cwd

delete

feat

list

mdtm

mfmt

mkdir

mlsd

mlst

noop

pwd

port

quit

rename

rmdir

size

syst

type

pasv

dir

parseDir

retrieve

store

command

responseCode

responseStatus

responsePurpose

isConnected