La classe java.net.URLStreamHandler

Sommaire du document

• java.lang.Object
  • java.net.URLStreamHandler

La classe abstraite URLStreamHandler permet la gestion d'un protocole spécifique. Nous appelerons cependant rarement directement ses méthodes, car elles sont appelées par d'autres méthodes des classes URL et URLConnection. C'est en surchargeant (“overriding”) les méthodes d'URLStreamHandler que nous pouvons permettre à la classe URL d'utiliser de nouveaux protocoles.

La classe URLStreamHandler définit 4 méthodes d'accès qui peuvent être surchargées par les sous-classes, mais seule la méthode openConnection doit obligatoirement être surchargée car elle est abstraite et ne fournit donc pas d'implémentation par défaut.

Méthode openConnection

protected abstract URLConnection openConnection(URL u) throws IOException

La plus importante responsabilité de URLStreamHandler est de créer un objet URLConnection approprié à l'URL par une surcharge de la méthode abstraite openConnection.

La méthode openConnection prend en paramètre une URL. De cette URL, elle peut extraire le protocole, et retourner un objet URLConnection. L'objet URLConnection peut être utilisé pour créer les flux d'entrée et de sortie pour accéder à la ressource pointée par l'URL.

import java.io.IOException;
import java.net.URL;
import java.net.URLConnection;
import java.net.URLStreamHandler;
 
public class Handler extends URLStreamHandler{
 
	private static final int DEFAULT_PORT = 8241;
 
	protected URLConnection openConnection(URL u) throws IOException {
		if("prout".equals(u.getProtocol())){
			return new ProutURLConnection(u);
		}
		return null;
	}
 
	public int getDefaultPort() {
		return DEFAULT_PORT;
	}
}

Nous pouvons aussi utiliser une classe qui implémente l'interface URLStreamHandlerFactory

/**
 * This BrolURLStreamHandlerFactory allows us to create URL 
 * objects that will use the sun.net.www protocol handlers 
 * for known schemes. If the scheme is not one of those 
 * within the JDK, we create an instance of our BrolHandler  
 * and return that. If this factory returned null instead, 
 * a MalformedURLException would be thrown for unknown
 * schemes.
 */
import java.net.URLStreamHandler;
import java.net.URLStreamHandlerFactory;
 
public class BrolURLStreamHandlerFactory implements URLStreamHandlerFactory {
 
	public URLStreamHandler createURLStreamHandler(String protocol) {
		if (protocol.equalsIgnoreCase("ftp")) {
			return new sun.net.www.protocol.ftp.Handler();
		}
		if (protocol.equalsIgnoreCase("gopher")) {
			return new sun.net.www.protocol.gopher.Handler();
		}
		if (protocol.equalsIgnoreCase("file")) {
			return new sun.net.www.protocol.file.Handler();
		}
		if (protocol.equalsIgnoreCase("mailto")) {
			return new sun.net.www.protocol.mailto.Handler();
		}
		if (protocol.equalsIgnoreCase("prout")) {
			return new sun.net.www.protocol.prout.Handler();
		}
		return new sun.net.www.protocol.brol.Handler();
	}
}

package sun.net.www.protocol.brol;
 
import java.io.IOException;
import java.net.URL;
import java.net.URLConnection;
import java.net.URLStreamHandler;
 
/**
 * This is a null protocol handler. This handler will allow
 * us to create a URL object for this protocol, but we won't
 * be able to retrieve any data through it.
 */
public class Handler extends URLStreamHandler{
 
  /**
   * This method will only return null. Data cannot be 
   * obtained from this handler.
   * @param u The URL to obtain data from.
   * @return A null URLConnection.
   */
  protected URLConnection openConnection(URL u) throws IOException {
		return null;
	}
}

Méthode parseURL

protected void parseURL(URL u, String spec, int start, int limit)

Une autre responsabilité importante de la classe URLStreamHandler est de diviser la chaîne de caractères représentant l'URL en différentes parties et d'utiliser ces parties pour affecter les valeurs aux différents champs de l'objet URL. La méthode parseURL analyse et divise l'URL puis appelle enfin  la méthode setURL pour assigner les valeurs aux différents champs de l'URL.

La méthode parseURL que Java fournit présume que l'URL ressemble plus ou moins à une URL HTTP :

protocole://www.domaine.com:port/chemin/ressource.ext

Ce comportement fonctionne pour des URL de type FTP ou Gopher, mais pas pour mailto ou news, et encore moins dans le cas d'un protocole que nous créons nous-même, et qui définit sa propre structure d'URL.
Si nous notre « gestionnaire de protocole » (en anglais, “protocol handler”) utilise des URL de type HTTP, nous ne sommes pas obligés de surcharger la methode parseURL. Cependant, si nous devons surcharger la méthode parseURL, nous devons aussi absolument surcharger la méthode toExternalForm qui place les parties de l'URL dans une chaîne de caractères.

public void parseURL(URL u, String spec, int start, int limit){
		String protocol = u.getProtocol();
		int port = u.getPort();
		String host, file, userInfo, query, ref, authority;
		host = "";
		file = "";
		authority = "";
 
		if(start<limit){
			String address = spec.substring(start,limit);
			int atSign       = address.indexOf('@');
			int questionMark = address.indexOf('?');
			int hostEnd = questionMark <=0 ? questionMark : address.length();
			if(atSign >= 0){
				host     = address.substring(atSign+1, hostEnd);
				userInfo = address.substring(0, atSign);
			}
			if(questionMark >= 0 && questionMark < atSign){
				query = address.substring(questionMark+1);
			}
			if(userInfo != null){
				authority = userInfo + '@';
			}
			authority += host;
			if(port < 0){
				authority += ':' + port;
			}
			setURL(u, protocol, host, port, authority, userInfo, file, query, ref);
		}
	}

Remarque

La requête est extraite de l'URL, mais nous devons ensuite veiller à la décoder.N'oublions pas non plus qu'au moment de coder l'URL, nous devons veiller à préserver les caractères spéciaux (par exemple, le point d'interrogation qui marque le début des paramètres, le signe & qui permet de séparer les paramètres, etc.).

Notes

1. ↑^{a,b,c,d,e,f,g,h,i,j,k,l} Uniform Resource Locator : correspond à « localisateur uniforme de ressource” en français
   
   
2. ↑^{a,b,c,d,e,f,g,h,i,j,k,l} URL : “Uniform Resource Locator” (en français, « localisateur uniforme de ressource »)
   
   
3. ↑^a,b Hypertext Transfer Protocol : correspond à « protocole de transfert hypertexte” en français
   
   
4. ↑^a,b HTTP : “Hypertext Transfer Protocol” (en français, « protocole de transfert hypertexte »)
   
   
5. ↑ File Transfer Protocol : correspond à « protocole de transfert de fichiers” en français
   
   
6. ↑ FTP : “File Transfer Protocol” (en français, « protocole de transfert de fichiers »)
   
   
7. ↑ gestionnaire de protocole : correspond à “protocol handler » en anglais
   
   

Structure du document