01: /*
02: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
03: *
04: * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
05: *
06: * The contents of this file are subject to the terms of either the GNU
07: * General Public License Version 2 only ("GPL") or the Common Development
08: * and Distribution License("CDDL") (collectively, the "License"). You
09: * may not use this file except in compliance with the License. You can obtain
10: * a copy of the License at https://glassfish.dev.java.net/public/CDDL+GPL.html
11: * or glassfish/bootstrap/legal/LICENSE.txt. See the License for the specific
12: * language governing permissions and limitations under the License.
13: *
14: * When distributing the software, include this License Header Notice in each
15: * file and include the License file at glassfish/bootstrap/legal/LICENSE.txt.
16: * Sun designates this particular file as subject to the "Classpath" exception
17: * as provided by Sun in the GPL Version 2 section of the License file that
18: * accompanied this code. If applicable, add the following below the License
19: * Header, with the fields enclosed by brackets [] replaced by your own
20: * identifying information: "Portions Copyrighted [year]
21: * [name of copyright owner]"
22: *
23: * Contributor(s):
24: *
25: * If you wish your version of this file to be governed by only the CDDL or
26: * only the GPL Version 2, indicate your decision by adding "[Contributor]
27: * elects to include this software in this distribution under the [CDDL or GPL
28: * Version 2] license." If you don't indicate a single choice of license, a
29: * recipient has the option to distribute your version of this file under
30: * either the CDDL, the GPL Version 2 or to extend the choice of license to
31: * its licensees as provided above. However, if you add GPL Version 2 code
32: * and therefore, elected the GPL Version 2 license, then the option applies
33: * only if the new code is made subject to such option by the copyright
34: * holder.
35: */
36:
37: package com.sun.xml.ws.transport.http;
38:
39: import java.net.URL;
40: import java.net.MalformedURLException;
41: import java.util.Set;
42:
43: /**
44: * Used to locate resources for {@link DeploymentDescriptorParser}.
45: *
46: * <p>
47: * This allows {@link DeploymentDescriptorParser} to be used outside a servlet container,
48: * but it still needs to work with a layout similar to the web application.
49: * If this can be abstracted away better, that would be nice.
50: *
51: * @author Kohsuke Kawaguchi
52: */
53: public interface ResourceLoader {
54: /**
55: * Returns the actual location of the resource from the 'path'
56: * that represents a virtual locaion of a file inside a web application.
57: *
58: * @param path
59: * Desiganates an absolute path within an web application, such as:
60: * '/WEB-INF/web.xml' or some such.
61: *
62: * @return
63: * the actual location, if found, or null if not found.
64: */
65: URL getResource(String path) throws MalformedURLException;
66:
67: /**
68: * Gets the catalog XML file that should be consulted when
69: * loading resources from this {@link ResourceLoader}.
70: */
71: URL getCatalogFile() throws MalformedURLException;
72:
73: /**
74: * Returns the list of files in the given directory.
75: *
76: * @return
77: * null if the path is invalid. empty if the path didn't contain
78: * any entry in it.
79: *
80: * @see javax.servlet.http.ServletContext#getResourcePaths(String)
81: */
82: Set<String> getResourcePaths(String path);
83: }
|