Package org.pentaho.platform.web.http.api.resources

Class GeneratorStreamingOutput

java.lang.Object

org.pentaho.platform.web.http.api.resources.GeneratorStreamingOutput

public class GeneratorStreamingOutput
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
protected List<javax.ws.rs.core.MediaType>	acceptableMediaTypes
protected String	command
protected org.pentaho.platform.api.engine.IContentGenerator	contentGenerator
protected ContentGeneratorDescriptor	contentGeneratorDescriptor
protected String	contentGeneratorID
protected org.pentaho.platform.api.repository2.unified.RepositoryFile	file
protected String	fileType
protected javax.servlet.http.HttpServletRequest	httpServletRequest
protected javax.servlet.http.HttpServletResponse	httpServletResponse
protected String	mimeType
protected org.pentaho.platform.api.engine.IPluginManager	pluginMgr

Constructor Summary

Constructors

Constructor	Description
GeneratorStreamingOutput(org.pentaho.platform.api.engine.IContentGenerator contentGenerator, ContentGeneratorDescriptor desc, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, List<javax.ws.rs.core.MediaType> acceptableMediaTypes, org.pentaho.platform.api.repository2.unified.RepositoryFile file, String command)	Invokes a content generator to produce some content either in the context of a repository file, or in the form of a direct service call (no repository file in view).

Method Summary

Modifier and Type	Method	Description
protected org.pentaho.platform.api.engine.IParameterProvider	createHeaderParamProvider()
protected org.pentaho.platform.api.engine.IParameterProvider	createPathParamProvider()
protected org.pentaho.platform.api.engine.IParameterProvider	createRequestParamProvider()
protected org.pentaho.platform.api.engine.IParameterProvider	createSessionParameterProvider()
protected void	generateContent(OutputStream outputStream, GeneratorStreamingOutputProvider.MimeTypeCallback callback)
String	getMimeType()
void	setMimeType(String mimeType)
void	write(OutputStream output, GeneratorStreamingOutputProvider.MimeTypeCallback callback)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

contentGenerator

protected org.pentaho.platform.api.engine.IContentGenerator contentGenerator

contentGeneratorID

protected String contentGeneratorID

file

protected org.pentaho.platform.api.repository2.unified.RepositoryFile file

command

protected String command

httpServletRequest

protected javax.servlet.http.HttpServletRequest httpServletRequest

httpServletResponse

protected javax.servlet.http.HttpServletResponse httpServletResponse

pluginMgr

protected org.pentaho.platform.api.engine.IPluginManager pluginMgr

fileType

protected String fileType

mimeType

protected String mimeType

acceptableMediaTypes

protected List<javax.ws.rs.core.MediaType> acceptableMediaTypes

contentGeneratorDescriptor

protected ContentGeneratorDescriptor contentGeneratorDescriptor

Constructor Detail

GeneratorStreamingOutput

public GeneratorStreamingOutput(org.pentaho.platform.api.engine.IContentGenerator contentGenerator,
                                ContentGeneratorDescriptor desc,
                                javax.servlet.http.HttpServletRequest request,
                                javax.servlet.http.HttpServletResponse response,
                                List<javax.ws.rs.core.MediaType> acceptableMediaTypes,
                                org.pentaho.platform.api.repository2.unified.RepositoryFile file,
                                String command)

Invokes a content generator to produce some content either in the context of a repository file, or in the form of a direct service call (no repository file in view).

Parameters:

contentGenerator - the content generator to invoke

ContentGeneratorDescriptor - a descriptor detailing info about the content generator

request - the HTTP request

response - the HTTP response

producesMimeType - the requested return type of the output (can be null if none is preferred)

file - the repository file being rendered (can be null if a repository file does not apply)

command - the trailing part of the URL path of the request, typically used as a command sequence (can be null)

Method Detail

write

public void write(OutputStream output,
                  GeneratorStreamingOutputProvider.MimeTypeCallback callback)
           throws IOException

Throws:

IOException

generateContent

protected void generateContent(OutputStream outputStream,
                               GeneratorStreamingOutputProvider.MimeTypeCallback callback)
                        throws Exception

Throws:

Exception

createRequestParamProvider

protected org.pentaho.platform.api.engine.IParameterProvider createRequestParamProvider()

createSessionParameterProvider

protected org.pentaho.platform.api.engine.IParameterProvider createSessionParameterProvider()

createHeaderParamProvider

protected org.pentaho.platform.api.engine.IParameterProvider createHeaderParamProvider()

createPathParamProvider

protected org.pentaho.platform.api.engine.IParameterProvider createPathParamProvider()
                                                                              throws IOException

Throws:

IOException

getMimeType

public String getMimeType()

setMimeType

public void setMimeType(String mimeType)