se.entra.phantom.server.rconsole
Interface AdminFileTransferInterface

All Superinterfaces:
VirtualInterface, VirtualServerUserWindowInterface, VirtualUserWindowInterface
All Known Implementing Classes:
RCONSOLE_FILETRANSFER

public interface AdminFileTransferInterface
extends VirtualServerUserWindowInterface

This interface is implemented by the file transfer server user window.


Field Summary
 
Fields inherited from interface se.entra.phantom.server.VirtualInterface
TOOLTIP_TEXT
 
Method Summary
 boolean closeFileTransfer()
          Closes the file transfer of the requested file.
 boolean continueFileTransfer()
          Requests next block of data for the file transfer.
 boolean initiateFileTransfer(AdminFileTransferListener listener, String fileName)
          Initiates file transfer.
 boolean listDirectoryTree(AdminFileTransferListener listener, String directory)
          Lists the directory tree recursively in a directory.
 boolean listFiles(AdminFileTransferListener listener, String directory)
          Lists all files (and directories) in a directory.
 boolean listFiles(AdminFileTransferListener listener, String directory, boolean doExtended)
          Lists all files (and directories) in a directory (extended operation).
 boolean selectFileForTransfer(AdminFileTransferListener listener)
          Selects a file to transfer.
 boolean selectTargetFile(AdminFileTransferListener listener)
          Selects a target file on the client.
 boolean serverToClientFileTransfer(AdminFileTransferListener listener, String fileName, int totalSize, int size, byte[] data)
          File transfer from server to client.
 
Methods inherited from interface se.entra.phantom.server.VirtualServerUserWindowInterface
create
 
Methods inherited from interface se.entra.phantom.server.VirtualUserWindowInterface
areTextPromptsAlwaysRefreshed, clientUpdated, dispose, fireCreate, fireUpdate, hostScreenChanged, issueAction, refresh, refreshTextPrompts
 
Methods inherited from interface se.entra.phantom.server.VirtualInterface
callControl, deleteAll, deleteLine, getBackgroundColor, getCell, getColor, getFont, getForegroundColor, getLength, getLine, getLineCount, getNextSelection, getProperty, getText, insertLine, isChecked, isEnabled, isVisible, selectField, setBackgroundColor, setCell, setChecked, setColor, setEnabled, setFileFromList, setFocus, setFocus, setFont, setForegroundColor, setLength, setLine, setListFromFile, setProperty, setSelection, setText, setVisible
 

Method Detail

selectFileForTransfer

boolean selectFileForTransfer(AdminFileTransferListener listener)
Selects a file to transfer.

Returns:
true for success, false when the action cannot be performed due to another file transfer action in progress.

listFiles

boolean listFiles(AdminFileTransferListener listener,
                  String directory)
Lists all files (and directories) in a directory.

Returns:
true for success, false when the action cannot be performed due to another file transfer action in progress.

listFiles

boolean listFiles(AdminFileTransferListener listener,
                  String directory,
                  boolean doExtended)
Lists all files (and directories) in a directory (extended operation).

Returns:
true for success, false when the action cannot be performed due to another file transfer action in progress.

initiateFileTransfer

boolean initiateFileTransfer(AdminFileTransferListener listener,
                             String fileName)
Initiates file transfer.

Note that just one file at a time can be active.

Returns:
true for success, false when the action cannot be performed due to another file transfer action in progress.

continueFileTransfer

boolean continueFileTransfer()
Requests next block of data for the file transfer.

Returns:
true for success, false when the action cannot be performed due to another file transfer action in progress.

closeFileTransfer

boolean closeFileTransfer()
Closes the file transfer of the requested file.

Note that just one file at a time can be active.

Returns:
true for success, false when the action cannot be performed due to another file transfer action in progress.

serverToClientFileTransfer

boolean serverToClientFileTransfer(AdminFileTransferListener listener,
                                   String fileName,
                                   int totalSize,
                                   int size,
                                   byte[] data)
File transfer from server to client.

Note that just one file at a time can be active.

Returns:
true for success, false when the action cannot be performed due to another file transfer action in progress.

selectTargetFile

boolean selectTargetFile(AdminFileTransferListener listener)
Selects a target file on the client. The file is used when transferring a file from the server to the client.

Returns:
true for success, false when the action can't be performed due to another file transfer action in progress.

listDirectoryTree

boolean listDirectoryTree(AdminFileTransferListener listener,
                          String directory)
Lists the directory tree recursively in a directory.

Returns:
true for success, false when the action cannot be performed due to another file transfer action in progress.


Phantom® and NetPhantom® are registered trademarks of Codectica Systems SARL.
© Copyright Codectica Systems SARL, 2008. All rights reserved.