ENTDownloader
Gestionnaire de fichiers pour l'ENT de l'Université d'Auvergne
Développé par Kévin Subileau
Référence de la classe Browser
Gère les connexions HTTP et permet des utilisations avancées tels que l'obtention des sources HTML et le téléchargement de fichiers. Plus de détails...
Types publics | |
enum | Method { GET, POST } |
Fonctions membres publiques | |
Browser () | |
Constructeur par défaut de la classe Browser. | |
Browser (String url) | |
Constructeur de la classe Browser. | |
void | setParam (String name, String value) |
Ajoute un argument à la requête. | |
void | clearParam () |
Supprime tous les arguments de requête précédemment définis. | |
String | getPage () throws IOException |
Effectue la requête précédemment configuré et retourne le texte renvoyé par le serveur (code HTML par exemple). | |
void | downloadFile (String destinationPath) throws FileNotFoundException |
Télécharge le fichier défini par setUrl(String) et l'enregistre à l'emplacement désigné par destinationPath . | |
String | getUrl () |
Retourne l'url courante de l'objet. | |
void | setUrl (String url) |
Définit l'url cible de la requête. | |
Method | getMethod () |
Retourne la méthode HTTP actuellement utilisée. | |
void | setMethod (Method method) |
Configure la méthode HTTP à utiliser (POST ou GET). | |
boolean | isFollowRedirects () |
Retourne l'état actuel du suivi des redirections. | |
void | setFollowRedirects (boolean followRedirects) |
Active ou désactive le suivi des redirections HTTP (code 3xx) | |
String | getCookieValueByName (String name) |
Retourne la valeur du champ de cookie portant le nom fieldname , ou null si ce champ n'existe pas. | |
HttpCookie | getCookieByName (String name) |
Retourne le cookie portant le nom indiqué. | |
void | setCookieField (String name, String value) |
Ajoute ou redéfinit la valeur du champ de cookie spécifié | |
void | delCookie () |
Supprime tous les cookies actuellement défini. | |
void | delCookie (String name) |
Supprime le champ de cookie spécifié | |
void | setCookies (String cookie) |
Définit les cookies envoyés dans les requêtes suivantes. | |
int | getResponseCode () |
Obtient le code de statut du message de réponse HTTP. | |
Map< String, List< String > > | getHeaderFields () |
Retourne une Map contenant l'ensemble des entêtes de la réponse HTTP, ou null si aucune requête n'a été effectué. | |
String | getHeaderField (String name) |
Retourne la valeur du champ d'entête portant le nom désigné, ou null s'il n'y a pas ce champ dans la réponse. | |
void | setHttpProxy (String host, int port) |
Installe un proxy HTTP à utiliser pour la connexion à Internet. | |
void | setHttpProxy (Proxy proxy) |
Installe un proxy HTTP à utiliser pour la connexion à Internet. | |
Proxy | getProxy () |
Retourne le proxy HTTP utilisé pour la connexion à Internet. | |
void | removeHttpProxy () |
Supprime la configuration de proxy précédemment installé. | |
Fonctions membres protégées | |
void | encodeParam () throws UnsupportedEncodingException |
Description détaillée
Gère les connexions HTTP et permet des utilisations avancées tels que l'obtention des sources HTML et le téléchargement de fichiers.
Documentation des énumérations membres
enum Method |
Documentation des constructeurs et destructeur
Documentation des fonctions membres
void clearParam | ( | ) |
Supprime tous les arguments de requête précédemment définis.
void delCookie | ( | String | name | ) |
Supprime le champ de cookie spécifié
- Paramètres:
-
name Le champ à supprimer
void delCookie | ( | ) |
Supprime tous les cookies actuellement défini.
void downloadFile | ( | String | destinationPath | ) | throws FileNotFoundException |
Télécharge le fichier défini par setUrl(String) et l'enregistre à l'emplacement désigné par destinationPath
.
- Paramètres:
-
destinationPath Le chemin où le fichier sera enregistrer
- Exceptions:
-
FileNotFoundException Voir le constructeur de java.io.FileOutputStream
void encodeParam | ( | ) | throws UnsupportedEncodingException [protected] |
HttpCookie getCookieByName | ( | String | name | ) |
Retourne le cookie portant le nom indiqué.
- Paramètres:
-
name Le nom du cookie recherché.
- Renvoie:
- Le cookie portant le nom indiqué, ou null si ce dernier n'existe pas.
String getCookieValueByName | ( | String | name | ) |
Retourne la valeur du champ de cookie portant le nom fieldname
, ou null si ce champ n'existe pas.
- Paramètres:
-
name Le nom du champ de cookie souhaité
- Renvoie:
- La valeur du champ de cookie demandé, ou null si le champ n'est pas défini.
String getHeaderField | ( | String | name | ) |
Retourne la valeur du champ d'entête portant le nom désigné, ou null s'il n'y a pas ce champ dans la réponse.
- Exceptions:
-
IllegalStateException Si aucune requête n'a été effectué.
- Voir également:
- URLConnection.getHeaderField(String)
Map<String, List<String> > getHeaderFields | ( | ) |
Retourne une Map contenant l'ensemble des entêtes de la réponse HTTP, ou null si aucune requête n'a été effectué.
- Voir également:
- URLConnection.getHeaderFields()
Method getMethod | ( | ) |
Retourne la méthode HTTP actuellement utilisée.
String getPage | ( | ) | throws IOException |
Effectue la requête précédemment configuré et retourne le texte renvoyé par le serveur (code HTML par exemple).
- Renvoie:
- Le texte renvoyé par le serveur (code HTML ou XML par exemple).
- Exceptions:
-
IOException La connexion a échoué.
Proxy getProxy | ( | ) |
Retourne le proxy HTTP utilisé pour la connexion à Internet.
- Renvoie:
- Le proxy HTTP utilisé pour la connexion à Internet.
int getResponseCode | ( | ) |
Obtient le code de statut du message de réponse HTTP.
- Renvoie:
- Le code de statut HTTP, ou -1 si aucun code ne peut être discerné de la réponse (la réponse n'est pas valide) ou si aucune requête n'a été effectué.
- Voir également:
- HttpURLConnection.getResponseCode()
String getUrl | ( | ) |
Retourne l'url courante de l'objet.
boolean isFollowRedirects | ( | ) |
Retourne l'état actuel du suivi des redirections.
- Renvoie:
- True si le suivi des redirections est activé, false sinon.
void removeHttpProxy | ( | ) |
Supprime la configuration de proxy précédemment installé.
void setCookieField | ( | String | name, |
String | value | ||
) |
Ajoute ou redéfinit la valeur du champ de cookie spécifié
- Paramètres:
-
name Le nom du champ de cookie à définir value La valeur du champ de cookie fieldname.
void setCookies | ( | String | cookie | ) |
Définit les cookies envoyés dans les requêtes suivantes.
Les précédents cookies sont écrasés
- Paramètres:
-
cookie Cookies à définir
void setFollowRedirects | ( | boolean | followRedirects | ) |
Active ou désactive le suivi des redirections HTTP (code 3xx)
- Paramètres:
-
followRedirects Nouvelle valeur
void setHttpProxy | ( | String | host, |
int | port | ||
) |
Installe un proxy HTTP à utiliser pour la connexion à Internet.
- Paramètres:
-
host Le nom d'hôte ou l'adresse du proxy. port Le port du proxy.
void setHttpProxy | ( | Proxy | proxy | ) |
Installe un proxy HTTP à utiliser pour la connexion à Internet.
- Paramètres:
-
proxy L'instance de java.net.Proxy à utiliser.
- Voir également:
- java.net.Proxy
void setMethod | ( | Method | method | ) |
Configure la méthode HTTP à utiliser (POST ou GET).
- Paramètres:
-
method Méthode HTTP à utiliser.
void setParam | ( | String | name, |
String | value | ||
) |
Ajoute un argument à la requête.
Si l'argument a déjà été défini, l'ancienne valeur sera écrasé.
- Paramètres:
-
name Nom du champ de l'argument. value Valeur de l'argument.
void setUrl | ( | String | url | ) |
Définit l'url cible de la requête.
- Paramètres:
-
url URL à définir
La documentation de cette classe a été générée à partir du fichier suivant :