|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.pentaho.platform.scheduler.QuartzBackgroundExecutionHelper
public class QuartzBackgroundExecutionHelper
Nested Class Summary | |
---|---|
static class |
QuartzBackgroundExecutionHelper.BackgroundExecuteListener
|
Field Summary | |
---|---|
static String |
BACKGROUND_CONTENT_COOKIE_PREFIX
|
static String |
BACKGROUND_CONTENT_GUID_STR
|
static String |
BACKGROUND_CONTENT_LOCATION_STR
|
static String |
BACKGROUND_EXECUTION_FLAG
|
static String |
BACKGROUND_USER_NAME_STR
|
static String |
DEFAULT_BACKGROUND_LOCATION
|
static String |
DEFAULT_JOB_NAME
|
static String |
DEFAULT_TRIGGER_NAME
|
Fields inherited from interface org.pentaho.platform.api.engine.IBackgroundExecution |
---|
BACKGROUND_ACTION_NAME_STR, BACKGROUND_SUBMITTED, DEFAULT_USER_NAME |
Constructor Summary | |
---|---|
QuartzBackgroundExecutionHelper()
|
Method Summary | |
---|---|
String |
backgroundExecuteAction(IPentahoSession userSession,
IParameterProvider parameterProvider)
NOTE: client code is responsible for making sure a job with the name identified by the parameter StandardSettings.SCHEDULE_NAME in the parameter provider does not already exist in the quartz scheduler. |
IContentItem |
getBackgroundContent(String contentGUID,
IPentahoSession userSession)
Gets the content generated by background execution |
List |
getBackgroundExecutedContentList(IPentahoSession userSession)
Gets a list of content GUIDs of background executed jobs |
IOutputHandler |
getContentOutputHandler(String location,
String fileName,
String solutionName,
IPentahoSession userSession,
IParameterProvider parameterProvider)
Returns the output handler for content, specific to the implementation of the background execution helper. |
IPentahoSession |
getEffectiveUserSession(String user)
When the job runs in background, gets the effective user session for the user executing the job |
List<IJobDetail> |
getScheduledAndExecutingBackgroundJobs(IPentahoSession userSession)
Gets the list of items scheduled for background execution, and those currently executing |
void |
removeBackgroundExecutedContentForID(String contentGUID,
IPentahoSession userSession)
Removes the content generated by background execution |
void |
trackBackgroundExecution(IPentahoSession userSession,
String GUID)
This provides an entry point for tracking the created background execution task |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final String DEFAULT_JOB_NAME
public static final String DEFAULT_TRIGGER_NAME
public static final String DEFAULT_BACKGROUND_LOCATION
public static final String BACKGROUND_USER_NAME_STR
public static final String BACKGROUND_CONTENT_GUID_STR
public static final String BACKGROUND_CONTENT_LOCATION_STR
public static final String BACKGROUND_CONTENT_COOKIE_PREFIX
public static final String BACKGROUND_EXECUTION_FLAG
Constructor Detail |
---|
public QuartzBackgroundExecutionHelper()
Method Detail |
---|
public String backgroundExecuteAction(IPentahoSession userSession, IParameterProvider parameterProvider) throws BackgroundExecutionException
backgroundExecuteAction
in interface IBackgroundExecution
parameterProvider
- IParameterProvider expected to have the following parameters:
required:
solution
path
action
optional (cron-string is required to create a CronTrigger):
cron-string
repeat-count
repeat-time-milliseconds
start-date
end-dateuserSession
- IPentahoSession of the session executing in background
BackgroundExecutionException
public void trackBackgroundExecution(IPentahoSession userSession, String GUID)
IBackgroundExecution
trackBackgroundExecution
in interface IBackgroundExecution
public IContentItem getBackgroundContent(String contentGUID, IPentahoSession userSession)
IBackgroundExecution
getBackgroundContent
in interface IBackgroundExecution
contentGUID
- The GUID for the contentuserSession
- The user session
public List<IJobDetail> getScheduledAndExecutingBackgroundJobs(IPentahoSession userSession) throws BackgroundExecutionException
IBackgroundExecution
getScheduledAndExecutingBackgroundJobs
in interface IBackgroundExecution
userSession
- The usersession
BackgroundExecutionException
public void removeBackgroundExecutedContentForID(String contentGUID, IPentahoSession userSession)
IBackgroundExecution
removeBackgroundExecutedContentForID
in interface IBackgroundExecution
contentGUID
- The GUID of the content generateduserSession
- The user sessionpublic List getBackgroundExecutedContentList(IPentahoSession userSession)
IBackgroundExecution
getBackgroundExecutedContentList
in interface IBackgroundExecution
userSession
- User session
public IPentahoSession getEffectiveUserSession(String user)
IBackgroundExecution
getEffectiveUserSession
in interface IBackgroundExecution
user
- The user name
public IOutputHandler getContentOutputHandler(String location, String fileName, String solutionName, IPentahoSession userSession, IParameterProvider parameterProvider)
IBackgroundExecution
getContentOutputHandler
in interface IBackgroundExecution
location
- Location for the contentfileName
- File name for the contentsolutionName
- Solution nameuserSession
- IPentahoSession of the callerparameterProvider
- parameter provider containing request parameters
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |