Class RequireFileChecksum

    • Field Detail

      • file

        private java.io.File file
      • checksum

        private java.lang.String checksum
      • type

        private java.lang.String type
      • nonexistentFileMessage

        private java.lang.String nonexistentFileMessage
    • Constructor Detail

      • RequireFileChecksum

        public RequireFileChecksum()
    • Method Detail

      • execute

        public void execute​(EnforcerRuleHelper helper)
                     throws EnforcerRuleException
        Description copied from interface: EnforcerRule
        This is the interface into the rule. This method should throw an exception containing a reason message if the rule fails the check. The plugin will then decide based on the fail flag if it should stop or just log the message as a warning.
        Parameters:
        helper - The helper provides access to the log, MavenSession and has helpers to get common components. It is also able to lookup components by class name.
        Throws:
        EnforcerRuleException - the enforcer rule exception
      • setFile

        public void setFile​(java.io.File file)
        The file to check.
        Parameters:
        file - file
      • setChecksum

        public void setChecksum​(java.lang.String checksum)
        The expected checksum value.
        Parameters:
        checksum - checksum
      • setType

        public void setType​(java.lang.String type)
        The checksum algorithm to use. Possible values: "md5", "sha1", "sha256", "sha384", "sha512".
        Parameters:
        type - algorithm
      • setNonexistentFileMessage

        public void setNonexistentFileMessage​(java.lang.String nonexistentFileMessage)
        The friendly message to use when the file does not exist.
        Parameters:
        nonexistentFileMessage - message