com.marklogic.hub.flow.impl

Class FlowRunnerImpl

java.lang.Object

com.marklogic.hub.flow.impl.FlowRunnerImpl

All Implemented Interfaces:

FlowRunner

@Component
public class FlowRunnerImpl
extends java.lang.Object
implements FlowRunner

Field Summary

Fields

Modifier and Type	Field and Description
protected org.slf4j.Logger	logger

Constructor Summary

Constructors

Constructor and Description
FlowRunnerImpl()
FlowRunnerImpl(com.marklogic.hub.HubClient hubClient) Constructs a FlowRunnerImpl that can be used for running flows without any reference to project files on a filesystem - and thus, this constructor will not instantiate an instance of FlowManager, which is used for reading project files from the filesystem.
FlowRunnerImpl(HubConfig hubConfig) Deprecated.
FlowRunnerImpl(HubConfig hubConfig, FlowManager flowManager) Simulates construction of this object via Spring, where the Autowired objects are set manually.
FlowRunnerImpl(java.lang.String host, java.lang.String username, java.lang.String password) Convenience constructor for running flows with no dependency on project files on the filesystem, and where a user can authenticate with just a username and a password.

Method Summary

Modifier and Type	Method and Description
void	awaitCompletion() Blocks until the flow execution is complete.
void	awaitCompletion(long timeout, java.util.concurrent.TimeUnit unit) Blocks until the flow execution is complete.
protected void	configureStopOnError(Flow flow, java.util.Map<java.lang.String,java.lang.Object> options) To support the "failHard" parameter in CommandLineFlowInputs, this method checks for stopOnError in the options map.
protected void	copyJobDataToResponse(RunFlowResponse response, RunFlowResponse jobDocument)
RunFlowResponse	getJobResponseById(java.lang.String jobId)
java.util.List<java.lang.String>	getQueuedJobIdsFromFlow(java.lang.String flowName)
Flow	getRunningFlow()
java.lang.String	getRunningStepKey()
boolean	isJobRunning()
FlowRunner	onStatusChanged(FlowStatusListener listener) Sets the status change listener on the flowrunner object
RunFlowResponse	runFlow(FlowInputs flowInputs) Retrieves the given flow from the staging database in MarkLogic, and then proceeds with the normal execution of the flow.
protected RunFlowResponse	runFlow(Flow flow, java.util.List<java.lang.String> stepNums, java.lang.String jobId, java.util.Map<java.lang.String,java.lang.Object> options, java.util.Map<java.lang.String,java.lang.Object> stepConfig)
RunFlowResponse	runFlow(java.lang.String flowName) Deprecated.
RunFlowResponse	runFlow(java.lang.String flowName, java.util.List<java.lang.String> stepNums) Deprecated.
RunFlowResponse	runFlow(java.lang.String flowName, java.util.List<java.lang.String> stepNums, java.lang.String jobId) Deprecated.
RunFlowResponse	runFlow(java.lang.String flowName, java.util.List<java.lang.String> stepNums, java.lang.String jobId, java.util.Map<java.lang.String,java.lang.Object> options) Deprecated.
RunFlowResponse	runFlow(java.lang.String flowName, java.util.List<java.lang.String> stepNums, java.lang.String jobId, java.util.Map<java.lang.String,java.lang.Object> options, java.util.Map<java.lang.String,java.lang.Object> stepConfig) Deprecated.
RunFlowResponse	runFlow(java.lang.String flowName, java.lang.String jobId) Deprecated.
RunFlowResponse	runFlow(java.lang.String flowName, java.lang.String jobId, java.util.Map<java.lang.String,java.lang.Object> options) Deprecated.
void	stopJob(java.lang.String jobId) Runs the flow.

Methods inherited from class java.lang.Object

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

Field Detail

logger

protected final org.slf4j.Logger logger

Constructor Detail

FlowRunnerImpl

public FlowRunnerImpl()

FlowRunnerImpl

public FlowRunnerImpl(HubConfig hubConfig,
                      FlowManager flowManager)

Simulates construction of this object via Spring, where the Autowired objects are set manually.

Parameters:

hubConfig -

flowManager -

FlowRunnerImpl

public FlowRunnerImpl(java.lang.String host,
                      java.lang.String username,
                      java.lang.String password)

Convenience constructor for running flows with no dependency on project files on the filesystem, and where a user can authenticate with just a username and a password.

Parameters:

host - the host of the Data Hub instance to connect to

username - the username of the MarkLogic user for running a flow

password - the password of the MarkLogic user for running a flow

FlowRunnerImpl

public FlowRunnerImpl(com.marklogic.hub.HubClient hubClient)

Constructs a FlowRunnerImpl that can be used for running flows without any reference to project files on a filesystem - and thus, this constructor will not instantiate an instance of FlowManager, which is used for reading project files from the filesystem. This constructor handles ensuring that step definitions are retrieved from MarkLogic as opposed to from the filesystem. It is expected that the "runFlow(FlowInputs)" method will then be used, which ensures that flow artifacts are also retrieved from MarkLogic as opposed to from the filesystem.

Parameters:

hubClient -

FlowRunnerImpl

@Deprecated
public FlowRunnerImpl(HubConfig hubConfig)

Deprecated.

Method Detail

onStatusChanged

public FlowRunner onStatusChanged(FlowStatusListener listener)

Description copied from interface: FlowRunner

Sets the status change listener on the flowrunner object

Specified by:

onStatusChanged in interface FlowRunner

Parameters:

listener - - the listener for when the status changes

Returns:

the flow runner object

runFlow

@Deprecated
public RunFlowResponse runFlow(java.lang.String flowName)

