com.aspc.remote.util.net

Interface NetClient

All Known Implementing Classes:

NetClientFile, NetClientFtp, NetClientS3, NetClientSftp

public interface NetClient

NetClient represents a class for protocol transparent file operations.

Since:

February 16, 2006

Author:

Nigel Leck
THREAD MODE: MULTI-THREADED

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	PREFIX_FILE FILE url
static java.lang.String	PREFIX_FTP FTP url
static java.lang.String	PREFIX_S3 S3 url
static java.lang.String	PREFIX_SFTP SFTP url

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

Field Detail

PREFIX_FILE

static final java.lang.String PREFIX_FILE

FILE url

See Also:

Constant Field Values

PREFIX_FTP

static final java.lang.String PREFIX_FTP

FTP url

See Also:

Constant Field Values

PREFIX_SFTP

static final java.lang.String PREFIX_SFTP

SFTP url

See Also:

Constant Field Values

PREFIX_S3

static final java.lang.String PREFIX_S3

S3 url

See Also:

Constant Field Values

Method Detail

exists

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

Checks if the file specified by the given arguments physically exists

Parameters:

path - the path

Returns:

boolean true if it exists

Throws:

java.lang.Exception - a serious problem

fetch

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

Fetches the file specified by the given arguments

Parameters:

path - the path of the file

target - the target file

Throws:

java.lang.Exception - a serious problem

remove

void remove(@Nonnull
            java.lang.String path)
     throws java.lang.Exception

Removes the physical file specified by the given arguments

Parameters:

path - the file to remove

Throws:

java.lang.Exception - a serious problem

rename

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

Renames the physical file specified by the given arguments

Parameters:

from - the current path of the file

to - the new path of the file

Throws:

java.lang.Exception - a serious problem

send

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

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

Parameters:

rawFile - the file to send

path - the path to send the file to

Throws:

java.lang.Exception - a serious problem

changeDirectory

@CheckReturnValue
boolean changeDirectory(@Nonnull
                                          java.lang.String path,
                                          boolean create)
                                   throws java.io.IOException

Changes the working directory to the given directory

Parameters:

path - the path

create - should we create the directory if missing ?

Returns:

boolean true if directory changed false otherwise

Throws:

java.io.IOException

retrieveFileList

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

Gets the list of files in the path

Returns:

String[] list of files

Throws:

java.lang.Exception - a serious problem

getDirectory

@CheckReturnValue
 @Nonnull
java.lang.String getDirectory()
                                                   throws java.lang.Exception

Gets the current working directory

Returns:

String the current working directory

Throws:

java.lang.Exception - a serious problem

getType

@CheckReturnValue
 @Nonnull
java.lang.String getType()

The protocol that this client is for

Returns:

String the protocol type

canConnect

@CheckReturnValue
boolean canConnect(@Nonnull
                                     java.lang.String url)

Checks that the client is able to connect

Parameters:

url - the URL to try

Returns:

boolean true if the client can connect, false otherwise

activate

void activate()

Activates the client, also used by pooling

destroy

void destroy()

Destroys the client, also used by pooling

make

void make(@Nonnull
          java.lang.String url)
   throws java.lang.Exception

Makes a new client, also used by pooling

Parameters:

url - the client url

Throws:

java.lang.Exception - a serious problem

make

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

Makes a new client, also used by pooling

Parameters:

url - the client url

SOCKSProxyURL - the SOCKSProxyURL

keyPath - the keyPath

serverPort - the port

Throws:

java.lang.Exception - a serious problem

validate

@CheckReturnValue
boolean validate()

Validates a client, also used by pooling

Returns:

boolean true if the client is valid, false otherwise

setProgressListener

@Nullable
ProgressListener setProgressListener(@Nullable
                                               ProgressListener monitor)

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

Parameters:

monitor - the progress listener to use

Returns:

the previous version

getUnderlyingConnectionObject

@Nullable
 @CheckReturnValue
java.lang.Object getUnderlyingConnectionObject()

Get the underlying connection object

Returns:

the underlying connection object