com.marklogic.hub.flow

Interface FlowRunner

All Known Implementing Classes:

FlowRunnerImpl

public interface FlowRunner

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.
FlowRunner	onStatusChanged(FlowStatusListener listener) Sets the status change listener on the flowrunner object
RunFlowResponse	runFlow(FlowInputs flowInputs) Run a flow without any dependency on an underlying HubProject for either finding artifacts (flows and step definitions) or for resolving file paths for an ingestion step.
RunFlowResponse	runFlow(java.lang.String flow) Deprecated. Starting in 5.2.0, prefer runFlow(FlowInputs), which does not depend on Spring or project files on the filesystem
RunFlowResponse	runFlow(java.lang.String flow, java.util.List<java.lang.String> steps) Deprecated. Starting in 5.2.0, prefer runFlow(FlowInputs), which does not depend on Spring or project files on the filesystem
RunFlowResponse	runFlow(java.lang.String flow, java.util.List<java.lang.String> steps, java.lang.String jobId) Deprecated. Starting in 5.2.0, prefer runFlow(FlowInputs), which does not depend on Spring or project files on the filesystem
RunFlowResponse	runFlow(java.lang.String flow, java.util.List<java.lang.String> steps, java.lang.String jobId, java.util.Map<java.lang.String,java.lang.Object> options) Deprecated. Starting in 5.2.0, prefer runFlow(FlowInputs), which does not depend on Spring or project files on the filesystem
RunFlowResponse	runFlow(java.lang.String flow, java.util.List<java.lang.String> steps, 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. Starting in 5.2.0, prefer runFlow(FlowInputs), which does not depend on Spring or project files on the filesystem
RunFlowResponse	runFlow(java.lang.String flow, java.lang.String jobId) Deprecated. Starting in 5.2.0, prefer runFlow(FlowInputs), which does not depend on Spring or project files on the filesystem
RunFlowResponse	runFlow(java.lang.String flow, java.lang.String jobId, java.util.Map<java.lang.String,java.lang.Object> options) Deprecated. Starting in 5.2.0, prefer runFlow(FlowInputs), which does not depend on Spring or project files on the filesystem
void	stopJob(java.lang.String jobId) Runs the flow.

Method Detail

runFlow

RunFlowResponse runFlow(FlowInputs flowInputs)

Run a flow without any dependency on an underlying HubProject for either finding artifacts (flows and step definitions) or for resolving file paths for an ingestion step. If an ingestion step does have a relative file path, then the ingestion step will fail due to not being able to resolve the relative file path to an absolute file path. Aside from retrieving flows and step definitions from MarkLogic instead of from the filesystem, the behavior of this method - the output of each step and the returned RunFlowResponse - will be identical to that of every other "runFlow" method in this class.

Parameters:

flowInputs -

Returns:

runFlow

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

Deprecated. Starting in 5.2.0, prefer runFlow(FlowInputs), which does not depend on Spring or project files on the filesystem

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

Parameters:

flow - the flow to run

jobId - the jobid to be used for the flow

Returns:

a response object

runFlow

@Deprecated
RunFlowResponse runFlow(java.lang.String flow,
                                    java.util.List<java.lang.String> steps,
                                    java.lang.String jobId)

Deprecated. Starting in 5.2.0, prefer runFlow(FlowInputs), which does not depend on Spring or project files on the filesystem

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

Parameters:

flow - the flow to run

steps - the steps in the flow to run

jobId - the jobid to be used for the flow

Returns:

a response object

runFlow

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

Deprecated. Starting in 5.2.0, prefer runFlow(FlowInputs), which does not depend on Spring or project files on the filesystem

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

Parameters:

flow - 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
RunFlowResponse runFlow(java.lang.String flow,
                                    java.util.List<java.lang.String> steps,
                                    java.lang.String jobId,
                                    java.util.Map<java.lang.String,java.lang.Object> options)

Deprecated. Starting in 5.2.0, prefer runFlow(FlowInputs), which does not depend on Spring or project files on the filesystem

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

Parameters:

flow - the flow to run

steps - 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
RunFlowResponse runFlow(java.lang.String flow,
                                    java.util.List<java.lang.String> steps,
                                    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. Starting in 5.2.0, prefer runFlow(FlowInputs), which does not depend on Spring or project files on the filesystem

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

Parameters:

flow - the flow to run

steps - 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

@Deprecated
RunFlowResponse runFlow(java.lang.String flow,
                                    java.util.List<java.lang.String> steps)

Deprecated. Starting in 5.2.0, prefer runFlow(FlowInputs), which does not depend on Spring or project files on the filesystem

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

Parameters:

flow - the flow to run

steps - the steps in the flow to run

Returns:

a response object

runFlow

@Deprecated
RunFlowResponse runFlow(java.lang.String flow)

Deprecated. Starting in 5.2.0, prefer runFlow(FlowInputs), which does not depend on Spring or project files on the filesystem

Runs the entire flow, with full defaults

Parameters:

flow - the flow to run

Returns:

a response object

stopJob

void stopJob(java.lang.String jobId)

Runs the flow.

Parameters:

jobId - the id of the running flow

awaitCompletion

void awaitCompletion()

Blocks until the flow execution is complete.

awaitCompletion

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

Blocks until the flow execution is complete.

Parameters:

timeout - the maximum time to wait

unit - the time unit of the timeout argument

Throws:

java.lang.InterruptedException - if interrupted while waiting

java.util.concurrent.TimeoutException - if times out

onStatusChanged

FlowRunner onStatusChanged(FlowStatusListener listener)

Sets the status change listener on the flowrunner object

Parameters:

listener - - the listener for when the status changes

Returns:

the flow runner object