Record Class EvidencePackOptions

java.lang.Object
java.lang.Record
org.egothor.methodatlas.evidence.EvidencePackOptions
Record Components:
framework - target compliance framework; must not be null
outputDir - directory in which to materialise the pack; when null the command will derive a default location relative to the first scan root
overwrite - when true, an existing output directory is reused; when false, a pre-existing directory is treated as an error
keyringFile - encrypted ZeroEcho keyring file holding the signing key, or null; not a JDK PKCS12/JKS keystore and not produced by keytool (use -gen-signing-key). Its .nonce sidecar must sit next to it in an owner-only directory
keyringEnv - name of an environment variable holding a keyring secret bundle (produced by -export-keyring-secret), or null; intended for CI/CD pipelines where the keyring is supplied through a platform secret. When both keyringEnv and keyringFile are set, the environment variable takes precedence. When both are null the pack is unsigned
passwordFile - file whose first line is the keyring password, or null
passwordEnv - name of an environment variable holding the keyring password, or null; when neither password option is set, METHODATLAS_KEYRING_PASSWORD and then an interactive prompt are tried
keyAlias - keyring alias of the signing key; when null the first alias in the keyring is used; for hybrid signatures the format is "classicAlias/pqcAlias"
signatureAlgorithm - signature algorithm identifier; null means derive it from the keyring entry (defaulting to "Ed25519" when generated by MethodAtlas); a value of the form "classic+pqc" (for example "Ed25519+SPHINCS+") selects hybrid signing
public record EvidencePackOptions(EvidenceFramework framework, Path outputDir, boolean overwrite, Path keyringFile, String keyringEnv, Path passwordFile, String passwordEnv, String keyAlias, String signatureAlgorithm) extends Record
Immutable bag of evidence-pack options collected from the command line.

This record is constructed directly by CliArgs; there is no builder. Fields with sensible defaults are documented in the parameter Javadoc.

See Also:

  • Constructor Details

    • EvidencePackOptions

      public EvidencePackOptions(EvidenceFramework framework, Path outputDir, boolean overwrite, Path keyringFile, String keyringEnv, Path passwordFile, String passwordEnv, String keyAlias, String signatureAlgorithm)
      Creates an instance of a EvidencePackOptions record class.
      Parameters:
      framework - the value for the framework record component
      outputDir - the value for the outputDir record component
      overwrite - the value for the overwrite record component
      keyringFile - the value for the keyringFile record component
      keyringEnv - the value for the keyringEnv record component
      passwordFile - the value for the passwordFile record component
      passwordEnv - the value for the passwordEnv record component
      keyAlias - the value for the keyAlias record component
      signatureAlgorithm - the value for the signatureAlgorithm record component

  • Method Details

    • 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 the compare method from their corresponding wrapper classes.
      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.

    • framework

      public EvidenceFramework framework()
      Returns the value of the framework record component.
      Returns:
      the value of the framework record component

    • outputDir

      public Path outputDir()
      Returns the value of the outputDir record component.
      Returns:
      the value of the outputDir record component

    • overwrite

      public boolean overwrite()
      Returns the value of the overwrite record component.
      Returns:
      the value of the overwrite record component

    • keyringFile

      public Path keyringFile()
      Returns the value of the keyringFile record component.
      Returns:
      the value of the keyringFile record component

    • keyringEnv

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

    • passwordFile

      public Path passwordFile()
      Returns the value of the passwordFile record component.
      Returns:
      the value of the passwordFile record component

    • passwordEnv

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

    • keyAlias

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

    • signatureAlgorithm

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