Interface Capture

All Superinterfaces:
org.aeonbits.owner.Config, EngineProperties<Capture>, Serializable
@Sources({"system:properties","file:src/main/resources/properties/custom.properties","file:src/main/resources/properties/default/custom.properties","classpath:custom.properties"}) public interface Capture extends EngineProperties<Capture>
Configuration properties interface for API capture recording settings in the SHAFT framework. Controls HTTP/WebSocket request and response capture behavior during test execution.

Use set() to override values programmatically: 

SHAFT.Properties.capture.set().enabled(true).maxBodyBytes(2097152);

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static class 
    Capture.CapturePropertyBuilder
    Fluent current-thread overrides for API capture recording.

    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
    boolean
    enabled()
     
    boolean
    firstPartyOnly()
     
    boolean
    includeAssets()
     
    int
    maxBodyBytes()
     
    int
    maxTransactions()
     
    default Capture.CapturePropertyBuilder
    set()
    Returns a fluent builder for current-thread overrides.
    boolean
    storeSecretsLocally()
     
    String
    urlExcludeGlobs()
     
    String
    urlIncludeGlobs()
     

  • Method Details

    • enabled

      @Key("capture.api.enabled") @DefaultValue("false") boolean enabled()
      Returns:
      whether API capture recording is enabled

    • maxBodyBytes

      @Key("capture.api.maxBodyBytes") @DefaultValue("1048576") int maxBodyBytes()
      Returns:
      maximum request/response body size in bytes to capture

    • includeAssets

      @Key("capture.api.includeAssets") @DefaultValue("false") boolean includeAssets()
      Returns:
      whether to capture static asset requests (images, stylesheets, scripts)

    • firstPartyOnly

      @Key("capture.api.firstPartyOnly") @DefaultValue("true") boolean firstPartyOnly()
      Returns:
      whether to capture only same-origin requests (first-party)

    • storeSecretsLocally

      @Key("capture.api.storeSecretsLocally") @DefaultValue("false") boolean storeSecretsLocally()
      Returns:
      whether to store sensitive request/response data locally in reports

    • maxTransactions

      @Key("capture.api.maxTransactions") @DefaultValue("500") int maxTransactions()
      Returns:
      maximum number of network transactions to retain per capture session

    • urlIncludeGlobs

      @Key("capture.api.urlIncludeGlobs") @DefaultValue("") String urlIncludeGlobs()
      Returns:
      comma-separated glob patterns; when non-empty, only matching URLs are captured

    • urlExcludeGlobs

      @Key("capture.api.urlExcludeGlobs") @DefaultValue("") String urlExcludeGlobs()
      Returns:
      comma-separated glob patterns; matching URLs are always excluded from capture

    • set

      default Capture.CapturePropertyBuilder set()
      Returns a fluent builder for current-thread overrides.
      Specified by:
      set in interface EngineProperties<Capture>
      Returns:
      current-thread property builder