org.jasig.portal
Interface IMimeResponse

All Known Implementing Classes:

MultithreadedCacheableMimeResponseChannelAdapter, MultithreadedCacheableMimeResponseCharacterChannelAdapter, MultithreadedMimeResponseChannelAdapter, MultithreadedMimeResponseCharacterChannelAdapter, MultithreadedPrivilegedCacheableMimeResponseChannelAdapter, MultithreadedPrivilegedCacheableMimeResponseCharacterChannelAdapter, MultithreadedPrivilegedMimeResponseChannelAdapter, MultithreadedPrivilegedMimeResponseCharacterChannelAdapter

public interface IMimeResponse

An interface that a channel that wants to download MIME files must implement.

Version:

$Revision: 1.7 $

Author:

Shridar Venkatesh, svenkatesh@interactivebusiness.com

Method Summary

void	downloadData(java.io.OutputStream out) Pass the OutputStream object to the download code if it needs special handling (like outputting a Zip file).
java.lang.String	getContentType() Returns the MIME type of the content.
java.util.Map	getHeaders() Returns a list of header values that can be set in the HttpResponse.
java.io.InputStream	getInputStream() Returns the MIME content in the form of an input stream.
java.lang.String	getName() Returns the name of the MIME file.
void	reportDownloadError(java.lang.Exception e) Let the channel know that there were problems with the download

Method Detail

getContentType

java.lang.String getContentType()

Returns the MIME type of the content.

getInputStream

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

Returns the MIME content in the form of an input stream. Returns null if the code needs the OutputStream object

Throws:

java.io.IOException

downloadData

void downloadData(java.io.OutputStream out)
                  throws java.io.IOException

Pass the OutputStream object to the download code if it needs special handling (like outputting a Zip file).

Throws:

java.io.IOException

getName

java.lang.String getName()

Returns the name of the MIME file.

getHeaders

java.util.Map getHeaders()

Returns a list of header values that can be set in the HttpResponse. Returns null if no headers need to be set.

reportDownloadError

void reportDownloadError(java.lang.Exception e)

Let the channel know that there were problems with the download

Parameters:

e -