Package jadex.bridge.service.types.filetransfer

Interface IFileTransferService

public interface IFileTransferService

Interface for the file transfer service.

Method Summary

Modifier and Type	Method	Description
IFuture<java.lang.Void>	deleteFile(java.lang.String path)	Delete a file.
ISubscriptionIntermediateFuture<java.lang.Long>	downloadFile(IOutputConnection con, java.lang.String name)	Download a file.
IFuture<FileData[]>	getRoots()	Get the root devices.
IFuture<FileData[]>	listDirectory(java.lang.String dir)	List the contents of a directory.
IFuture<java.lang.Void>	openFile(java.lang.String path)	Open a file.
IFuture<java.lang.String>	renameFile(java.lang.String path, java.lang.String name)	Rename a file.
ISubscriptionIntermediateFuture<java.lang.Long>	uploadFile(IInputConnection con, java.lang.String path, java.lang.String name)	Put a file.

Method Detail

uploadFile

ISubscriptionIntermediateFuture<java.lang.Long> uploadFile(IInputConnection con,
                                                           java.lang.String path,
                                                           java.lang.String name)

Put a file.

Parameters:

file - The file data.

path - The target path.

Returns:

True, when the file has been copied.

downloadFile

ISubscriptionIntermediateFuture<java.lang.Long> downloadFile(IOutputConnection con,
                                                             java.lang.String name)

Download a file.

Parameters:

file - The file data.

path - The target path.

Returns:

True, when the file has been copied.

renameFile

IFuture<java.lang.String> renameFile(java.lang.String path,
                                     java.lang.String name)

Rename a file.

Parameters:

path - The target path.

name - The name.

Returns:

True, if rename was successful.

deleteFile

IFuture<java.lang.Void> deleteFile(java.lang.String path)

Delete a file.

Parameters:

path - The target path.

Returns:

True, if delete was successful.

openFile

IFuture<java.lang.Void> openFile(java.lang.String path)

Open a file.

Parameters:

path - The filename to open.

getRoots

IFuture<FileData[]> getRoots()

Get the root devices.

Returns:

The root device files.

listDirectory

IFuture<FileData[]> listDirectory(java.lang.String dir)

List the contents of a directory.

Parameters:

dir - The directory, null for current directory.

Returns:

The contained files.