ee.ria.dhx.util

Class FileUtil

java.lang.Object

ee.ria.dhx.util.FileUtil

public class FileUtil
extends java.lang.Object

Utility methods related to files. e.g. creating files, reading files, zipping and unzipping, base64 endocding and decoding

Author:

Aleksei Kokarev

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.Integer	BINARY_BUFFER_SIZE

Constructor Summary

Constructors

Constructor and Description
FileUtil()

Method Summary

Modifier and Type	Method and Description
static java.io.File	createFileAndWrite(java.io.InputStream stream) Creates file in temporary directory and writes stream to that file.
static java.io.File	createPipelineFile() Generates operationsystem temporary file with unique name.
static FileDataHandler	getDatahandlerFromFile(java.io.File file) Method creates DataHandler from File.
static FileDataHandler	getDatahandlerFromFile(java.io.File file, java.lang.String contentType) Method creates DataHandler from File.
static javax.activation.DataHandler	getDatahandlerFromStream(java.io.InputStream stream) Method creates DataHandler from InputStream.
static java.io.File	getFile(java.lang.String path) Gets file from classpath or from filesystem by files path.
static java.io.InputStream	getFileAsStream(java.io.File file) Returns files stream.
static java.io.InputStream	getFileAsStream(java.lang.String path) Gets file from classpath or from filesystem by files path and returns files stream
static void	safeCloseReader(java.io.Reader reader) Safely closes reader.
static void	safeCloseStream(java.io.InputStream stream) Safely closes inputstream.
static void	safeCloseStream(java.io.OutputStream stream) Safely closes outputstream.
static void	safeCloseWriter(java.io.Writer writer) Safely closes writer.
static void	writeToFile(java.io.InputStream inStream, java.io.FileOutputStream targetStream) Writes stream to FileOutputStream.
static void	writeToFile(java.lang.String stringToWrite, java.io.FileOutputStream targetStream) Writes string to FileOutputStream.
static java.io.InputStream	zipUnpack(java.io.InputStream zipStream, java.lang.String fileToFindInZip) Unpacks ZIP file and find file provided in input.

Methods inherited from class java.lang.Object

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

Field Detail

BINARY_BUFFER_SIZE

public static final java.lang.Integer BINARY_BUFFER_SIZE

Constructor Detail

FileUtil

public FileUtil()

Method Detail

createPipelineFile

@Loggable
public static java.io.File createPipelineFile()
                                                  throws java.io.IOException

Generates operationsystem temporary file with unique name. File is written to java.io.tmpdir

Returns:

created file

Throws:

java.io.IOException - - thrown if error occurs while creating file

getFile

public static java.io.File getFile(java.lang.String path)
                            throws DhxException

Gets file from classpath or from filesystem by files path.

Parameters:

path - - path of the file. if start with jar://, then searches from classpath

Returns:

- file

Throws:

DhxException - - throws if error occurs while getting file

getFileAsStream

public static java.io.InputStream getFileAsStream(java.lang.String path)
                                           throws DhxException

Gets file from classpath or from filesystem by files path and returns files stream

Parameters:

path - - path of the file. if start with jar://, then searches from classpath

Returns:

- files InputStream

Throws:

DhxException - - throws if error occurs while getting file

getFileAsStream

public static java.io.InputStream getFileAsStream(java.io.File file)
                                           throws DhxException

Returns files stream.

Parameters:

file - - File to get its stream

Returns:

- files InputStream

Throws:

DhxException - - throws if error occcurs while getting files stream

createFileAndWrite

public static java.io.File createFileAndWrite(java.io.InputStream stream)
                                       throws DhxException

Creates file in temporary directory and writes stream to that file.

Parameters:

stream - - stream to write to file

Returns:

- file containing data from stream

Throws:

DhxException - - thrown if error occured while creating or writing file

writeToFile

public static void writeToFile(java.io.InputStream inStream,
                               java.io.FileOutputStream targetStream)
                        throws DhxException

Writes stream to FileOutputStream.

Parameters:

inStream - - stream to write to file

targetStream - - FileOutputStream into which write the inStream

Throws:

DhxException - - thrown if error occured while writing to file

writeToFile

public static void writeToFile(java.lang.String stringToWrite,
                               java.io.FileOutputStream targetStream)
                        throws DhxException

Writes string to FileOutputStream.

Parameters:

stringToWrite - - string to write to file

targetStream - - FileOutputStream into which write the inStream

Throws:

DhxException - - thrown if error occured while writing to file

safeCloseStream

public static void safeCloseStream(java.io.InputStream stream)

Safely closes inputstream.

Parameters:

stream - - stream to close

safeCloseStream

public static void safeCloseStream(java.io.OutputStream stream)

Safely closes outputstream.

Parameters:

stream - - stream to close

safeCloseReader

public static void safeCloseReader(java.io.Reader reader)

Safely closes reader.

Parameters:

reader - - reader to close

safeCloseWriter

public static void safeCloseWriter(java.io.Writer writer)

Safely closes writer.

Parameters:

writer - - writer to close

zipUnpack

public static java.io.InputStream zipUnpack(java.io.InputStream zipStream,
                                            java.lang.String fileToFindInZip)
                                     throws DhxException

Unpacks ZIP file and find file provided in input.

Parameters:

zipStream - - InputStream of ZIP file

fileToFindInZip - - file to find inside ZIP file

Returns:

- InputStream of file found

Throws:

DhxException - - throws if error occurs while unzipping of during file search

getDatahandlerFromFile

public static FileDataHandler getDatahandlerFromFile(java.io.File file)

Method creates DataHandler from File.

Parameters:

file - - File to create DataHandler from

Returns:

FileDataHandler created from File

getDatahandlerFromFile

public static FileDataHandler getDatahandlerFromFile(java.io.File file,
                                                     java.lang.String contentType)

Method creates DataHandler from File.

Parameters:

file - - File to create DataHandler from

contentType - conent type to set for the handler

Returns:

FileDataHandler created from File

getDatahandlerFromStream

public static javax.activation.DataHandler getDatahandlerFromStream(java.io.InputStream stream)
                                                             throws DhxException

Method creates DataHandler from InputStream.

Parameters:

stream - - InputStream to create DataHandler from

Returns:

DataHandler created from InputStream

Throws:

DhxException - - throws if error occurs while creating DataHandler