com.ibm.etools.systems.universal.util
Class DownloadListener
java.lang.Object
com.ibm.etools.systems.universal.util.DownloadListener
- All Implemented Interfaces:
- ICommunicationsListener, IDomainListener, IUniversalDataStoreConstants
- public class DownloadListener
- extends Object
- implements IDomainListener, ICommunicationsListener, IUniversalDataStoreConstants
Fields inherited from interface com.ibm.etools.systems.universal.miners.IUniversalDataStoreConstants |
BINARY_MODE, BUFFER_SIZE, C_DOWNLOAD_FILE, C_QUERY_QUALIFIED_CLASSNAME, C_QUERY_UNUSED_PORT, C_SYSTEM_ENCODING, Copyright, DOWNLOAD_RESULT_EXCEPTION, DOWNLOAD_RESULT_FILE_NOT_FOUND_EXCEPTION, DOWNLOAD_RESULT_IO_EXCEPTION, DOWNLOAD_RESULT_SUCCESS_MESSAGE, DOWNLOAD_RESULT_SUCCESS_TYPE, DOWNLOAD_RESULT_UNEXPECTED_ERROR, DOWNLOAD_RESULT_UNSUPPORTED_ENCODING_EXCEPTION, FAILED, FAILED_TO_DELETE_DIR, FAILED_WITH_DOES_NOT_EXIST, FAILED_WITH_EXCEPTION, FAILED_WITH_EXIST, FAILED_WITH_SECURITY, KB_IN_BYTES, MESSAGE_DESCRIPTOR, NUM_OF_KB, SUCCESS, TEXT_MODE, TOKEN_SEPARATOR, TYPE_QUALIFIED_CLASSNAME, UNEXPECTED_ERROR, UNIVERSAL_ARCHIVE_FILE_DESCRIPTOR, UNIVERSAL_FILE_DESCRIPTOR, UNIVERSAL_FILESYSTEM_MINER, UNIVERSAL_FILTER_DESCRIPTOR, UNIVERSAL_FOLDER_DESCRIPTOR, UNIVERSAL_NODE_DESCRIPTOR, UNIVERSAL_TEMP_DESCRIPTOR, UNIVERSAL_VIRTUAL_FILE_DESCRIPTOR, UNIVERSAL_VIRTUAL_FOLDER_DESCRIPTOR, VERSION_1 |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
copyright
public static final String copyright
- See Also:
- Constant Field Values
DownloadListener
public DownloadListener(Shell shell,
IProgressMonitor monitor,
ISystem system,
DataElement status,
File localFile,
String remotePath,
long totalLength)
isCancelled
public boolean isCancelled()
getStatus
public DataElement getStatus()
listeningTo
public boolean listeningTo(DomainEvent event)
- Specified by:
listeningTo
in interface IDomainListener
- See Also:
IDomainListener.listeningTo(DomainEvent)
domainChanged
public void domainChanged(DomainEvent event)
- Specified by:
domainChanged
in interface IDomainListener
- See Also:
IDomainListener.domainChanged(DomainEvent)
setDone
public void setDone(boolean done)
- setDone(boolean)
getShell
public Shell getShell()
- Specified by:
getShell
in interface IDomainListener
- See Also:
IDomainListener.getShell()
wasCancelled
public boolean wasCancelled()
communicationsStateChange
public void communicationsStateChange(CommunicationsEvent e)
- Description copied from interface:
ICommunicationsListener
- This method is invoked whenever the communications state is invoked
immediately before and after the state of the communications changes.
The state field in CommunicationsEvent determines which state
change is about to or has occured.
- Specified by:
communicationsStateChange
in interface ICommunicationsListener
- See Also:
ICommunicationsListener.communicationsStateChange(CommunicationsEvent)
isPassiveCommunicationsListener
public boolean isPassiveCommunicationsListener()
- Description copied from interface:
ICommunicationsListener
- This method determines if the communications listener is a passive or
active listener. Typically a passive listener registers with the communications
system and responds to events as they occur. An active listener typically
registeres with the communications system only for the duration of the task (i.e.
user editing a file, or outstanding communications request.)
The user will be prompted on a disconnect if there are any active communication
listeners registered.
- Specified by:
isPassiveCommunicationsListener
in interface ICommunicationsListener
- Returns:
- false if the communications listener is an active listener, true if the
communications listener is a passive listener.
- See Also:
ICommunicationsListener.isPassiveCommunicationsListener()
waitForUpdate
public DataElement waitForUpdate()
throws InterruptedException
- Wait for the the status DataElement to be refreshed
- Returns:
- The status DataElement after it has been updated, or the user
has pressed cancel
- Throws:
InterruptedException
- if the thread was interrupted.
waitForUpdate
public DataElement waitForUpdate(ICommunicationsDiagnosticFactory factory)
throws InterruptedException
- Throws:
InterruptedException
waitForUpdate
public DataElement waitForUpdate(ICommunicationsDiagnosticFactory factory,
int wait)
throws InterruptedException
- Throws:
InterruptedException
cancelDownload
public void cancelDownload()
Copyright © 2005 IBM Corp. All Rights Reserved.
Note: This documentation is for part of an interim API that is still under development and expected to change significantly before reaching stability. It is being made available at this early stage to solicit feedback from pioneering adopters on the understanding that any code that uses this API will almost certainly be broken (repeatedly) as the API evolves.