Class NBBaseCommand

java.lang.Object

io.nosqlbench.nb.api.components.core.NBBaseComponentMetrics

io.nosqlbench.nb.api.components.core.NBBaseComponent

io.nosqlbench.engine.core.lifecycle.scenario.execution.NBInvokableCommand

io.nosqlbench.engine.core.lifecycle.scenario.execution.NBBaseCommand

All Implemented Interfaces:

NBComponent, NBComponentAdvisors, NBComponentEvents, NBComponentMetrics, NBComponentProps, NBComponentServices, NBComponentTimeline, NBProviderSearch, NBTokenWords, NBLabeledElement, AutoCloseable, BiFunction<NBBufferedContainer,NBCommandParams,Object>

Direct Known Subclasses:

CMD_await, CMD_error, CMD_example, CMD_findmax, CMD_forceStop, CMD_getenv, CMD_ok, CMD_optimize, CMD_optimo, CMD_reset, CMD_run, CMD_start, CMD_stop, CMD_wait, NB_diag, NBScriptedCommand

public abstract class NBBaseCommand
extends NBInvokableCommand

Nested Class Summary

Nested classes/interfaces inherited from interface io.nosqlbench.nb.api.labels.NBLabeledElement

NBLabeledElement.BasicLabeledElement

Field Summary

Fields

Modifier and Type	Field	Description
protected org.apache.logging.log4j.Logger	logger

Fields inherited from class io.nosqlbench.nb.api.components.core.NBBaseComponent

bufferOrphanedMetrics, closed_ns, error, errored_ns, labels, metricsBuffer, parent, started_epoch_ms, started_ns, state, teardown_ns

Fields inherited from interface io.nosqlbench.nb.api.components.core.NBComponent

EMPTY_COMPONENT

Fields inherited from interface io.nosqlbench.nb.api.components.core.NBComponentProps

HDRDIGITS, SUMMARY

Fields inherited from interface io.nosqlbench.nb.api.labels.NBLabeledElement

EMPTY

Constructor Summary

Constructors

Constructor	Description
NBBaseCommand(NBBufferedContainer parentComponent, String commandLabel)
NBBaseCommand(NBBufferedContainer parentComponent, String stepName, String targetScenario)

Method Summary

Modifier and Type	Method	Description
final Object	apply(NBBufferedContainer sctx, NBCommandParams params)
String	getScenarioName()
String	getTargetScenario()
abstract Object	invoke(NBCommandParams params, PrintWriter stdout, PrintWriter stderr, Reader stdin, ContainerActivitiesController controller)
String	toString()

Methods inherited from class io.nosqlbench.engine.core.lifecycle.scenario.execution.NBInvokableCommand

invokeSafe

Methods inherited from class io.nosqlbench.nb.api.components.core.NBBaseComponent

addAdvisor, addMetricsCloseable, attachChild, beforeDetach, close, create, detachChild, find, findParentService, getAdvisors, getChildren, getComponentOnlyLabels, getComponentProp, getComponentState, getLabels, getNanosSinceStart, getParent, getTokens, nanosof_close, nanosof_error, nanosof_start, nanosof_teardown, onError, onEvent, reportExecutionMetric, setComponentProp, started_epoch_ms, teardown

Methods inherited from class io.nosqlbench.nb.api.components.core.NBBaseComponentMetrics

addComponentMetric, addListener, findComponentMetrics, findComponentMetrics, getComponentMetric, getComponentMetrics, removeListener

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.function.BiFunction

andThen

Methods inherited from interface io.nosqlbench.nb.api.components.core.NBComponentAdvisors

getAdvisorResults

Methods inherited from interface io.nosqlbench.nb.api.components.core.NBComponentMetrics

addComponentMetric, findComponentMetrics, findComponentMetrics, findOneComponentMetric, findOneComponentMetric, getComponentMetric, getComponentMetrics

Methods inherited from interface io.nosqlbench.nb.api.labels.NBLabeledElement

description

Field Details

logger

protected org.apache.logging.log4j.Logger logger

Constructor Details

NBBaseCommand

public NBBaseCommand(NBBufferedContainer parentComponent,
 String stepName,
 String targetScenario)

NBBaseCommand

public NBBaseCommand(NBBufferedContainer parentComponent,
 String commandLabel)

Method Details

getScenarioName

public String getScenarioName()

getTargetScenario

public String getTargetScenario()

apply

public final Object apply(NBBufferedContainer sctx,
 NBCommandParams params)

Specified by:

apply in interface BiFunction<NBBufferedContainer,NBCommandParams,Object>

Specified by:

apply in class NBInvokableCommand

toString

public String toString()

Overrides:

toString in class NBBaseComponent

invoke

public abstract Object invoke(NBCommandParams params,
 PrintWriter stdout,
 PrintWriter stderr,
 Reader stdin,
 ContainerActivitiesController controller)