org.eclipse.ecf.provider.fileshare
Class BaseFileShareRetriever

java.lang.Object
  org.eclipse.ecf.core.sharedobject.AbstractSharedObject
      org.eclipse.ecf.provider.fileshare.BaseFileShareRetriever

All Implemented Interfaces:

org.eclipse.core.runtime.IAdaptable, IIdentifiable, ISharedObject, IEventHandler, IFileShare

public class BaseFileShareRetriever
extends AbstractSharedObject
implements IFileShare

File share retriever implementation

Field Summary

protected static java.lang.String	CANCEL_METHOD
protected static java.lang.String	RETRIEVE_METHOD

Constructor Summary

BaseFileShareRetriever(ID remoteTargetFileID, java.io.File localTarget, IFileShareListener listener)

Method Summary

void	cancel() Cancel the file transfer
protected void	cleanUp()
protected void	closeStreams()
protected void	doCancel()
protected void	doRetrieve()
protected void	fireRetrieveComplete()
protected void	fireRetrieveData(byte[] bytesReceived)
protected void	fireRetrieveStart()
java.lang.Object	getAdapter(java.lang.Class clazz)
protected java.io.File	getUniqueLocalFile()
protected boolean	handleSharedObjectMsg(SharedObjectMsg msg) SharedObjectMsg handler method.
protected void	initialize() Initialize this shared object.
void	remove()
void	start() Start the file transfer

Methods inherited from class org.eclipse.ecf.core.sharedobject.AbstractSharedObject

addEventProcessor, clearEventProcessors, creationCompleted, destroyRemote, destroySelf, destroySelfLocal, dispose, fireEventProcessors, getConfig, getContext, getGroupID, getHomeContainerID, getID, getLocalContainerID, getProperties, getReplicaDescription, getReplicaDescriptions, getSharedObjectMsgFromEvent, handleEvent, handleEvents, handleSharedObjectCreateResponseEvent, handleSharedObjectMsgEvent, handleUnhandledEvent, init, isConnected, isPrimary, removeEventProcessor, replicateToRemoteContainers, sendSharedObjectMsgTo, sendSharedObjectMsgToPrimary, sendSharedObjectMsgToSelf

Methods inherited from class java.lang.Object

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

Field Detail

RETRIEVE_METHOD

protected static final java.lang.String RETRIEVE_METHOD

See Also:

Constant Field Values

CANCEL_METHOD

protected static final java.lang.String CANCEL_METHOD

See Also:

Constant Field Values

Constructor Detail

BaseFileShareRetriever

public BaseFileShareRetriever(ID remoteTargetFileID,
                              java.io.File localTarget,
                              IFileShareListener listener)

Method Detail

initialize

protected void initialize()
                   throws SharedObjectInitException

Description copied from class: AbstractSharedObject

Initialize this shared object. Subclasses may override as appropriate to define custom initialization behavior. If initialization should fail, then a SharedObjectInitException should be thrown by implementing code. Also, subclasses overriding this method should call super.initialize() before running their own code.

Overrides:

initialize in class AbstractSharedObject

Throws:

SharedObjectInitException - if initialization should throw

handleSharedObjectMsg

protected boolean handleSharedObjectMsg(SharedObjectMsg msg)

Description copied from class: AbstractSharedObject

SharedObjectMsg handler method. This method will be called by AbstractSharedObject.handleSharedObjectMsgEvent(ISharedObjectMessageEvent) when a SharedObjectMsg is received either from a local source or a remote source. This default implementation simply returns false so that other processing of of the given msg can occur. Subclasses should override this behavior to define custom logic for handling SharedObjectMsgs.

Overrides:

handleSharedObjectMsg in class AbstractSharedObject

Parameters:

msg - the SharedObjectMsg received

Returns:

true if the msg has been completely handled and subsequent processing should stop. False if processing should continue

fireRetrieveComplete

protected void fireRetrieveComplete()

fireRetrieveData

protected void fireRetrieveData(byte[] bytesReceived)
                         throws java.io.IOException

Throws:

java.io.IOException

getUniqueLocalFile

protected java.io.File getUniqueLocalFile()

cleanUp

protected void cleanUp()

fireRetrieveStart

protected void fireRetrieveStart()

doCancel

protected void doCancel()

doRetrieve

protected void doRetrieve()

closeStreams

protected void closeStreams()

start

public void start()

Description copied from interface: IFileShare

Start the file transfer

Specified by:

start in interface IFileShare

cancel

public void cancel()

Description copied from interface: IFileShare

Cancel the file transfer

Specified by:

cancel in interface IFileShare

getAdapter

public java.lang.Object getAdapter(java.lang.Class clazz)

Specified by:

getAdapter in interface org.eclipse.core.runtime.IAdaptable

Overrides:

getAdapter in class AbstractSharedObject

remove

public void remove()