Package org.frankframework.stream

Class SerializableFileReference

java.lang.Object

org.frankframework.stream.SerializableFileReference

All Implemented Interfaces:

Serializable, AutoCloseable

public class SerializableFileReference
extends Object
implements Serializable, AutoCloseable

A reference to a file Path that can be serialized. When serialized it will write all the file data to the serialization stream. When deserialized, it will copy all file-data to a new temporary file.

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final String	TEMP_MESSAGE_DIRECTORY

Constructor Summary

Constructors

Constructor	Description
SerializableFileReference(String charset, Path path)	Create a character-data SerializableFileReference for the file at given path.
SerializableFileReference(Path path, boolean deleteOnClose)	Create a binary SerializableFileReference for the file at given path.

Method Summary

Modifier and Type	Method	Description
void	close()
InputStream	getInputStream()
Path	getPath()
BufferedReader	getReader()
long	getSize()
boolean	isBinary()
static SerializableFileReference	of(byte[] data)	Create a new SerializableFileReference from the given byte[].
static SerializableFileReference	of(InputStream in)	Create a new SerializableFileReference from the given InputStream.
static SerializableFileReference	of(Reader in, String charset)	Create a new SerializableFileReference from the given Reader.
static SerializableFileReference	of(String data, String charset)	Create a new SerializableFileReference from the given String.

Methods inherited from class java.lang.Object

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

Field Details

TEMP_MESSAGE_DIRECTORY

public static final String TEMP_MESSAGE_DIRECTORY

See Also:

• Constant Field Values

Constructor Details

SerializableFileReference

public SerializableFileReference(Path path,
 boolean deleteOnClose)

Create a binary SerializableFileReference for the file at given path.

Parameters:

path - Path to the file being referenced.

deleteOnClose - if the temporary file will be deleted on calling close().

SerializableFileReference

public SerializableFileReference(String charset,
 Path path)

Create a character-data SerializableFileReference for the file at given path.

The file will be not deleted on calling close().

Parameters:

charset - Character set to be used when reading the file.

path - Path to the file being referenced.

Method Details

of

public static SerializableFileReference of(InputStream in)
                                    throws IOException

Create a new SerializableFileReference from the given InputStream. The InputStream will be copied to a temporary file on disk and will be closed afterward. The SerializableFileReference will be treated as binary data.

The temporary file will be deleted on calling close().

Parameters:

in - The InputStream from which to create the SerializableFileReference. Will be closed after completion of this method.

Returns:

A new binary SerializableFileReference.

Throws:

IOException - If the InputStream cannot be read or a temporary file cannot be created / written to.

of

public static SerializableFileReference of(byte[] data)
                                    throws IOException

Create a new SerializableFileReference from the given byte[]. The byte[] will be copied to a temporary file on disk. The SerializableFileReference will be treated as binary data.

The temporary file will be deleted on calling close().

Parameters:

data - The byte[] from which to create the SerializableFileReference.

Returns:

A new binary SerializableFileReference.

Throws:

IOException - If the byte[] cannot be written to a temporary file.

of

public static SerializableFileReference of(Reader in,
 String charset)
                                    throws IOException

Create a new SerializableFileReference from the given Reader. The Reader will be copied to a temporary file on disk and will be closed afterward. The SerializableFileReference will be treated as character data.

The temporary file will be deleted on calling close().

Parameters:

in - The Reader from which to create the SerializableFileReference. Will be closed after completion of this method.

charset - Character set of the data in the Reader.

Returns:

A new character-data SerializableFileReference.

Throws:

IOException - If the Reader cannot be read or a temporary file cannot be created / written to.

of

public static SerializableFileReference of(String data,
 String charset)
                                    throws IOException

Create a new SerializableFileReference from the given String. The String will be copied to a temporary file on disk. The SerializableFileReference will be treated as character data.

The temporary file will be deleted on calling close().

Parameters:

data - The String from which to create the SerializableFileReference.

charset - Character used for writing out and reading back the data.

Returns:

A new character-data SerializableFileReference.

Throws:

IOException - If the String data cannot be written to a temporary file.

getSize

public long getSize()

getReader

public BufferedReader getReader()
                         throws IOException

Throws:

IOException

getInputStream

public InputStream getInputStream()
                           throws IOException

Throws:

IOException

close

public void close()

Specified by:

close in interface AutoCloseable

isBinary

public boolean isBinary()

getPath

public Path getPath()