org.pentaho.platform.engine.services
Class BaseRequestHandler

java.lang.Object
  org.pentaho.platform.engine.services.BaseRequestHandler

All Implemented Interfaces:

IActionCompleteListener, IActionRequestHandler

Direct Known Subclasses:

HttpServletRequestHandler, HttpWebServiceRequestHandler

public class BaseRequestHandler
extends java.lang.Object
implements IActionRequestHandler, IActionCompleteListener

Field Summary

static int	ON_TIMEOUT_CANCEL
static int	ON_TIMEOUT_RETURN

Constructor Summary

BaseRequestHandler(IPentahoSession session, java.lang.String instanceId, IOutputHandler outputHandler, IParameterProvider parameterProvider, IPentahoUrlFactory urlFactory)

Method Summary

void	actionComplete(IRuntimeContext completedRuntime) Invoked when a Component execution has completed
void	dispose()
java.lang.String	getActionName()
java.lang.String	getActionPath()
java.lang.String	getInstanceId()
java.util.List	getMessages() As the execution happens, the action handler is responsible for storing a list of all the messages that occur in the case of component failure.
IOutputHandler	getOutputHandler()
java.util.HashMap	getParameterProviders()
IRuntimeContext	getRuntime(java.lang.String requestHandle) Gets the runtime.
java.lang.String	getSolutionName()
IRuntimeContext	handleActionAsyncRequest() Executes an action sequence asynchronously.
IRuntimeContext	handleActionRequest(int timeout, int timeoutType) Responsible for executing the action using the solution engine.
void	setAction(java.lang.String actionPath, java.lang.String actionName)
void	setActionPath(java.lang.String actionPath)
void	setCreateFeedbackParameterCallback(ICreateFeedbackParameterCallback createFeedbackParameterCallback)
void	setForcePrompt(boolean forcePrompt) Sets whether to force the generation of a prompt page
void	setInstanceEnds(boolean instanceEnds)
void	setInstanceId(java.lang.String instanceId)
void	setOutputHandler(IOutputHandler outputHandler)
void	setParameterProvider(java.lang.String name, IParameterProvider parameterProvider)
void	setParameterXsl(java.lang.String xsl)
void	setProcessId(java.lang.String processId)
void	setSolutionName(java.lang.String solutionName)

Methods inherited from class java.lang.Object

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

Field Detail

ON_TIMEOUT_CANCEL

public static final int ON_TIMEOUT_CANCEL

See Also:

Constant Field Values

ON_TIMEOUT_RETURN

public static final int ON_TIMEOUT_RETURN

See Also:

Constant Field Values

Constructor Detail

BaseRequestHandler

public BaseRequestHandler(IPentahoSession session,
                          java.lang.String instanceId,
                          IOutputHandler outputHandler,
                          IParameterProvider parameterProvider,
                          IPentahoUrlFactory urlFactory)

Method Detail

getMessages

public java.util.List getMessages()

Description copied from interface: IActionRequestHandler

As the execution happens, the action handler is responsible for storing a list of all the messages that occur in the case of component failure. This method returns that list. The items in the list are presented to the user as execution feedback.

Specified by:

getMessages in interface IActionRequestHandler

Returns:

list of messages

setInstanceEnds

public void setInstanceEnds(boolean instanceEnds)

setParameterProvider

public void setParameterProvider(java.lang.String name,
                                 IParameterProvider parameterProvider)

getParameterProviders

public java.util.HashMap getParameterProviders()

setOutputHandler

public void setOutputHandler(IOutputHandler outputHandler)

setProcessId

public void setProcessId(java.lang.String processId)

setInstanceId

public void setInstanceId(java.lang.String instanceId)

getInstanceId

public java.lang.String getInstanceId()

setAction

public void setAction(java.lang.String actionPath,
                      java.lang.String actionName)

setSolutionName

public void setSolutionName(java.lang.String solutionName)

getSolutionName

public java.lang.String getSolutionName()

handleActionRequest

public IRuntimeContext handleActionRequest(int timeout,
                                           int timeoutType)

Description copied from interface: IActionRequestHandler

Responsible for executing the action using the solution engine.

Specified by:

handleActionRequest in interface IActionRequestHandler

Parameters:

timeout - Timeout for the execution - currently ignored in the Base

timeoutType - - currently ignored in the Base

Returns:

RuntimeContext from the execution

See Also:

BaseRequestHandler

dispose

public void dispose()

handleActionAsyncRequest

public IRuntimeContext handleActionAsyncRequest()

Description copied from interface: IActionRequestHandler

Executes an action sequence asynchronously. Note - this is currently not implemented in the BaseRequestHandler

Specified by:

handleActionAsyncRequest in interface IActionRequestHandler

Returns:

RuntimeContext created for the asynchronous execution.

getRuntime

public IRuntimeContext getRuntime(java.lang.String requestHandle)

Description copied from interface: IActionRequestHandler

Gets the runtime. Currently not called anywhere in the platform

Specified by:

getRuntime in interface IActionRequestHandler

Returns:

the RuntimeContext for the execution

actionComplete

public void actionComplete(IRuntimeContext completedRuntime)

Description copied from interface: IActionCompleteListener

Invoked when a Component execution has completed

Specified by:

actionComplete in interface IActionCompleteListener

Parameters:

completedRuntime - the runtime context associated with this action

getOutputHandler

public IOutputHandler getOutputHandler()

setForcePrompt

public void setForcePrompt(boolean forcePrompt)

Description copied from interface: IActionRequestHandler

Sets whether to force the generation of a prompt page

Specified by:

setForcePrompt in interface IActionRequestHandler

setParameterXsl

public void setParameterXsl(java.lang.String xsl)

getActionName

public java.lang.String getActionName()

getActionPath

public java.lang.String getActionPath()

setActionPath

public void setActionPath(java.lang.String actionPath)

setCreateFeedbackParameterCallback

public void setCreateFeedbackParameterCallback(ICreateFeedbackParameterCallback createFeedbackParameterCallback)

Specified by:

setCreateFeedbackParameterCallback in interface IActionRequestHandler