org.pentaho.platform.scheduler
Class SchedulerAdminUIComponent

java.lang.Object
  org.pentaho.platform.engine.core.system.PentahoBase
      org.pentaho.platform.engine.services.PentahoMessenger
          org.pentaho.platform.uifoundation.component.BaseUIComponent
              org.pentaho.platform.uifoundation.component.xml.XmlComponent
                  org.pentaho.platform.scheduler.SchedulerAdminUIComponent

All Implemented Interfaces:

Serializable, ILogger, IUIComponent, IXMLComponent

public class SchedulerAdminUIComponent
extends XmlComponent

API description: Base URL is: http://://SchedulerAdmin or http://localhost:8080/pentaho/SchedulerAdmin deleteJob: schedulerAction=deleteJob&jobName=PentahoSystemVersionCheck&jobGroup=DEFAULT executeJobNow: schedulerAction=executeJob&jobName=PentahoSystemVersionCheck&jobGroup=DEFAULT getJobNames: schedulerAction=getJobNames isSchedulerPaused: schedulerAction=isSchedulerPaused pauseAll: schedulerAction=suspendScheduler pauseJob: schedulerAction=pauseJob&jobName=PentahoSystemVersionCheck&jobGroup=DEFAULT resumeAll: schedulerAction=resumeScheduler resumeJob: schedulerAction=resumeJob&jobName=PentahoSystemVersionCheck&jobGroup=DEFAULT TODO sbarkdull, add API for create and update NOTE: the term "Job" is somewhat misused in much of this file. Often where you see the term "Job", it means "Schedule". A Schedule is a combination of a trigger and a Job. A trigger is essentially a time to execute something, a Job is essentially the set of things to execute when a trigger fires.

Author:

wseyler TODO To change the template for this generated type comment go to Window - Preferences - Java - Code Style - Code Templates

See Also:

Serialized Form

Field Summary

static String	CREATE_JOB_ACTION_STR
static String	DELETE_JOB_ACTION_STR
static String	GET_IS_SCHEDULER_PAUSED_ACTION_STR
static String	GET_JOB_NAMES_ACTION_STR
static String	PAUSE_JOB_ACTION_STR
static String	RESUME_JOB_ACTION_STR
static String	RESUME_SCHEDULER_ACTION_STR
static String	RUN_JOB_ACTION_STR
static String	SCHEDULER_ACTION_STR
static String	SUSPEND_SCHEDULER_ACTION_STR
static String	UPDATE_JOB_ACTION_STR

Fields inherited from class org.pentaho.platform.uifoundation.component.BaseUIComponent

debug

Fields inherited from class org.pentaho.platform.engine.core.system.PentahoBase

EMPTYLOGID, LOGID_MASK1, LOGID_MASK2, LOGID_SEPARATOR

Fields inherited from interface org.pentaho.platform.api.engine.ILogger

ACTIVITY_LOG, DEBUG, ERROR, FATAL, INFO, INSTANCE_LOG, SESSION_LOG, SOLUTION_LOG, TRACE, UNKNOWN, WARN

Constructor Summary

SchedulerAdminUIComponent(IPentahoUrlFactory urlFactory, List<String> messages)

Method Summary

org.apache.commons.logging.Log	getLogger()
org.dom4j.Document	getXmlContent()
boolean	validate()

Methods inherited from class org.pentaho.platform.uifoundation.component.xml.XmlComponent

getContent

Methods inherited from class org.pentaho.platform.uifoundation.component.BaseUIComponent

done, getObjectParameter, getParameter, getParameterAsArray, getParameterProviders, getXsl, getXslProperties, handleRequest, setParameterProvider, setParameterProviders, setRequestHandler, setUrlFactory, setXsl, setXslProperty, validate

Methods inherited from class org.pentaho.platform.engine.services.PentahoMessenger

debug, debug, error, error, error, fatal, fatal, getMessages, getUserString, info, info, setMessages, trace, trace, warn, warn

Methods inherited from class org.pentaho.platform.engine.core.system.PentahoBase

genLogIdFromInfo, genLogIdFromInfo, genLogIdFromSession, getLoggingLevel, getLogId, getObjectName, setLoggingLevel, setLogId

Methods inherited from class java.lang.Object

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

Field Detail

RESUME_SCHEDULER_ACTION_STR

public static final String RESUME_SCHEDULER_ACTION_STR

See Also:

Constant Field Values

SUSPEND_SCHEDULER_ACTION_STR

public static final String SUSPEND_SCHEDULER_ACTION_STR

See Also:

Constant Field Values

GET_JOB_NAMES_ACTION_STR

public static final String GET_JOB_NAMES_ACTION_STR

See Also:

Constant Field Values

GET_IS_SCHEDULER_PAUSED_ACTION_STR

public static final String GET_IS_SCHEDULER_PAUSED_ACTION_STR

See Also:

Constant Field Values

PAUSE_JOB_ACTION_STR

public static final String PAUSE_JOB_ACTION_STR

See Also:

Constant Field Values

RESUME_JOB_ACTION_STR

public static final String RESUME_JOB_ACTION_STR

See Also:

Constant Field Values

DELETE_JOB_ACTION_STR

public static final String DELETE_JOB_ACTION_STR

See Also:

Constant Field Values

SCHEDULER_ACTION_STR

public static final String SCHEDULER_ACTION_STR

See Also:

Constant Field Values

RUN_JOB_ACTION_STR

public static final String RUN_JOB_ACTION_STR

See Also:

Constant Field Values

CREATE_JOB_ACTION_STR

public static final String CREATE_JOB_ACTION_STR

See Also:

Constant Field Values

UPDATE_JOB_ACTION_STR

public static final String UPDATE_JOB_ACTION_STR

See Also:

Constant Field Values

Constructor Detail

SchedulerAdminUIComponent

public SchedulerAdminUIComponent(IPentahoUrlFactory urlFactory,
                                 List<String> messages)

Parameters:

urlFactory -

Method Detail

getLogger

public org.apache.commons.logging.Log getLogger()

Specified by:

getLogger in class BaseUIComponent

validate

public boolean validate()

Specified by:

validate in interface IUIComponent

Specified by:

validate in class BaseUIComponent

getXmlContent

public org.dom4j.Document getXmlContent()

Specified by:

getXmlContent in interface IXMLComponent

Specified by:

getXmlContent in class XmlComponent