ENTDownloader
Gestionnaire de fichiers pour l'ENT de l'Université d'Auvergne
Développé par Kévin Subileau
Référence de la classe ENTDownloader
Classe principale de l'application, interface entre les classes externes et l'ENT. Plus de détails...
Fonctions membres publiques | |
boolean | login (String login, char[] password) throws java.io.IOException, ParseException |
Établit la connexion au serveur de l'ENT. | |
void | changeDirectory (String path) throws ENTUnauthenticatedUserException, ENTDirectoryNotFoundException, ENTInvalidFS_ElementTypeException, ParseException, IOException |
Change le répertoire courant. | |
boolean | getFile (String name, String destination) throws IOException |
Télécharge le fichier name. | |
boolean | getFile (String name) throws IOException |
Télécharge le fichier name. | |
int | getAllFiles (String destination) throws IOException |
Télécharge tous les fichiers contenus dans le dossier courant et ses sous dossiers. | |
int | getAllFiles (String destination, int maxdepth) throws IOException |
Télécharge tous les fichiers contenus dans le dossier courant et ses sous dossiers. | |
List< FS_Element > | getDirectoryContent () |
Retourne le contenu du répertoire courant. | |
String | getDirectoryName () |
Obtient le nom du répertoire courant. | |
int | getNbDossiers () |
Retourne le nombre de dossiers dans le dossier courant. | |
int | getNbFiles () |
Retourne le nombre de fichiers dans le dossier courant. | |
long | getFilesSize () |
Retourne la taille totale des fichiers dans le dossier courant en octets. | |
String | getDirectoryPath () |
Obtient le chemin absolu permettant d'atteindre le répertoire courant. | |
String | getUsername () |
Retourne le nom complet de l'utilisateur, ou null si ce dernier est inconnu. | |
int | getUsedSpace () |
Retourne l'espace disque utilisé sur le service de stockage en Mo, ou -1 si ce dernier est inconnu. | |
int | getCapacity () |
Retourne l'espace disque total sur le service de stockage en Mo, ou -1 si ce dernier est inconnu. | |
String | getLogin () |
Retourne le login utilisé pour la connexion, ou null si ce dernier est inconnu. | |
void | setProxy (String host, int port) |
Installe un proxy HTTP à utiliser pour la connexion à l'ENT. | |
void | setProxy (Proxy proxy) |
Installe un proxy HTTP à utiliser pour la connexion à l'ENT. | |
Proxy | getProxy () |
Retourne le proxy HTTP utilisé pour la connexion à l'ENT. | |
String | getProxyFile () |
Retourne le fichier PAC utilisé pour la configuration du proxy le cas échéant. | |
void | removeProxy () |
Supprime la configuration de proxy précédemment installé. | |
void | setProxy (String pacFile) throws Exception |
Installe un proxy HTTP à utiliser pour la connexion à l'ENT en utilisant un fichier PAC (Proxy auto-configuration). | |
Fonctions membres publiques statiques | |
static ENTDownloader | getInstance () |
Récupère l'instance unique de la classe ENTDownloader. |
Description détaillée
Classe principale de l'application, interface entre les classes externes et l'ENT.
Classe singleton : utilisez getInstance() pour obtenir l'instance de la classe.
Documentation des fonctions membres
void changeDirectory | ( | String | path | ) | throws ENTUnauthenticatedUserException, ENTDirectoryNotFoundException, ENTInvalidFS_ElementTypeException, ParseException, IOException |
Change le répertoire courant.
- Paramètres:
-
path Nom du dossier ou directive de parcours. Le dossier . est le dossier courant : appeler cette méthode avec ce paramètre ne change donc pas le dossier courant mais permet de rafraîchir son contenu. Le dossier .. est le dossier parent, il permet donc de remonter dans l'arborescence. Enfin, le dossier / est la racine du service de stockage de l'utilisateur.
- Exceptions:
-
ENTDirectoryNotFoundException Si le répertoire demandé n'existe pas dans le dossier courant ENTInvalidFS_ElementTypeException Si le nom d'un fichier a été passé en paramètre. ParseException En cas d'erreur d'analyse du contenu du dossier cible. ENTUnauthenticatedUserException Si l'utilisateur n'est pas authentifier lors de l'appel de la méthode IOException Si le service est indisponible.
int getAllFiles | ( | String | destination | ) | throws IOException |
Télécharge tous les fichiers contenus dans le dossier courant et ses sous dossiers.
Les fichiers et dossiers seront enregistrés sous le dossier destination, sous le même nom que celui sous lequel ils sont stockés sur l'ENT.
- Paramètres:
-
destination Dossier de destination des fichiers et dossiers téléchargés. Si null ou vide, ils seront enregistrés dans le répertoire courant.
- Exceptions:
-
ENTInvalidFS_ElementTypeException Lancée lorsque le paramètre destination désigne un fichier existant. IOException
- Voir également:
- ENTDownloader.getFile(String, String)
- Renvoie:
- Le nombre de fichiers téléchargés
int getAllFiles | ( | String | destination, |
int | maxdepth | ||
) | throws IOException |
Télécharge tous les fichiers contenus dans le dossier courant et ses sous dossiers.
Les fichiers et dossiers seront enregistrés sous le dossier destination, sous le même nom que celui sous lequel ils sont stockés sur l'ENT.
- Paramètres:
-
destination Dossier de destination des fichiers et dossiers téléchargés. Si null ou vide, ils seront enregistrés dans le répertoire courant. maxdepth Profondeur maximale de téléchargement. 0 (zéro) signifie que la méthode ne va télécharger que les fichiers du dossier courant, sans descendre dans les sous-dossiers. Une valeur négative signifie aucune limite.
- Exceptions:
-
ENTInvalidFS_ElementTypeException Lancée lorsque le paramètre destination désigne un fichier existant. IOException
- Voir également:
- ENTDownloader.getFile(String, String)
- Renvoie:
- Le nombre de fichiers téléchargés
int getCapacity | ( | ) |
Retourne l'espace disque total sur le service de stockage en Mo, ou -1 si ce dernier est inconnu.
List<FS_Element> getDirectoryContent | ( | ) |
Retourne le contenu du répertoire courant.
String getDirectoryName | ( | ) |
Obtient le nom du répertoire courant.
String getDirectoryPath | ( | ) |
Obtient le chemin absolu permettant d'atteindre le répertoire courant.
boolean getFile | ( | String | name, |
String | destination | ||
) | throws IOException |
Télécharge le fichier name.
Le fichier sera enregistré sous le dossier et le nom spécifié dans le paramètre destination, ou sous le même nom que celui sous lequel il est stocké sur l'ENT si le nouveau nom n'est pas indiqué dans destination.
Exemples pour un fichier "tp13.pdf":
- Si le chemin de destination est "/home/sasa/tps/tpNumero13.pdf", le fichier sera stocké sous "/home/sasa/tps/tpNumero13.pdf";
- Si le chemin de destination est "/home/sasa/bonjour/", le fichier sera stocké sous "/home/sasa/bonjour/tp13.pdf";
- Si le chemin de destination est "tp13.pdf", le fichier sera stocké sous System.getProperty("user.dir") + "tp13.pdf";
- Si le chemin de destination est vide ou null, le fichier sera stocké sous System.getProperty("user.dir") + nom utilisé sous l'ENT;
- Si le chemin de destination est "~/bonjour.pdf", le fichier sera stocké sous System.getProperty("user.home") + "bonjour.pdf;
- Paramètres:
-
name Nom du fichier à télécharger destination Chemin de destination du fichier
- Exceptions:
-
IOException
- Voir également:
- Misc.tildeToHome(String)
- Browser.downloadFile(String)
- Renvoie:
True
si le téléchargement du fichier s'est terminé normalement,false
sinon.
boolean getFile | ( | String | name | ) | throws IOException |
Télécharge le fichier name.
Le fichier sera enregistré dans le dossier local courant (généralement le dossier de l'application), sous le même nom que celui sous lequel il est stocké sur l'ENT.
- Paramètres:
-
name Le nom du fichier à télécharger.
- Exceptions:
-
IOException
- Renvoie:
True
si le téléchargement du fichier s'est terminé normalement,false
sinon.
long getFilesSize | ( | ) |
Retourne la taille totale des fichiers dans le dossier courant en octets.
static ENTDownloader getInstance | ( | ) | [static] |
Récupère l'instance unique de la classe ENTDownloader.
Remarque : le constructeur est rendu inaccessible
String getLogin | ( | ) |
Retourne le login utilisé pour la connexion, ou null si ce dernier est inconnu.
int getNbDossiers | ( | ) |
Retourne le nombre de dossiers dans le dossier courant.
int getNbFiles | ( | ) |
Retourne le nombre de fichiers dans le dossier courant.
Proxy getProxy | ( | ) |
Retourne le proxy HTTP utilisé pour la connexion à l'ENT.
- Renvoie:
- Le proxy HTTP utilisé pour la connexion à l'ENT.
String getProxyFile | ( | ) |
Retourne le fichier PAC utilisé pour la configuration du proxy le cas échéant.
Si aucun proxy n'est utilisé ou si la configuration ne provient pas d'un fichier PAC, cette méthode retourne null
.
- Renvoie:
- Le fichier PAC utilisé pour la configuration du proxy.
int getUsedSpace | ( | ) |
Retourne l'espace disque utilisé sur le service de stockage en Mo, ou -1 si ce dernier est inconnu.
String getUsername | ( | ) |
Retourne le nom complet de l'utilisateur, ou null si ce dernier est inconnu.
boolean login | ( | String | login, |
char[] | password | ||
) | throws java.io.IOException, ParseException |
Établit la connexion au serveur de l'ENT.
- Paramètres:
-
login Le nom d'utilisatateur pour la connexion. password Mot de passe de connexion.
- Renvoie:
- True en cas de réussite, ou false si l'authentification a échoué.
- Exceptions:
-
ParseException Impossible d'obtenir les informations de session.
void removeProxy | ( | ) |
Supprime la configuration de proxy précédemment installé.
void setProxy | ( | Proxy | proxy | ) |
Installe un proxy HTTP à utiliser pour la connexion à l'ENT.
- Paramètres:
-
proxy L'instance de java.net.Proxy à utiliser.
- Voir également:
- java.net.Proxy
void setProxy | ( | String | host, |
int | port | ||
) |
Installe un proxy HTTP à utiliser pour la connexion à l'ENT.
- Paramètres:
-
host Le nom d'hôte ou l'adresse du proxy. port Le port du proxy.
void setProxy | ( | String | pacFile | ) | throws Exception |
Installe un proxy HTTP à utiliser pour la connexion à l'ENT en utilisant un fichier PAC (Proxy auto-configuration).
- Paramètres:
-
pacFile Emplacement du fichier PAC
- Exceptions:
-
URISyntaxException MalformedURLException IOException
- Voir également:
- PAC File on Wikipedia
La documentation de cette classe a été générée à partir du fichier suivant :