sjero.net Git - linphone/blob - p2pproxy/dependencies-src/jxse-src-2.5/api/src/net/jxta/platform/JxtaLoader.java

   1 /*
   2  * Copyright (c) 2001-2007 Sun Microsystems, Inc.  All rights reserved.
   3  *
   4  *  The Sun Project JXTA(TM) Software License
   5  *
   6  *  Redistribution and use in source and binary forms, with or without
   7  *  modification, are permitted provided that the following conditions are met:
   8  *
   9  *  1. Redistributions of source code must retain the above copyright notice,
  10  *     this list of conditions and the following disclaimer.
  11  *
  12  *  2. Redistributions in binary form must reproduce the above copyright notice,
  13  *     this list of conditions and the following disclaimer in the documentation
  14  *     and/or other materials provided with the distribution.
  15  *
  16  *  3. The end-user documentation included with the redistribution, if any, must
  17  *     include the following acknowledgment: "This product includes software
  18  *     developed by Sun Microsystems, Inc. for JXTA(TM) technology."
  19  *     Alternately, this acknowledgment may appear in the software itself, if
  20  *     and wherever such third-party acknowledgments normally appear.
  21  *
  22  *  4. The names "Sun", "Sun Microsystems, Inc.", "JXTA" and "Project JXTA" must
  23  *     not be used to endorse or promote products derived from this software
  24  *     without prior written permission. For written permission, please contact
  25  *     Project JXTA at http://www.jxta.org.
  26  *
  27  *  5. Products derived from this software may not be called "JXTA", nor may
  28  *     "JXTA" appear in their name, without prior written permission of Sun.
  29  *
  30  *  THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES,
  31  *  INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
  32  *  FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SUN
  33  *  MICROSYSTEMS OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
  34  *  INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  35  *  LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
  36  *  OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
  37  *  LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
  38  *  NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
  39  *  EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  40  *
  41  *  JXTA is a registered trademark of Sun Microsystems, Inc. in the United
  42  *  States and other countries.
  43  *
  44  *  Please see the license information page at :
  45  *  <http://www.jxta.org/project/www/license.html> for instructions on use of
  46  *  the license in source files.
  47  *
  48  *  ====================================================================
  49  *
  50  *  This software consists of voluntary contributions made by many individuals
  51  *  on behalf of Project JXTA. For more information on Project JXTA, please see
  52  *  http://www.jxta.org.
  53  *
  54  *  This license is based on the BSD license adopted by the Apache Foundation.
  55  */
  56
  57 package net.jxta.platform;
  58
  59
  60 import java.net.URL;
  61 import java.net.URLClassLoader;
  62
  63 import net.jxta.protocol.ModuleImplAdvertisement;
  64
  65
  66 /**
  67  * A ClassLoader which provides additional JXTA functionality. You can load
  68  * classes by ModuleSpecID. Classes are defined with ModuleImplAdvertisements
  69  * and class loading will determine suitability using the provided
  70  * compatibility statements.
  71  */
  72 public abstract class JxtaLoader extends URLClassLoader {
  73
  74     /**
  75      *  Construct a new loader with the specified parent loader and
  76      *
  77      *  @param parent  the parent class loader for delegation.
  78      */
  79     public JxtaLoader(ClassLoader parent) {
  80         this(new URL[0], parent);
  81     }
  82
  83     /**
  84      * Construct a new loader for the specified URLS with the specified parent
  85      * loader.
  86      *
  87      *  @param urls  the URLs from which to load classes and resources.
  88      *  @param parent  the parent class loader for delegation.
  89      */
  90     public JxtaLoader(URL[] urls, ClassLoader parent) {
  91         super(urls, parent);
  92     }
  93
  94     /**
  95      *  {@inheritDoc}
  96      */
  97     @Override
  98     public void addURL(URL url) {
  99         super.addURL(url);
 100     }
 101
 102     /**
 103      * Finds and loads the class with the specified spec ID from the URL search
 104      * path. Any URLs referring to JAR files are loaded and opened as needed
 105      * until the class is found.
 106      *
 107      *  @param spec the specid of the class to load.
 108      *  @throws ClassNotFoundException if the class could not be found.
 109      *  @return the resulting class.
 110      */
 111     public abstract Class<? extends Module> findClass(ModuleSpecID spec) throws ClassNotFoundException;
 112
 113     /**
 114      *  Loads the class with the specified spec ID from the URL search
 115      *  path.
 116      *
 117      *  @param spec the specid of the class to load.
 118      *  @throws ClassNotFoundException if the class could not be found.
 119      *  @return the resulting class.
 120      */
 121     public abstract Class<? extends Module> loadClass(ModuleSpecID spec) throws ClassNotFoundException;
 122
 123     /**
 124      *  Defines a new class from a Module Impl Advertisement.
 125      *
 126      *  @param impl The moduleImplAdvertisement containing the class
 127      *  specification
 128      *  @return The Class object that was created from the specified class data.
 129      */
 130     public abstract Class<? extends Module> defineClass(ModuleImplAdvertisement impl);
 131
 132     /**
 133      *  Finds the ModuleImplAdvertisement for the associated class in the
 134      *  context of this ClassLoader.
 135      *
 136      *  @param clazz The class who's ModuleImplAdvertisement is desired.
 137      *  @return The matching {@code ModuleImplAdvertisement} otherwise
 138      *  {@code null} if there is no known association.
 139      */
 140     public abstract ModuleImplAdvertisement findModuleImplAdvertisement(Class<? extends Module> clazz);
 141
 142     /**
 143      *  Finds the ModuleImplAdvertisement for the associated class in the
 144      *  context of this ClassLoader.
 145      *
 146      *  @param msid The module spec id who's ModuleImplAdvertisement is desired.
 147      *  @return The matching {@code ModuleImplAdvertisement} otherwise
 148      *  {@code null} if there is no known association.
 149      */
 150     public abstract ModuleImplAdvertisement findModuleImplAdvertisement(ModuleSpecID msid);
 151 }