cz.ues.platform.commons.lang

Class UESFileHandler

java.lang.Object

cz.ues.platform.commons.lang.UESStreamHandler

cz.ues.platform.commons.lang.UESFileHandler

Direct Known Subclasses:

UESAttachmentStreamHandler

@XMLBindable
public class UESFileHandler
extends UESStreamHandler

This data-structure should be used to transfer streamed files between UESCommand services.

Since:

UES6-00

Nested Class Summary

Nested classes/interfaces inherited from class cz.ues.platform.commons.lang.UESStreamHandler

UESStreamHandler.InputStreamFilter, UESStreamHandler.StreamDataSource

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.String	fileName Name of file.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	UESFileHandler() Default no-arg constructor necessary for JAXB serialization.
	UESFileHandler(java.io.File file) Creates new Instance of UESFileHandler.
	UESFileHandler(java.io.File file, java.lang.String fileName) Creates new Instance of UESFileHandler.
	UESFileHandler(UESFileSource fileSource) Creates new Instance of UESFileHandler.
	UESFileHandler(UESFileSource fileSource, java.lang.String fileName) Creates new Instance of UESFileHandler.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getFileName() Returns name of streamed file.
protected void	setFileName(java.lang.String fileName) Sets name of streamed file.
void	writeTo(java.io.File file, boolean overwrite) Writes streamed file content into given file.

Methods inherited from class cz.ues.platform.commons.lang.UESStreamHandler

getContentType, getDataSource, getInputStream, getSize, initialize, writeTo

Methods inherited from class java.lang.Object

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

Field Detail

fileName

private fileName

Name of file.

Constructor Detail

UESFileHandler

protected UESFileHandler()

Default no-arg constructor necessary for JAXB serialization.

Since:

UES6-00

UESFileHandler

public UESFileHandler(UESFileSource fileSource)
throws UESIORTException

Creates new Instance of UESFileHandler.

Parameters:

fileSource - File source

Throws:

UESIORTException - In case file from file source does not exist

Since:

UES7-04

UESFileHandler

public UESFileHandler(UESFileSource fileSource,
java.lang.String fileName)
throws UESIORTException

Creates new Instance of UESFileHandler.

Parameters:

fileSource - File source

fileName - Optional name of file. If null, name from given file source is used

Throws:

UESIORTException - In case file from file source does not exist

Since:

UES7-04

UESFileHandler

public UESFileHandler(java.io.File file)
throws UESIORTException

Creates new Instance of UESFileHandler.

Parameters:

file - File to be streamed

Throws:

UESIORTException - In case file does not exist

Since:

UES6-00

UESFileHandler

public UESFileHandler(java.io.File file,
java.lang.String fileName)
throws UESIORTException

Creates new Instance of UESFileHandler.

Parameters:

file - File to be streamed

fileName - Optional name of file. If null, name from given file is used

Throws:

UESIORTException - In case file does not exist

Since:

UES6-00

Method Detail

setFileName

protected void setFileName(java.lang.String fileName)

Sets name of streamed file.

Parameters:

fileName - Name of streamed file

Since:

UES6-06

getFileName

public java.lang.String getFileName()

Returns name of streamed file.

Returns:

Name of streamed file

Since:

UES6-00

writeTo

public void writeTo(java.io.File file,
boolean overwrite)
throws UESIORTException

Writes streamed file content into given file.

Parameters:

file - File where to write streamed content

overwrite - True if existing file should be overwritten

Throws:

UESIORTException - In case writing to file fails

Since:

UES6-00