| /* |
| * Licensed to the Apache Software Foundation (ASF) under one or more |
| * contributor license agreements. See the NOTICE file distributed with |
| * this work for additional information regarding copyright ownership. |
| * The ASF licenses this file to You under the Apache License, Version 2.0 |
| * (the "License"); you may not use this file except in compliance with |
| * the License. You may obtain a copy of the License at |
| * |
| * http://www.apache.org/licenses/LICENSE-2.0 |
| * |
| * Unless required by applicable law or agreed to in writing, software |
| * distributed under the License is distributed on an "AS IS" BASIS, |
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| * See the License for the specific language governing permissions and |
| * limitations under the License. |
| */ |
| package org.apache.commons.vfs2.provider; |
| |
| import java.util.Arrays; |
| import java.util.Map; |
| import java.util.TreeMap; |
| |
| import org.apache.commons.vfs2.FileName; |
| import org.apache.commons.vfs2.FileObject; |
| import org.apache.commons.vfs2.FileSystem; |
| import org.apache.commons.vfs2.FileSystemConfigBuilder; |
| import org.apache.commons.vfs2.FileSystemException; |
| import org.apache.commons.vfs2.FileSystemOptions; |
| import org.apache.commons.vfs2.provider.local.GenericFileNameParser; |
| |
| /** |
| * A partial {@link FileProvider} implementation. Takes care of managing the file systems created by the provider. |
| */ |
| public abstract class AbstractFileProvider extends AbstractVfsContainer implements FileProvider { |
| private static final AbstractFileSystem[] EMPTY_ABSTRACTFILESYSTEMS = new AbstractFileSystem[0]; |
| |
| /** |
| * The cached file systems. |
| * <p> |
| * This is a mapping from {@link FileSystemKey} (root URI and options) to {@link FileSystem}. |
| * </p> |
| */ |
| private final Map<FileSystemKey, FileSystem> fileSystems = new TreeMap<>(); // @GuardedBy("self") |
| |
| private FileNameParser parser; |
| |
| public AbstractFileProvider() { |
| parser = GenericFileNameParser.getInstance(); |
| } |
| |
| protected FileNameParser getFileNameParser() { |
| return parser; |
| } |
| |
| protected void setFileNameParser(final FileNameParser parser) { |
| this.parser = parser; |
| } |
| |
| /** |
| * Closes the file systems created by this provider. |
| */ |
| @Override |
| public void close() { |
| synchronized (fileSystems) { |
| fileSystems.clear(); |
| } |
| super.close(); |
| } |
| |
| /** |
| * Creates a layered file system. This method throws a 'not supported' exception. |
| * |
| * @param scheme The protocol to use to access the file. |
| * @param file a FileObject. |
| * @param fileSystemOptions Options to the file system. |
| * @return A FileObject associated with the new FileSystem. |
| * @throws FileSystemException if an error occurs. |
| */ |
| @Override |
| public FileObject createFileSystem(final String scheme, final FileObject file, |
| final FileSystemOptions fileSystemOptions) throws FileSystemException { |
| // Can't create a layered file system |
| throw new FileSystemException("vfs.provider/not-layered-fs.error", scheme); |
| } |
| |
| /** |
| * Adds a file system to those cached by this provider. |
| * <p> |
| * The file system may implement {@link VfsComponent}, in which case it is initialised. |
| * </p> |
| * |
| * @param key The root file of the file system, part of the cache key. |
| * @param fs the file system to add. |
| * @throws FileSystemException if any error occurs. |
| */ |
| protected void addFileSystem(final Comparable<?> key, final FileSystem fs) throws FileSystemException { |
| // Add to the container and initialize |
| addComponent(fs); |
| |
| final FileSystemKey treeKey = new FileSystemKey(key, fs.getFileSystemOptions()); |
| ((AbstractFileSystem) fs).setCacheKey(treeKey); |
| |
| synchronized (fileSystems) { |
| fileSystems.put(treeKey, fs); |
| } |
| } |
| |
| /** |
| * Locates a cached file system. |
| * |
| * @param key The root file of the file system, part of the cache key. |
| * @param fileSystemOptions file system options the file system instance must have. |
| * @return The file system instance, or null if it is not cached. |
| */ |
| protected FileSystem findFileSystem(final Comparable<?> key, final FileSystemOptions fileSystemOptions) { |
| final FileSystemKey treeKey = new FileSystemKey(key, fileSystemOptions); |
| |
| synchronized (fileSystems) { |
| return fileSystems.get(treeKey); |
| } |
| } |
| |
| /** |
| * Returns the FileSystemConfigBuidler. |
| * |
| * @return the FileSystemConfigBuilder. |
| */ |
| @Override |
| public FileSystemConfigBuilder getConfigBuilder() { |
| return null; |
| } |
| |
| /** |
| * Free unused resources. |
| */ |
| public void freeUnusedResources() { |
| AbstractFileSystem[] abstractFileSystems; |
| synchronized (fileSystems) { |
| // create snapshot under lock |
| abstractFileSystems = fileSystems.values().toArray(EMPTY_ABSTRACTFILESYSTEMS); |
| } |
| |
| // process snapshot outside lock |
| Arrays.stream(abstractFileSystems).filter(AbstractFileSystem::isReleaseable) |
| .forEach(AbstractFileSystem::closeCommunicationLink); |
| } |
| |
| /** |
| * Close the FileSystem. |
| * |
| * @param fileSystem The FileSystem to close. |
| */ |
| public void closeFileSystem(final FileSystem fileSystem) { |
| final AbstractFileSystem fs = (AbstractFileSystem) fileSystem; |
| |
| final FileSystemKey key = fs.getCacheKey(); |
| if (key != null) { |
| synchronized (fileSystems) { |
| fileSystems.remove(key); |
| } |
| } |
| |
| removeComponent(fs); |
| fs.close(); |
| } |
| |
| /** |
| * Parses an absolute URI. |
| * |
| * @param base The base file - if null the {@code uri} needs to be absolute |
| * @param uri The URI to parse. |
| * @return The FileName. |
| * @throws FileSystemException if an error occurs. |
| */ |
| @Override |
| public FileName parseUri(final FileName base, final String uri) throws FileSystemException { |
| if (getFileNameParser() != null) { |
| return getFileNameParser().parseUri(getContext(), base, uri); |
| } |
| |
| throw new FileSystemException("vfs.provider/filename-parser-missing.error"); |
| } |
| } |