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 package org.apache.commons.vfs2;
18
19 import org.apache.commons.vfs2.impl.DefaultFileSystemManager;
20
21 /**
22 * Test configuration for a file system.
23 */
24 public interface ProviderTestConfig {
25
26 /**
27 * Returns the base folder for tests. This folder must exist, and contain the following structure:
28 * <ul>
29 * <li>"/read-tests"</li>
30 * <li>"/write-tests"</li>
31 * </ul>
32 */
33 FileObject getBaseTestFolder(FileSystemManager manager) throws Exception;
34
35 /**
36 * Returns a DefaultFileSystemManager instance (or subclass instance).
37 */
38 DefaultFileSystemManager getDefaultFileSystemManager();
39
40 /**
41 * Returns the filesCache implementation used for tests.
42 */
43 FilesCache getFilesCache();
44
45 /**
46 * Tests whether or not the root of test file system is accessible.
47 *
48 * For example, with the default Jackrabbit (WebDAV) server, the root is not accessible, but deeper paths are OK.
49 *
50 * @return Whether or not the root of test file system is accessible.
51 */
52 boolean isFileSystemRootAccessible();
53
54 /**
55 * Prepares the file system manager.
56 */
57 void prepare(DefaultFileSystemManager manager) throws Exception;
58
59 }