Deprecated.

Description copied from interface: FlowRunner

Runs the entire flow, with full defaults

Specified by:

runFlow in interface FlowRunner

Parameters:

flowName - the flow to run

Returns:

a response object

runFlow

@Deprecated
public RunFlowResponse runFlow(java.lang.String flowName,
                                           java.util.List<java.lang.String> stepNums)

Deprecated.

Description copied from interface: FlowRunner

Runs the flow, with a specific set of steps, with all defaults from step

Specified by:

runFlow in interface FlowRunner

Parameters:

flowName - the flow to run

stepNums - the steps in the flow to run

Returns:

a response object

runFlow

@Deprecated
public RunFlowResponse runFlow(java.lang.String flowName,
                                           java.lang.String jobId)

Deprecated.

Description copied from interface: FlowRunner

Runs the flow, with a specific set of steps, with all custom settings

Specified by:

runFlow in interface FlowRunner

Parameters:

flowName - the flow to run

jobId - the jobid to be used for the flow

Returns:

a response object

runFlow

@Deprecated
public RunFlowResponse runFlow(java.lang.String flowName,
                                           java.util.List<java.lang.String> stepNums,
                                           java.lang.String jobId)

Deprecated.

Description copied from interface: FlowRunner

Runs the flow, with a specific set of steps, with all custom settings

Specified by:

runFlow in interface FlowRunner

Parameters:

flowName - the flow to run

stepNums - the steps in the flow to run

jobId - the jobid to be used for the flow

Returns:

a response object

runFlow

@Deprecated
public RunFlowResponse runFlow(java.lang.String flowName,
                                           java.lang.String jobId,
                                           java.util.Map<java.lang.String,java.lang.Object> options)

Deprecated.

Description copied from interface: FlowRunner

Runs the flow, with a specific set of steps, with all custom settings

Specified by:

runFlow in interface FlowRunner

Parameters:

flowName - the flow to run

jobId - the jobid to be used for the flow

options - the key/value options to be passed

Returns:

a response object

runFlow

@Deprecated
public RunFlowResponse runFlow(java.lang.String flowName,
                                           java.util.List<java.lang.String> stepNums,
                                           java.lang.String jobId,
                                           java.util.Map<java.lang.String,java.lang.Object> options)

Deprecated.

Description copied from interface: FlowRunner

Runs the flow, with a specific set of steps, with all custom settings

Specified by:

runFlow in interface FlowRunner

Parameters:

flowName - the flow to run

stepNums - the steps in the flow to run

jobId - the jobid to be used for the flow

options - the key/value options to be passed

Returns:

a response object

runFlow

@Deprecated
public RunFlowResponse runFlow(java.lang.String flowName,
                                           java.util.List<java.lang.String> stepNums,
                                           java.lang.String jobId,
                                           java.util.Map<java.lang.String,java.lang.Object> options,
                                           java.util.Map<java.lang.String,java.lang.Object> stepConfig)

Deprecated.

Description copied from interface: FlowRunner

Runs the flow, with a specific set of steps, with all custom settings

Specified by:

runFlow in interface FlowRunner

Parameters:

flowName - the flow to run

stepNums - the steps in the flow to run

jobId - the jobid to be used for the flow

options - the key/value options to be passed

stepConfig - the key/value config to override the running of the step

Returns:

a response object

runFlow

public RunFlowResponse runFlow(FlowInputs flowInputs)

Retrieves the given flow from the staging database in MarkLogic, and then proceeds with the normal execution of the flow.

Specified by:

runFlow in interface FlowRunner

Parameters:

flowInputs -

Returns:

runFlow

protected RunFlowResponse runFlow(Flow flow,
                                  java.util.List<java.lang.String> stepNums,
                                  java.lang.String jobId,
                                  java.util.Map<java.lang.String,java.lang.Object> options,
                                  java.util.Map<java.lang.String,java.lang.Object> stepConfig)

configureStopOnError

protected void configureStopOnError(Flow flow,
                                    java.util.Map<java.lang.String,java.lang.Object> options)

To support the "failHard" parameter in CommandLineFlowInputs, this method checks for stopOnError in the options map. If true, this will set stopOnError in the flow. That will cause no other steps to be run once a step fails.

Parameters:

flow -

options -

stopJob

public void stopJob(java.lang.String jobId)

Description copied from interface: FlowRunner

Runs the flow.

Specified by:

stopJob in interface FlowRunner

Parameters:

jobId - the id of the running flow

copyJobDataToResponse

protected void copyJobDataToResponse(RunFlowResponse response,
                                     RunFlowResponse jobDocument)

awaitCompletion

public void awaitCompletion()

Description copied from interface: FlowRunner

Blocks until the flow execution is complete.

Specified by:

awaitCompletion in interface FlowRunner

awaitCompletion

public void awaitCompletion(long timeout,
                            java.util.concurrent.TimeUnit unit)
                     throws java.lang.InterruptedException

Description copied from interface: FlowRunner

Blocks until the flow execution is complete.

Specified by:

awaitCompletion in interface FlowRunner

Parameters:

timeout - the maximum time to wait

unit - the time unit of the timeout argument

Throws:

java.lang.InterruptedException - if interrupted while waiting

getQueuedJobIdsFromFlow

public java.util.List<java.lang.String> getQueuedJobIdsFromFlow(java.lang.String flowName)

getJobResponseById

public RunFlowResponse getJobResponseById(java.lang.String jobId)

isJobRunning

public boolean isJobRunning()

getRunningStepKey

public java.lang.String getRunningStepKey()

getRunningFlow

public Flow getRunningFlow()