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.zip;
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.FileSystemConfigBuilder;
28  import org.apache.commons.vfs2.FileSystemException;
29  import org.apache.commons.vfs2.FileSystemOptions;
30  import org.apache.commons.vfs2.FileType;
31  import org.apache.commons.vfs2.provider.AbstractFileName;
32  import org.apache.commons.vfs2.provider.AbstractLayeredFileProvider;
33  import org.apache.commons.vfs2.provider.LayeredFileName;
34  
35  /**
36   * A file system provider for ZIP files. Provides read-only file systems.
37   */
38  public class ZipFileProvider extends AbstractLayeredFileProvider {
39  
40      /** The list of capabilities this provider supports */
41      protected static final Collection<Capability> capabilities = Collections.unmodifiableCollection(Arrays.asList(Capability.GET_LAST_MODIFIED, Capability.GET_TYPE, Capability.LIST_CHILDREN, Capability.READ_CONTENT,
42              Capability.URI, Capability.COMPRESS, Capability.VIRTUAL));
43  
44      public ZipFileProvider() {
45          super();
46      }
47  
48      /**
49       * Creates a layered file system. This method is called if the file system is
50       * not cached.
51       *
52       * @param scheme The URI scheme.
53       * @param file   The file to create the file system on top of.
54       * @return The file system.
55       */
56      @Override
57      protected FileSystem doCreateFileSystem(final String scheme, final FileObject file,
58              final FileSystemOptions fileSystemOptions) throws FileSystemException {
59          final AbstractFileName rootName = new LayeredFileName(scheme, file.getName(), FileName.ROOT_PATH,
60                  FileType.FOLDER);
61          return new ZipFileSystem(rootName, file, fileSystemOptions);
62      }
63  
64      @Override
65      public Collection<Capability> getCapabilities() {
66          return capabilities;
67      }
68  
69      /**
70       * Return config builder.
71       *
72       * @return A config builder for ZipFileProvider.
73       * @see org.apache.commons.vfs2.provider.AbstractFileProvider#getConfigBuilder()
74       */
75      @Override
76      public FileSystemConfigBuilder getConfigBuilder() {
77          return ZipFileSystemConfigBuilder.getInstance();
78      }
79  }