Package step.client.planrunners
Class RemotePlanRunner
- java.lang.Object
-
- step.client.AbstractRemoteClient
-
- step.client.planrunners.RemotePlanRunner
-
- All Implemented Interfaces:
Closeable
,AutoCloseable
,PlanRunner
public class RemotePlanRunner extends AbstractRemoteClient implements PlanRunner
A runner that runs plans fully remotely- Author:
- Jérôme Comte
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description class
RemotePlanRunner.RemotePlanRunnerResult
-
Field Summary
-
Fields inherited from class step.client.AbstractRemoteClient
client, cookies, credentials
-
-
Constructor Summary
Constructors Constructor Description RemotePlanRunner()
RemotePlanRunner(ControllerCredentials credentials)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description AbstractArtefact
getArtefact(String artefactId)
Execution
getExecution(String executionID)
PlanRunnerResult
run(Plan plan)
Runs a plan instancePlanRunnerResult
run(Plan plan, Map<String,String> executionParameters)
Runs a plan instance using the provided execution parametersPlanRunnerResult
runPlanById(Map<String,String> executionParameters, String planId, String name)
Execution
waitForExecutionToTerminate(String executionID, long timeout)
-
Methods inherited from class step.client.AbstractRemoteClient
close, executeRequest, notImplemented, requestBuilder, requestBuilder
-
-
-
-
Constructor Detail
-
RemotePlanRunner
public RemotePlanRunner()
-
RemotePlanRunner
public RemotePlanRunner(ControllerCredentials credentials)
-
-
Method Detail
-
run
public PlanRunnerResult run(Plan plan)
Description copied from interface:PlanRunner
Runs a plan instance- Specified by:
run
in interfacePlanRunner
- Parameters:
plan
- the plan to be run- Returns:
- an handle to the execution result
-
run
public PlanRunnerResult run(Plan plan, Map<String,String> executionParameters)
Description copied from interface:PlanRunner
Runs a plan instance using the provided execution parameters- Specified by:
run
in interfacePlanRunner
- Parameters:
plan
- thje plan to be runexecutionParameters
- the execution parameters to be used for the execution. These parameters are equivalent to the parameters selected on the execution screen of the STEP UI- Returns:
- an handle to the execution result
-
runPlanById
public PlanRunnerResult runPlanById(Map<String,String> executionParameters, String planId, String name)
-
waitForExecutionToTerminate
public Execution waitForExecutionToTerminate(String executionID, long timeout) throws TimeoutException, InterruptedException
- Throws:
TimeoutException
InterruptedException
-
getArtefact
public AbstractArtefact getArtefact(String artefactId)
-
-