Interface Internal

All Superinterfaces:
org.aeonbits.owner.Config, EngineProperties<Internal>, Serializable
@Sources({"system:properties","file:src/main/resources/properties/internal.properties","file:src/main/resources/properties/default/internal.properties","classpath:internal.properties"}) public interface Internal extends EngineProperties<Internal>
Configuration properties interface for internal engine metadata in the SHAFT framework. Exposes internal defaults such as the framework version, build timestamp, and the version coordinates used to bootstrap the Allure 3 CLI at report-generation time. These values are typically populated from build-time defaults, but they may also be supplied or overridden through the configured OWNER property sources, such as system properties or internal properties files.

  • Nested Class Summary

    Nested classes/interfaces inherited from interface org.aeonbits.owner.Config

    org.aeonbits.owner.Config.ConverterClass, org.aeonbits.owner.Config.DecryptorClass, org.aeonbits.owner.Config.DefaultValue, org.aeonbits.owner.Config.DisableableFeature, org.aeonbits.owner.Config.DisableFeature, org.aeonbits.owner.Config.EncryptedValue, org.aeonbits.owner.Config.HotReload, org.aeonbits.owner.Config.HotReloadType, org.aeonbits.owner.Config.Key, org.aeonbits.owner.Config.LoadPolicy, org.aeonbits.owner.Config.LoadType, org.aeonbits.owner.Config.PreprocessorClasses, org.aeonbits.owner.Config.Separator, org.aeonbits.owner.Config.Sources, org.aeonbits.owner.Config.TokenizerClass

    Nested classes/interfaces inherited from interface EngineProperties

    EngineProperties.SetProperty

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    allure3Version()
    Version of the Allure 3 npm package used when the CLI is not already on PATH.
    String
    ga4ApiSecret()
    Google Analytics 4 API Secret used for the Measurement Protocol.
    String
    ga4MeasurementId()
    Google Analytics 4 Measurement ID used for anonymous telemetry.
    String
    nodeLtsVersion()
    Version of the portable Node.js LTS distribution that SHAFT downloads when neither allure nor npx is available on PATH.
    String
    shaftEngineVersion()
     
    String
    watermarkImagePath()
     

    Methods inherited from interface EngineProperties

    set

  • Method Details

    • shaftEngineVersion

      @Key("shaftEngineVersion") @DefaultValue("10.2.20260506") String shaftEngineVersion()

    • watermarkImagePath

      @Key("watermarkImagePath") @DefaultValue("https://raw.githubusercontent.com/ShaftHQ/SHAFT_ENGINE/main/src/main/resources/images/shaft_white_bg.png") String watermarkImagePath()

    • allure3Version

      @Key("allure3Version") @DefaultValue("3.7.0") String allure3Version()
      Version of the Allure 3 npm package used when the CLI is not already on PATH. SHAFT invokes npx --yes allure@<version> to download and cache the package automatically. Update this value here to upgrade the bundled CLI across the engine without changing AllureManager or any CI script. Use this url for the latest version Allure3Releases

    • nodeLtsVersion

      @Key("nodeLtsVersion") @DefaultValue("24.15.0") String nodeLtsVersion()
      Version of the portable Node.js LTS distribution that SHAFT downloads when neither allure nor npx is available on PATH. The archive is cached in ~/.m2/repository/nodejs/ so it is only downloaded once per machine. Update this value here to upgrade the bundled Node.js runtime. Use this url for the latest version NodeJsLTS

    • ga4MeasurementId

      @Key("ga4MeasurementId") @DefaultValue("G-4L9L79WZBV") String ga4MeasurementId()
      Google Analytics 4 Measurement ID used for anonymous telemetry. Found in the GA4 console under Admin > Data Streams > choose your stream > Measurement ID. Override in internal.properties to route telemetry to a different GA4 property.

    • ga4ApiSecret

      @Key("ga4ApiSecret") @DefaultValue("nzK22pHiTZWu8FGgvDVtnA") String ga4ApiSecret()
      Google Analytics 4 API Secret used for the Measurement Protocol. Found in the GA4 console under Admin > Data Streams > choose your stream > Measurement Protocol > Create. Override in internal.properties to supply a fresh secret after rotation.

      Note: if you override this with your own GA4 property's secret, rotate the secret regularly via the GA4 console to prevent abuse; the new value can then be supplied via internal.properties without a SHAFT release.