# browseFileTransferProtocolFactory

###### Identifier:

org.eclipse.ecf.provider.filetransfer.browseFileTransferProtocolFactory

###### Since:

1.0.0

###### Description:

This extension point allows IRemoteFileSystemBrowserFactorys to be defined for given file transfer protocols.

###### Configuration Markup:

<!ELEMENT extension (browseFileTransferProtocolFactory*)>

<!ATTLIST extension

point CDATA #REQUIRED

id CDATA #IMPLIED

name CDATA #IMPLIED>

<!ELEMENT browseFileTransferProtocolFactory EMPTY>

<!ATTLIST browseFileTransferProtocolFactory

protocol CDATA #REQUIRED

class CDATA #REQUIRED

priority CDATA #IMPLIED

uri (true | false) >

Browse remote file system protocol factory extention point

- protocol - Protocol to define factory for. For example, http, https, ftp, bittorrent, my.favorite.protocol.
- class - The factory class to use for given protocol. Must implement org.eclipse.ecf.filetransfer.service.IRemoteFileSystemBrowserFactory
- priority - Priority relative to other browseFileTransferProtocolFactory extensions. Valid priorities are 0 (highest priority) to 100 (lowest priority). If this optional attribute is not specified, it will automatically be assigned a default priority of 100.
- uri - Flag to indicate that the protocol factory will use URIs (rather than URLs...which is the default). True indicates that URIs will be used, and *no* URLStreamHandler will be registered for the associated protocol. If false, URLs will be used and an URLStreamHandler will be registered for the given protocol factory. NOTE: If this flag is true, providers that attempt to access IFileID.getURL() may be unable to do so, since the URI may not be successfully parsed as a URL.

###### Examples:

       <extension
             point="org.eclipse.ecf.provider.filetransfer.browseFileTransferProtocolFactory">
          <browseFileTransferProtocolFactory
                class="org.eclipse.ecf.provider.filetransfer.ssh.ScpBrowseFileTransferFactory"
                protocol="scp"
                priority="90">
          </browseFileTransferProtocolFactory>
       </extension>

###### API Information:

Here is the org.eclipse.ecf.filetransfer.service.IRemoteFileSystemBrowserFactory

    /**
     * Remote file browser factory. This service interface is used by clients to
     * create a new IRemoteFileSystemBrowser instance.
     */
    public interface IRemoteFileSystemBrowserFactory {

     /**
      * Get new instance of IRemoteFileSystemBrowser.
      *
      * @return IRemoteFileSystemBrowser for initiating a retrieval of a remote file.
      */
     public IRemoteFileSystemBrowser newInstance();

    }

###### Supplied Implementation:

None

Copyright (c) 2004 Composent, Inc., IBM and others. This program and the accompanying materials are made available under the terms of the Eclipse Public License 2.0 which is available at https://www.eclipse.org/legal/epl-2.0/ SPDX-License-Identifier: EPL-2.0