public class MultiProtocolRetrieveAdapter extends Object implements IRetrieveFileTransfer
| Constructor and Description |
|---|
MultiProtocolRetrieveAdapter() |
| Modifier and Type | Method and Description |
|---|---|
Object |
getAdapter(Class adapter) |
Namespace |
getRetrieveNamespace()
Get namespace to be used for creation of remoteFileID for retrieve
request.
|
void |
sendRetrieveRequest(IFileID remoteFileID,
IFileRangeSpecification rangeSpecification,
IFileTransferListener transferListener,
Map options)
Send request for transfer of a remote file to local file storage.
|
void |
sendRetrieveRequest(IFileID remoteFileID,
IFileTransferListener transferListener,
Map options)
Send request for transfer of a remote file to local file storage.
|
void |
setConnectContextForAuthentication(IConnectContext connectContext)
Set connect context for authentication upon subsequent
IRetrieveFileTransferContainerAdapter.sendRetrieveRequest(IFileID, IFileTransferListener, Map). |
void |
setProxy(Proxy proxy)
Set proxy for use upon subsequent
IRetrieveFileTransferContainerAdapter.sendRetrieveRequest(IFileID, IFileTransferListener, Map). |
public Namespace getRetrieveNamespace()
IRetrieveFileTransferContainerAdapterIDFactory.createID(Namespace, String) to be used as first in
IRetrieveFileTransferContainerAdapter.sendRetrieveRequest(IFileID, IFileTransferListener, Map)getRetrieveNamespace in interface IRetrieveFileTransferContainerAdapterIDFactory.createID(Namespace, String). Will not be
null.public void setConnectContextForAuthentication(IConnectContext connectContext)
IRetrieveFileTransferContainerAdapterIRetrieveFileTransferContainerAdapter.sendRetrieveRequest(IFileID, IFileTransferListener, Map). This
method should be called with a non-null connectContext in order to allow
authentication to occur during call to
IRetrieveFileTransferContainerAdapter.sendRetrieveRequest(IFileID, IFileTransferListener, Map).setConnectContextForAuthentication in interface IRetrieveFileTransferContainerAdapterconnectContext - the connect context to use for authenticating during
subsequent call to
IRetrieveFileTransferContainerAdapter.sendRetrieveRequest(IFileID, IFileTransferListener, Map).
If null, then no authentication will be
attempted.public void setProxy(Proxy proxy)
IRetrieveFileTransferContainerAdapterIRetrieveFileTransferContainerAdapter.sendRetrieveRequest(IFileID, IFileTransferListener, Map). This
method should be called with proxy to allow the given proxy to
be used in subsequent calls to
IRetrieveFileTransferContainerAdapter.sendRetrieveRequest(IFileID, IFileTransferListener, Map).
When proxy is null or has not been called providers must use
the org.eclipse.core.net proxy API to obtain proxy information
and proxy credentials if they support proxies of the type(s) supported by
that API. The API is provided by an OSGi service of type
org.eclipse.core.net.proxy.IProxyService.
If no information is available via IProxyService
providers may use other defaults.
setProxy in interface IRetrieveFileTransferContainerAdapterproxy - the proxy to use for subsequent calls to
IRetrieveFileTransferContainerAdapter.sendRetrieveRequest(IFileID, IFileTransferListener, Map).
If null, then proxy information is obtained from
IProxyService if available. Otherwise provider
defined defaults may be used.public void sendRetrieveRequest(IFileID remoteFileID, IFileTransferListener transferListener, Map options) throws IncomingFileTransferException
IRetrieveFileTransferContainerAdapter
NOTE: if this method completes successfully, the given transferListener
will be asynchronously notified via an IIncomingFileTransferReceiveDoneEvent
(along with other possible events). All implementations are required to
issue this event whether successful or failed. Listeners
can consult IIncomingFileTransferReceiveDoneEvent.getException() to
determine whether the transfer operation completed successfully.
sendRetrieveRequest in interface IRetrieveFileTransferContainerAdapterremoteFileID - reference to the remote target file (e.g.
http://www.eclipse.org/index.html) or a reference to a
resource that specifies the location of a target file.
Implementing providers will determine what protocol schemes
are supported (e.g. ftp, http, torrent, file, etc) and the
required format of the scheme-specific information. If a
protocol is specified that is not supported, or the
scheme-specific information is not well-formed, then an
IncomingFileTransferException will be thrown. Typically,
callers will create IFileID instances via calls such as:
IFileID remoteFileID = FileIDFactory.getDefault().createID(
ftc.getRetrieveNamespace(), "http://www.composent.com/index.html");
Must not be null.transferListener - a listener for file transfer events. Must not be null. Must not be null. See Note above.options - a Map of options associated with sendRetrieveRequest. The
particular name/value pairs will be unique to the individual
providers. May be null.IncomingFileTransferException - if the provider is not connected or is not in the correct
state for initiating file transferpublic void sendRetrieveRequest(IFileID remoteFileID, IFileRangeSpecification rangeSpecification, IFileTransferListener transferListener, Map options) throws IncomingFileTransferException
IRetrieveFileTransferContainerAdapter
NOTE: if this method completes successfully, the given transferListener
will be asynchronously notified via an IIncomingFileTransferReceiveDoneEvent
(along with other possible events). All implementations are required to
issue this event whether successful or failed. Listeners
can consult IIncomingFileTransferReceiveDoneEvent.getException() to
determine whether the transfer operation completed successfully.
sendRetrieveRequest in interface IRetrieveFileTransferContainerAdapterremoteFileID - reference to the remote target file (e.g.
http://www.eclipse.org/index.html) or a reference to a
resource that specifies the location of a target file.
Implementing providers will determine what protocol schemes
are supported (e.g. ftp, http, torrent, file, etc) and the
required format of the scheme-specific information. If a
protocol is specified that is not supported, or the
scheme-specific information is not well-formed, then an
IncomingFileTransferException will be thrown. Typically,
callers will create IFileID instances via calls such as:
IFileID remoteFileID = FileIDFactory.getDefault().createID(
ftc.getRetrieveNamespace(), "http://www.composent.com/index.html");
Must not be null.rangeSpecification - a range specification for retrieving a portion of the given
remote file. If null the entire file will be retrieved (as per IRetrieveFileTransferContainerAdapter.sendRetrieveRequest(IFileID, IFileTransferListener, Map).
If non-null the given file range will be used to retrieve the given file. For example, if the
rangeSpecification has a start value of 1 and end value of 3, and the total length of the file is
5 bytes with content [a, b, c, d, e], a successful retrieve request would transfer bytes 'b', 'c', and 'd', but not 'a', and 'e'.transferListener - a listener for file transfer events. Must not be null. See Note above.options - a Map of options associated with sendRetrieveRequest. The
particular name/value pairs will be unique to the individual
providers. May be null.IncomingFileTransferException - if the provider is not connected or is not in the correct
state for initiating file transferCopyright © 2004–2020 Eclipse Foundation. All rights reserved.