View Javadoc

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.provider.tar;
18  
19  import org.apache.commons.vfs.Capability;
20  import org.apache.commons.vfs.FileName;
21  import org.apache.commons.vfs.FileObject;
22  import org.apache.commons.vfs.FileSystem;
23  import org.apache.commons.vfs.FileSystemException;
24  import org.apache.commons.vfs.FileSystemOptions;
25  import org.apache.commons.vfs.FileType;
26  import org.apache.commons.vfs.provider.AbstractLayeredFileProvider;
27  import org.apache.commons.vfs.provider.FileProvider;
28  import org.apache.commons.vfs.provider.LayeredFileName;
29  
30  import java.util.Arrays;
31  import java.util.Collection;
32  import java.util.Collections;
33  
34  /***
35   * A file system provider for Tar files.  Provides read-only file systems.
36   */
37  public class TarFileProvider
38      extends AbstractLayeredFileProvider
39      implements FileProvider
40  {
41      protected final static Collection capabilities = Collections.unmodifiableCollection(Arrays.asList(new Capability[]
42          {
43              Capability.GET_LAST_MODIFIED,
44              Capability.GET_TYPE,
45              Capability.LIST_CHILDREN,
46              Capability.READ_CONTENT,
47              Capability.URI,
48              Capability.VIRTUAL
49          }));
50  
51      public TarFileProvider()
52      {
53          super();
54      }
55  
56      /***
57       * Creates a layered file system.  This method is called if the file system
58       * is not cached.
59       *
60       * @param scheme The URI scheme.
61       * @param file   The file to create the file system on top of.
62       * @return The file system.
63       */
64      protected FileSystem doCreateFileSystem(final String scheme,
65                                              final FileObject file,
66                                              final FileSystemOptions fileSystemOptions)
67          throws FileSystemException
68      {
69          final FileName rootName =
70              new LayeredFileName(scheme, file.getName(), FileName.ROOT_PATH, FileType.FOLDER);
71          return new TarFileSystem(rootName, file, fileSystemOptions);
72      }
73  
74      public Collection getCapabilities()
75      {
76          return capabilities;
77      }
78  }