uPortal 2.4.1
API Documentation

org.jasig.portal
Interface IMultithreadedMimeResponse

All Known Implementing Classes:
CPersonAttributes, CWebProxy

public interface IMultithreadedMimeResponse

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

Version:
$Revision: 1.5 $
Author:
Alex Vigdor

Method Summary
 void downloadData(java.io.OutputStream out, java.lang.String uid)
          Pass the OutputStream object to the download code if it needs special handling (like outputting a Zip file).
 java.lang.String getContentType(java.lang.String uid)
          Returns the MIME type of the content.
 java.util.Map getHeaders(java.lang.String uid)
          Returns a list of header values that can be set in the HttpResponse.
 java.io.InputStream getInputStream(java.lang.String uid)
          Returns the MIME content in the form of an input stream.
 java.lang.String getName(java.lang.String uid)
          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

public java.lang.String getContentType(java.lang.String uid)
Returns the MIME type of the content.


getInputStream

public java.io.InputStream getInputStream(java.lang.String uid)
                                   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

public void downloadData(java.io.OutputStream out,
                         java.lang.String uid)
                  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

public java.lang.String getName(java.lang.String uid)
Returns the name of the MIME file.


getHeaders

public java.util.Map getHeaders(java.lang.String uid)
Returns a list of header values that can be set in the HttpResponse. Returns null if no headers need to be set.


reportDownloadError

public void reportDownloadError(java.lang.Exception e)
Let the channel know that there were problems with the download

Parameters:
e -

uPortal 2.4.1
API Documentation