nixonftp

Class NXFtpClient

java.lang.Object

FtpClient

nixonftp.NXFtpClient

All Implemented Interfaces:

NXSocketClient

public class NXFtpClient
extends FtpClient
implements NXSocketClient

Constructor Summary

Constructors

Constructor and Description
NXFtpClient()
NXFtpClient(NXLog log, java.net.Proxy proxy)

Method Summary

Methods

Modifier and Type	Method and Description
void	cdUp()
void	changeFolder(java.lang.String dir)
void	connect() Connects to the server with the credentials set by calling SetCredentials.
void	createDirectory(java.lang.String dir)
void	delete(java.lang.String file)
void	deleteDirectory(java.lang.String dir)
void	disconnect()
void	fakeDirectory(NXObjectIndex oi, java.lang.String path) Make a fake directory listing from NXObjectIndex given for path.
byte[]	get(java.lang.String remoteFile, java.lang.String localFile, boolean preview, NXProgressUpdateRunnable callBack) Downloads a remote file.
boolean	getBinary()
java.lang.String[]	getCredentials()
java.lang.String	getCurrDir()
java.util.HashMap	getObjectIndex()
java.lang.String	getWelcome()
int	indexDirectory(java.lang.String dir)
boolean	isDirectory(java.lang.String dir) Check if dir is a directory.
void	put(java.lang.String localFile, java.lang.String remoteFile, NXProgressUpdateRunnable callBack)
void	renameImpl(java.lang.String oldFile, java.lang.String newFile)
void	setCredentials(java.lang.String[] argv) Sets the credentials for the session.
void	stopCurrent()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

NXFtpClient

public NXFtpClient()

NXFtpClient

public NXFtpClient(NXLog log,
           java.net.Proxy proxy)

Method Detail

getCurrDir

public java.lang.String getCurrDir()

Specified by:

getCurrDir in interface NXSocketClient

getBinary

public boolean getBinary()

setCredentials

public void setCredentials(java.lang.String[] argv)

Sets the credentials for the session.

Specified by:

setCredentials in interface NXSocketClient

Parameters:

argv - An array of strings containing: 0: Server's hostname 1: Username 2: Password

getCredentials

public java.lang.String[] getCredentials()

Specified by:

getCredentials in interface NXSocketClient

connect

public void connect()
             throws java.net.SocketException,
                    sun.net.ftp.FtpLoginException,
                    sun.net.ftp.FtpProtocolException,
                    java.net.UnknownHostException,
                    java.io.IOException

Connects to the server with the credentials set by calling SetCredentials. Be sure to have called SetCredentials before calling this.

Specified by:

connect in interface NXSocketClient

Throws:

java.net.SocketException

sun.net.ftp.FtpLoginException

sun.net.ftp.FtpProtocolException

java.net.UnknownHostException

java.io.IOException

indexDirectory

public int indexDirectory(java.lang.String dir)
                   throws java.net.SocketException,
                          sun.net.ftp.FtpProtocolException,
                          java.io.IOException

Specified by:

indexDirectory in interface NXSocketClient

Throws:

java.net.SocketException

sun.net.ftp.FtpProtocolException

java.io.IOException

fakeDirectory

public void fakeDirectory(NXObjectIndex oi,
                 java.lang.String path)

Make a fake directory listing from NXObjectIndex given for path.

Specified by:

fakeDirectory in interface NXSocketClient

isDirectory

public boolean isDirectory(java.lang.String dir)

Check if dir is a directory.

Specified by:

isDirectory in interface NXSocketClient

getObjectIndex

public java.util.HashMap getObjectIndex()

Specified by:

getObjectIndex in interface NXSocketClient

createDirectory

public void createDirectory(java.lang.String dir)
                     throws java.io.IOException

Specified by:

createDirectory in interface NXSocketClient

Throws:

java.io.IOException

deleteDirectory

public void deleteDirectory(java.lang.String dir)
                     throws java.io.IOException,
                            sun.net.ftp.FtpProtocolException

Specified by:

deleteDirectory in interface NXSocketClient

Throws:

java.io.IOException

sun.net.ftp.FtpProtocolException

delete

public void delete(java.lang.String file)
            throws java.io.IOException,
                   sun.net.ftp.FtpProtocolException

Specified by:

delete in interface NXSocketClient

Throws:

java.io.IOException

sun.net.ftp.FtpProtocolException

get

public byte[] get(java.lang.String remoteFile,
         java.lang.String localFile,
         boolean preview,
         NXProgressUpdateRunnable callBack)
           throws java.io.IOException,
                  sun.net.ftp.FtpProtocolException

Downloads a remote file.

Specified by:

get in interface NXSocketClient

Parameters:

remoteFile - The remote file.

localFile - The local file.

preview - If true, then downloads to byte array and then returns it.

callBack - Calls to update progress.

Throws:

java.io.IOException

sun.net.ftp.FtpProtocolException

put

public void put(java.lang.String localFile,
       java.lang.String remoteFile,
       NXProgressUpdateRunnable callBack)
         throws java.io.IOException,
                sun.net.ftp.FtpProtocolException

Specified by:

put in interface NXSocketClient

Throws:

java.io.IOException

sun.net.ftp.FtpProtocolException

disconnect

public void disconnect()

Specified by:

disconnect in interface NXSocketClient

changeFolder

public void changeFolder(java.lang.String dir)
                  throws java.lang.Exception

Specified by:

changeFolder in interface NXSocketClient

Throws:

java.lang.Exception

stopCurrent

public void stopCurrent()

Specified by:

stopCurrent in interface NXSocketClient

getWelcome

public java.lang.String getWelcome()

Specified by:

getWelcome in interface NXSocketClient

cdUp

public void cdUp()
          throws java.io.IOException

Specified by:

cdUp in interface NXSocketClient

Throws:

java.io.IOException

renameImpl

public void renameImpl(java.lang.String oldFile,
              java.lang.String newFile)
                throws java.io.IOException,
                       sun.net.ftp.FtpProtocolException

Specified by:

renameImpl in interface NXSocketClient

Throws:

java.io.IOException

sun.net.ftp.FtpProtocolException