KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > codehaus > loom > components > util > ResourceUtil


1 /* ====================================================================
2  * Loom Software License, version 1.1
3  *
4  * Copyright (c) 2003, Loom Group. All rights reserved.
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  *
9  * 1. Redistributions of source code must retain the above copyright
10  * notice, this list of conditions and the following disclaimer.
11  *
12  * 2. Redistributions in binary form must reproduce the above copyright
13  * notice, this list of conditions and the following disclaimer in
14  * the documentation and/or other materials provided with the
15  * distribution.
16  *
17  * 3. Neither the name of the Loom Group nor the name "Loom" nor
18  * the names of its contributors may be used to endorse or promote
19  * products derived from this software without specific prior
20  * written permission.
21  *
22  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
23  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
24  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
25  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
26  * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
27  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
28  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
29  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
30  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
31  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
32  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
33  * POSSIBILITY OF SUCH DAMAGE.
34  *
35  * ====================================================================
36  *
37  * Loom includes code from the Apache Software Foundation
38  *
39  * ====================================================================
40  * The Apache Software License, Version 1.1
41  *
42  * Copyright (c) 1997-2003 The Apache Software Foundation. All rights
43  * reserved.
44  *
45  * Redistribution and use in source and binary forms, with or without
46  * modification, are permitted provided that the following conditions
47  * are met:
48  *
49  * 1. Redistributions of source code must retain the above copyright
50  * notice, this list of conditions and the following disclaimer.
51  *
52  * 2. Redistributions in binary form must reproduce the above copyright
53  * notice, this list of conditions and the following disclaimer in
54  * the documentation and/or other materials provided with the
55  * distribution.
56  *
57  * 3. The end-user documentation included with the redistribution,
58  * if any, must include the following acknowledgment:
59  * "This product includes software developed by the
60  * Apache Software Foundation (http://www.apache.org/)."
61  * Alternately, this acknowledgment may appear in the software
62  * itself, if and wherever such third-party acknowledgments
63  * normally appear.
64  *
65  * 4. The names "Jakarta", "Avalon", and "Apache Software Foundation"
66  * must not be used to endorse or promote products derived from this
67  * software without prior written permission. For written
68  * permission, please contact apache@apache.org.
69  *
70  * 5. Products derived from this software may not be called "Apache",
71  * nor may "Apache" appear in their name, without prior written
72  * permission of the Apache Software Foundation.
73  *
74  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
75  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
76  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
77  * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
78  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
79  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
80  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
81  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
82  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
83  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
84  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
85  * SUCH DAMAGE.
86  */

87 package org.codehaus.loom.components.util;
88
89 import java.io.File JavaDoc;
90 import java.net.MalformedURLException JavaDoc;
91
92 import org.codehaus.loom.interfaces.LoomException;
93
94 /**
95  * A utility class for working with resources in default sar layout.
96  *
97  * @author Peter Donald
98  * @version $Revision: 1.3 $ $Date: 2004/08/17 23:14:32 $
99  */

100 public class ResourceUtil
101 {
102     private static final String JavaDoc SAR_PROTOCOL = "sar:";
103     private static final String JavaDoc SAR_INF = "SAR-INF/";
104     private static final String JavaDoc CLASSES = SAR_INF + "classes";
105     private static final String JavaDoc LIB = SAR_INF + "lib";
106
107     /**
108      * Expand any URLs with sar: protocol so that they accurately match the
109      * actual location
110      *
111      * @param codeBase the input url
112      * @return the result url, modified to file url if it is protocol "sar:"
113      * @throws LoomException if invalidly specified URL
114      */

115     public static String JavaDoc expandSarURL( final String JavaDoc codeBase,
116                                        final File JavaDoc baseDirectory,
117                                        final File JavaDoc workDirectory )
118         throws Exception JavaDoc
119     {
120         if( codeBase.startsWith( SAR_PROTOCOL ) )
121         {
122             final File JavaDoc file =
123                 getFileForResource( codeBase.substring( 4 ),
124                                     baseDirectory,
125                                     workDirectory );
126             try
127             {
128                 return file.toURL().toString();
129             }
130             catch( MalformedURLException JavaDoc e )
131             {
132                 throw new LoomException( e.getMessage(), e );
133             }
134         }
135         else
136         {
137             return codeBase;
138         }
139     }
140
141     public static File JavaDoc getFileForResource( final String JavaDoc location,
142                                            final File JavaDoc baseDirectory,
143                                            final File JavaDoc workDirectory )
144     {
145         String JavaDoc filename =
146             location.replace( '/', File.separatorChar );
147         if( filename.startsWith( "/" ) )
148         {
149             filename = filename.substring( 1 );
150         }
151
152         final File JavaDoc baseDir =
153             getBaseDirectoryFor( location, baseDirectory, workDirectory );
154         return new File JavaDoc( baseDir, filename );
155     }
156
157     private static File JavaDoc getBaseDirectoryFor( final String JavaDoc location,
158                                              final File JavaDoc baseDirectory,
159                                              final File JavaDoc workDirectory )
160     {
161         if( location.startsWith( CLASSES ) ||
162             location.startsWith( LIB ) )
163         {
164             return workDirectory;
165         }
166         else
167         {
168             return baseDirectory;
169         }
170     }
171 }
172
Popular Tags