|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.pentaho.platform.web.http.HttpOutputHandler
public class HttpOutputHandler
Field Summary |
---|
Fields inherited from interface org.pentaho.platform.api.engine.IOutputHandler |
---|
CONTENT, FILE, OUTPUT_TYPE_CONTENT, OUTPUT_TYPE_DEFAULT, OUTPUT_TYPE_PARAMETERS, RESPONSE |
Constructor Summary | |
---|---|
HttpOutputHandler(HttpServletResponse response,
OutputStream outputStream,
boolean allowFeedback)
|
Method Summary | |
---|---|
boolean |
allowFeedback()
Determines whether this output handler can send feedback ContentItems or not. |
boolean |
contentDone()
|
IContentItem |
getFeedbackContentItem()
Retrieve the ContentItem that describes the request interface for additional or missing information (missing from the original request) |
IMimeTypeListener |
getMimeTypeListener()
|
IContentItem |
getOutputContent()
|
IContentItem |
getOutputContentItem(String objectName,
String contentName,
String solution,
String instanceId,
String mimeType)
Retrieve the ContentItem that describes the output from this request's component execution. |
IContentItem |
getOutputContentItem(String objectName,
String contentName,
String title,
String url,
String solution,
String instanceId,
String mimeType)
Retrieve the ContentItem that describes the output from this request's component execution. |
IOutputDef |
getOutputDef(String name)
Retrieve a single output parameter definition by name |
Map |
getOutputDefs()
Returns a map of the valid output parameter definitions for this request. |
int |
getOutputPreference()
Gets the output type prefered by the handler. |
HttpServletResponse |
getResponse()
|
IPentahoSession |
getSession()
|
void |
setContentItem(IContentItem content,
String objectName,
String contentName)
Sets the output ContentItem for this handler. |
void |
setMimeType(String mimeType)
|
void |
setMimeTypeListener(IMimeTypeListener mimeTypeListener)
|
void |
setName(String name)
|
void |
setOutput(String name,
Object value)
Sets an output of the handler. |
void |
setOutputContent(IContentItem outputContent)
|
void |
setOutputPreference(int outputType)
Sets the output type that is wanted by the handler. |
void |
setResponse(HttpServletResponse response)
|
void |
setRuntimeContext(IRuntimeContext runtimeContext)
|
void |
setSession(IPentahoSession session)
|
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public HttpOutputHandler(HttpServletResponse response, OutputStream outputStream, boolean allowFeedback)
Method Detail |
---|
public void setSession(IPentahoSession session)
setSession
in interface IOutputHandler
public IPentahoSession getSession()
getSession
in interface IOutputHandler
public void setOutputPreference(int outputType)
IOutputHandler
setOutputPreference
in interface IOutputHandler
outputType
- Output type requestedpublic int getOutputPreference()
IOutputHandler
getOutputPreference
in interface IOutputHandler
public void setMimeType(String mimeType)
setMimeType
in interface IMimeTypeListener
public void setName(String name)
setName
in interface IMimeTypeListener
public boolean contentDone()
contentDone
in interface IOutputHandler
public boolean allowFeedback()
IOutputHandler
Generally, if there is no client on the other side of the request that could receive and process feedback, then this boolean should be setto false.
allowFeedback
in interface IOutputHandler
public Map getOutputDefs()
IOutputHandler
getOutputDefs
in interface IOutputHandler
public IOutputDef getOutputDef(String name)
IOutputHandler
getOutputDef
in interface IOutputHandler
name
- name of the output parameter definition requested
public IContentItem getFeedbackContentItem()
IOutputHandler
getFeedbackContentItem
in interface IOutputHandler
public IContentItem getOutputContentItem(String objectName, String contentName, String solution, String instanceId, String mimeType)
IOutputHandler
getOutputContentItem
in interface IOutputHandler
objectName
- Name of the objectcontentName
- Name of the content
public IContentItem getOutputContentItem(String objectName, String contentName, String title, String url, String solution, String instanceId, String mimeType)
IOutputHandler
getOutputContentItem
in interface IOutputHandler
objectName
- Name of the objectcontentName
- Name of the contenttitle
- Title of the objecturl
- URL to view the object
public void setContentItem(IContentItem content, String objectName, String contentName)
IOutputHandler
setContentItem
in interface IOutputHandler
content
- ContentItem to setobjectName
- Name of the objectcontentName
- Name of the contentpublic void setOutput(String name, Object value)
IOutputHandler
setOutput
in interface IOutputHandler
name
- Name of the outputvalue
- Value of the outputpublic IMimeTypeListener getMimeTypeListener()
getMimeTypeListener
in interface IOutputHandler
public void setMimeTypeListener(IMimeTypeListener mimeTypeListener)
setMimeTypeListener
in interface IOutputHandler
public IContentItem getOutputContent()
public void setOutputContent(IContentItem outputContent)
public HttpServletResponse getResponse()
public void setResponse(HttpServletResponse response)
public void setRuntimeContext(IRuntimeContext runtimeContext)
setRuntimeContext
in interface IOutputHandler
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |