org.apache.commons.vfs2.provider

Interface VfsComponent

All Superinterfaces:

AutoCloseable, Closeable

All Known Implementing Classes:

AbstractFileProvider, AbstractFilesCache, AbstractFileSystem, AbstractLayeredFileProvider, AbstractOriginatingFileProvider, AbstractVfsComponent, AbstractVfsContainer, Bzip2FileProvider, Bzip2FileSystem, CompositeFileProvider, CompressedFileFileProvider, CompressedFileFileSystem, DefaultFileReplicator, DefaultFilesCache, DefaultLocalFileProvider, FtpFileProvider, FtpFileSystem, FtpsFileProvider, FtpsFileSystem, GzipFileProvider, GzipFileSystem, HdfsFileProvider, HdfsFileSystem, Http4FileProvider, Http4FileSystem, Http4sFileProvider, Http5FileProvider, Http5FileSystem, Http5sFileProvider, HttpFileProvider, HttpFileSystem, HttpsFileProvider, JarFileProvider, JarFileSystem, LocalFileSystem, LRUFilesCache, NullFilesCache, PrivilegedFileReplicator, RamFileProvider, RamFileSystem, ResourceFileProvider, SftpFileProvider, SftpFileSystem, SoftRefFilesCache, TarFileProvider, TarFileSystem, Tbz2FileProvider, TemporaryFileProvider, TgzFileProvider, UrlFileProvider, UrlFileSystem, VirtualFileProvider, VirtualFileSystem, WeakRefFilesCache, ZipFileProvider, ZipFileSystem

public interface VfsComponent
extends Closeable

This interface is used to manage the lifecycle of all VFS components. This includes all implementations of the following interfaces:

• FileProvider
• FileSystem
• FileReplicator
• TemporaryFileStore

Method Summary

Modifier and Type	Method and Description
void	close() Closes the component.
void	init() Initializes the component.
void	setContext(VfsComponentContext context) Sets the context for the component.
void	setLogger(org.apache.commons.logging.Log logger) Sets the Logger to use for the component.

Method Detail

setLogger

void setLogger(org.apache.commons.logging.Log logger)

Sets the Logger to use for the component.

Parameters:

logger - The Log

setContext

void setContext(VfsComponentContext context)

Sets the context for the component.

Parameters:

context - The context.

init

void init()
   throws FileSystemException

Initializes the component.

Throws:

FileSystemException - if an error occurs.

close

void close()

Closes the component.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable