com.aspc.remote.util.net

Class NetClientFtp

java.lang.Object

com.aspc.remote.util.net.NetClientFtp

All Implemented Interfaces:

NetClient

public class NetClientFtp
extends java.lang.Object
implements NetClient

Implements the ftp protocol for NetClient
THREAD MODE: SINGLE-THREADED

Since:

February 21, 2006

Author:

luke

Field Summary

Fields inherited from interface com.aspc.remote.util.net.NetClient

PREFIX_FILE, PREFIX_FTP, PREFIX_S3, PREFIX_SFTP

Constructor Summary

Constructors

Constructor and Description
NetClientFtp()

Method Summary

Modifier and Type	Method and Description
void	activate() Activates the client, also used by pooling
void	bytesTransferred(CopyStreamEvent cse) CopyStreamListener interface
void	bytesTransferred(long total, int count, long size) CopyStreamListener interface.
boolean	canConnect(java.lang.String url) Checks that the client is able to connect and login.
boolean	changeDirectory(java.lang.String path, boolean create) Changes the working directory to the given directory.
static boolean	contains(FTPFile[] list, java.lang.String search) Checks if the given list of strings contains the search string
void	destroy() Destroys the client, also used by pooling
boolean	exists(java.lang.String path) Checks if the file specified by the given arguments physically exists
void	fetch(java.lang.String path, java.io.File target) Fetches the file specified by the given arguments
java.lang.String	getDirectory() Gets the current working directory
java.lang.String	getType() Gets the protocol prefix that this client implements
java.lang.Object	getUnderlyingConnectionObject() Get the underlying connection object
void	make(java.lang.String url) Makes a new client, also used by pooling.
void	make(java.lang.String url, java.lang.String SOCKSProxyURL, java.lang.String keyPath, int serverPort) Makes a new client, also used by pooling
void	remove(java.lang.String path) Removes the physical file specified by the given arguments
void	rename(java.lang.String from, java.lang.String to) Renames the physical file specified by the given arguments
java.lang.String[]	retrieveFileList() returns the names of files in a location
void	send(java.io.File rawFile, java.lang.String path) Sends the file specified by the given arguments to the given location
void	setConnectionTimeOut(int timeout) Set ftp connection time out
ProgressListener	setProgressListener(ProgressListener monitor) Sets the progress listener.
boolean	validate() Validates a client, also used by pooling

Methods inherited from class java.lang.Object

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

Constructor Detail

NetClientFtp

public NetClientFtp()

Method Detail

exists

public boolean exists(java.lang.String path)
               throws java.lang.Exception

Checks if the file specified by the given arguments physically exists

Specified by:

exists in interface NetClient

Parameters:

path - the file path

Returns:

boolean true if it exists

Throws:

java.lang.Exception - a serious problem

fetch

public void fetch(@Nonnull
                  java.lang.String path,
                  @Nonnull
                  java.io.File target)
           throws java.lang.Exception

Fetches the file specified by the given arguments

Specified by:

fetch in interface NetClient

Parameters:

path - the path of the file

target - the target file

Throws:

java.lang.Exception - a serious problem

remove

public void remove(java.lang.String path)
            throws java.lang.Exception

Removes the physical file specified by the given arguments

Specified by:

remove in interface NetClient

Parameters:

path - the file to remove

Throws:

java.lang.Exception - a serious problem

rename

public void rename(java.lang.String from,
                   java.lang.String to)
            throws java.lang.Exception

Renames the physical file specified by the given arguments

Specified by:

rename in interface NetClient

Parameters:

from - the current path of the file

to - the new path of the file

Throws:

java.lang.Exception - a serious problem

send

public void send(java.io.File rawFile,
                 java.lang.String path)
          throws java.lang.Exception

Sends the file specified by the given arguments to the given location

Specified by:

send in interface NetClient

Parameters:

rawFile - the file to send

path - the path to send the file to

Throws:

java.lang.Exception - a serious problem

changeDirectory

public boolean changeDirectory(java.lang.String path,
                               boolean create)

Changes the working directory to the given directory.

