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

Class XactionUtil

java.lang.Object

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

public class XactionUtil
extends Object

Constructor Summary

Constructors

Constructor	Description
XactionUtil()

Method Summary

Modifier and Type	Method	Description
static void	createOutputFileName(org.pentaho.platform.api.repository2.unified.RepositoryFile file, org.pentaho.platform.api.engine.IOutputHandler outputHandler)
static HttpOutputHandler	createOutputHandler(javax.servlet.http.HttpServletResponse response, OutputStream outputStream)
static String	doParameter(org.pentaho.platform.api.repository2.unified.RepositoryFile file, org.pentaho.platform.api.engine.IParameterProvider parameterProvider, org.pentaho.platform.api.engine.IPentahoSession userSession)
static String	execute(String returnContentType, org.pentaho.platform.api.repository2.unified.RepositoryFile file, javax.servlet.http.HttpServletRequest httpServletRequest, javax.servlet.http.HttpServletResponse httpServletResponse, org.pentaho.platform.api.engine.IPentahoSession userSession, org.pentaho.platform.api.engine.IMimeTypeListener mimeTypeListener)
static String	executeHtml(org.pentaho.platform.api.repository2.unified.RepositoryFile file, javax.servlet.http.HttpServletRequest httpServletRequest, javax.servlet.http.HttpServletResponse httpServletResponse, org.pentaho.platform.api.engine.IPentahoSession userSession, org.pentaho.platform.api.engine.IMimeTypeListener mimeTypeListener)
protected static org.pentaho.platform.api.engine.IRuntimeContext	executeInternal(org.pentaho.platform.api.repository2.unified.RepositoryFile file, org.pentaho.platform.api.engine.IParameterProvider requestParams, javax.servlet.http.HttpServletRequest httpServletRequest, org.pentaho.platform.api.engine.IOutputHandler outputHandler, Map<String,org.pentaho.platform.api.engine.IParameterProvider> parameterProviders, org.pentaho.platform.api.engine.IPentahoSession userSession, boolean forcePrompt, List messages)
static String	executeScheduleUi(org.pentaho.platform.api.repository2.unified.RepositoryFile file, javax.servlet.http.HttpServletRequest httpServletRequest, javax.servlet.http.HttpServletResponse httpServletResponse, org.pentaho.platform.api.engine.IPentahoSession userSession, org.pentaho.platform.api.engine.IMimeTypeListener mimeTypeListener)	This method executes an xaction with forcePrompt=true and outputPreference=PARAMETERS, allowing for the xaction to render the secure filter appropriately when being executed in the background or while being scheduled.
static String	executeXml(org.pentaho.platform.api.repository2.unified.RepositoryFile file, javax.servlet.http.HttpServletRequest httpServletRequest, javax.servlet.http.HttpServletResponse httpServletResponse, org.pentaho.platform.api.engine.IPentahoSession userSession)
static OutputStream	getOutputStream(javax.servlet.http.HttpServletResponse response, boolean doMessages)
static String	postExecute(org.pentaho.platform.api.engine.IRuntimeContext runtime, boolean debugMessages, boolean doWrapper, org.pentaho.platform.api.engine.IOutputHandler outputHandler, Map<String,org.pentaho.platform.api.engine.IParameterProvider> parameterProviders, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, List<?> messages, boolean deleteGeneratedFiles)
static void	setupOutputHandler(HttpOutputHandler outputHandler, org.pentaho.platform.api.engine.IParameterProvider requestParameters)

Methods inherited from class java.lang.Object

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

Constructor Detail

XactionUtil

public XactionUtil()

Method Detail

createOutputFileName

public static void createOutputFileName(org.pentaho.platform.api.repository2.unified.RepositoryFile file,
                                        org.pentaho.platform.api.engine.IOutputHandler outputHandler)

getOutputStream

public static OutputStream getOutputStream(javax.servlet.http.HttpServletResponse response,
                                           boolean doMessages)
                                    throws javax.servlet.ServletException,
                                           IOException

Throws:

javax.servlet.ServletException

IOException

