org.apache.commons.vfs2.provider.tar

Class TarFileSystem

java.lang.Object

org.apache.commons.vfs2.provider.AbstractVfsComponent

org.apache.commons.vfs2.provider.AbstractFileSystem

org.apache.commons.vfs2.provider.tar.TarFileSystem

All Implemented Interfaces:

FileSystem, VfsComponent

public class TarFileSystem
extends AbstractFileSystem

A read-only file system for Tar files.

Field Summary

Fields

Modifier and Type	Field and Description
private static int	DEFAULT_INDEX_SIZE
private java.io.File	file
private static org.apache.commons.logging.Log	LOG
private org.apache.commons.compress.archivers.tar.TarArchiveInputStream	tarFile

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	TarFileSystem(AbstractFileName rootName, FileObject parentLayer, FileSystemOptions fileSystemOptions)

Method Summary

Modifier and Type	Method and Description
protected void	addCapabilities(java.util.Collection<Capability> caps) Returns the capabilities of this file system.
protected FileObject	createFile(AbstractFileName name) Creates a file object.
protected org.apache.commons.compress.archivers.tar.TarArchiveInputStream	createTarFile(java.io.File file)
protected TarFileObject	createTarFileObject(AbstractFileName name, org.apache.commons.compress.archivers.tar.TarArchiveEntry entry)
protected void	doCloseCommunicationLink() Closes the underlying link used to access the files.
java.io.InputStream	getInputStream(org.apache.commons.compress.archivers.tar.TarArchiveEntry entry)
protected org.apache.commons.compress.archivers.tar.TarArchiveInputStream	getTarFile()
void	init() Initializes this component.
private void	recreateTarFile()
protected void	resetTarFile()

Methods inherited from class org.apache.commons.vfs2.provider.AbstractFileSystem

addJunction, addListener, close, closeCommunicationLink, decorateFileObject, doReplicateFile, fireFileChanged, fireFileCreated, fireFileDeleted, getAttribute, getFileFromCache, getFileSystemManager, getFileSystemOptions, getLastModTimeAccuracy, getParentLayer, getRoot, getRootName, getRootURI, hasCapability, isOpen, isReleaseable, notifyAllStreamsClosed, putFileToCache, removeFileFromCache, removeJunction, removeListener, replicateFile, resolveFile, resolveFile, setAttribute

Methods inherited from class org.apache.commons.vfs2.provider.AbstractVfsComponent

getContext, getLogger, setContext, setLogger

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEFAULT_INDEX_SIZE

private static final int DEFAULT_INDEX_SIZE

See Also:

Constant Field Values

LOG

private static final org.apache.commons.logging.Log LOG

file

private final java.io.File file

tarFile

private org.apache.commons.compress.archivers.tar.TarArchiveInputStream tarFile

Constructor Detail

TarFileSystem

protected TarFileSystem(AbstractFileName rootName,
                        FileObject parentLayer,
                        FileSystemOptions fileSystemOptions)
                 throws FileSystemException

Throws:

FileSystemException

Method Detail

init

public void init()
          throws FileSystemException

Description copied from class: AbstractFileSystem

Initializes this component.

Specified by:

init in interface VfsComponent

Overrides:

init in class AbstractFileSystem

Throws:

FileSystemException - if an error occurs.

getInputStream

public java.io.InputStream getInputStream(org.apache.commons.compress.archivers.tar.TarArchiveEntry entry)
                                   throws FileSystemException

Throws:

FileSystemException

resetTarFile

protected void resetTarFile()
                     throws FileSystemException

Throws:

FileSystemException

recreateTarFile

private void recreateTarFile()
                      throws FileSystemException

Throws:

FileSystemException

getTarFile

protected org.apache.commons.compress.archivers.tar.TarArchiveInputStream getTarFile()
                                                                              throws FileSystemException

Throws:

FileSystemException

createTarFileObject

protected TarFileObject createTarFileObject(AbstractFileName name,
                                            org.apache.commons.compress.archivers.tar.TarArchiveEntry entry)
                                     throws FileSystemException

Throws:

FileSystemException

createTarFile

protected org.apache.commons.compress.archivers.tar.TarArchiveInputStream createTarFile(java.io.File file)
                                                                                 throws FileSystemException

Throws:

FileSystemException

doCloseCommunicationLink

protected void doCloseCommunicationLink()

Description copied from class: AbstractFileSystem

Closes the underlying link used to access the files.

Overrides:

doCloseCommunicationLink in class AbstractFileSystem

addCapabilities

protected void addCapabilities(java.util.Collection<Capability> caps)

Returns the capabilities of this file system.

Specified by:

addCapabilities in class AbstractFileSystem

Parameters:

caps - collections of Capabilities, can be immutable.

createFile

protected FileObject createFile(AbstractFileName name)
                         throws FileSystemException

Creates a file object.

Specified by:

createFile in class AbstractFileSystem

Parameters:

name - name referencing the new file.

Returns:

new created FileObject.

Throws:

FileSystemException