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.zip;
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 Zip files.  Provides read-only file systems.
36   *
37   * @author <a href="mailto:adammurdoch@apache.org">Adam Murdoch</a>
38   * @version $Revision: 480428 $ $Date: 2006-11-29 07:15:24 +0100 (Mi, 29 Nov 2006) $
39   */
40  public class ZipFileProvider
41      extends AbstractLayeredFileProvider
42      implements FileProvider
43  {
44      protected final static Collection capabilities = Collections.unmodifiableCollection(Arrays.asList(new Capability[]
45          {
46              Capability.GET_LAST_MODIFIED,
47              Capability.GET_TYPE,
48              Capability.LIST_CHILDREN,
49              Capability.READ_CONTENT,
50              Capability.URI,
51              Capability.COMPRESS,
52              Capability.VIRTUAL
53          }));
54  
55      public ZipFileProvider()
56      {
57          super();
58      }
59  
60      /***
61       * Creates a layered file system.  This method is called if the file system
62       * is not cached.
63       *
64       * @param scheme The URI scheme.
65       * @param file   The file to create the file system on top of.
66       * @return The file system.
67       */
68      protected FileSystem doCreateFileSystem(final String scheme,
69                                              final FileObject file,
70                                              final FileSystemOptions fileSystemOptions)
71          throws FileSystemException
72      {
73          final FileName rootName =
74              new LayeredFileName(scheme, file.getName(), FileName.ROOT_PATH, FileType.FOLDER);
75          return new ZipFileSystem(rootName, file, fileSystemOptions);
76      }
77  
78      public Collection getCapabilities()
79      {
80          return capabilities;
81      }
82  }