org.cyclos.server.utils

Class SerializableInputStream

java.lang.Object

java.io.InputStream

org.cyclos.server.utils.SerializableInputStream

All Implemented Interfaces:

java.io.Closeable, java.io.Serializable, java.lang.AutoCloseable

public class SerializableInputStream
extends java.io.InputStream
implements java.io.Serializable

An InputStream which wraps another InputStream, so that intra-jvm access is done directly on that stream. However, when it's serialized, the data is sent on chunks and, when read on the other side, those chunks are written in a temporary file. So, it's safe to serialize large amount of data without consuming large memory.

Author:

luis

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
SerializableInputStream(java.sql.Blob blob) Wraps the given blob, and calls forceCopyToFile(), as blobs can only be accessed from within a database transaction
SerializableInputStream(byte[] bytes) Shortcut to SerializableInputStream(InputStream) using a ByteArrayInputStream
SerializableInputStream(java.io.File file) Reads the given file, deleting it when close() is invoked
SerializableInputStream(java.io.InputStream inputStream) Wraps the given stream

Method Summary

Methods

Modifier and Type	Method and Description
void	close()
java.io.File	file() Returns a temporary File with the contents of this stream.
java.io.File	forceCopyToFile() Exhausts the open stream and copy the contents to a temporary file.
int	read()
int	read(byte[] b)
int	read(byte[] b, int off, int len)

Methods inherited from class java.io.InputStream

available, mark, markSupported, reset, skip

Methods inherited from class java.lang.Object

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

Constructor Detail

SerializableInputStream

public SerializableInputStream(java.sql.Blob blob)
                        throws java.io.IOException

Wraps the given blob, and calls forceCopyToFile(), as blobs can only be accessed from within a database transaction

Throws:

java.io.IOException

SerializableInputStream

public SerializableInputStream(byte[] bytes)

Shortcut to SerializableInputStream(InputStream) using a ByteArrayInputStream

SerializableInputStream

public SerializableInputStream(java.io.File file)

Reads the given file, deleting it when close() is invoked

SerializableInputStream

public SerializableInputStream(java.io.InputStream inputStream)

Wraps the given stream

Method Detail

close

public void close()
           throws java.io.IOException

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Overrides:

close in class java.io.InputStream

Throws:

java.io.IOException

file

public java.io.File file()
                  throws java.io.IOException,
                         java.lang.IllegalStateException

Returns a temporary File with the contents of this stream. When the stream has been serialized, the contents is already on a temporary file, so it is returned. Otherwise, copy the wrapped stream into a temporary file and return it. It is important to state that after this method is invoked, the temporary file will no longer be deleted when this stream is closed, and it's the callers responsibility to remove the temporary file.

Throws:

java.io.IOException - When there was an error reading to the temporary file

java.lang.IllegalStateException - When this stream was already closed

forceCopyToFile

public java.io.File forceCopyToFile()
                             throws java.io.IOException

Exhausts the open stream and copy the contents to a temporary file. No-op if already on a file. The file is not marked as to being kept (opposed to what happens on the file() method), so, subsequent invocation of close() method will delete the file

Throws:

java.io.IOException - Error writing to file

read

public int read()
         throws java.io.IOException

Specified by:

read in class java.io.InputStream

Throws:

java.io.IOException

read

public int read(byte[] b)
         throws java.io.IOException

Overrides:

read in class java.io.InputStream

Throws:

java.io.IOException

read

public int read(byte[] b,
       int off,
       int len)
         throws java.io.IOException

Overrides:

read in class java.io.InputStream

Throws:

java.io.IOException