LoaderResolver


1   /*
2    * Copyright (C) The Spice Group. All rights reserved.
3    *
4    * This software is published under the terms of the Spice
5    * Software License version 1.1, a copy of which has been included
6    * with this distribution in the LICENSE.txt file.
7    */
8   package org.codehaus.loom.classman.builder;
9   
10  import java.net.URL  ;
11  
12  import org.codehaus.loom.extension.Extension;
13  
14  /**
15   * This is the class that clients provide to implement a specific policy with
16   * respect to how ClassLoader hierarchy is constructed.
17   *
18   * @author Peter Donald
19   * @version $Revision: 1.1 $ $Date: 2004/04/19 22:19:25 $
20   */
21  public interface LoaderResolver
22  {
23      /**
24       * Resolve an Extension to a URL. The URL that locates the "Optional
25       * Package" that provides specified Extension.
26       *
27       * @param extension the extension
28       * @return the URL that locates the "Optional Package" that provides
29       *         specified Extension.
30       * @throws Exception if unable to locate Extension
31       */
32      URL   resolveExtension( Extension extension )
33          throws Exception  ;
34  
35      /**
36       * Resolve a string into a URL. This allows resolvers to anchor URLs using
37       * relative URL or by handling non-standard URL protocols (such as
38       * "sar:/SAR-INF/lib/cornerstone.jar").
39       *
40       * @param location the location to transform into a URL
41       * @return the URL
42       * @throws Exception if unable to resolve URL
43       */
44      URL   resolveURL( String   location )
45          throws Exception  ;
46  
47      /**
48       * Resolve a fileset to a set of URLs.
49       *
50       * @param baseDirectory the Base directory of fileset
51       * @return the set of URLs making up fileset
52       * @throws Exception if unable to resolve fileset
53       */
54      URL  [] resolveFileSet( String   baseDirectory,
55                            String  [] includes,
56                            String  [] excludes )
57          throws Exception  ;
58  
59      /**
60       * Create a Join ClassLoader for specified ClassLoaders.
61       *
62       * @param classLoaders the ClassLoaders to "join"
63       * @return the joined ClassLoader
64       * @throws Exception if unable to create classloader
65       */
66      ClassLoader   createJoinClassLoader( ClassLoader  [] classLoaders )
67          throws Exception  ;
68  
69      /**
70       * Create a ClassLoader with specified parent and containing specified
71       * URLs.
72       *
73       * @param parent the parent classloader
74       * @param urls the URLs that the ClassLoader should contain
75       * @return the newly created ClassLoader
76       * @throws Exception if unable to create classloader
77       */
78      ClassLoader   createClassLoader( ClassLoader   parent, URL  [] urls )
79          throws Exception  ;
80  }
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags