org.pentaho.platform.scheduler
Class SecurityAwareBackgroundExecutionHelper

java.lang.Object
  org.pentaho.platform.scheduler.QuartzBackgroundExecutionHelper
      org.pentaho.platform.scheduler.SecurityAwareBackgroundExecutionHelper

All Implemented Interfaces:

IBackgroundExecution

Direct Known Subclasses:

SecurityAwareBackgroundSubscriptionHelper

public class SecurityAwareBackgroundExecutionHelper
extends QuartzBackgroundExecutionHelper

Nested Class Summary

Nested classes/interfaces inherited from class org.pentaho.platform.scheduler.QuartzBackgroundExecutionHelper

QuartzBackgroundExecutionHelper.BackgroundExecuteListener

Field Summary

Fields inherited from class org.pentaho.platform.scheduler.QuartzBackgroundExecutionHelper

BACKGROUND_CONTENT_COOKIE_PREFIX, BACKGROUND_CONTENT_GUID_STR, BACKGROUND_CONTENT_LOCATION_STR, BACKGROUND_EXECUTION_FLAG, BACKGROUND_USER_NAME_STR, DEFAULT_BACKGROUND_LOCATION, DEFAULT_JOB_NAME, DEFAULT_TRIGGER_NAME

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

BACKGROUND_ACTION_NAME_STR, BACKGROUND_SUBMITTED, DEFAULT_USER_NAME

Constructor Summary

SecurityAwareBackgroundExecutionHelper()

Method Summary

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 userName) When the job runs in background, gets the effective user session for the user executing the job

Methods inherited from class org.pentaho.platform.scheduler.QuartzBackgroundExecutionHelper

backgroundExecuteAction, getBackgroundContent, getBackgroundExecutedContentList, getScheduledAndExecutingBackgroundJobs, removeBackgroundExecutedContentForID, trackBackgroundExecution

Methods inherited from class java.lang.Object

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

Constructor Detail

SecurityAwareBackgroundExecutionHelper

public SecurityAwareBackgroundExecutionHelper()

Method Detail

getEffectiveUserSession

public IPentahoSession getEffectiveUserSession(String userName)

Description copied from interface: IBackgroundExecution

When the job runs in background, gets the effective user session for the user executing the job

Specified by:

getEffectiveUserSession in interface IBackgroundExecution

Overrides:

getEffectiveUserSession in class QuartzBackgroundExecutionHelper

Parameters:

userName - The user name

Returns:

IPentahoSession for the user as if the user was clicking to run the job in realtime.

getContentOutputHandler

public IOutputHandler getContentOutputHandler(String location,
                                              String fileName,
                                              String solutionName,
                                              IPentahoSession userSession,
                                              IParameterProvider parameterProvider)

Description copied from interface: IBackgroundExecution

Returns the output handler for content, specific to the implementation of the background execution helper.

Specified by:

getContentOutputHandler in interface IBackgroundExecution

Overrides:

getContentOutputHandler in class QuartzBackgroundExecutionHelper

Parameters:

location - Location for the content

fileName - File name for the content

solutionName - Solution name

userSession - IPentahoSession of the caller

parameterProvider - parameter provider containing request parameters

Returns:

IOutputHandler implementation for storing the content.