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