org.eclipse.ecf.provider.filetransfer.retrieve

Class AbstractRetrieveFileTransfer

java.lang.Object

org.eclipse.ecf.provider.filetransfer.retrieve.AbstractRetrieveFileTransfer

Direct Known Subclasses:

UrlConnectionRetrieveFileTransfer

public abstract class AbstractRetrieveFileTransfer
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
protected int	buff_length
protected long	bytesReceived
protected static int	CLOSE_TIMEOUT
protected boolean	closeOutputStream
protected IConnectContext	connectContext
static int	DEFAULT_BUF_LENGTH
protected boolean	done
protected double	downloadRateBytesPerSecond
protected java.lang.Exception	exception
protected long	fileLength
protected Job	job
protected java.lang.Object	jobLock
protected long	lastModifiedTime
protected IFileTransferListener	listener
protected java.io.OutputStream	localFileContents
protected java.util.Map	options
protected boolean	paused
protected static int	POLLING_RETRY_ATTEMPTS
protected Proxy	proxy
protected IFileRangeSpecification	rangeSpecification
protected static int	READ_TIMEOUT
protected java.io.InputStream	remoteFileContents
protected IFileID	remoteFileID
protected java.net.URL	remoteFileURL
protected java.util.Map	responseHeaders
protected static int	TIMEOUT_INPUTSTREAM_BUFFER_SIZE
protected long	transferStartTime

Constructor Summary

Constructors

Constructor and Description
AbstractRetrieveFileTransfer()

Method Summary

Modifier and Type	Method and Description
void	cancel()
protected java.lang.String	createJobName()
protected java.lang.String	createRangeName()
protected abstract boolean	doPause() Subclass overridable version of pause().
protected abstract boolean	doResume() Subclass overridable version of resume().
protected void	fireReceiveResumedEvent()
protected void	fireReceiveStartEvent()
protected void	fireTransferReceiveDataEvent()
protected void	fireTransferReceiveDoneEvent()
protected void	fireTransferReceivePausedEvent()
java.lang.Object	getAdapter(java.lang.Class adapter)
long	getBytesReceived()
java.lang.Exception	getException()
long	getFileLength()
IFileRangeSpecification	getFileRangeSpecification()
protected IStatus	getFinalStatus(java.lang.Throwable exception1)
ID	getID()
IFileTransferListener	getListener()
protected java.util.Map	getOptions()
double	getPercentComplete()
java.lang.String	getRemoteFileName()
protected java.net.URL	getRemoteFileURL()
java.util.Date	getRemoteLastModified()
Namespace	getRetrieveNamespace()
protected int	getSocketCloseTimeout()
protected int	getSocketReadTimeout()
protected void	handleReceivedData(byte[] buf, int bytes, double factor, IProgressMonitor monitor)
protected void	hardClose()
protected boolean	isCanceled()
boolean	isDone()
boolean	isPaused()
protected UserCancelledException	newUserCancelledException()
protected abstract void	openStreams() Open incoming and outgoing streams associated with this file transfer.
boolean	pause()
protected void	resetDoneAndException()
boolean	resume()
protected IProxyData	selectProxyFromProxies(java.lang.String protocol, IProxyData[] proxies) Select a single proxy from a set of proxies available for the given host.
void	sendRetrieveRequest(IFileID rFileID, IFileRangeSpecification rangeSpec, IFileTransferListener transferListener, java.util.Map ops)
void	sendRetrieveRequest(IFileID remoteFileID1, IFileTransferListener transferListener, java.util.Map options1)
protected void	setCloseOutputStream(boolean close)
void	setConnectContextForAuthentication(IConnectContext connectContext)
protected void	setDone(boolean done)
protected void	setDoneCanceled()
protected void	setDoneCanceled(java.lang.Exception e)
protected void	setDoneException(java.lang.Exception e)
protected void	setFileLength(long length)
protected void	setInputStream(java.io.InputStream ins)
protected void	setLastModifiedTime(long timestamp)
protected void	setOutputStream(java.io.OutputStream outs)
void	setProxy(Proxy proxy)
protected void	setupAndScheduleJob(FileTransferJob fileTransferJob)
protected void	setupProxies()
protected abstract void	setupProxy(Proxy proxy) Setup ECF proxy.
protected boolean	targetHasGzSuffix(java.lang.String target)
static java.lang.String	toHumanReadableBytes(double size)
protected java.io.InputStream	wrapTransferReadInputStream(java.io.InputStream inputStream, IProgressMonitor monitor)

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_BUF_LENGTH

