Class | Line # | Actions | |||||
---|---|---|---|---|---|---|---|
Environment | 36 | 0 | - | 0 | 0 |
1 | /* | |
2 | * See the NOTICE file distributed with this work for additional | |
3 | * information regarding copyright ownership. | |
4 | * | |
5 | * This is free software; you can redistribute it and/or modify it | |
6 | * under the terms of the GNU Lesser General Public License as | |
7 | * published by the Free Software Foundation; either version 2.1 of | |
8 | * the License, or (at your option) any later version. | |
9 | * | |
10 | * This software is distributed in the hope that it will be useful, | |
11 | * but WITHOUT ANY WARRANTY; without even the implied warranty of | |
12 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
13 | * Lesser General Public License for more details. | |
14 | * | |
15 | * You should have received a copy of the GNU Lesser General Public | |
16 | * License along with this software; if not, write to the Free | |
17 | * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA | |
18 | * 02110-1301 USA, or see the FSF site: http://www.fsf.org. | |
19 | */ | |
20 | package org.xwiki.environment; | |
21 | ||
22 | import java.io.File; | |
23 | import java.io.InputStream; | |
24 | import java.net.URL; | |
25 | ||
26 | import org.xwiki.component.annotation.Role; | |
27 | ||
28 | /** | |
29 | * Abstraction that represents an Environment (Java SE, Servlet, Portlet, etc) and provides API to access | |
30 | * environment-related data. | |
31 | * | |
32 | * @version $Id: bbe14c304d432691d6493a67eb344fbd40d40c8b $ | |
33 | * @since 3.5M1 | |
34 | */ | |
35 | @Role | |
36 | public interface Environment | |
37 | { | |
38 | /** | |
39 | * Gets the directory for storing temporary data. The content of this directory may be deleted across restarts and | |
40 | * thus is not a safe place to store permanent/important data. | |
41 | * | |
42 | * @return a {@link File} object pointing to a directory that the application can use for storing temporary files | |
43 | */ | |
44 | File getTemporaryDirectory(); | |
45 | ||
46 | /** | |
47 | * Gets the root directory of a location for storing persisting data. Contrary to the Temporary Directory the | |
48 | * content of this directory is guaranteed to persist across time. | |
49 | * | |
50 | * @return a {@link File} object pointing to the root folder of the permanent directory | |
51 | */ | |
52 | File getPermanentDirectory(); | |
53 | ||
54 | /** | |
55 | * @param resourceName the full name of the resource to access (eg "/somefile.properties") | |
56 | * @return the resource location as a {@link URL} or null if not found | |
57 | */ | |
58 | URL getResource(String resourceName); | |
59 | ||
60 | /** | |
61 | * @param resourceName the full name of the resource to access (eg "/somefile.properties") | |
62 | * @return the resource location as an {@link InputStream} | |
63 | */ | |
64 | InputStream getResourceAsStream(String resourceName); | |
65 | } |