View Javadoc

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