setupOutputHandler

public static void setupOutputHandler(HttpOutputHandler outputHandler,
                                      org.pentaho.platform.api.engine.IParameterProvider requestParameters)

createOutputHandler

public static HttpOutputHandler createOutputHandler(javax.servlet.http.HttpServletResponse response,
                                                    OutputStream outputStream)

postExecute

public static String postExecute(org.pentaho.platform.api.engine.IRuntimeContext runtime,
                                 boolean debugMessages,
                                 boolean doWrapper,
                                 org.pentaho.platform.api.engine.IOutputHandler outputHandler,
                                 Map<String,org.pentaho.platform.api.engine.IParameterProvider> parameterProviders,
                                 javax.servlet.http.HttpServletRequest request,
                                 javax.servlet.http.HttpServletResponse response,
                                 List<?> messages,
                                 boolean deleteGeneratedFiles)
                          throws Exception

Throws:

Exception

executeHtml

public static String executeHtml(org.pentaho.platform.api.repository2.unified.RepositoryFile file,
                                 javax.servlet.http.HttpServletRequest httpServletRequest,
                                 javax.servlet.http.HttpServletResponse httpServletResponse,
                                 org.pentaho.platform.api.engine.IPentahoSession userSession,
                                 org.pentaho.platform.api.engine.IMimeTypeListener mimeTypeListener)
                          throws Exception

Throws:

Exception

executeScheduleUi

public static String executeScheduleUi(org.pentaho.platform.api.repository2.unified.RepositoryFile file,
                                       javax.servlet.http.HttpServletRequest httpServletRequest,
                                       javax.servlet.http.HttpServletResponse httpServletResponse,
                                       org.pentaho.platform.api.engine.IPentahoSession userSession,
                                       org.pentaho.platform.api.engine.IMimeTypeListener mimeTypeListener)
                                throws Exception

This method executes an xaction with forcePrompt=true and outputPreference=PARAMETERS, allowing for the xaction to render the secure filter appropriately when being executed in the background or while being scheduled.

Parameters:

file - the location of the xaction

httpServletRequest - the request object

httpServletResponse - the response object

userSession - the user session

Returns:

potential response message

Throws:

Exception

executeInternal

protected static org.pentaho.platform.api.engine.IRuntimeContext executeInternal(org.pentaho.platform.api.repository2.unified.RepositoryFile file,
                                                                                 org.pentaho.platform.api.engine.IParameterProvider requestParams,
                                                                                 javax.servlet.http.HttpServletRequest httpServletRequest,
                                                                                 org.pentaho.platform.api.engine.IOutputHandler outputHandler,
                                                                                 Map<String,org.pentaho.platform.api.engine.IParameterProvider> parameterProviders,
                                                                                 org.pentaho.platform.api.engine.IPentahoSession userSession,
                                                                                 boolean forcePrompt,
                                                                                 List messages)
                                                                          throws Exception

Throws:

Exception

executeXml

public static String executeXml(org.pentaho.platform.api.repository2.unified.RepositoryFile file,
                                javax.servlet.http.HttpServletRequest httpServletRequest,
                                javax.servlet.http.HttpServletResponse httpServletResponse,
                                org.pentaho.platform.api.engine.IPentahoSession userSession)
                         throws Exception

Throws:

Exception

execute

public static String execute(String returnContentType,
                             org.pentaho.platform.api.repository2.unified.RepositoryFile file,
                             javax.servlet.http.HttpServletRequest httpServletRequest,
                             javax.servlet.http.HttpServletResponse httpServletResponse,
                             org.pentaho.platform.api.engine.IPentahoSession userSession,
                             org.pentaho.platform.api.engine.IMimeTypeListener mimeTypeListener)
                      throws Exception

Throws:

Exception

doParameter

public static String doParameter(org.pentaho.platform.api.repository2.unified.RepositoryFile file,
                                 org.pentaho.platform.api.engine.IParameterProvider parameterProvider,
                                 org.pentaho.platform.api.engine.IPentahoSession userSession)
                          throws IOException

Throws:

IOException