Package org.pentaho.platform.scheduler2.quartz

Class ActionAdapterQuartzJob

java.lang.Object

org.pentaho.platform.scheduler2.quartz.ActionAdapterQuartzJob

All Implemented Interfaces:

org.quartz.Job

public class ActionAdapterQuartzJob
extends Object
implements org.quartz.Job

A Quartz job that is responsible for executing the IAction referred to in the job context.

Author:

aphillips

Constructor Summary

Constructors

Constructor	Description
ActionAdapterQuartzJob()

Method Summary

Modifier and Type	Method	Description
void	execute(org.quartz.JobExecutionContext context)
org.pentaho.platform.api.action.IActionInvoker	getActionInvoker()
protected void	invokeAction(String actionClassName, String actionId, String actionUser, org.quartz.JobExecutionContext context, Map<String,Serializable> params)	Invokes the IAction bean that is created from the provided actionClassName and actionId as the provided actionUser.
protected void	invokeAction(org.pentaho.platform.api.action.IAction actionBean, String actionUser, org.quartz.JobExecutionContext context, Map<String,Serializable> params)	Deprecated. as of 8.0, use invokeAction(String, String, String, JobExecutionContext, Map)} instead
void	setActionInvoker(org.pentaho.platform.api.action.IActionInvoker actionInvoker)

Methods inherited from class java.lang.Object

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

Constructor Detail

ActionAdapterQuartzJob

public ActionAdapterQuartzJob()

Method Detail

execute

public void execute(org.quartz.JobExecutionContext context)
             throws org.quartz.JobExecutionException

Specified by:

execute in interface org.quartz.Job

Throws:

org.quartz.JobExecutionException

invokeAction

@Deprecated
protected void invokeAction(org.pentaho.platform.api.action.IAction actionBean,
                            String actionUser,
                            org.quartz.JobExecutionContext context,
                            Map<String,Serializable> params)
                     throws Exception

Deprecated.

as of 8.0, use invokeAction(String, String, String, JobExecutionContext, Map)} instead

Throws:

Exception

invokeAction

protected void invokeAction(String actionClassName,
                            String actionId,
                            String actionUser,
                            org.quartz.JobExecutionContext context,
                            Map<String,Serializable> params)
                     throws Exception

Invokes the IAction bean that is created from the provided actionClassName and actionId as the provided actionUser. If the IAction execution fails as-is, the scheduler attempts to re-create the job that will try to invoke the IAction again.

Parameters:

actionClassName - The class name of the IAction bean; used as a backup, if the actionId is not available or vald

actionId - The bean id of the IAction requested to be invoked.

actionUser - The user invoking the IAction

context - the JobExecutionContext

params - the Map or parameters needed to invoke the IAction

Throws:

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

getActionInvoker

public org.pentaho.platform.api.action.IActionInvoker getActionInvoker()

setActionInvoker

public void setActionInvoker(org.pentaho.platform.api.action.IActionInvoker actionInvoker)