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.tar;
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.FileSystemException;
028import org.apache.commons.vfs2.FileSystemOptions;
029import org.apache.commons.vfs2.FileType;
030import org.apache.commons.vfs2.provider.AbstractFileName;
031import org.apache.commons.vfs2.provider.AbstractLayeredFileProvider;
032import org.apache.commons.vfs2.provider.LayeredFileName;
033
034/**
035 * A file system provider for Tar files. Provides read-only file systems.
036 */
037public class TarFileProvider extends AbstractLayeredFileProvider {
038
039    /** The provider's capabilities */
040    protected static final Collection<Capability> capabilities = Collections
041            .unmodifiableCollection(Arrays.asList(Capability.GET_LAST_MODIFIED, Capability.GET_TYPE, Capability.LIST_CHILDREN,
042                    Capability.READ_CONTENT, Capability.URI, Capability.VIRTUAL));
043
044    /**
045     * Constructs a new instance.
046     */
047    public TarFileProvider() {
048    }
049
050    /**
051     * Creates a layered file system. This method is called if the file system is not cached.
052     *
053     * @param scheme The URI scheme.
054     * @param file The file to create the file system on top of.
055     * @return The file system.
056     */
057    @Override
058    protected FileSystem doCreateFileSystem(final String scheme, final FileObject file,
059            final FileSystemOptions fileSystemOptions) throws FileSystemException {
060        final AbstractFileName rootName = new LayeredFileName(scheme, file.getName(), FileName.ROOT_PATH,
061                FileType.FOLDER);
062        return new TarFileSystem(rootName, file, fileSystemOptions);
063    }
064
065    @Override
066    public Collection<Capability> getCapabilities() {
067        return capabilities;
068    }
069}