org.pentaho.platform.api.action

Interface IActionAdaptor

public interface IActionAdaptor

This interface will provide a way to create an adaptor between IAction and any orchestration tool like for example Mesos or Kubernetes etc.

Method Summary

Modifier and Type	Method and Description
IActionInvokeStatus	delete(IAction action, String user, Map<String,Serializable> params) Delete the request
IActionInvokeStatus	execute(IAction action, String user, Map<String,Serializable> params) Execute the request in the orchestration environment
IActionInvokeStatus	schedule(IAction action, String user, Map<String,Serializable> params) Schedule the request for execution in the orchestration environment in future

Method Detail

execute

IActionInvokeStatus execute(IAction action,
                            String user,
                            Map<String,Serializable> params)
                     throws Exception

Execute the request in the orchestration environment

Parameters:

(@link - IAction) that holds the action for execution

user - The user invoking the action

(@link - Map) of parameters for execution

Returns:

the IActionInvokeStatus object containing result of the action

Throws:

Exception

schedule

IActionInvokeStatus schedule(IAction action,
                             String user,
                             Map<String,Serializable> params)
                      throws Exception

Schedule the request for execution in the orchestration environment in future

Parameters:

(@link - IAction) that holds the action for execution

user - The user invoking the action

(@link - Map) of parameters for execution

Returns:

the IActionInvokeStatus object containing result of the action

Throws:

Exception

delete

IActionInvokeStatus delete(IAction action,
                           String user,
                           Map<String,Serializable> params)
                    throws Exception

Delete the request

Parameters:

(@link - IAction) that holds the action for execution

user - The user invoking the action

(@link - Map) of parameters for execution

Returns:

the IActionInvokeStatus object containing result of the action

Throws:

Exception