Thu, 31 Aug 2017 15:18:52 +0800
merge
aoqi@0 | 1 | /* |
aoqi@0 | 2 | * Copyright (c) 1997, 2012, Oracle and/or its affiliates. All rights reserved. |
aoqi@0 | 3 | * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
aoqi@0 | 4 | * |
aoqi@0 | 5 | * This code is free software; you can redistribute it and/or modify it |
aoqi@0 | 6 | * under the terms of the GNU General Public License version 2 only, as |
aoqi@0 | 7 | * published by the Free Software Foundation. Oracle designates this |
aoqi@0 | 8 | * particular file as subject to the "Classpath" exception as provided |
aoqi@0 | 9 | * by Oracle in the LICENSE file that accompanied this code. |
aoqi@0 | 10 | * |
aoqi@0 | 11 | * This code is distributed in the hope that it will be useful, but WITHOUT |
aoqi@0 | 12 | * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
aoqi@0 | 13 | * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
aoqi@0 | 14 | * version 2 for more details (a copy is included in the LICENSE file that |
aoqi@0 | 15 | * accompanied this code). |
aoqi@0 | 16 | * |
aoqi@0 | 17 | * You should have received a copy of the GNU General Public License version |
aoqi@0 | 18 | * 2 along with this work; if not, write to the Free Software Foundation, |
aoqi@0 | 19 | * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
aoqi@0 | 20 | * |
aoqi@0 | 21 | * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA |
aoqi@0 | 22 | * or visit www.oracle.com if you need additional information or have any |
aoqi@0 | 23 | * questions. |
aoqi@0 | 24 | */ |
aoqi@0 | 25 | |
aoqi@0 | 26 | package com.sun.xml.internal.ws.transport.http; |
aoqi@0 | 27 | |
aoqi@0 | 28 | import java.net.URL; |
aoqi@0 | 29 | import java.net.MalformedURLException; |
aoqi@0 | 30 | import java.util.Set; |
aoqi@0 | 31 | |
aoqi@0 | 32 | /** |
aoqi@0 | 33 | * Used to locate resources for {@link DeploymentDescriptorParser}. |
aoqi@0 | 34 | * |
aoqi@0 | 35 | * <p> |
aoqi@0 | 36 | * This allows {@link DeploymentDescriptorParser} to be used outside a servlet container, |
aoqi@0 | 37 | * but it still needs to work with a layout similar to the web application. |
aoqi@0 | 38 | * If this can be abstracted away better, that would be nice. |
aoqi@0 | 39 | * |
aoqi@0 | 40 | * @author Kohsuke Kawaguchi |
aoqi@0 | 41 | */ |
aoqi@0 | 42 | public interface ResourceLoader { |
aoqi@0 | 43 | /** |
aoqi@0 | 44 | * Returns the actual location of the resource from the 'path' |
aoqi@0 | 45 | * that represents a virtual locaion of a file inside a web application. |
aoqi@0 | 46 | * |
aoqi@0 | 47 | * @param path |
aoqi@0 | 48 | * Desiganates an absolute path within an web application, such as: |
aoqi@0 | 49 | * '/WEB-INF/web.xml' or some such. |
aoqi@0 | 50 | * |
aoqi@0 | 51 | * @return |
aoqi@0 | 52 | * the actual location, if found, or null if not found. |
aoqi@0 | 53 | */ |
aoqi@0 | 54 | URL getResource(String path) throws MalformedURLException; |
aoqi@0 | 55 | |
aoqi@0 | 56 | /** |
aoqi@0 | 57 | * Gets the catalog XML file that should be consulted when |
aoqi@0 | 58 | * loading resources from this {@link ResourceLoader}. |
aoqi@0 | 59 | */ |
aoqi@0 | 60 | URL getCatalogFile() throws MalformedURLException; |
aoqi@0 | 61 | |
aoqi@0 | 62 | /** |
aoqi@0 | 63 | * Returns the list of files in the given directory. |
aoqi@0 | 64 | * |
aoqi@0 | 65 | * @return |
aoqi@0 | 66 | * null if the path is invalid. empty if the path didn't contain |
aoqi@0 | 67 | * any entry in it. |
aoqi@0 | 68 | * |
aoqi@0 | 69 | * @see javax.servlet.ServletContext#getResourcePaths(String) |
aoqi@0 | 70 | */ |
aoqi@0 | 71 | Set<String> getResourcePaths(String path); |
aoqi@0 | 72 | } |