Difference between revisions of "Home Library FTPClient"
From Gcube Wiki
(→Usage) |
(→Usage) |
||
| Line 49: | Line 49: | ||
To check the correct behavior of all features: | To check the correct behavior of all features: | ||
<source lang="java"> | <source lang="java"> | ||
| + | FTPClient client = .. | ||
client.test(); | client.test(); | ||
</source> | </source> | ||
| Line 61: | Line 62: | ||
=== Example === | === Example === | ||
<source lang="java"> | <source lang="java"> | ||
| + | FTPClient client = .. | ||
client.currentDirectory(); | client.currentDirectory(); | ||
</source> | </source> | ||
| Line 77: | Line 79: | ||
=== Example === | === Example === | ||
<source lang="java"> | <source lang="java"> | ||
| + | FTPClient client = .. | ||
client.currentDirectory(); | client.currentDirectory(); | ||
</source> | </source> | ||
| Line 93: | Line 96: | ||
=== Example === | === Example === | ||
<source lang="java"> | <source lang="java"> | ||
| + | FTPClient client = .. | ||
File myFile = .. | File myFile = .. | ||
client.upload(myFile, myFile.getName(), "my new file"); | client.upload(myFile, myFile.getName(), "my new file"); | ||
| Line 98: | Line 102: | ||
== List a directory == | == List a directory == | ||
| − | To list the content of | + | To list the content of the current directory. |
| − | <source lang=" | + | <source lang="java"> |
| − | + | FTPFile[] list() | |
</source> | </source> | ||
| − | |||
| − | |||
| − | |||
=== Example === | === Example === | ||
| − | <source lang=" | + | <source lang="java"> |
| − | + | FTPClient client = .. | |
| − | + | FTPFile[] myFiles = client.list(); | |
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
</source> | </source> | ||
| − | == Remove files | + | == Remove files == |
| − | To remove files | + | To remove files: |
| − | <source lang=" | + | <source lang="java"> |
| − | + | void deleteFile(String path) | |
</source> | </source> | ||
| − | + | Arguments: | |
| − | * ''' | + | * '''path''': the path of file to remove. |
=== Example === | === Example === | ||
| − | + | <source lang="java"> | |
| − | <source lang=" | + | FTPClient client = .. |
| − | + | String myFilename = .. | |
| + | client.deleteFile(myFilename); | ||
| + | </source> | ||
| − | + | == Remove directories == | |
| − | + | To remove directories: | |
| − | + | <source lang="java"> | |
| − | + | void deleteDirectory(String path) | |
</source> | </source> | ||
| − | + | Arguments: | |
| − | + | * '''path''': the path of directory to remove. | |
| − | + | ||
| − | + | === Example === | |
| − | + | ||
| − | + | <source lang="java"> | |
| − | + | FTPClient client = .. | |
| + | String myDir = .. | ||
| + | client.deleteDirectory(myDir); | ||
</source> | </source> | ||
Revision as of 12:32, 3 May 2016
Contents |
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 create a directory in the root or in a subfolder.
- 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 a jar-with-depencencies, you only need a Java 7 JDK.
Download the latest release from here:
Start
A FTPClient is created with:
FTPClient client = new FTPClient();
Run the test
To check the correct behavior of all features:
FTPClient client = .. client.test();
Current Directory
To know the current working directory:
public String currentDirectory()
Example
FTPClient client = .. client.currentDirectory();
Create a directory
To create a new remote directory in the current working one.
void createDirectory(String directoryName, String description)
Arguments:
- directoryName: the name of the new folder.
- description: the description for the new directory.
Example
FTPClient client = .. client.currentDirectory();
Upload a file
To upload a file, if it does not already exist.
void upload(File file, String name, String description)
Mandatory arguments:
- file: the file to upload.
- name: a name for the file
- description: a description for the file.
Example
FTPClient client = .. File myFile = .. client.upload(myFile, myFile.getName(), "my new file");
List a directory
To list the content of the current directory.
FTPFile[] list()
Example
FTPClient client = .. FTPFile[] myFiles = client.list();
Remove files
To remove files:
void deleteFile(String path)
Arguments:
- path: the path of file to remove.
Example
FTPClient client = .. String myFilename = .. client.deleteFile(myFilename);
Remove directories
To remove directories:
void deleteDirectory(String path)
Arguments:
- path: the path of directory to remove.
Example
FTPClient client = .. String myDir = .. client.deleteDirectory(myDir);
