Package 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:

Closeable, AutoCloseable, FileSystem, VfsComponent

public class TarFileSystem
extends AbstractFileSystem

A read-only file system for Tar files.

Field Summary

Fields

Modifier and Type	Field	Description
private final Map<FileName,FileObject>	cache	Cache doesn't need to be synchronized since it is read-only.
private static final char[]	ENC
private final File	file
private static final org.apache.commons.logging.Log	LOG
private org.apache.commons.compress.archivers.tar.TarArchiveInputStream	tarFile

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	TarFileSystem(AbstractFileName rootName, FileObject parentLayer, FileSystemOptions fileSystemOptions)	Constructs a new instance.

Method Summary

Modifier and Type	Method	Description
protected void	addCapabilities(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(File file)	Creates a new TarArchiveInputStream.
protected TarFileObject	createTarFileObject(AbstractFileName fileName, org.apache.commons.compress.archivers.tar.TarArchiveEntry entry)	Creates a new TarFileObject.
protected void	doCloseCommunicationLink()	Closes the underlying link used to access the files.
protected FileObject	getFileFromCache(FileName name)	Returns a cached file.
InputStream	getInputStream(org.apache.commons.compress.archivers.tar.TarArchiveEntry entry)	Returns the input stream for the given entry.
protected org.apache.commons.compress.archivers.tar.TarArchiveInputStream	getTarFile()	Gets the TarArchiveInputStream.
void	init()	Initializes this component.
protected void	putFileToCache(FileObject file)	Adds a file object to the cache.
private void	recreateTarFile()	will be called after all file-objects closed their streams.
protected void	removeFileFromCache(FileName name)	remove a cached file.
protected void	resetTarFile()	Resets the tar file.

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

addJunction, addListener, close, closeCommunicationLink, decorateFileObject, doReplicateFile, fireFileChanged, fireFileCreated, fireFileDeleted, getAttribute, getFileSystemManager, getFileSystemOptions, getLastModTimeAccuracy, getParentLayer, getRoot, getRootName, getRootURI, hasCapability, isOpen, isReleaseable, notifyAllStreamsClosed, 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 Details

LOG

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

ENC

private static final char[] ENC

file

private final File file

tarFile

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

cache

private final Map<FileName,FileObject> cache

Cache doesn't need to be synchronized since it is read-only.

Constructor Details

TarFileSystem

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

Constructs a new instance.

Parameters:

rootName - The root file name of this file system.

parentLayer - The parent layer of this file system.

fileSystemOptions - Options to build this file system.

Throws:

FileSystemException - if a file system error occurs.

Method Details

addCapabilities

protected void addCapabilities(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

createTarFile

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

Creates a new TarArchiveInputStream.

Parameters:

file - the file.

Returns:

a new TarArchiveInputStream.

Throws:

FileSystemException - if a file system error occurs.

createTarFileObject

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

Creates a new TarFileObject.

Parameters:

fileName - the file name.

entry - the archive entry.

Returns:

a new TarFileObject.

doCloseCommunicationLink

protected void doCloseCommunicationLink()

Description copied from class: AbstractFileSystem

Closes the underlying link used to access the files.

Overrides:

doCloseCommunicationLink in class AbstractFileSystem

getFileFromCache

protected FileObject getFileFromCache(FileName name)

Returns a cached file.

Overrides:

getFileFromCache in class AbstractFileSystem

Parameters:

name - name to search for.

Returns:

file object or null if not found.

getInputStream

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

Returns the input stream for the given entry.

Parameters:

entry - The entry to seek.

Returns:

the input stream for the given entry.

Throws:

FileSystemException - If an I/O error occurs.

getTarFile

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

Gets the TarArchiveInputStream.

Returns:

the TarArchiveInputStream.

Throws:

FileSystemException - if a file system error occurs.

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.

putFileToCache

protected void putFileToCache(FileObject file)

Adds a file object to the cache.

Overrides:

putFileToCache in class AbstractFileSystem

Parameters:

file - the file to add.

recreateTarFile

private void recreateTarFile()
                      throws FileSystemException

will be called after all file-objects closed their streams. protected void notifyAllStreamsClosed() { closeCommunicationLink(); }

Throws:

FileSystemException

removeFileFromCache

protected void removeFileFromCache(FileName name)

remove a cached file.

Overrides:

removeFileFromCache in class AbstractFileSystem

Parameters:

name - The file name to remove.

resetTarFile

protected void resetTarFile()
                     throws FileSystemException

Resets the tar file.

Throws:

FileSystemException - if a file system error occurs.