public static final int DEFAULT_BUF_LENGTH

See Also:

Constant Field Values

POLLING_RETRY_ATTEMPTS

protected static final int POLLING_RETRY_ATTEMPTS

TIMEOUT_INPUTSTREAM_BUFFER_SIZE

protected static final int TIMEOUT_INPUTSTREAM_BUFFER_SIZE

See Also:

Constant Field Values

READ_TIMEOUT

protected static final int READ_TIMEOUT

CLOSE_TIMEOUT

protected static final int CLOSE_TIMEOUT

jobLock

protected java.lang.Object jobLock

job

protected Job job

remoteFileURL

protected java.net.URL remoteFileURL

remoteFileID

protected IFileID remoteFileID

listener

protected IFileTransferListener listener

buff_length

protected int buff_length

done

protected boolean done

bytesReceived

protected volatile long bytesReceived

remoteFileContents

protected java.io.InputStream remoteFileContents

localFileContents

protected java.io.OutputStream localFileContents

closeOutputStream

protected boolean closeOutputStream

exception

protected java.lang.Exception exception

fileLength

protected long fileLength

lastModifiedTime

protected long lastModifiedTime

options

protected java.util.Map options

paused

protected boolean paused

rangeSpecification

protected IFileRangeSpecification rangeSpecification

proxy

protected Proxy proxy

connectContext

protected IConnectContext connectContext

transferStartTime

protected long transferStartTime

downloadRateBytesPerSecond

protected double downloadRateBytesPerSecond

responseHeaders

protected java.util.Map responseHeaders

Since:

3.1

Constructor Detail

AbstractRetrieveFileTransfer

public AbstractRetrieveFileTransfer()

Method Detail

wrapTransferReadInputStream

protected java.io.InputStream wrapTransferReadInputStream(java.io.InputStream inputStream,
                                                          IProgressMonitor monitor)

getRemoteFileURL

protected java.net.URL getRemoteFileURL()

getSocketReadTimeout

protected int getSocketReadTimeout()

getSocketCloseTimeout

protected int getSocketCloseTimeout()

setInputStream

protected void setInputStream(java.io.InputStream ins)

setOutputStream

protected void setOutputStream(java.io.OutputStream outs)

setCloseOutputStream

protected void setCloseOutputStream(boolean close)

setFileLength

protected void setFileLength(long length)

setLastModifiedTime

protected void setLastModifiedTime(long timestamp)

getOptions

protected java.util.Map getOptions()

handleReceivedData

protected void handleReceivedData(byte[] buf,
                                  int bytes,
                                  double factor,
                                  IProgressMonitor monitor)
                           throws java.io.IOException

Throws:

java.io.IOException

toHumanReadableBytes

public static java.lang.String toHumanReadableBytes(double size)

getID

public ID getID()

getFinalStatus

protected IStatus getFinalStatus(java.lang.Throwable exception1)

hardClose

protected void hardClose()

fireTransferReceivePausedEvent

protected void fireTransferReceivePausedEvent()

fireTransferReceiveDoneEvent

protected void fireTransferReceiveDoneEvent()

fireTransferReceiveDataEvent

protected void fireTransferReceiveDataEvent()

setConnectContextForAuthentication

public void setConnectContextForAuthentication(IConnectContext connectContext)

setProxy

public void setProxy(Proxy proxy)

getBytesReceived

public long getBytesReceived()

newUserCancelledException

protected UserCancelledException newUserCancelledException()

Returns:

UserCancelledException if some user cancellation

