RMIClassLoaderSpi (Java Platform SE 6)

This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.

Overview

Package

Class

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

java.rmi.server
class RMIClassLoaderSpi

java.lang.Object
  java.rmi.server.RMIClassLoaderSpi

public abstract class RMIClassLoaderSpi
extends Object

RMIClassLoaderSpi is the service provider interface for RMIClassLoader. In particular, an RMIClassLoaderSpi instance provides an implementation of the following static methods of RMIClassLoader:

{@link RMIClassLoader#loadClass(URL,String)}
{@link RMIClassLoader#loadClass(String,String)}
{@link RMIClassLoader#loadClass(String,String,ClassLoader)}
{@link RMIClassLoader#loadProxyClass(String,String[],ClassLoader)}
{@link RMIClassLoader#getClassLoader(String)}
{@link RMIClassLoader#getClassAnnotation(Class)}

When one of those methods is invoked, its behavior is to delegate to a corresponding method on an instance of this class. The details of how each method delegates to the provider instance is described in the documentation for each particular method. See the documentation for {@link RMIClassLoader} for a description of how a provider instance is chosen.

Constructor Summary
`RMIClassLoaderSpi()`

Method Summary
`abstract String`	`getClassAnnotation(Class cl)` Provides the implementation for java.rmi.server.RMIClassLoader.getClassAnnotation.
`abstract ClassLoader`	`getClassLoader(String codebase)` Provides the implementation for java.rmi.server.RMIClassLoader.getClassLoader.
`abstract Class`	`loadClass(String codebase, String name, ClassLoader defaultLoader)` Provides the implementation for java.rmi.server.RMIClassLoader.loadClass, java.rmi.server.RMIClassLoader.loadClass, and java.rmi.server.RMIClassLoader.loadClass.
`abstract Class`	`loadProxyClass(String codebase, String[] interfaces, ClassLoader defaultLoader)` Provides the implementation for java.rmi.server.RMIClassLoader.loadProxyClass.

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Constructor Detail

RMIClassLoaderSpi

public RMIClassLoaderSpi()

Method Detail

getClassAnnotation

public abstract String getClassAnnotation(Class cl)

Provides the implementation for {@link RMIClassLoader#getClassAnnotation(Class)}. 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.

Parameters:: cl - the class to obtain the annotation for
Returns:: a string to be used to annotate the given class when it gets marshalled, or null

getClassLoader

public abstract ClassLoader getClassLoader(String codebase)
                                    throws MalformedURLException

Provides the implementation for {@link RMIClassLoader#getClassLoader(String)}. Returns a class loader that loads classes from the given codebase URL path.

If there is a security manger, its checkPermission method will be invoked with a RuntimePermission("getClassLoader") permission; this could result in a SecurityException. The 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.

Parameters:: codebase - the list of URLs (space-separated) from which the returned class loader will load classes from, or null
Returns:: a class loader that loads classes from the given codebase URL path
Throws:: MalformedURLException - if codebase is non-null and contains an invalid URL, or if codebase is null and a provider-specific URL used to identify the class loader is invalid

loadClass

public abstract Class loadClass(String codebase,
                                String name,
                                ClassLoader defaultLoader)
                         throws MalformedURLException,
                                ClassNotFoundException

Provides the implementation for {@link RMIClassLoader#loadClass(URL,String)}, {@link RMIClassLoader#loadClass(String,String)}, and {@link RMIClassLoader#loadClass(String,String,ClassLoader)}. Loads a class from a codebase URL path, optionally using the supplied loader. 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.

An implementation of this method must either return a class with the given name or throw an exception.

Parameters:: codebase - the list of URLs (separated by spaces) to load the class from, or null; name - the name of the class to load; defaultLoader - additional contextual class loader to use, or null
Returns:: the Class object representing the loaded class
Throws:: MalformedURLException - if codebase is non-null and contains an invalid URL, or if codebase is null and a provider-specific URL used to load classes is invalid; ClassNotFoundException - if a definition for the class could not be found at the specified location

loadProxyClass

public abstract Class loadProxyClass(String codebase,
                                     String[] interfaces,
                                     ClassLoader defaultLoader)
                              throws MalformedURLException,
                                     ClassNotFoundException

Provides the implementation for {@link RMIClassLoader#loadProxyClass(String,String[],ClassLoader)}. Loads a dynamic proxy class (see {@link java.lang.reflect.Proxy} that implements a set of interfaces with the given names from a codebase URL path, optionally using the supplied loader.

An implementation of this method must either return a proxy class that implements the named interfaces or throw an exception.

Parameters:: codebase - the list of URLs (space-separated) to load classes from, or null; interfaces - the names of the interfaces for the proxy class to implement; defaultLoader - additional contextual class loader to use, or null
Returns:: a dynamic proxy class that implements the named interfaces
Throws:: MalformedURLException - if codebase is non-null and contains an invalid URL, or if codebase is null and a provider-specific URL used to load classes is invalid; ClassNotFoundException - if a definition for one of the named interfaces could not be found at the specified location, or if creation of the dynamic proxy class failed (such as if {@link java.lang.reflect.Proxy#getProxyClass(ClassLoader,Class[])} would throw an IllegalArgumentException for the given interface list)