Package com.caucho.vfs

Resin's Virtual File System.

See: Description

Interface Summary

Interface	Description
Dependency	Interface representing a resource that might change.
EnclosedWriteStream
FlushBuffer	Interface if a writer supports the flushBuffer().
LockableStream
Path.FileChannelFactory
PersistentDependency	Interface representing a resource that might change.
SendfileOutputStream	An OutputStream which supports sendfile and mmap.
SSLFactory	Abstract socket to handle both normal sockets and bin/resin sockets.
TempStreamApi
VfsWriteObject

Class Summary

Class	Description
AbstractByteToChar	Utility class for converting a byte stream to a character stream.
AbstractPrintWriter	An abstract print writer.
BasicDependencyContainer	Contains a set of dependencies.
BufferedReaderAdapter	Trivial adapter so readers and input streams can be used in the same servlet.
ByteToChar	Utility class for converting a byte stream to a character stream.
ByteToCharWriter	Utility class for converting a byte stream to a character stream.
CaseInsensitive	Configuration for CaseInsensitive environments.
ClasspathPath	The classpath scheme.
ConfigPath	ConfigPath implements remote configuration scheme.
ConstPath
ContextLoaderObjectInputStream	Object input stream which loads based on the context class loader.
Crc64InputStream
Crc64OutputStream
Crc64Stream
DatagramStream	Specialized stream to handle sockets.
DatastoreBlock
DatastoreFile
DatastoreInputStream
DatastoreOutputStream
DatastorePath
DatastoreRandomAccessFile
DatastoreRandomAccessInputStream
DatastoreRandomAccessOutputStream
DatastoreRandomAccessStream	Reads from a file in a random-access fashion.
DatastoreReadStream	Stream encapsulating FileInputStream
DatastoreWriteStream	Stream encapsulating FileOutputStream
Depend	Class for keeping track of modifications.
EMF
Encoding	Converts between the mime encoding names and Java encoding names.
FilePath	FilePath implements the native filesystem.
FileRandomAccessStream	Reads from a file in a random-access fashion.
FileReadStream	Stream encapsulating FileInputStream
FileStatus
FilesystemPath	Abstract FilesystemPath, the parent of hierarchical Paths like FilePath or HttpPath.
FileWriteStream	Stream encapsulating FileOutputStream
GoogleBlobStorePath
GoogleInode	Inode representing the meta-data of the GS file.
GoogleInodeService
GoogleLock
GoogleMergePath	Represents the root merged path for Google.
GooglePath	FilePath implements the native filesystem.
GoogleStoreLockService
GoogleStorePath
GzipStream	Underlying stream handling HTTP requests.
HttpPath	The HTTP scheme.
HttpsPath	The HTTP scheme.
HttpStreamWrapper	Facade to HttpStream to properly handle the close.
InetAddressUtil	Abstract socket to handle both normal sockets and bin/resin sockets.
InputStreamSource	Stream source for Hessian serialization of large data
InputStreamStream
Jar	Jar is a cache around a jar file to avoid scanning through the whole file on each request.
JarPath	A filesystem for .jar files.
JarScheme	JarScheme implements the lookup of the jar scheme.
JndiPath	Adapts the JNDI to the Path API.
JniFilePath	FilePath implements the native filesystem.
JniFilePathImpl	FilePath implements the native filesystem.
JniFileStream	Stream using with JNI.
JniMemoryMappedCopy	Stream using with JNI.
JniMemoryMappedFile	Stream using with JNI.
JniRandomAccessFile	Stream using with JNI.
JniServerSocketImpl	Abstract socket to handle both normal sockets and bin/resin sockets.
JniSharedMemory	Stream using with JNI.
JniSocketImpl	Abstract socket to handle both normal sockets and bin/resin sockets.
JniStream	Stream using with JNI.
JsseSSLFactory	Abstract socket to handle both normal sockets and bin/resin sockets.
MailtoPath	The mailto: scheme sends mail using the SMTP protocol.
MemoryPath
MemoryScheme
MemoryStream
MergePath	A merging of several Paths used like a CLASSPATH.
MultipartStream
NotFoundPath	Always returns FileNotFound for any open attempt.
NullPath
NullWriteStream	A WriteStream that writes to nothing.
OldByteToChar	Utility class for converting a byte stream to a character stream.
OpenSSLFactory	Abstract socket to handle both normal sockets and bin/resin sockets.
OutputStreamWithBuffer	An OutputStream with an accessible buffer.
Path	A virtual filesystem path, essentially represented by a URL.
PathExistsDependency	Class for keeping track of modifications.
PathWrapper	Wraps a path object.
PipeStream	Stream allowing two threads to read and write to each other.
PrintWriterImpl	A print writer which allows for a changing writer.
QJniServerSocket	Abstract socket to handle both normal sockets and bin/resin sockets.
QServerSocket	Abstract socket to handle both normal sockets and bin/resin sockets.
QServerSocketWrapper	Abstract socket to handle both normal sockets and bin/resin sockets.
QSocket	Abstract socket to handle both normal sockets and JNI sockets.
QSocketChannelWrapper	Abstract socket to handle both normal sockets and bin/resin sockets.
QSocketWrapper	Abstract socket to handle both normal sockets and bin/resin sockets.
RandomAccessStream	Reads from a file in a random-access fashion.
ReaderStream
ReaderWriterStream
ReadStream	A fast bufferered input stream supporting both character and byte data.
ReadWritePair
SchemeMap	The top-level filesystem schemes are collected into a single map.
SchemeRoot	The root of a scheme.
SelfSignedCert	Abstract socket to handle both normal sockets and bin/resin sockets.
SocketChannelStream	Specialized stream to handle sockets.
SocketStream	Specialized stream to handle sockets.
SpyPath	Logs usage of the path.
SpyRandomAccessStream	Reads from a file in a random-access fashion.
SpyScheme
SSLFactoryBase	Abstract socket to handle both normal sockets and bin/resin sockets.
StderrStream	Stream encapsulating System.err.
StdoutStream	Stream encapsulating System.out.
StreamFilter
StreamImpl	This is the service provider's interface for a stream supported by the VFS.
StreamImplInputStream	Unbuffered input stream to the stream impl
StreamImplOutputStream	Unbuffered output stream to the stream impl the VFS.
StreamPrintWriter	A print writer which writes to a specific WriteStream.
StreamSource	Stream source for Hessian serialization of large data
StreamSourceHessianDeserializer	Stream source for Hessian serialization of large data
StreamSourceHessianSerializer	Stream source for Hessian serialization of large data
StringPath
StringReader	A stream reading data from a string.
StringStream
StringWriter
Syslog	Stream which writes to syslog.
TcpPath	Implements a tcp stream, essentially just a socket pair.
TcpsPath	Implements a tcp stream, essentially just a socket pair.
TempBuffer	Pooled temporary byte buffer.
TempCharBuffer
TempCharReader	Char reader based on an underlying buffer.
TempCharStream
TempFile
TempInputStream
TempInputStreamNoFree
TempOutputStream
TempReadStream
TempStream
Vfs	Facade to create useful Path and Stream objects.
VfsSchemeConfig	Configures a vfs scheme.
VfsStream	Stream encapsulating InputStream/OutputStream.
WriterStreamImpl	Handles a stream which outputs to a writer.
WriteStream	A fast bufferered output stream supporting both character and byte data.
XmlWriter
XmlWriter.Html
XmlWriter.Strategy
XmlWriter.Xhtml	If content model is empty,
XmlWriter.Xml
ZipScanner	Scans a zip file, returning the names.