Since:

3.0

resetDoneAndException

protected void resetDoneAndException()

setDone

protected void setDone(boolean done)

setDoneException

protected void setDoneException(java.lang.Exception e)

isCanceled

protected boolean isCanceled()

setDoneCanceled

protected void setDoneCanceled()

setDoneCanceled

protected void setDoneCanceled(java.lang.Exception e)

cancel

public void cancel()

getException

public java.lang.Exception getException()

getPercentComplete

public double getPercentComplete()

getFileLength

public long getFileLength()

getRemoteLastModified

public java.util.Date getRemoteLastModified()

isDone

public boolean isDone()

getAdapter

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

openStreams

protected abstract void openStreams()
                             throws IncomingFileTransferException

Open incoming and outgoing streams associated with this file transfer. Subclasses must implement this method to open input and output streams. The remoteFileContents and localFileContent must be non-null after successful completion of the implementation of this method.

Throws:

IncomingFileTransferException - if some problem

sendRetrieveRequest

public void sendRetrieveRequest(IFileID remoteFileID1,
                                IFileTransferListener transferListener,
                                java.util.Map options1)
                         throws IncomingFileTransferException

Throws:

IncomingFileTransferException

getRetrieveNamespace

public Namespace getRetrieveNamespace()

isPaused

public boolean isPaused()

doPause

protected abstract boolean doPause()

Subclass overridable version of pause(). Subclasses must provide an implementation of this method to support IFileTransferPausable .

Returns:

true if the pause is successful. false otherwise.

pause

public boolean pause()

doResume

protected abstract boolean doResume()

Subclass overridable version of resume(). Subclasses must provide an implementation of this method to support IFileTransferPausable.

Returns:

true if the resume is successful. false otherwise.

resume

public boolean resume()

getListener

public IFileTransferListener getListener()

createRangeName

protected java.lang.String createRangeName()

createJobName

protected java.lang.String createJobName()

setupAndScheduleJob

protected void setupAndScheduleJob(FileTransferJob fileTransferJob)

fireReceiveStartEvent

protected void fireReceiveStartEvent()

fireReceiveResumedEvent

protected void fireReceiveResumedEvent()

getFileRangeSpecification

public IFileRangeSpecification getFileRangeSpecification()

sendRetrieveRequest

public void sendRetrieveRequest(IFileID rFileID,
                                IFileRangeSpecification rangeSpec,
                                IFileTransferListener transferListener,
                                java.util.Map ops)
                         throws IncomingFileTransferException

Throws:

IncomingFileTransferException - if some problem sending retrieve request

setupProxy

protected abstract void setupProxy(Proxy proxy)

Setup ECF proxy. Subclasses must override this method to do appropriate proxy setup. This method will be called from within sendRetrieveRequest(IFileID, IFileTransferListener, Map) and sendRetrieveRequest(IFileID, IFileRangeSpecification, IFileTransferListener, Map) , prior to the actual call to openStreams().

Parameters:

proxy - the proxy to be setup. Will not be null.

selectProxyFromProxies

protected IProxyData selectProxyFromProxies(java.lang.String protocol,
                                            IProxyData[] proxies)

Select a single proxy from a set of proxies available for the given host. This implementation selects in the following manner: 1) If proxies provided is null or array of 0 length, null is returned. If only one proxy is available (array of length 1) then the entry is returned. If proxies provided is length greater than 1, then if the type of a proxy in the array matches the given protocol (e.g. http, https), then the first matching proxy is returned. If the protocol does not match any of the proxies, then the *first* proxy (i.e. proxies[0]) is returned. Subclasses may override if desired.

Parameters:

protocol - the target protocol (e.g. http, https, scp, etc). Will not be null.

proxies - the proxies to select from. May be null or array of length 0.

Returns:

proxy data selected from the proxies provided.

setupProxies

protected void setupProxies()

getRemoteFileName

public java.lang.String getRemoteFileName()

targetHasGzSuffix

protected boolean targetHasGzSuffix(java.lang.String target)