Package org.pentaho.platform.scheduler2.action

Class DefaultActionInvoker

java.lang.Object

org.pentaho.platform.scheduler2.action.DefaultActionInvoker

All Implemented Interfaces:

org.pentaho.platform.api.action.IActionInvoker

public class DefaultActionInvoker
extends Object
implements org.pentaho.platform.api.action.IActionInvoker

A concrete implementation of the IActionInvoker interface that invokes the IAction locally.

Constructor Summary

Constructors

Constructor	Description
DefaultActionInvoker()

Method Summary

Modifier and Type	Method	Description
protected IBackgroundExecutionStreamProvider	getStreamProvider(Map<String,Serializable> params)	Gets the stream provider from the RESERVEDMAPKEY_STREAMPROVIDER key within the params Map.
org.pentaho.platform.api.action.IActionInvokeStatus	invokeAction(org.pentaho.platform.api.action.IAction actionBean, String actionUser, Map<String,Serializable> params)	Invokes the provided IAction as the provided actionUser.
protected org.pentaho.platform.api.action.IActionInvokeStatus	invokeActionImpl(org.pentaho.platform.api.action.IAction actionBean, String actionUser, Map<String,Serializable> params)	Invokes the provided IAction as the provided actionUser.
boolean	isSupportedAction(org.pentaho.platform.api.action.IAction action)
void	validate(org.pentaho.platform.api.action.IAction actionBean, String actionUser, Map<String,Serializable> params)	Validates that the conditions required for the IAction to be invoked are true, throwing an ActionInvocationException, if the conditions are not met.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultActionInvoker

public DefaultActionInvoker()

Method Detail

getStreamProvider

protected IBackgroundExecutionStreamProvider getStreamProvider(Map<String,Serializable> params)

Gets the stream provider from the RESERVEDMAPKEY_STREAMPROVIDER key within the params Map.

Parameters:

params - the Map or parameters needed to invoke the IAction

Returns:

a IBackgroundExecutionStreamProvider represented in the params Map

validate

public void validate(org.pentaho.platform.api.action.IAction actionBean,
                     String actionUser,
                     Map<String,Serializable> params)
              throws org.pentaho.platform.api.action.ActionInvocationException

Validates that the conditions required for the IAction to be invoked are true, throwing an ActionInvocationException, if the conditions are not met.

Parameters:

actionBean - The IAction to be invoked

actionUser - The user invoking the IAction

params - the Map or parameters needed to invoke the IAction

Throws:

org.pentaho.platform.api.action.ActionInvocationException - when conditions needed to invoke the IAction are not met

invokeAction

public org.pentaho.platform.api.action.IActionInvokeStatus invokeAction(org.pentaho.platform.api.action.IAction actionBean,
                                                                        String actionUser,
                                                                        Map<String,Serializable> params)
                                                                 throws Exception

Invokes the provided IAction as the provided actionUser.

Specified by:

invokeAction in interface org.pentaho.platform.api.action.IActionInvoker

Parameters:

actionBean - the IAction being invoked

actionUser - The user invoking the IAction

params - the Map or parameters needed to invoke the IAction

Returns:

the IActionInvokeStatus object containing information about the action invocation

Throws:

Exception - when the IAction cannot be invoked for some reason.

invokeActionImpl

protected org.pentaho.platform.api.action.IActionInvokeStatus invokeActionImpl(org.pentaho.platform.api.action.IAction actionBean,
                                                                               String actionUser,
                                                                               Map<String,Serializable> params)
                                                                        throws Exception

Invokes the provided IAction as the provided actionUser.

Parameters:

actionBean - the IAction being invoked

actionUser - The user invoking the IAction

params - the Map or parameters needed to invoke the IAction

Returns:

the IActionInvokeStatus object containing information about the action invocation

Throws:

Exception - when the IAction cannot be invoked for some reason.

isSupportedAction

public boolean isSupportedAction(org.pentaho.platform.api.action.IAction action)

Specified by:

isSupportedAction in interface org.pentaho.platform.api.action.IActionInvoker