com.stellent.cis.client.io
Interface ICISTransferStream

All Superinterfaces:

java.io.Serializable

public interface ICISTransferStream
extends java.io.Serializable

Interface used to transfer file streams back and forth from Command Client to Command Server

Method Summary

long	getContentLength()
java.lang.String	getContentType()
java.lang.String	getFileName()
java.io.InputStream	getInputStream()
java.lang.String	getProperty(java.lang.String key)
java.util.Collection	getPropertyNames()
void	setContentLength(long length) Set the length of this stream
void	setContentType(java.lang.String contentType) Set the content-type
void	setFile(java.io.File file) Set this stream to point to a file.
void	setFileName(java.lang.String fileName) Set the file name
void	setInputStream(java.io.InputStream inputStream) Set the inputstream this object is wrapping
void	setProperty(java.lang.String name, java.lang.String value) Set an arbitrary property associated with this stream

Method Detail

getInputStream

java.io.InputStream getInputStream()
                                   throws java.io.IOException

Returns:

the contained inputstream

Throws:

java.io.IOException

setInputStream

void setInputStream(java.io.InputStream inputStream)

Set the inputstream this object is wrapping

Parameters:

inputStream - the input stream

setFile

void setFile(java.io.File file)
             throws java.io.IOException

Set this stream to point to a file. A convenience method that internally does the following: setInputStream (new FileInputStream (file)); setFileName (file.getName ()); setContentLength (file.getLength ());

Parameters:

file - the file to transfer

Throws:

java.io.IOException

getContentType

java.lang.String getContentType()

Returns:

the content mime-type

setContentType

void setContentType(java.lang.String contentType)

Set the content-type

Parameters:

contentType - the mime type

getContentLength

long getContentLength()

Returns:

the content length or -1 if not known

setContentLength

void setContentLength(long length)

Set the length of this stream

Parameters:

length - the stream length or -1

getFileName

java.lang.String getFileName()

Returns:

the original file name this stream represents

setFileName

void setFileName(java.lang.String fileName)

Set the file name

Parameters:

fileName - the name of this file

getProperty

java.lang.String getProperty(java.lang.String key)

Parameters:

key - the metadata key

Returns:

arbitrary metadata about this stream

setProperty

void setProperty(java.lang.String name,
                 java.lang.String value)

Set an arbitrary property associated with this stream

Parameters:

name - property name

value - property value

getPropertyNames

java.util.Collection getPropertyNames()

Returns:

a collection of the available property names