Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance. Project price only 1 $
You can buy this project and download/modify it how often you want.
/*
* JBoss, Home of Professional Open Source
* Copyright 2009, JBoss Inc., and individual contributors as indicated
* by the @authors tag.
*
* Licensed 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.jboss.vfs.spi;
import java.io.Closeable;
import java.io.File;
import java.io.IOException;
import java.io.InputStream;
import java.net.URI;
import java.net.URISyntaxException;
import java.security.CodeSigner;
import java.util.List;
import org.jboss.vfs.VirtualFile;
/**
* A file system which is mounted in to the VFS. This is the driver class for a given virtual file system type. An
* instance of {@code FileSystem} will be mounted at some point on a VFS. The specific instance is only called when a
* file from this filesystem is called upon. The path components passed in to the operations are canonical, with no "."
* or ".." components.
*
* @author David M. Lloyd
*/
public interface FileSystem extends Closeable {
/**
* Get a real {@code File} for the given path within this filesystem. Some filesystem types will need to make a copy
* in order to return this file; such copies should be cached and retained until the filesystem is closed. Depending
* on the file type, the real path of the returned {@code File} may or may not bear a relationship to the virtual
* path provided; if such a relationship is required, it must be negotiated at the time the filesystem is mounted.
*
* @param mountPoint the mount point of the filesystem instance (guaranteed to be a parent of {@code target})
* @param target the virtual file to act upon
* @return the file instance
* @throws IOException if an I/O error occurs
*/
File getFile(VirtualFile mountPoint, VirtualFile target) throws IOException;
/**
* Open an input stream for the file at the given relative path.
*
* @param mountPoint the mount point of the filesystem instance (guaranteed to be a parent of {@code target})
* @param target the virtual file to act upon
* @return the input stream
* @throws IOException if an I/O error occurs
*/
InputStream openInputStream(VirtualFile mountPoint, VirtualFile target) throws IOException;
/**
* Determine whether this filesystem is read-only. A read-only filesystem prohibits file modification or deletion.
* It is not an error to mount a read-write filesystem within a read-only filesystem however (this operation does not
* take place within the {@code FileSystem} implementation).
*
* @return {@code true} if the filesystem is read-only
*/
boolean isReadOnly();
/**
* Attempt to delete a virtual file within this filesystem.
*
* @param mountPoint the mount point of the filesystem instance (guaranteed to be a parent of {@code target})
* @param target the virtual file to act upon
* @return {@code true} if the file was deleted, {@code false} if it failed for any reason
*/
boolean delete(VirtualFile mountPoint, VirtualFile target);
/**
* Get the size of a virtual file within this filesystem.
*
* @param mountPoint the mount point of the filesystem instance (guaranteed to be a parent of {@code target})
* @param target the virtual file to act upon
* @return the size, in bytes, or 0L if the file does not exist or is a directory
*/
long getSize(VirtualFile mountPoint, VirtualFile target);
/**
* Get the last modification time of a virtual file within this filesystem.
*
* @param mountPoint the mount point of the filesystem instance (guaranteed to be a parent of {@code target})
* @param target the virtual file to act upon
* @return the modification time in milliseconds, or 0L if the file does not exist or if an error occurs
*/
long getLastModified(VirtualFile mountPoint, VirtualFile target);
/**
* Ascertain the existance of a virtual file within this filesystem.
*
* @param mountPoint the mount point of the filesystem instance (guaranteed to be a parent of {@code target})
* @param target the virtual file to act upon
* @return {@code true} if the file exists, {@code false} otherwise
* @throws IOException if an I/O error occurs
*/
boolean exists(VirtualFile mountPoint, VirtualFile target);
/**
* Ascertain whether a virtual file within this filesystem is a plain file.
*
* @param mountPoint the mount point of the filesystem instance (guaranteed to be a parent of {@code target})
* @param target the virtual file to act upon
* @return {@code true} if the file exists and is a plain file, {@code false} otherwise
*/
boolean isFile(VirtualFile mountPoint, VirtualFile target);
/**
* Ascertain whether a virtual file within this filesystem is a directory.
*
* @param mountPoint the mount point of the filesystem instance (guaranteed to be a parent of {@code target})
* @param target the virtual file to act upon
* @return {@code true} if the file exists and is a directory, {@code false} otherwise
*/
boolean isDirectory(VirtualFile mountPoint, VirtualFile target);
/**
* Read a directory. Returns all the simple path names (excluding "." and ".."). The returned list will be empty if
* the node is not a directory.
*
* @param mountPoint the mount point of the filesystem instance (guaranteed to be a parent of {@code target})
* @param target the virtual file to act upon
* @return the collection of children names
*/
List getDirectoryEntries(VirtualFile mountPoint, VirtualFile target);
/**
* Get the {@link CodeSigner}s for a the virtual file.
*
* @param mountPoint the mount point of the filesystem instance (guaranteed to be a parent of {@code target})
* @param target the virtual file to act upon
* @return {@link CodeSigner} for the virtual file or null if not signed.
*/
CodeSigner[] getCodeSigners(VirtualFile mountPoint, VirtualFile target);
/**
* Destroy this filesystem instance. After this method is called, the filesystem may not be used in any way. This
* method should be called only after all mounts of this filesystem have been cleared; otherwise, VFS accesses may
* result in {@code IOException}s.
*
* @throws IOException if an I/O error occurs during close
*/
void close() throws IOException;
/**
* Get the {@link java.io.File} source provided at mount time.
*
* @return the source used for mounting
*/
File getMountSource();
/**
* Get the root URI for this file system, or {@code null} if there is no valid root URI.
*
* @return the root URI
* @throws URISyntaxException if the URI isn't valid
*/
URI getRootURI() throws URISyntaxException;
}
