From 6a15d30b22f278b793baeebec6f02facc5baa278 Mon Sep 17 00:00:00 2001 From: Andrew John Hughes Date: Fri, 22 Apr 2005 05:45:02 +0000 Subject: [PATCH] Naming.java: Added class documentation. 2005-04-22 Andrew John Hughes * java/rmi/Naming.java: Added class documentation. (lookup(String)): Call parseURL and getName. (bind(String,java.rmi.Remote)): Likewise. (unbind(String)): Likewise. (rebind(String, java.rmi.Remote)): Likewise. (list(String)): Call parseURL. (parseURL(String)): New method to handle parsing and defaults. (getName(java.net.URL)): New method to handle finding the service name. From-SVN: r98542 --- libjava/ChangeLog | 12 ++++ libjava/java/rmi/Naming.java | 134 +++++++++++++++++++++++++++++++------------ 2 files changed, 110 insertions(+), 36 deletions(-) diff --git a/libjava/ChangeLog b/libjava/ChangeLog index 5712644..230fa67 100644 --- a/libjava/ChangeLog +++ b/libjava/ChangeLog @@ -1,3 +1,15 @@ +2005-04-22 Andrew John Hughes + + * java/rmi/Naming.java: + Added class documentation. + (lookup(String)): Call parseURL and getName. + (bind(String,java.rmi.Remote)): Likewise. + (unbind(String)): Likewise. + (rebind(String, java.rmi.Remote)): Likewise. + (list(String)): Call parseURL. + (parseURL(String)): New method to handle parsing and defaults. + (getName(java.net.URL)): New method to handle finding the service name. + 2005-04-21 Tom Tromey * java/lang/natClass.cc (initializeClass): Link class. diff --git a/libjava/java/rmi/Naming.java b/libjava/java/rmi/Naming.java index 4df9045..dbf687b 100644 --- a/libjava/java/rmi/Naming.java +++ b/libjava/java/rmi/Naming.java @@ -39,11 +39,45 @@ exception statement from your version. */ package java.rmi; import java.net.MalformedURLException; +import java.net.URI; +import java.net.URISyntaxException; import java.net.URL; import java.rmi.registry.LocateRegistry; import java.rmi.registry.Registry; +/** + *

+ * The Naming class handles interactions with RMI registries. + * Each method takes a URL in String form, which points to + * the RMI registry. The scheme of the URL is irrelevant. The relevant + * part is: + *

+ *

+ * //host:port/name + *

+ *

+ * which tells the method how to locate and access the registry. The host + * and port are both optional, and default to `localhost' and the standard + * RMI registry port (1099) respectively. The name is simply a string + * used to refer to a particular service hosted by the registry. The + * registry does not attempt to interpret this further. + *

+ *

+ * RMI services are registered using one of these names, and the same name + * is later used by the client to lookup the service and access its methods. + * Registries can be shared by multiple services, or a service can create + * its own registry using createRegistry(). + *

+ * + * @author Original author unknown. + * @author Ingo Proetel (proetel@aicas.com) + * @author Guilhem Lavaux (guilhem@kaffe.org) + * @author Jeroen Frijters (jeroen@frijters.net) + * @author Andrew John Hughes (gnu_andrew@member.fsf.org) + * @since 1.1 + */ public final class Naming { + /** * This class isn't intended to be instantiated. */ @@ -66,17 +100,9 @@ public final class Naming { * @throws RemoteException */ public static Remote lookup(String name) throws NotBoundException, MalformedURLException, RemoteException { - // hack to accept "rmi://host:port/service" strings - if(name.startsWith("rmi:")){ name = name.substring(4); } - URL u = new URL("http:" + name); - String filename = u.getFile(); - - // If the filename begins with a slash we must cut it for - // name resolution. - if (filename.charAt(0) == '/') - return (getRegistry(u).lookup(filename.substring(1))); - else - return (getRegistry(u).lookup(filename)); + URL u = parseURL(name); + String serviceName = getName(u); + return (getRegistry(u).lookup(serviceName)); } /** @@ -88,14 +114,9 @@ public static Remote lookup(String name) throws NotBoundException, MalformedURLE * @throws RemoteException */ public static void bind(String name, Remote obj) throws AlreadyBoundException, MalformedURLException, RemoteException { - URL u = new URL("http:" + name); - String filename = u.getFile(); - // If the filename begins with a slash we must cut it for - // name resolution. - if (filename.charAt(0) == '/') - getRegistry(u).bind(filename.substring(1), obj); - else - getRegistry(u).bind(filename, obj); + URL u = parseURL(name); + String serviceName = getName(u); + getRegistry(u).bind(serviceName, obj); } /** @@ -106,14 +127,9 @@ public static void bind(String name, Remote obj) throws AlreadyBoundException, M * @throws MalformedURLException */ public static void unbind(String name) throws RemoteException, NotBoundException, MalformedURLException { - URL u = new URL("http:" + name); - String filename = u.getFile(); - // If the filename begins with a slash we must cut it for - // name resolution. - if (filename.charAt(0) == '/') - getRegistry(u).unbind(filename.substring(1)); - else - getRegistry(u).unbind(filename); + URL u = parseURL(name); + String serviceName = getName(u); + getRegistry(u).unbind(serviceName); } /** @@ -125,14 +141,9 @@ public static void unbind(String name) throws RemoteException, NotBoundException * @throws MalformedURLException */ public static void rebind(String name, Remote obj) throws RemoteException, MalformedURLException { - URL u = new URL("http:" + name); - String filename = u.getFile(); - // If the filename begins with a slash we must cut it for - // name resolution. - if (filename.charAt(0) == '/') - getRegistry(u).rebind(filename.substring(1), obj); - else - getRegistry(u).rebind(filename, obj); + URL u = parseURL(name); + String serviceName = getName(u); + getRegistry(u).rebind(serviceName, obj); } /** @@ -143,7 +154,7 @@ public static void rebind(String name, Remote obj) throws RemoteException, Malfo * @throws MalformedURLException */ public static String[] list(String name) throws RemoteException, MalformedURLException { - return (getRegistry(new URL("http:" + name)).list()); + return (getRegistry(parseURL(name)).list()); } private static Registry getRegistry(URL u) throws RemoteException { @@ -155,4 +166,55 @@ private static Registry getRegistry(URL u) throws RemoteException { } } + /** + * Parses the supplied URL and converts it to use the HTTP + * protocol. From an RMI perspective, the scheme is irrelevant + * and we want to be able to create a URL for which a handler is + * available. + * + * @param name the URL in String form. + * @throws MalformedURLException if the URL is invalid. + */ + private static URL parseURL(String name) + throws MalformedURLException + { + try + { + URI uri = new URI(name); + String host = uri.getHost(); + int port = uri.getPort(); + String query = uri.getQuery(); + String path = uri.getPath(); + return new URL("http", + (host == null ? "localhost" : host), + (port == -1 ? 1099 : port), + uri.getPath() + (query == null ? "" : query)); + } + catch (URISyntaxException e) + { + throw new MalformedURLException("The URL syntax was invalid: " + + e.getMessage()); + } + } + + /** + * Checks that the URL contains a name, and removes any leading + * slashes. + * + * @param url the URL to check. + * @throws MalformedURLException if no name is specified. + */ + private static String getName(URL url) + throws MalformedURLException + { + String filename = url.getFile(); + if (filename.length() == 0) + throw new MalformedURLException("No path specified: " + url); + // If the filename begins with a slash we must cut it for + // name resolution. + if (filename.charAt(0) == '/') + return filename.substring(1); + return filename; + } + } -- 2.7.4