1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one or more
3 * contributor license agreements. See the NOTICE file distributed with
4 * this work for additional information regarding copyright ownership.
5 * The ASF licenses this file to You under the Apache License, Version 2.0
6 * (the "License"); you may not use this file except in compliance with
7 * the License. You may obtain a copy of the License at
8 *
9 * http://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
16 */
17
18 package org.apache.jetspeed.components.util.system;
19
20 import java.net.MalformedURLException;
21 import java.net.URL;
22
23 /***
24 * <p>
25 * SystemResourceUtil
26 * </p>
27 * <p>
28 * This is a simple component that allows location of system resources
29 * based on implementation. Sources could be anyone or combination of:
30 * the file system, classloaders, VFS source (see the Virtual File System
31 * project: http://jakarta.apache.org/commons/sandbox/vfs/)
32 * </p>
33 *
34 * @author <a href="mailto:weaver@apache.org">Scott T. Weaver</a>
35 * @version $Id: SystemResourceUtil.java 516448 2007-03-09 16:25:47Z ate $
36 *
37 */
38 public interface SystemResourceUtil
39 {
40 /***
41 *
42 * @return The root from were this system is running
43 */
44 String getSystemRoot();
45
46 /***
47 * Creates a fully qualified path to the <code>relativePath</code>
48 * as a {@link java.net.URL}
49 * @param relativePath
50 * @return
51 */
52 URL getURL(String relativePath) throws MalformedURLException;
53
54 }