https://github.com/erwanlt/sftpclientfactory
factory for auto reconnect SshClient
https://github.com/erwanlt/sftpclientfactory
autoreconnect java sftp-client
Last synced: about 1 year ago
JSON representation
factory for auto reconnect SshClient
- Host: GitHub
- URL: https://github.com/erwanlt/sftpclientfactory
- Owner: ErwanLT
- License: mit
- Created: 2023-10-26T08:51:25.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2023-10-27T09:52:53.000Z (over 2 years ago)
- Last Synced: 2025-04-14T12:08:16.245Z (about 1 year ago)
- Topics: autoreconnect, java, sftp-client
- Language: Java
- Homepage:
- Size: 24.4 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# SftpClientFactory
Une usine pour créer et gérer les clients SFTP en utilisant Apache Commons Pool 2.
## Description
La classe `SftpClientFactory` est conçue pour créer et gérer les clients SFTP en utilisant Apache Commons Pool 2. Elle crée des clients SFTP en utilisant la bibliothèque SSHJ et les met en pool pour une utilisation efficace.
## Table des matières
- [Installation](#installation)
- [Utilisation](#utilisation)
- [Exemples](#exemple)
- [Configuration](#configuration)
- [Tests](#tests)
- [Contribuer](#contribuer)
- [Licence](#licence)
## Installation
Pour utiliser cette usine, assurez-vous de suivre ces étapes :
1. Incluez cette classe dans votre projet.
2. Assurez-vous d'avoir les dépendances nécessaires, y compris Apache Commons Pool 2, SSHJ, et d'autres dépendances liées à votre projet.
## Utilisation
Pour utiliser la classe `SftpClientFactory` dans votre projet, suivez ces étapes :
1. Créez une instance de `SftpProperties` avec les informations de configuration SFTP.
2. Instanciez la classe `SftpClientFactory` en lui passant les `SftpProperties`.
3. Utilisez l'usine pour créer et gérer des clients SFTP.
## Exemple
```java
public static void main(String[] args) {
SftpProperties sftpProperties = new SftpProperties();
SftpClientFactory factory = new SftpClientFactory(sftpProperties);
SFTPClient sftpClient = factory.create();
// Utilisez le client SFTP pour télécharger ou téléverser des fichiers, etc.
factory.destroy();
}
```
## Configuration
Assurez-vous que votre projet est correctement configuré pour inclure Apache Commons Pool 2 et SSHJ. Vous devez également définir correctement les propriétés SFTP dans l'objet SftpProperties.
## Tests
Ce projet est livré avec des tests unitaires pour la classe ConnexionThread. Les tests sont écrits en utilisant JUnit, une bibliothèque de test Java populaire.
Pour exécuter les tests, assurez-vous d'avoir JUnit configuré dans votre projet. Ensuite, exécutez les tests à l'aide de votre environnement de développement ou de la ligne de commande.
## Contribuer
Si vous souhaitez contribuer à ce projet, suivez ces étapes :
1. Fork ce projet.
2. Créez une nouvelle branche avec votre nom de fonctionnalité ou correctif.
3. Effectuez les modifications ou ajoutez de nouvelles fonctionnalités.
4. Soumettez une demande d'extraction (Pull Request) vers la branche principale de ce projet.
## Licence
Ce projet est sous licence MIT. Consultez le fichier [LICENSE](LICENSE) pour plus de détails.