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.vfs.test;
18  
19  import org.apache.commons.vfs.FileObject;
20  import org.apache.commons.vfs.FileSystemManager;
21  import org.apache.commons.vfs.FilesCache;
22  import org.apache.commons.vfs.impl.DefaultFileSystemManager;
23  
24  /***
25   * Test configuration for a file system.
26   *
27   * @author <a href="mailto:adammurdoch@apache.org">Adam Murdoch</a>
28   * @version $Revision: 480428 $ $Date: 2006-11-29 07:15:24 +0100 (Mi, 29 Nov 2006) $
29   */
30  public interface ProviderTestConfig
31  {
32      /***
33       * Prepares the file system manager.
34       */
35      void prepare(DefaultFileSystemManager manager) throws Exception;
36  
37      /***
38       * Returns the base folder for tests.  This folder must exist, and contain
39       * the following structure:
40       * <ul>
41       * <li>/read-tests
42       * <li>/write-tests
43       * </ul>
44       */
45      FileObject getBaseTestFolder(FileSystemManager manager) throws Exception;
46  
47      /***
48       * Returns the filesCache implementation used for tests.
49       */
50      FilesCache getFilesCache();
51  }