org.eclipse.ecf.provider.filetransfer.outgoing

Class AbstractOutgoingFileTransfer

java.lang.Object

org.eclipse.ecf.provider.filetransfer.outgoing.AbstractOutgoingFileTransfer

Direct Known Subclasses:

AbstractUrlConnectionOutgoingFileTransfer, LocalFileOutgoingFileTransfer

public abstract class AbstractOutgoingFileTransfer
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
protected int	buff_length
protected long	bytesSent
protected IConnectContext	connectContext
static int	DEFAULT_BUF_LENGTH
protected boolean	done
protected java.lang.Exception	exception
protected IFileTransferInfo	fileTransferInfo
protected Job	job
protected IFileTransferListener	listener
protected java.io.InputStream	localFileContents
protected java.util.Map	options
protected Proxy	proxy
protected java.io.OutputStream	remoteFileContents
protected IFileID	remoteFileID
protected java.net.URL	remoteFileURL

Constructor Summary

Constructors

Constructor and Description
AbstractOutgoingFileTransfer()

Method Summary

Modifier and Type	Method and Description
void	addListener(IIncomingFileTransferRequestListener l)
void	cancel()
protected java.lang.String	createJobName()
protected void	fireSendStartEvent()
protected void	fireTransferSendDataEvent()
protected void	fireTransferSendDoneEvent()
java.lang.Object	getAdapter(java.lang.Class adapter)
long	getBytesSent()
java.lang.Exception	getException()
long	getFileLength()
protected IFileTransferInfo	getFileTransferInfo()
protected IStatus	getFinalStatus(java.lang.Throwable exception1)
ID	getID()
IFileTransferListener	getListener()
protected java.util.Map	getOptions()
Namespace	getOutgoingNamespace()
double	getPercentComplete()
protected java.net.URL	getRemoteFileURL()
protected void	hardClose()
boolean	isDone()
protected abstract void	openStreams() Open incoming and outgoing streams associated with this file transfer.
boolean	removeListener(IIncomingFileTransferRequestListener l)
protected IProxyData	selectProxyFromProxies(java.lang.String protocol, IProxyData[] proxies) Select a single proxy from a set of proxies available for the given host.
void	sendOutgoingRequest(IFileID targetReceiver, java.io.File localFileToSend, IFileTransferListener transferListener, java.util.Map ops)
void	sendOutgoingRequest(IFileID targetReceiver, IFileTransferInfo localFileToSend, IFileTransferListener transferListener, java.util.Map ops)
void	setConnectContextForAuthentication(IConnectContext connectContext)
protected void	setInputStream(java.io.InputStream ins)
protected void	setOutputStream(java.io.OutputStream outs)
void	setProxy(Proxy proxy)
protected void	setupAndScheduleJob()
protected void	setupProxies()
protected abstract void	setupProxy(Proxy proxy)

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

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

bytesSent

protected long bytesSent

localFileContents

protected java.io.InputStream localFileContents

remoteFileContents

protected java.io.OutputStream remoteFileContents

exception

protected java.lang.Exception exception

fileTransferInfo

protected IFileTransferInfo fileTransferInfo

options

protected java.util.Map options

connectContext

protected IConnectContext connectContext

proxy

protected Proxy proxy

Constructor Detail

AbstractOutgoingFileTransfer

public AbstractOutgoingFileTransfer()

Method Detail

getRemoteFileURL

protected java.net.URL getRemoteFileURL()

setInputStream

protected void setInputStream(java.io.InputStream ins)

setOutputStream

protected void setOutputStream(java.io.OutputStream outs)

getFileTransferInfo

protected IFileTransferInfo getFileTransferInfo()

getOptions

protected java.util.Map getOptions()

getFinalStatus

protected IStatus getFinalStatus(java.lang.Throwable exception1)

hardClose

protected void hardClose()

getID

public ID getID()

fireTransferSendDoneEvent

protected void fireTransferSendDoneEvent()

fireTransferSendDataEvent

protected void fireTransferSendDataEvent()

getBytesSent

public long getBytesSent()

cancel

public void cancel()

getException

public java.lang.Exception getException()

getPercentComplete

public double getPercentComplete()

getFileLength

public long getFileLength()

isDone

public boolean isDone()

getAdapter

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

openStreams

protected abstract void openStreams()
                             throws SendFileTransferException

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:

SendFileTransferException - if some problem

getOutgoingNamespace

public Namespace getOutgoingNamespace()

getListener

public IFileTransferListener getListener()

createJobName

protected java.lang.String createJobName()

setupAndScheduleJob

protected void setupAndScheduleJob()

fireSendStartEvent

protected void fireSendStartEvent()

setupProxy

protected abstract void setupProxy(Proxy proxy)

setupProxies

protected void setupProxies()

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.

sendOutgoingRequest

public void sendOutgoingRequest(IFileID targetReceiver,
                                IFileTransferInfo localFileToSend,
                                IFileTransferListener transferListener,
                                java.util.Map ops)
                         throws SendFileTransferException

Throws:

SendFileTransferException

sendOutgoingRequest

public void sendOutgoingRequest(IFileID targetReceiver,
                                java.io.File localFileToSend,
                                IFileTransferListener transferListener,
                                java.util.Map ops)
                         throws SendFileTransferException

Throws:

SendFileTransferException

addListener

public void addListener(IIncomingFileTransferRequestListener l)

removeListener

public boolean removeListener(IIncomingFileTransferRequestListener l)

setConnectContextForAuthentication

public void setConnectContextForAuthentication(IConnectContext connectContext)

setProxy

public void setProxy(Proxy proxy)