Package step.core.plans.runner

Class PlanRunnerResult

java.lang.Object

step.core.plans.runner.PlanRunnerResult

Direct Known Subclasses:

RemoteExecutionFuture, RemotePlanRunner.RemotePlanRunnerResult

public class PlanRunnerResult
extends Object

This class provides an API for the manipulation of plan executions

Field Summary

Fields

Modifier and Type	Field	Description
protected final String	executionId
protected final ReportTreeAccessor	reportTreeAccessor
protected final ResourceManager	resourceManager
protected final String	rootReportNodeId

Constructor Summary

Constructors

Constructor	Description
PlanRunnerResult(String executionId, String rootReportNodeId, ReportTreeAccessor reportTreeAccessor)
PlanRunnerResult(String executionId, String rootReportNodeId, ReportTreeAccessor reportTreeAccessor, ResourceManager resourceManager)

Method Summary

Modifier and Type	Method	Description
Set<Integer>	getErrorCodes(int limit)
Stream<step.core.reports.Error>	getErrors()
String	getErrorSummary()
String	getExecutionId()
Stream<ReportNode>	getReportNodesWithErrors()
ReportTreeAccessor	getReportTreeAccessor()
protected ReportTreeVisitor	getReportTreeVisitor()
ReportNodeStatus	getResult()
ReportNode	getRootReportNode()
String	getTreeAsString()
PlanRunnerResult	printTree()	Prints the result tree to the standard output
PlanRunnerResult	printTree(Writer writer)	Prints the result tree to the Writer provided as input
PlanRunnerResult	printTree(Writer writer, boolean printAttachments)	Prints the result tree to the Writer provided as input
PlanRunnerResult	printTree(Writer writer, boolean printNodeDetails, boolean printAttachments)	Prints the result tree to the Writer provided as input
PlanRunnerResult	visitReportNodes(Consumer<ReportNode> consumer)	Visits the report tree of the execution using the Consumer of ReportNode
PlanRunnerResult	visitReportTree(Consumer<ReportTreeVisitor.ReportNodeEvent> consumer)	Visits the report tree of the execution using the Consumer of ReportTreeVisitor.ReportNodeEvent
PlanRunnerResult	waitForExecutionToTerminate()	Wait indefinitely for an the execution to terminate
PlanRunnerResult	waitForExecutionToTerminate(long timeout)	Wait for an the execution to terminate
PlanRunnerResult	writeReport(ReportWriter reportWriter, File outputFile)	Writes a report of the execution using the provided ReportWriter

Methods inherited from class java.lang.Object

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

Field Details

executionId

protected final String executionId

rootReportNodeId

protected final String rootReportNodeId

reportTreeAccessor

protected final ReportTreeAccessor reportTreeAccessor

resourceManager

protected final ResourceManager resourceManager

Constructor Details

PlanRunnerResult

public PlanRunnerResult(String executionId,
 String rootReportNodeId,
 ReportTreeAccessor reportTreeAccessor)

PlanRunnerResult

public PlanRunnerResult(String executionId,
 String rootReportNodeId,
 ReportTreeAccessor reportTreeAccessor,
 ResourceManager resourceManager)

Method Details

getResult

public ReportNodeStatus getResult()

getRootReportNode

public ReportNode getRootReportNode()

getReportNodesWithErrors

public Stream<ReportNode> getReportNodesWithErrors()

Returns:

a stream of all report nodes with errors that caused this execution to fail. This returns only the so-called contributing errors according to following definition ReportNode.getContributingError()

getErrors

public Stream<step.core.reports.Error> getErrors()

Returns:

a stream of all errors that caused this execution to fail. This returns only the so-called contributing errors according to following definition ReportNode.getContributingError()

getErrorSummary

public String getErrorSummary()

Returns:

a concatenation of the first 10 error messages that caused this execution to fail. This considers only the so-called contributing errors according to following definition ReportNode.getContributingError()

getErrorCodes

public Set<Integer> getErrorCodes(int limit)

Parameters:

limit - the max errors to be scanned

Returns:

a Set containing the error codes of the first n errors where n is set by the limit parameter.

getExecutionId

public String getExecutionId()

getReportTreeAccessor

public ReportTreeAccessor getReportTreeAccessor()

visitReportNodes

public PlanRunnerResult visitReportNodes(Consumer<ReportNode> consumer)

Visits the report tree of the execution using the Consumer of ReportNode

Parameters:

consumer - the visitor

Returns:

this instance

visitReportTree

public PlanRunnerResult visitReportTree(Consumer<ReportTreeVisitor.ReportNodeEvent> consumer)

Visits the report tree of the execution using the Consumer of ReportTreeVisitor.ReportNodeEvent

Parameters:

consumer - the visitor

Returns:

this instance

getReportTreeVisitor

protected ReportTreeVisitor getReportTreeVisitor()

waitForExecutionToTerminate

public PlanRunnerResult waitForExecutionToTerminate(long timeout)
                                             throws TimeoutException,
InterruptedException

Wait for an the execution to terminate

Parameters:

timeout - the timeout in ms

Returns:

this instance

Throws:

TimeoutException

InterruptedException

waitForExecutionToTerminate

public PlanRunnerResult waitForExecutionToTerminate()
                                             throws TimeoutException,
InterruptedException

Wait indefinitely for an the execution to terminate

Returns:

this instance

Throws:

TimeoutException

InterruptedException

printTree

public PlanRunnerResult printTree()
                           throws IOException

Prints the result tree to the standard output

Returns:

this instance

Throws:

IOException

printTree

public PlanRunnerResult printTree(Writer writer)
                           throws IOException

Prints the result tree to the Writer provided as input

Parameters:

writer -

Returns:

this instance

Throws:

IOException

printTree

public PlanRunnerResult printTree(Writer writer,
 boolean printAttachments)
                           throws IOException

Prints the result tree to the Writer provided as input

Parameters:

writer -

printAttachments - if the attachments of the report nodes have to be printed out (currently restricted to attachments called "exception.log")

Returns:

this instance

Throws:

IOException

printTree

public PlanRunnerResult printTree(Writer writer,
 boolean printNodeDetails,
 boolean printAttachments)
                           throws IOException

Prints the result tree to the Writer provided as input

Parameters:

writer -

printNodeDetails - if the details of the report nodes should be printed out

printAttachments - if the attachments of the report nodes have to be printed out (currently restricted to attachments called "exception.log")

Returns:

this instance

Throws:

IOException

getTreeAsString

public String getTreeAsString()
                       throws IOException

Throws:

IOException

writeReport

public PlanRunnerResult writeReport(ReportWriter reportWriter,
 File outputFile)
                             throws IOException

Writes a report of the execution using the provided ReportWriter

Parameters:

reportWriter - the ReportWriter to be used to write the report

outputFile - the output file of the report

Returns:

this instance

Throws:

IOException - if an exception occurs while writing the report