Class RequireFileChecksum
java.lang.Object
org.apache.maven.plugins.enforcer.AbstractStandardEnforcerRule
org.apache.maven.plugins.enforcer.AbstractNonCacheableEnforcerRule
org.apache.maven.plugins.enforcer.RequireFileChecksum
- All Implemented Interfaces:
EnforcerRule
,EnforcerRule2
Rule to validate a file to match the specified checksum.
-
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprivate String
void
execute
(EnforcerRuleHelper helper) This is the interface into the rule.void
setChecksum
(String checksum) The expected checksum value.void
The file to check.void
setNonexistentFileMessage
(String nonexistentFileMessage) The friendly message to use when the file does not exist.void
The checksum algorithm to use.Methods inherited from class org.apache.maven.plugins.enforcer.AbstractNonCacheableEnforcerRule
getCacheId, isCacheable, isResultValid
Methods inherited from class org.apache.maven.plugins.enforcer.AbstractStandardEnforcerRule
getLevel, getMessage, setLevel, setMessage
-
Field Details
-
file
-
checksum
-
type
-
nonexistentFileMessage
-
-
Constructor Details
-
RequireFileChecksum
public RequireFileChecksum()
-
-
Method Details
-
execute
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
The file to check.- Parameters:
file
- file
-
setChecksum
The expected checksum value.- Parameters:
checksum
- checksum
-
setType
The checksum algorithm to use. Possible values: "md5", "sha1", "sha256", "sha384", "sha512".- Parameters:
type
- algorithm
-
setNonexistentFileMessage
The friendly message to use when the file does not exist.- Parameters:
nonexistentFileMessage
- message
-
calculateChecksum
- Throws:
EnforcerRuleException
-