comprises static methods to support
dynamic class loading with RMI. Included are methods for loading
classes from a network location (one or more URLs) and obtaining
the location from which an existing class should be loaded by
remote parties. These methods are used by the RMI runtime when
marshalling and unmarshalling classes contained in the arguments
and return values of remote method calls, and they also may be
invoked directly by applications in order to mimic RMI's dynamic
class loading behavior.
, the
service provider interface for those methods. When one of the
methods is invoked, its behavior is to delegate to a corresponding
method on the service provider instance. The details of how each
method delegates to the provider instance is described in the
documentation for each particular method.
| Method from java.rmi.server.RMIClassLoader Detail: |
public static String getClassAnnotation(Class cl) {
return provider.getClassAnnotation(cl);
}
Returns the annotation string (representing a location for
the class definition) that RMI will use to annotate the class
descriptor when marshalling objects of the given class.
This method delegates to the
RMIClassLoaderSpi#getClassAnnotation(Class) method
of the provider instance, passing cl as the argument. |
public static ClassLoader getClassLoader(String codebase) throws MalformedURLException, SecurityException {
return provider.getClassLoader(codebase);
}
Returns a class loader that loads classes from the given codebase
URL path.
The class loader returned is the class loader that the
#loadClass(String,String) method would use to load classes
for the same codebase argument.
This method delegates to the
RMIClassLoaderSpi#getClassLoader(String) method
of the provider instance, passing codebase as the argument.
If there is a security manger, its checkPermission
method will be invoked with a
RuntimePermission("getClassLoader") permission;
this could result in a SecurityException.
The provider implementation of this method may also perform further
security checks to verify that the calling context has permission to
connect to all of the URLs in the codebase URL path. |
public static RMIClassLoaderSpi getDefaultProviderInstance() {
SecurityManager sm = System.getSecurityManager();
if (sm != null) {
sm.checkPermission(new RuntimePermission("setFactory"));
}
return defaultProvider;
}
Returns the canonical instance of the default provider
for the service provider interface RMIClassLoaderSpi .
If the system property java.rmi.server.RMIClassLoaderSpi
is not defined, then the RMIClassLoader static
methods
will use the canonical instance of the default provider
as the service provider instance.
If there is a security manager, its
checkPermission method will be invoked with a
RuntimePermission("setFactory") permission; this
could result in a SecurityException.
The default service provider instance implements
RMIClassLoaderSpi as follows:
The getClassAnnotation method returns a String
representing the codebase URL path that a remote party should
use to download the definition for the specified class. The
format of the returned string is a path of URLs separated by
spaces.
The codebase string returned depends on the defining class
loader of the specified class:
- If the class loader is the system class loader (see
ClassLoader#getSystemClassLoader ), a parent of the
system class loader such as the loader used for installed
extensions, or the bootstrap class loader (which may be
represented by
null), then the value of the
java.rmi.server.codebase property (or possibly an
earlier cached value) is returned, or
null is returned if that property is not set.
- Otherwise, if the class loader is an instance of
URLClassLoader, then the returned string is a
space-separated list of the external forms of the URLs returned
by invoking the getURLs methods of the loader. If
the URLClassLoader was created by this provider to
service an invocation of its loadClass or
loadProxyClass methods, then no permissions are
required to get the associated codebase string. If it is an
arbitrary other URLClassLoader instance, then if
there is a security manager, its checkPermission
method will be invoked once for each URL returned by the
getURLs method, with the permission returned by
invoking openConnection().getPermission() on each
URL; if any of those invocations throws a
SecurityException or an IOException,
then the value of the java.rmi.server.codebase
property (or possibly an earlier cached value) is returned, or
null is returned if that property is not set.
- Finally, if the class loader is not an instance of
URLClassLoader, then the value of the
java.rmi.server.codebase property (or possibly an
earlier cached value) is returned, or
null is returned if that property is not set.
For the implementations of the methods described below,
which all take a String parameter named
codebase that is a space-separated list of URLs,
each invocation has an associated codebase loader that
is identified using the codebase argument in
conjunction with the current thread's context class loader (see
Thread#getContextClassLoader() ). When there is a
security manager, this provider maintains an internal table of
class loader instances (which are at least instances of java.net.URLClassLoader ) keyed by the pair of their parent
class loader and their codebase URL path (an ordered list of
URLs). If the codebase argument is null,
the codebase URL path is the value of the system property
java.rmi.server.codebase or possibly an
earlier cached value. For a given codebase URL path passed as the
codebase argument to an invocation of one of the
below methods in a given context, the codebase loader is the
loader in the table with the specified codebase URL path and
the current thread's context class loader as its parent. If no
such loader exists, then one is created and added to the table.
The table does not maintain strong references to its contained
loaders, in order to allow them and their defined classes to be
garbage collected when not otherwise reachable. In order to
prevent arbitrary untrusted code from being implicitly loaded
into a virtual machine with no security manager, if there is no
security manager set, the codebase loader is just the current
thread's context class loader (the supplied codebase URL path
is ignored, so remote class loading is disabled).
The getClassLoader method returns the codebase loader for the
specified codebase URL path. If there is a security manager,
then if the calling context does not have permission to connect
to all of the URLs in the codebase URL path, a
SecurityException will be thrown.
The loadClass method attempts to load the class with the
specified name as follows:
If the defaultLoader argument is
non-null, it first attempts to load the class with the
specified name using the
defaultLoader, such as by evaluating
Class.forName(name, false, defaultLoader)
If the class is successfully loaded from the
defaultLoader, that class is returned. If an
exception other than ClassNotFoundException is
thrown, that exception is thrown to the caller.
Next, the loadClass method attempts to load the
class with the specified name using the codebase
loader for the specified codebase URL path.
If there is a security manager, then the calling context
must have permission to connect to all of the URLs in the
codebase URL path; otherwise, the current thread's context
class loader will be used instead of the codebase loader.
The loadProxyClass method attempts to return a dynamic proxy
class with the named interface as follows:
If the defaultLoader argument is
non-null and all of the named interfaces can be
resolved through that loader, then,
- if all of the resolved interfaces are
public,
then it first attempts to obtain a dynamic proxy class (using
Proxy.getProxyClass ) for the resolved interfaces defined in
the codebase loader; if that attempt throws an
IllegalArgumentException, it then attempts to
obtain a dynamic proxy class for the resolved interfaces
defined in the defaultLoader. If both attempts
throw IllegalArgumentException, then this method
throws a ClassNotFoundException. If any other
exception is thrown, that exception is thrown to the caller.
- if all of the non-
public resolved interfaces
are defined in the same class loader, then it attempts to
obtain a dynamic proxy class for the resolved interfaces
defined in that loader.
- otherwise, a
LinkageError is thrown (because a
class that implements all of the specified interfaces cannot be
defined in any loader).
Otherwise, if all of the named interfaces can be resolved
through the codebase loader, then,
- if all of the resolved interfaces are
public,
then it attempts to obtain a dynamic proxy class for the
resolved interfaces in the codebase loader. If the attempt
throws an IllegalArgumentException, then this
method throws a ClassNotFoundException.
- if all of the non-
public resolved interfaces
are defined in the same class loader, then it attempts to
obtain a dynamic proxy class for the resolved interfaces
defined in that loader.
- otherwise, a
LinkageError is thrown (because a
class that implements all of the specified interfaces cannot be
defined in any loader).
Otherwise, a ClassNotFoundException is thrown
for one of the named interfaces that could not be resolved.
|
public static Object getSecurityContext(ClassLoader loader) {
return sun.rmi.server.LoaderHandler.getSecurityContext(loader);
} Deprecated! no - replacement. As of the Java 2 platform v1.2, RMI no
longer uses this method to obtain a class loader's security context.
Returns the security context of the given class loader. |
public static Class loadClass(String name) throws MalformedURLException, ClassNotFoundException {
return loadClass((String) null, name);
} Deprecated! replaced - by loadClass(String,String) method
Loads the class with the specified name.
This method delegates to #loadClass(String,String) ,
passing null as the first argument and
name as the second argument. |
public static Class loadClass(URL codebase,
String name) throws MalformedURLException, ClassNotFoundException {
return provider.loadClass(
codebase != null ? codebase.toString() : null, name, null);
}
Loads a class from a codebase URL.
If codebase is null, then this method
will behave the same as #loadClass(String,String) with a
null codebase and the given class name.
This method delegates to the
RMIClassLoaderSpi#loadClass(String,String,ClassLoader)
method of the provider instance, passing the result of invoking
URL#toString on the given URL (or null if
codebase is null) as the first argument,
name as the second argument,
and null as the third argument. |
public static Class loadClass(String codebase,
String name) throws MalformedURLException, ClassNotFoundException {
return provider.loadClass(codebase, name, null);
}
|
public static Class loadClass(String codebase,
String name,
ClassLoader defaultLoader) throws MalformedURLException, ClassNotFoundException {
return provider.loadClass(codebase, name, defaultLoader);
}
Loads a class from a codebase URL path, optionally using the
supplied loader.
This method should be used when the caller would like to make
available to the provider implementation an additional contextual
class loader to consider, such as the loader of a caller on the
stack. Typically, a provider implementation will attempt to
resolve the named class using the given defaultLoader,
if specified, before attempting to resolve the class from the
codebase URL path.
This method delegates to the
RMIClassLoaderSpi#loadClass(String,String,ClassLoader)
method of the provider instance, passing codebase
as the first argument, name as the second argument,
and defaultLoader as the third argument. |
public static Class loadProxyClass(String codebase,
String[] interfaces,
ClassLoader defaultLoader) throws MalformedURLException, ClassNotFoundException {
return provider.loadProxyClass(codebase, interfaces, defaultLoader);
}
|