Enum Summary

Enum	Description
GoogleInode.FileType

Exception Summary

Exception	Description
ClientDisconnectException	Exception thrown when a client unexpectedly closes a connection.
ClientTimeoutException	Exception thrown when a client unexpectedly closes a connection.
IOExceptionWrapper
IOTimeoutException
SocketTimeoutException	Exception thrown when a client unexpectedly closes a connection.

Package com.caucho.vfs Description

Resin's Virtual File System. Resin's VFS combines and simplifies the morass in Java I/O. The core classes are:

• Path -- API similar to File, but supports URLs as well as paths.
• ReadStream -- buffered read stream handing both byte and character input
• WriteStream -- buffered write stream handling both byte and character output

Virtual Paths

Path access is based on standard URLs. The following URL schemes are predefined.

• file: -- the standard filesystem
• http: -- the http filesystem
• mailto: -- sending mail
• stdout: -- standard output (System.out)
• stderr: -- standard error (System.err)
• tcp: -- TCP socket pair
• null: -- /dev/null
• log: -- debug logging (controlled by resin.conf)

Reading a File

ReadStream implements InputStream so it can be used wherever an InputStream is appropriate.

The Vfs facade is convenient for opening files.

ReadStream rs = Vfs.openRead("http://www.yahoo.com");
int ch;

while ((ch = rs.read()) >= 0)
  System.out.print((char) ch);

Writing a File

WriteStream implements OutputStream so it can be used wherever an OutputStream is appropriate. It also implements the familiar print() methods from PrintStream, although they do throw IOExceptions.

The Vfs facade is convenient for opening files.

WriteStream ws = Vfs.openWrite("mailto:user@foo.com");
ws.setAttribute("subject", "hi, there");

ws.println("Just a little hello, world message");
ws.close();