01: /*
02: * This file is part of PFIXCORE.
03: *
04: * PFIXCORE is free software; you can redistribute it and/or modify
05: * it under the terms of the GNU Lesser General Public License as published by
06: * the Free Software Foundation; either version 2 of the License, or
07: * (at your option) any later version.
08: *
09: * PFIXCORE is distributed in the hope that it will be useful,
10: * but WITHOUT ANY WARRANTY; without even the implied warranty of
11: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12: * GNU Lesser General Public License for more details.
13: *
14: * You should have received a copy of the GNU Lesser General Public License
15: * along with PFIXCORE; if not, write to the Free Software
16: * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17: */
18:
19: package de.schlund.pfixxml.resources;
20:
21: import java.net.URI;
22:
23: /**
24: * Creates docroot resources using environment dependend methods.
25: * A class implementing this interface provides Pustefix docroot
26: * resources. This task can be performed by using files in a directory
27: * on the filesystem, files from a JAR file or any other mechanism
28: * that can provide file like resources.
29: *
30: * @author Sebastian Marsching <sebastian.marsching@1und1.de>
31: */
32: public interface DocrootResourceProvider {
33: /**
34: * Returns an instance of {@link DocrootResource} that represents
35: * the resource specified by the given URI. A resource is always
36: * returned unless the URI provided is invalid or does not use the
37: * pfixroot URI scheme. A DocrootResource object is returned even if
38: * the specified resource does not exist.
39: *
40: * @param uri URI using the pfixroot scheme
41: * @return A DocrootResource that can be used to access the resource
42: * specified by the URI.
43: */
44: DocrootResource getDocrootResource(URI uri);
45: }
|