View source for Home Library FTPClient

{| align="right"
||__TOC__
|}
= Introduction =

Home Library FTPClient is a Java library providing a simple interface to Home Library WebApp.

This library has following features:
* '''Current Directory''': returns the pathname of the current working directory.
* '''Change Directory''': to changes the current working directory.
* '''Change Directory Up''': to changes the current working directory to the parent one.
* '''Create Directory''': to create a directory in the root or in a subfolder.
* '''List Directory''': to list the content of a directory.
* '''Upload file''': to upload a file in a directory.
* '''Remove files and folders''': to remove a file or a directory (including subdirectories).
* '''Test''': a simple test to check the correct behavior of the features above.

The following sections will discuss each of these commands in turn, and discuss how to use them with Home Library FTPClient.

= Configuration File =

Home Library CLI is equipped with a simple configuration file to set the parameters and initial settings.

The fields are:
* '''URL_REPOSITORY''': the URL of Home Library WebApp.
* '''USERNAME''': username to connect to Home Library WebApp.
* '''PASSWORD''': password to connect to Home Library WebApp.
* '''LOGIN''': the portal login of the user who is using the library.
* '''ROOT_PATH ''': the ROOT of the VRE folder where the files and directory will be created.

The Configuration File cannot be modified by the final user, but it allows to use the CLI in different context.

= Usage =
== Prerequisites ==
Home Library FTPClient is Java library, you only need a Java 7 JDK. 

Download the jar to your local repository from here: 

[http://maven.research-infrastructures.eu:8081/nexus/content/repositories/gcube-snapshots/org/gcube/common/home-library-ftpclient/ home-library-ftpclient]

Example:
/1.0.0-SNAPSHOT/home-library-ftpclient-1.0.0-20160503.135144-1.jar

Otherwise you can user the Maven dependency:
<source lang="java">
		<dependency>
			<groupId>org.gcube.common</groupId>
			<artifactId>home-library-model</artifactId>
			<version>[1.0.0-SNAPSHOT,2.0.0-SNAPSHOT)</version>
		</dependency>

</source>

== FTPClient ==

A FTPClient is created with:

<source lang="java">
FTPClient client = new FTPClient();
</source>

=== Run the test ===
To check the correct behavior of all features:
<source lang="java">
void test()
</source>

Example:
<source lang="java">
client.test();
</source>

=== Current Directory ===
To know the current working directory:

<source lang="java">
public String currentDirectory()
</source>

Example:

<source lang="java">
client.currentDirectory();
</source>

=== Change directory ===

To changes the current working directory.
<source lang="java">
void changeDirectory(String path)
</source>

Where:
* '''path''': the path to the new working directory.


Example:

<source lang="java">
String mySubFolder = ..
client.changeDirectory(mySubFolder);
</source>

=== Change directory up ===

To changes the current working directory to the parent one.
<source lang="java">
void changeDirectoryUp()
</source>

Example:

<source lang="java">
client.changeDirectoryUp();
</source>

=== Create a directory ===

To create a new remote directory in the current working one.
<source lang="java">
void createDirectory(String directoryName, String description)
</source>

Where:
* '''directoryName''': the name of the new folder.
* '''description''': the description for the new directory.


Example:

<source lang="java">
client.currentDirectory();
</source>

=== Upload a file ===
To upload a file, if it does not already exist:
<source lang="java">
void upload(File file, String name, String description)
</source>

Where:
* '''file''': the file to upload.
* '''name''': a name for the file
* '''description''': a description for the file.


Example:

<source lang="java">
File myFile = ..
client.upload(myFile, myFile.getName(), "my new file");
</source>

=== List a directory ===
To list the content of the current directory:
<source lang="java">
FTPFile[] list()
</source>

Example:

<source lang="java">
FTPFile[] myFiles = client.list();
</source>

FTPFile represents the files in a remote FTP directory, as described in [[#FTPFile | FTPFile]].

=== Remove files ===
To remove files:
<source lang="java">
void deleteFile(String path)
</source>

Where:
* '''path''': the path of the file to remove.


Example:

<source lang="java">
String myFilename = ..
client.deleteFile(myFilename);
</source>

=== Remove directories ===
To remove directories:
<source lang="java">
void deleteDirectory(String path)
</source>

Where:
* '''path''': the path of the directory to remove.


Example:

<source lang="java">
FTPClient client = ..
String myDir = ..
client.deleteDirectory(myDir);
</source>

== FTPFile ==

A FTPFile represents the files in a remote FTP directory.

=== Get Path ===

To get the path of the current file or folder:
<source lang="java">
String getPath()
</source>

Example:

<source lang="java">
FTPFile file = ..
file.getPath();
</source>

=== Get Name ===

To get the name of the current file or folder
<source lang="java">
String getName()
</source>

Example:

<source lang="java">
FTPFile file = ..
file.getName();
</source>

=== Is Folder ===

To know if the current file is a folder:
<source lang="java">
Boolean isFolder()
</source>

Example:

<source lang="java">
FTPFile file = ..
file.isFolder();
</source>