Difference between revisions of "Home Library FTPClient"
(→FTPClient) |
(→Usage) |
||
| Line 50: | Line 50: | ||
To check the correct behavior of all features: | To check the correct behavior of all features: | ||
<source lang="java"> | <source lang="java"> | ||
| − | |||
client.test(); | client.test(); | ||
</source> | </source> | ||
| Line 65: | Line 64: | ||
<source lang="java"> | <source lang="java"> | ||
| − | |||
client.currentDirectory(); | client.currentDirectory(); | ||
</source> | </source> | ||
| Line 83: | Line 81: | ||
<source lang="java"> | <source lang="java"> | ||
| − | |||
String mySubFolder = .. | String mySubFolder = .. | ||
client.changeDirectory(mySubFolder); | client.changeDirectory(mySubFolder); | ||
| Line 99: | Line 96: | ||
<source lang="java"> | <source lang="java"> | ||
| − | |||
client.changeDirectoryUp(); | client.changeDirectoryUp(); | ||
</source> | </source> | ||
| Line 118: | Line 114: | ||
<source lang="java"> | <source lang="java"> | ||
| − | |||
client.currentDirectory(); | client.currentDirectory(); | ||
</source> | </source> | ||
| Line 137: | Line 132: | ||
<source lang="java"> | <source lang="java"> | ||
| − | |||
File myFile = .. | File myFile = .. | ||
client.upload(myFile, myFile.getName(), "my new file"); | client.upload(myFile, myFile.getName(), "my new file"); | ||
| Line 152: | Line 146: | ||
<source lang="java"> | <source lang="java"> | ||
| − | |||
FTPFile[] myFiles = client.list(); | FTPFile[] myFiles = client.list(); | ||
</source> | </source> | ||
| Line 169: | Line 162: | ||
<source lang="java"> | <source lang="java"> | ||
| − | |||
String myFilename = .. | String myFilename = .. | ||
client.deleteFile(myFilename); | client.deleteFile(myFilename); | ||
| Line 190: | Line 182: | ||
String myDir = .. | String myDir = .. | ||
client.deleteDirectory(myDir); | client.deleteDirectory(myDir); | ||
| + | </source> | ||
| + | |||
| + | == FTPFile == | ||
| + | |||
| + | === 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"> | ||
| + | FTPClient client = .. | ||
| + | client.currentDirectory(); | ||
</source> | </source> | ||
Revision as of 12:52, 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 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 a jar-with-depencencies, you only need a Java 7 JDK.
Download the latest release from here:
FTPClient
A FTPClient is created with:
FTPClient client = new FTPClient();
Run the test
To check the correct behavior of all features:
client.test();
Current Directory
To know the current working directory:
public String currentDirectory()
Example:
client.currentDirectory();
Change directory
To changes the current working directory.
void changeDirectory(String path)
Where:
- path: the path to the new working directory.
Example:
String mySubFolder = .. client.changeDirectory(mySubFolder);
Change directory up
To changes the current working directory to the parent one.
void changeDirectoryUp()
Example:
client.changeDirectoryUp();
Create a directory
To create a new remote directory in the current working one.
void createDirectory(String directoryName, String description)
Where:
- directoryName: the name of the new folder.
- description: the description for the new directory.
Example:
client.currentDirectory();
Upload a file
To upload a file, if it does not already exist:
void upload(File file, String name, String description)
Where:
- file: the file to upload.
- name: a name for the file
- description: a description for the file.
Example:
File myFile = .. client.upload(myFile, myFile.getName(), "my new file");
List a directory
To list the content of the current directory:
FTPFile[] list()
Example:
FTPFile[] myFiles = client.list();
Remove files
To remove files:
void deleteFile(String path)
Where:
- path: the path of the file to remove.
Example:
String myFilename = .. client.deleteFile(myFilename);
Remove directories
To remove directories:
void deleteDirectory(String path)
Where:
- path: the path of the directory to remove.
Example:
FTPClient client = .. String myDir = .. client.deleteDirectory(myDir);
FTPFile
Create a directory
To create a new remote directory in the current working one.
void createDirectory(String directoryName, String description)
Where:
- directoryName: the name of the new folder.
- description: the description for the new directory.
Example:
FTPClient client = .. client.currentDirectory();
