001/*
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements.  See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache License, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License.  You may obtain a copy of the License at
008 *
009 *      http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017package org.apache.commons.vfs2.provider.zip;
018
019import java.util.Arrays;
020import java.util.Collection;
021import java.util.Collections;
022
023import org.apache.commons.vfs2.Capability;
024import org.apache.commons.vfs2.FileName;
025import org.apache.commons.vfs2.FileObject;
026import org.apache.commons.vfs2.FileSystem;
027import org.apache.commons.vfs2.FileSystemConfigBuilder;
028import org.apache.commons.vfs2.FileSystemException;
029import org.apache.commons.vfs2.FileSystemOptions;
030import org.apache.commons.vfs2.FileType;
031import org.apache.commons.vfs2.provider.AbstractFileName;
032import org.apache.commons.vfs2.provider.AbstractLayeredFileProvider;
033import org.apache.commons.vfs2.provider.LayeredFileName;
034
035/**
036 * A file system provider for ZIP files. Provides read-only file systems.
037 */
038public class ZipFileProvider extends AbstractLayeredFileProvider {
039
040    /** The list of capabilities this provider supports */
041    protected static final Collection<Capability> capabilities = Collections.unmodifiableCollection(Arrays.asList(Capability.GET_LAST_MODIFIED,
042        Capability.GET_TYPE, Capability.LIST_CHILDREN, Capability.READ_CONTENT, Capability.URI, Capability.COMPRESS, Capability.VIRTUAL));
043
044    /**
045     * Constructs a new instance.
046     */
047    public ZipFileProvider() {
048    }
049
050    /**
051     * Creates a layered file system. This method is called if the file system is
052     * not cached.
053     *
054     * @param scheme The URI scheme.
055     * @param file   The file to create the file system on top of.
056     * @return The file system.
057     */
058    @Override
059    protected FileSystem doCreateFileSystem(final String scheme, final FileObject file,
060            final FileSystemOptions fileSystemOptions) throws FileSystemException {
061        final AbstractFileName rootName = new LayeredFileName(scheme, file.getName(), FileName.ROOT_PATH,
062                FileType.FOLDER);
063        return new ZipFileSystem(rootName, file, fileSystemOptions);
064    }
065
066    @Override
067    public Collection<Capability> getCapabilities() {
068        return capabilities;
069    }
070
071    /**
072     * Gets config builder.
073     *
074     * @return A config builder for ZipFileProvider.
075     * @see org.apache.commons.vfs2.provider.AbstractFileProvider#getConfigBuilder()
076     */
077    @Override
078    public FileSystemConfigBuilder getConfigBuilder() {
079        return ZipFileSystemConfigBuilder.getInstance();
080    }
081}