se.entra.phantom.server.rconsole
Class AdminUtilServerToClientFileTransfer

java.lang.Object
  extended by se.entra.phantom.server.VirtualPanelAdapter
      extended by se.entra.phantom.server.VirtualComponentAdapter
          extended by se.entra.phantom.server.rconsole.AdminUtilServerToClientFileTransfer
All Implemented Interfaces:
AdminFileTransferListener, VirtualComponentListener, VirtualPanelListener

public class AdminUtilServerToClientFileTransfer
extends VirtualComponentAdapter
implements AdminFileTransferListener

This class handles the transfer of an arbitrary file from the server to the client.


Field Summary
 
Fields inherited from interface se.entra.phantom.server.VirtualPanelListener
ICON_CRITICAL, ICON_INFORMATION, ICON_NOICON, ICON_QUERY, ICON_QUESTION, ICON_WARNING, MB_ABORTRETRYIGNORE, MB_CANCEL, MB_ENTER, MB_ENTERCANCEL, MB_OK, MB_OKCANCEL, MB_RETRYCANCEL, MB_YESNO, MB_YESNOCANCEL, MBID_CANCEL, MBID_DEFAULT, MBID_ENTER, MBID_IGNORE, MBID_NO, MBID_OK, MBID_RETRY, MBID_YES
 
Constructor Summary
AdminUtilServerToClientFileTransfer(ClientSessionManager csm, VirtualPanel vp)
          Constructor.
 
Method Summary
 void onAction(VirtualPanel vp, String controlID)
          Push buttons and menu items generates this event when selected.
 void onDirectoryList(VirtualPanel vp, AdminFileTransferInterface ft, AdminConfigFileTransferItem[] files)
          Returns the list of all files or directories in the requested directory.
 void onFileDownload(VirtualPanel vp, AdminFileTransferInterface ft, int totalSize, byte[] data)
          A piece of the download data of a file (data is null when canceled).
 void onFileSelected(VirtualPanel vp, AdminFileTransferInterface ft, String fileName, int size)
          A file has been selected in the dialog box (or canceled if file name is null).
 void onFileTransferError(VirtualPanel vp, AdminFileTransferInterface ft, String errorMessage)
          Called whenever a file transfer error occurs.
 void onFileUpload(VirtualPanel vp, AdminFileTransferInterface ft)
          The client is requesting a file for download
 void onFileUploadComplete(VirtualPanel vp, AdminFileTransferInterface ft)
          Method call when download is completed
 boolean onPanelClosing(VirtualPanel vp)
          Called when the close button of a panel is pressed, but before any other processing has been done.
 void onPanelDestroy(VirtualPanel vp)
          Called to inform the listener that the panel is destroyed.
 void onTargetFileSelected(VirtualPanel vp, AdminFileTransferInterface ft, String directory)
          A file has been chosen on the client
 
Methods inherited from class se.entra.phantom.server.VirtualComponentAdapter
onAction, onAction, onCheckedChange, onContentChanged, onContentChanged, onControlEvent, onFocusGained, onFocusLost, onMenuAction, onPropertyChange, onSelectionChanged
 
Methods inherited from class se.entra.phantom.server.VirtualPanelAdapter
onModalPanelCreate, onModalPanelProcessing, onPageActivated, onPanelClose, onPanelCreate
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface se.entra.phantom.server.VirtualPanelListener
onPageActivated, onPanelClose, onPanelCreate
 

Constructor Detail

AdminUtilServerToClientFileTransfer

public AdminUtilServerToClientFileTransfer(ClientSessionManager csm,
                                           VirtualPanel vp)
Constructor.

Method Detail

onFileUploadComplete

public void onFileUploadComplete(VirtualPanel vp,
                                 AdminFileTransferInterface ft)
Method call when download is completed

Specified by:
onFileUploadComplete in interface AdminFileTransferListener

onFileTransferError

public void onFileTransferError(VirtualPanel vp,
                                AdminFileTransferInterface ft,
                                String errorMessage)
Called whenever a file transfer error occurs.

Specified by:
onFileTransferError in interface AdminFileTransferListener

onFileSelected

public void onFileSelected(VirtualPanel vp,
                           AdminFileTransferInterface ft,
                           String fileName,
                           int size)
A file has been selected in the dialog box (or canceled if file name is null).

Specified by:
onFileSelected in interface AdminFileTransferListener

onDirectoryList

public void onDirectoryList(VirtualPanel vp,
                            AdminFileTransferInterface ft,
                            AdminConfigFileTransferItem[] files)
Returns the list of all files or directories in the requested directory.

Specified by:
onDirectoryList in interface AdminFileTransferListener

onFileDownload

public void onFileDownload(VirtualPanel vp,
                           AdminFileTransferInterface ft,
                           int totalSize,
                           byte[] data)
A piece of the download data of a file (data is null when canceled).

Specified by:
onFileDownload in interface AdminFileTransferListener

onFileUpload

public void onFileUpload(VirtualPanel vp,
                         AdminFileTransferInterface ft)
The client is requesting a file for download

Specified by:
onFileUpload in interface AdminFileTransferListener

onTargetFileSelected

public void onTargetFileSelected(VirtualPanel vp,
                                 AdminFileTransferInterface ft,
                                 String directory)
A file has been chosen on the client

Specified by:
onTargetFileSelected in interface AdminFileTransferListener

onAction

public void onAction(VirtualPanel vp,
                     String controlID)
Push buttons and menu items generates this event when selected.

Overrides:
onAction in class VirtualComponentAdapter

onPanelClosing

public boolean onPanelClosing(VirtualPanel vp)
Called when the close button of a panel is pressed, but before any other processing has been done. If this function returns false, the application close object will be called (if defined), otherwise a faked key-press of the Escape key is performed. If these two actions failed (because there is no close object or no button or menu item is connected to the Escape key), then the function onPanelClose is called.

Specified by:
onPanelClosing in interface VirtualPanelListener
Overrides:
onPanelClosing in class VirtualPanelAdapter
Returns:
true to cancel all default processing.
See Also:
VirtualPanelAdapter.onPanelClose(se.entra.phantom.server.VirtualPanel)

onPanelDestroy

public void onPanelDestroy(VirtualPanel vp)
Called to inform the listener that the panel is destroyed.

Closes any currently opened file transfer.

Specified by:
onPanelDestroy in interface VirtualPanelListener
Overrides:
onPanelDestroy in class VirtualPanelAdapter


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