JBoss.orgCommunity Documentation

Chapter 31. FTP

31.1. Introdution
31.2. Configuration Parameters
31.2.1. command-port:
31.2.2. data-min-port & data-max-port
31.2.3. system
31.2.4. client-side-encoding
31.2.5. def-folder-node-type
31.2.6. def-file-node-type
31.2.7. def-file-mime-type
31.2.8. cache-folder-name
31.2.9. upload-speed-limit
31.2.10. download-speed-limit
31.2.11. timeout

31.1. Introdution

The JCR-FTP Server represents the standard eXo service, operates as an FTP server with an access to a content stored in JCR repositories in the form of nt:file/nt:folder nodes or their successors. The client of an executed Server can be any FTP client. The FTP server is supported by a standard configuration which can be changed as required.

31.2. Configuration Parameters

<value-param>
   <name>command-port</name>
   <value>21</value>
</value-param>

The value of the command channel port. The value '21' is default.

When you have already some FTP server installed in your system , this parameter needs to be changed (2121 for example) to avoid conflicts or if the port is protected.

<value-param>
   <name>data-min-port</name>
   <value>52000</value>
</value-param>
<value-param>
   <name>data-max-port</name>
   <value>53000</value>
</value-param>

These two parameters indicate the minimal and maximal values of the range of ports, used by the server. The usage of the additional data channel is required by the FTP - protocol, which is used to transfer the contents of files and the listing of catalogues. This range of ports should be free from listening by other server-programs.

<value-param>
   <name>system</name>

   <value>Windows_NT</value>
     or
   <value>UNIX Type: L8</value>
</value-param>

Types of formats of listing of catalogues which are supported.

<value-param>
   <name>client-side-encoding</name>
      
   <value>windows-1251</value>
     or
   <value>KOI8-R</value>
     
</value-param>

This parameter specifies the coding which is used for dialogue with the client.

<value-param>
   <name>def-folder-node-type</name>
   <value>nt:folder</value>
</value-param>

This parameter specifies the type of a node, when an FTP-folder is created.

<value-param>
   <name>def-file-node-type</name>
   <value>nt:file</value>
</value-param>

This parameter specifies the type of a node, when an FTP - file is created.

<value-param>
   <name>def-file-mime-type</name>                 
   <value>application/zip</value>
</value-param>

The mime type of a created file is chosen by using its file extention. In case, a server cannot find the corresponding mime type, this value is used.

<value-param>
   <name>cache-folder-name</name>
   <value>../temp/ftp_cache</value>
</value-param>

The Path of the cache folder.

<value-param>
   <name>upload-speed-limit</name>           
   <value>20480</value>
</value-param>

Restriction of the upload speed. It is measured in bytes.

<value-param>
   <name>download-speed-limit</name>
   <value>20480</value>          
</value-param>

Restriction of the download speed. It is measured in bytes.

<value-param>
   <name>timeout</name>
   <value>60</value>
</value-param>

Defines the value of a timeout.