When FTPing from NY-> Syd each request takes 300ms due to network latency. To change directory to /docs/20/20/1/1200 we were saying does /docs exist ? cd /docs, does 20 exist ? cd 20, does 20 exits ? cd 20, does 1 exits ? cd 1, does 1200 exits ? cd 1200 == 3,000ms Now we say cd /docs/20/20/1/1200 == 300ms if that fails we try to cd to each directory in turn and if it fails we check if it exists and create if not so ~= 1,500ms worst case

Specified by:

changeDirectory in interface NetClient

Parameters:

path - the directory path

create - should we create the directory if it doesn't exist

Returns:

boolean true if directory changed false otherwise

contains

public static boolean contains(FTPFile[] list,
                               java.lang.String search)

Checks if the given list of strings contains the search string

Parameters:

list - the list of strings to search in

search - the string to search for

Returns:

boolean true if the list contains the string at least once, false otherwise

getDirectory

public java.lang.String getDirectory()
                              throws java.lang.Exception

Gets the current working directory

Specified by:

getDirectory in interface NetClient

Returns:

String the current working directory

Throws:

java.lang.Exception - a serious problem

getType

public java.lang.String getType()

Gets the protocol prefix that this client implements

Specified by:

getType in interface NetClient

Returns:

String the protocol type

canConnect

public boolean canConnect(java.lang.String url)

Checks that the client is able to connect and login. expects the url to be in the format username:password@server

Specified by:

canConnect in interface NetClient

Parameters:

url - the url to check

Returns:

boolean true if the client can connect, false otherwise

activate

public void activate()

Activates the client, also used by pooling

Specified by:

activate in interface NetClient

destroy

public void destroy()

Destroys the client, also used by pooling

Specified by:

destroy in interface NetClient

make

public void make(java.lang.String url)
          throws java.lang.Exception

Makes a new client, also used by pooling. Expects the url to be in the following format: username:password@server/baseDir

Specified by:

make in interface NetClient

Parameters:

url - the client url

Throws:

java.lang.Exception - a serious problem

validate

public boolean validate()

Validates a client, also used by pooling

Specified by:

validate in interface NetClient

Returns:

boolean true if the client is valid, false otherwise

setProgressListener

@CheckReturnValue
 @Nullable
public ProgressListener setProgressListener(@Nullable
                                                                         ProgressListener monitor)

Sets the progress listener. The progress monitor will be cleared by a call to activate.

Specified by:

setProgressListener in interface NetClient

Parameters:

monitor - the progress listener

Returns:

previous monitor

bytesTransferred

public void bytesTransferred(CopyStreamEvent cse)

CopyStreamListener interface

Parameters:

cse - the copy stream event

bytesTransferred

public void bytesTransferred(long total,
                             int count,
                             long size)

CopyStreamListener interface. used by fetch when there is a ProgressListener

Parameters:

count - the current bytes sent

total - the total bytes transferred

size - the size of the stream

retrieveFileList

@CheckReturnValue
 @Nonnull
public java.lang.String[] retrieveFileList()
                                                                throws java.lang.Exception

returns the names of files in a location

Specified by:

retrieveFileList in interface NetClient

Returns:

file names

Throws:

java.lang.Exception - serious problem

setConnectionTimeOut

public void setConnectionTimeOut(int timeout)
                          throws java.lang.Exception

Set ftp connection time out

Parameters:

timeout - Timeout in milliseconds

Throws:

java.lang.Exception - while setting the timeout

getUnderlyingConnectionObject

public java.lang.Object getUnderlyingConnectionObject()

Get the underlying connection object

Specified by:

getUnderlyingConnectionObject in interface NetClient

Returns:

the underlying connection object

make

public void make(java.lang.String url,
                 java.lang.String SOCKSProxyURL,
                 java.lang.String keyPath,
                 int serverPort)
          throws java.lang.Exception

Description copied from interface: NetClient

Makes a new client, also used by pooling

Specified by:

make in interface NetClient

Parameters:

url - the client url

SOCKSProxyURL - the SOCKSProxyURL

keyPath - the keyPath

serverPort - the port

Throws:

java.lang.Exception - a serious problem