Record Class ConfigState.Sinks

java.lang.Object
java.lang.Record
ai.attackframework.tools.burp.utils.config.ConfigState.Sinks
Enclosing class:
ConfigState

public static record ConfigState.Sinks(boolean filesEnabled, String filesPath, boolean fileJsonlEnabled, boolean fileBulkNdjsonEnabled, boolean fileTotalCapEnabled, double fileTotalCapGb, boolean fileDiskUsagePercentEnabled, int fileDiskUsagePercent, boolean osEnabled, String openSearchUrl, String openSearchUser, String openSearchPassword, String openSearchTlsMode) extends Record
Sinks selection and values.

File export can target document-only JSONL, bulk-compatible NDJSON, or both. Optional OpenSearch basic-auth remains non-durable (empty = no auth). openSearchTlsMode persists whether OpenSearch uses the system trust store, a session-imported pinned certificate, or trust-all TLS.

  • Constructor Summary

    Constructors
    Constructor
    Description
    Sinks(boolean filesEnabled, String filesPath, boolean fileJsonlEnabled, boolean fileBulkNdjsonEnabled, boolean fileTotalCapEnabled, double fileTotalCapGb, boolean fileDiskUsagePercentEnabled, int fileDiskUsagePercent, boolean osEnabled, String openSearchUrl, String openSearchUser, String openSearchPassword, boolean openSearchInsecureSsl)
     
    Sinks(boolean filesEnabled, String filesPath, boolean fileJsonlEnabled, boolean fileBulkNdjsonEnabled, boolean fileTotalCapEnabled, double fileTotalCapGb, boolean fileDiskUsagePercentEnabled, int fileDiskUsagePercent, boolean osEnabled, String openSearchUrl, String openSearchUser, String openSearchPassword, String openSearchTlsMode)
    Creates an instance of a Sinks record class.
    Sinks(boolean filesEnabled, String filesPath, boolean fileJsonlEnabled, boolean fileBulkNdjsonEnabled, boolean osEnabled, String openSearchUrl, String openSearchUser, String openSearchPassword, boolean openSearchInsecureSsl)
     
    Sinks(boolean filesEnabled, String filesPath, boolean fileJsonlEnabled, boolean fileBulkNdjsonEnabled, boolean osEnabled, String openSearchUrl, String openSearchUser, String openSearchPassword, String openSearchTlsMode)
     
    Sinks(boolean filesEnabled, String filesPath, boolean osEnabled, String openSearchUrl, String openSearchUser, String openSearchPassword, boolean openSearchInsecureSsl)
     
    Sinks(boolean filesEnabled, String filesPath, boolean osEnabled, String openSearchUrl, String openSearchUser, String openSearchPassword, String openSearchTlsMode)
    Convenience constructor for call sites that do not need to specify file formats.
  • Method Summary

    Modifier and Type
    Method
    Description
    final boolean
    Indicates whether some other object is "equal to" this one.
    boolean
    Returns the value of the fileBulkNdjsonEnabled record component.
    int
    Returns the value of the fileDiskUsagePercent record component.
    boolean
    Returns the value of the fileDiskUsagePercentEnabled record component.
    boolean
    Returns the value of the fileJsonlEnabled record component.
    boolean
    Returns the value of the filesEnabled record component.
    Returns the value of the filesPath record component.
    long
    Returns the configured file cap converted to bytes for runtime enforcement.
    boolean
    Returns the value of the fileTotalCapEnabled record component.
    double
    Returns the value of the fileTotalCapGb record component.
    final int
    Returns a hash code value for this object.
    Returns the value of the openSearchPassword record component.
    Returns the value of the openSearchTlsMode record component.
    Returns the value of the openSearchUrl record component.
    Returns the value of the openSearchUser record component.
    boolean
    Returns the value of the osEnabled record component.
    final String
    Returns a string representation of this record class.

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait
  • Constructor Details

    • Sinks

      public Sinks(boolean filesEnabled, String filesPath, boolean fileJsonlEnabled, boolean fileBulkNdjsonEnabled, boolean fileTotalCapEnabled, double fileTotalCapGb, boolean fileDiskUsagePercentEnabled, int fileDiskUsagePercent, boolean osEnabled, String openSearchUrl, String openSearchUser, String openSearchPassword, String openSearchTlsMode)
      Creates an instance of a Sinks record class.
      Parameters:
      filesEnabled - the value for the filesEnabled record component
      filesPath - the value for the filesPath record component
      fileJsonlEnabled - the value for the fileJsonlEnabled record component
      fileBulkNdjsonEnabled - the value for the fileBulkNdjsonEnabled record component
      fileTotalCapEnabled - the value for the fileTotalCapEnabled record component
      fileTotalCapGb - the value for the fileTotalCapGb record component
      fileDiskUsagePercentEnabled - the value for the fileDiskUsagePercentEnabled record component
      fileDiskUsagePercent - the value for the fileDiskUsagePercent record component
      osEnabled - the value for the osEnabled record component
      openSearchUrl - the value for the openSearchUrl record component
      openSearchUser - the value for the openSearchUser record component
      openSearchPassword - the value for the openSearchPassword record component
      openSearchTlsMode - the value for the openSearchTlsMode record component
    • Sinks

      public Sinks(boolean filesEnabled, String filesPath, boolean fileJsonlEnabled, boolean fileBulkNdjsonEnabled, boolean osEnabled, String openSearchUrl, String openSearchUser, String openSearchPassword, String openSearchTlsMode)
    • Sinks

      public Sinks(boolean filesEnabled, String filesPath, boolean fileJsonlEnabled, boolean fileBulkNdjsonEnabled, boolean fileTotalCapEnabled, double fileTotalCapGb, boolean fileDiskUsagePercentEnabled, int fileDiskUsagePercent, boolean osEnabled, String openSearchUrl, String openSearchUser, String openSearchPassword, boolean openSearchInsecureSsl)
    • Sinks

      public Sinks(boolean filesEnabled, String filesPath, boolean fileJsonlEnabled, boolean fileBulkNdjsonEnabled, boolean osEnabled, String openSearchUrl, String openSearchUser, String openSearchPassword, boolean openSearchInsecureSsl)
    • Sinks

      public Sinks(boolean filesEnabled, String filesPath, boolean osEnabled, String openSearchUrl, String openSearchUser, String openSearchPassword, String openSearchTlsMode)
      Convenience constructor for call sites that do not need to specify file formats.

      When used, file export formats default to disabled until explicitly selected in the UI or config.

    • Sinks

      public Sinks(boolean filesEnabled, String filesPath, boolean osEnabled, String openSearchUrl, String openSearchUser, String openSearchPassword, boolean openSearchInsecureSsl)
  • Method Details

    • fileTotalCapBytes

      public long fileTotalCapBytes()
      Returns the configured file cap converted to bytes for runtime enforcement.
    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object
    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object
    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.
    • filesEnabled

      public boolean filesEnabled()
      Returns the value of the filesEnabled record component.
      Returns:
      the value of the filesEnabled record component
    • filesPath

      public String filesPath()
      Returns the value of the filesPath record component.
      Returns:
      the value of the filesPath record component
    • fileJsonlEnabled

      public boolean fileJsonlEnabled()
      Returns the value of the fileJsonlEnabled record component.
      Returns:
      the value of the fileJsonlEnabled record component
    • fileBulkNdjsonEnabled

      public boolean fileBulkNdjsonEnabled()
      Returns the value of the fileBulkNdjsonEnabled record component.
      Returns:
      the value of the fileBulkNdjsonEnabled record component
    • fileTotalCapEnabled

      public boolean fileTotalCapEnabled()
      Returns the value of the fileTotalCapEnabled record component.
      Returns:
      the value of the fileTotalCapEnabled record component
    • fileTotalCapGb

      public double fileTotalCapGb()
      Returns the value of the fileTotalCapGb record component.
      Returns:
      the value of the fileTotalCapGb record component
    • fileDiskUsagePercentEnabled

      public boolean fileDiskUsagePercentEnabled()
      Returns the value of the fileDiskUsagePercentEnabled record component.
      Returns:
      the value of the fileDiskUsagePercentEnabled record component
    • fileDiskUsagePercent

      public int fileDiskUsagePercent()
      Returns the value of the fileDiskUsagePercent record component.
      Returns:
      the value of the fileDiskUsagePercent record component
    • osEnabled

      public boolean osEnabled()
      Returns the value of the osEnabled record component.
      Returns:
      the value of the osEnabled record component
    • openSearchUrl

      public String openSearchUrl()
      Returns the value of the openSearchUrl record component.
      Returns:
      the value of the openSearchUrl record component
    • openSearchUser

      public String openSearchUser()
      Returns the value of the openSearchUser record component.
      Returns:
      the value of the openSearchUser record component
    • openSearchPassword

      public String openSearchPassword()
      Returns the value of the openSearchPassword record component.
      Returns:
      the value of the openSearchPassword record component
    • openSearchTlsMode

      public String openSearchTlsMode()
      Returns the value of the openSearchTlsMode record component.
      Returns:
      the value of the openSearchTlsMode record component