io.nosqlbench.nb.api.metadata.ScenarioMetadataAware Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of nb-api Show documentation

The top level API module for NoSQLBench. This module should have no internal module dependencies other than the mvn-default module. All modules within NoSQLBench can safely depend on this module with circular dependencies. This module provides cross-cutting code infrastracture, such as path utilities and ways of describing services used between modules. It is also the transitive aggregation point for system-wide library dependencies for logging and testing or similar needs.

There is a newer version: 5.17.0

Show newest version

package io.nosqlbench.nb.api.metadata;

/**
 * Where supported, the following named fields are injected into object which
 * implement this interface:
 * 
 *     SCENARIO_NAME - The full scenario name, used for logging, metrics, etc
 *     STARTED_AT_MILLIS - The millisecond timestamp used to create the scenario name
 *     SYSTEM_ID - A stable identifier based on the available ip addresses
 *     SYSTEM_FINGERPRINT - a stable and pseudonymous identifier based on SYSTEM_ID
 * 
 */
public interface ScenarioMetadataAware {
    void setScenarioMetadata(ScenarioMetadata metadata);

    static void apply(Object target, ScenarioMetadata metadata) {
        if (target instanceof ScenarioMetadataAware) {
            ((ScenarioMetadataAware)target).setScenarioMetadata(metadata);
        }
    }
}