org.adroitlogic.ultraesb.api.format
Interface RawFileMessage

public interface RawFileMessage

A Raw file message holds the message payload in a file

Method Summary

java.io.File	getFile() Get the underlying File containing the payload
long	getFileSize() The file size
java.io.InputStream	getInputStream() Get an InputStream to the message payload
java.io.OutputStream	getOutputStream() Get an OutputStream to write the message payload
java.lang.String	toString() A String representation of the message payload, limited to 64K
void	writeTo(java.io.OutputStream os) Write the payload to the given OutputStream

Method Detail

getFile

java.io.File getFile()

Get the underlying File containing the payload

Returns:

the underlying payload file

getFileSize

long getFileSize()

The file size

Returns:

file size

getInputStream

java.io.InputStream getInputStream()

Get an InputStream to the message payload

Returns:

an InputStream to the message payload

getOutputStream

java.io.OutputStream getOutputStream()

Get an OutputStream to write the message payload

Returns:

an OutputStream to write the message payload

writeTo

void writeTo(java.io.OutputStream os)
             throws java.io.IOException

Write the payload to the given OutputStream

Parameters:

os - the OutputStream to serialize the message into

Throws:

java.io.IOException - on an IO error

toString

java.lang.String toString()

A String representation of the message payload, limited to 64K

Overrides:

toString in class java.lang.Object

Returns:

a String representation of the payload limited to 64K