org.eclipse.rse.subsystems.files.dstore.old
Class StatusChangeListener

java.lang.Object
  org.eclipse.rse.subsystems.files.dstore.old.StatusChangeListener

All Implemented Interfaces:

ICommunicationsListener, org.eclipse.dstore.extra.internal.extra.IDomainListener

Direct Known Subclasses:

FileTransferStatusListener

public class StatusChangeListener

extends Object

implements org.eclipse.dstore.extra.internal.extra.IDomainListener, ICommunicationsListener

Nested Class Summary

protected static class

StatusChangeListener.FindShell

Field Summary

protected boolean	_networkDown
protected boolean	cancelled
protected boolean	done
protected Vector	historyOfTargets
protected IProgressMonitor	monitor
protected Shell	shell
protected IConnectorService	system
protected org.eclipse.dstore.core.model.DataElement	target

Constructor Summary

StatusChangeListener(IConnectorService system)

StatusChangeListener(Shell shell, IProgressMonitor monitor, IConnectorService system)

StatusChangeListener(Shell shell, IProgressMonitor monitor, IConnectorService system, org.eclipse.dstore.core.model.DataElement target)
Construct a StatusChangeListener

Method Summary

void	communicationsStateChange(CommunicationsEvent e) This method is invoked whenever the communications state is invoked immediately before and after the state of the communications changes.
protected boolean	determineStatusDone() Determines whether the status is done.
void	domainChanged(org.eclipse.dstore.extra.internal.extra.DomainEvent event)
Shell	getShell()
org.eclipse.dstore.core.model.DataElement	getStatus()
boolean	isNetworkDown() Test if the StatusChangeListener returned because the network connection to the remote system was broken.
boolean	isPassiveCommunicationsListener() This method determines if the communications listener is a passive or active listener.
boolean	listeningTo(org.eclipse.dstore.extra.internal.extra.DomainEvent event)
void	setDone(boolean done) setDone(boolean)
void	setStatus(org.eclipse.dstore.core.model.DataElement p_target)
org.eclipse.dstore.core.model.DataElement	waitForUpdate() Wait for the the status DataElement to be refreshed
org.eclipse.dstore.core.model.DataElement	waitForUpdate(ICommunicationsDiagnosticFactory factory)
org.eclipse.dstore.core.model.DataElement	waitForUpdate(ICommunicationsDiagnosticFactory factory, int wait)
boolean	wasCancelled()
ICommunicationsDiagnostic	whatIsGoingOn(ICommunicationsDiagnosticFactory factory, boolean quiet) Start diagnostic

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

target

protected org.eclipse.dstore.core.model.DataElement target

shell

protected Shell shell

monitor

protected IProgressMonitor monitor

system

protected IConnectorService system

_networkDown

protected boolean _networkDown

done

protected boolean done

cancelled

protected boolean cancelled

historyOfTargets

protected Vector historyOfTargets

Constructor Detail

StatusChangeListener

public StatusChangeListener(Shell shell,
                            IProgressMonitor monitor,
                            IConnectorService system,
                            org.eclipse.dstore.core.model.DataElement target)

Construct a StatusChangeListener

Parameters:

shell - A valid Shell object

monitor - A progress monitor if you want this object to check if the user presses cancel while waiting for the status object to be updated

target - The status DataElement for which you wish to wait for an update

StatusChangeListener

public StatusChangeListener(Shell shell,
                            IProgressMonitor monitor,
                            IConnectorService system)

StatusChangeListener

public StatusChangeListener(IConnectorService system)

Method Detail

setStatus

public void setStatus(org.eclipse.dstore.core.model.DataElement p_target)

getStatus

public org.eclipse.dstore.core.model.DataElement getStatus()

listeningTo

public boolean listeningTo(org.eclipse.dstore.extra.internal.extra.DomainEvent event)

Specified by:

listeningTo in interface org.eclipse.dstore.extra.internal.extra.IDomainListener

See Also:

IDomainListener.listeningTo(DomainEvent)

domainChanged

public void domainChanged(org.eclipse.dstore.extra.internal.extra.DomainEvent event)

Specified by:

domainChanged in interface org.eclipse.dstore.extra.internal.extra.IDomainListener

See Also:

IDomainListener.domainChanged(DomainEvent)

setDone

public void setDone(boolean done)

setDone(boolean)

getShell

public Shell 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)

waitForUpdate

public org.eclipse.dstore.core.model.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 org.eclipse.dstore.core.model.DataElement waitForUpdate(ICommunicationsDiagnosticFactory factory)
                                                        throws InterruptedException

Throws:

InterruptedException

waitForUpdate

public org.eclipse.dstore.core.model.DataElement waitForUpdate(ICommunicationsDiagnosticFactory factory,
                                                               int wait)
                                                        throws InterruptedException

Throws:

InterruptedException

determineStatusDone

protected boolean determineStatusDone()

Determines whether the status is done.

Returns:

true if status done, false otherwise.

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

whatIsGoingOn

public ICommunicationsDiagnostic whatIsGoingOn(ICommunicationsDiagnosticFactory factory,
                                               boolean quiet)
                                        throws InterruptedException

Start diagnostic

Parameters:

quiet - is the flag to indicate if user should be prompted - true for no prompt

Returns:

ICommunciationsDiagnostic class instance

Throws:

InterruptedException

isNetworkDown

public boolean isNetworkDown()

Test if the StatusChangeListener returned because the network connection to the remote system was broken.