com.aspc.remote.util.net

Class NetClientFile

java.lang.Object

com.aspc.remote.util.net.NetClientFile

All Implemented Interfaces:

NetClient

public class NetClientFile
extends java.lang.Object
implements NetClient

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

Since:

February 21, 2006

Author:

Jason McGrath

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

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 and login.
boolean	changeDirectory(java.lang.String path, boolean create) Changes the base 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
static java.lang.String	getBaseFromPath(java.lang.String path) Gets the directory portion of a file path, if there is one.
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() Names of files in allocation
void	send(java.io.File rawFile, java.lang.String path) Sends the file specified by the given arguments to the given location
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

NetClientFile

public NetClientFile()

Method Detail

exists

@CheckReturnValue
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(@Nonnull
                   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(@Nonnull
                   java.lang.String from,
                   @Nonnull
                   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(@Nonnull
                 java.io.File rawFile,
                 @Nonnull
                 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

getBaseFromPath

@Nonnull
 @CheckReturnValue
public static java.lang.String getBaseFromPath(@Nonnull
                                                                           java.lang.String path)

Gets the directory portion of a file path, if there is one.

Parameters:

path - the file path

Returns:

String the directory portion

changeDirectory

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

Changes the base directory

Specified by:

changeDirectory in interface NetClient

Parameters:

create - create the directory if it doesn't exist

path - the directories to create

Returns:

boolean true if the path could be changed

Throws:

java.io.IOException

getDirectory

@CheckReturnValue
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

@CheckReturnValue
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

@CheckReturnValue
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://base_path

Specified by:

make in interface NetClient

Parameters:

url - the client url

Throws:

java.lang.Exception - a serious problem

validate

@CheckReturnValue
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 listener will be cleared by a call to activate.

Specified by:

setProgressListener in interface NetClient

Parameters:

monitor - the progress listener

Returns:

the previous version

retrieveFileList

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

Names of files in allocation

Specified by:

retrieveFileList in interface NetClient

Returns:

file names

Throws:

java.lang.Exception - io problem

getUnderlyingConnectionObject

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

Get the underlying connection object

Specified by:

getUnderlyingConnectionObject in interface NetClient

Returns:

the null as there is no 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