com.aspc.remote.util.net

Class NetClientS3

java.lang.Object

com.aspc.remote.util.net.NetClientS3

All Implemented Interfaces:

NetClient

public class NetClientS3
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
NetClientS3()

Method Summary

Modifier and Type	Method and Description
void	activate() Activates the client, also used by pooling
boolean	canConnect(java.lang.String url) Checks that the client is able to connect
boolean	changeDirectory(java.lang.String path, boolean create) Changes the working directory to the given directory
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 fetchPath, 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() The protocol that this client is for
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() Gets the list of files in the path
void	send(java.io.File rawFile, java.lang.String sendPath) Sends to the file specified by the given arguments to the given location
ProgressListener	setProgressListener(ProgressListener monitor) Sets the progress listener to be used by the client for fetch operations.
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

NetClientS3

public NetClientS3()

Method Detail

exists

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

Description copied from interface: NetClient

Checks if the file specified by the given arguments physically exists

Specified by:

exists in interface NetClient

Parameters:

path - the path

Returns:

boolean true if it exists

Throws:

java.lang.Exception - a serious problem

fetch

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

Description copied from interface: NetClient

Fetches the file specified by the given arguments

Specified by:

fetch in interface NetClient

Parameters:

fetchPath - 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

Description copied from interface: NetClient

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

Description copied from interface: NetClient

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 sendPath)
          throws java.lang.Exception

Description copied from interface: NetClient

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

Specified by:

send in interface NetClient

Parameters:

rawFile - the file to send

sendPath - the path to send the file to

Throws:

java.lang.Exception - a serious problem

changeDirectory

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

Description copied from interface: NetClient

Changes the working directory to the given directory

Specified by:

changeDirectory in interface NetClient

Parameters:

path - the path

create - should we create the directory if missing ?

Returns:

boolean true if directory changed false otherwise

retrieveFileList

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

Description copied from interface: NetClient

Gets the list of files in the path

Specified by:

retrieveFileList in interface NetClient

Returns:

String[] list of files

Throws:

java.lang.Exception - a serious problem

getDirectory

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

Description copied from interface: NetClient

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()

Description copied from interface: NetClient

The protocol that this client is for

Specified by:

getType in interface NetClient

Returns:

String the protocol type

canConnect

public boolean canConnect(java.lang.String url)

Description copied from interface: NetClient

Checks that the client is able to connect

Specified by:

canConnect in interface NetClient

Parameters:

url - the URL to try

Returns:

boolean true if the client can connect, false otherwise

activate

public void activate()

Description copied from interface: NetClient

Activates the client, also used by pooling

Specified by:

activate in interface NetClient

destroy

public void destroy()

Description copied from interface: NetClient

Destroys the client, also used by pooling

Specified by:

destroy in interface NetClient

make

public void make(@Nonnull
                 java.lang.String url)
          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

Throws:

java.lang.Exception - a serious problem

validate

public boolean validate()

Description copied from interface: NetClient

Validates a client, also used by pooling

Specified by:

validate in interface NetClient

Returns:

boolean true if the client is valid, false otherwise

setProgressListener

public ProgressListener setProgressListener(ProgressListener monitor)

Description copied from interface: NetClient

Sets the progress listener to be used by the client for fetch operations. A progress listener is not mandatory.

Specified by:

setProgressListener in interface NetClient

Parameters:

monitor - the progress listener to use

Returns:

the previous version

getUnderlyingConnectionObject

public java.lang.Object getUnderlyingConnectionObject()

Description copied from interface: NetClient

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