1 package org.codehaus.classworlds;
2
3 /*
4
5 Copyright 2002 (C) The Werken Company. All Rights Reserved.
6
7 Redistribution and use of this software and associated documentation
8 ("Software"), with or without modification, are permitted provided
9 that the following conditions are met:
10
11 1. Redistributions of source code must retain copyright
12 statements and notices. Redistributions must also contain a
13 copy of this document.
14
15 2. Redistributions in binary form must reproduce the
16 above copyright notice, this list of conditions and the
17 following disclaimer in the documentation and/or other
18 materials provided with the distribution.
19
20 3. The name "classworlds" must not be used to endorse or promote
21 products derived from this Software without prior written
22 permission of The Werken Company. For written permission,
23 please contact bob@werken.com.
24
25 4. Products derived from this Software may not be called "classworlds"
26 nor may "classworlds" appear in their names without prior written
27 permission of The Werken Company. "classworlds" is a registered
28 trademark of The Werken Company.
29
30 5. Due credit should be given to The Werken Company.
31 (http://classworlds.werken.com/).
32
33 THIS SOFTWARE IS PROVIDED BY THE WERKEN COMPANY AND CONTRIBUTORS
34 ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT
35 NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
36 FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
37 THE WERKEN COMPANY OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
38 INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
39 (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
40 SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
41 HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
42 STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
43 ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
44 OF THE POSSIBILITY OF SUCH DAMAGE.
45
46 */
47
48 import java.io.IOException;
49 import java.io.InputStream;
50 import java.net.URL;
51 import java.util.Enumeration;
52
53 /**
54 * <p>Autonomous sub-portion of a <code>ClassWorld</code>.</p>
55 *
56 * <p>This class most closed maps to the <code>ClassLoader</code>
57 * role from Java and in facts can provide a <code>ClassLoader</code>
58 * view of itself using {@link #getClassLoader}.</p>
59 *
60 * <p>This is a legacy interface from Classworlds 1.x, preserved for binary compatibility.
61 * The compiled bytecode of {@code org.eclipse.sisu:org.eclipse.sisu.plexus} references this
62 * interface directly. Removing it breaks all Maven 3+ builds.
63 * New code should use {@link org.codehaus.plexus.classworlds.realm.ClassRealm}.</p>
64 *
65 * @author <a href="mailto:bob@eng.werken.com">bob mcwhirter</a>
66 * @author <a href="mailto:jason@zenplex.com">Jason van Zyl</a>
67 * @deprecated Use {@link org.codehaus.plexus.classworlds.realm.ClassRealm} for new code.
68 * This interface must remain on the classpath for Sisu compatibility.
69 */
70 @SuppressWarnings("rawtypes")
71 @Deprecated
72 public interface ClassRealm {
73 String getId();
74
75 ClassWorld getWorld();
76
77 void importFrom(String realmId, String pkgName) throws NoSuchRealmException;
78
79 void addConstituent(URL constituent);
80
81 ClassRealm locateSourceRealm(String className);
82
83 void setParent(ClassRealm classRealm);
84
85 ClassRealm createChildRealm(String id) throws DuplicateRealmException;
86
87 ClassLoader getClassLoader();
88
89 ClassRealm getParent();
90
91 URL[] getConstituents();
92
93 // ----------------------------------------------------------------------
94 // Classloading
95 // ----------------------------------------------------------------------
96
97 Class loadClass(String name) throws ClassNotFoundException;
98
99 // ----------------------------------------------------------------------
100 // Resource handling
101 // ----------------------------------------------------------------------
102
103 URL getResource(String name);
104
105 Enumeration findResources(String name) throws IOException;
106
107 InputStream getResourceAsStream(String name);
108
109 void display();
110 }