org.pentaho.platform.scheduler2.action

Class DefaultActionInvoker

java.lang.Object

org.pentaho.platform.scheduler2.action.DefaultActionInvoker

All Implemented Interfaces:

IActionInvoker

public class DefaultActionInvoker
extends Object
implements IActionInvoker

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

Constructor Summary

Constructors

Constructor and Description
DefaultActionInvoker()

Method Summary

Modifier and Type	Method and Description
protected IBackgroundExecutionStreamProvider	getStreamProvider(Map<String,Serializable> params) Gets the stream provider from the RESERVEDMAPKEY_STREAMPROVIDER key within the params Map.
IActionInvokeStatus	invokeAction(IAction actionBean, String actionUser, Map<String,Serializable> params) Invokes the provided IAction as the provided actionUser.
protected IActionInvokeStatus	invokeActionImpl(IAction actionBean, String actionUser, Map<String,Serializable> params) Invokes the provided IAction as the provided actionUser.
boolean	isSupportedAction(IAction action)

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

invokeAction

public IActionInvokeStatus invokeAction(IAction actionBean,
                                        String actionUser,
                                        Map<String,Serializable> params)
                                 throws Exception

Invokes the provided IAction as the provided actionUser.

Specified by:

invokeAction in interface 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 IActionInvokeStatus invokeActionImpl(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(IAction action)

Specified by:

isSupportedAction in interface IActionInvoker