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
public class RequireFileChecksum extends AbstractNonCacheableEnforcerRule
Rule to validate a file to match the specified checksum.
-
-
Field Summary
Fields Modifier and Type Field Description private java.lang.Stringchecksumprivate java.io.Filefileprivate java.lang.StringnonexistentFileMessageprivate java.lang.Stringtype
-
Constructor Summary
Constructors Constructor Description RequireFileChecksum()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description private java.lang.StringcalculateChecksum()voidexecute(EnforcerRuleHelper helper)This is the interface into the rule.voidsetChecksum(java.lang.String checksum)The expected checksum value.voidsetFile(java.io.File file)The file to check.voidsetNonexistentFileMessage(java.lang.String nonexistentFileMessage)The friendly message to use when the file does not exist.voidsetType(java.lang.String type)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
-
-
-
-
Method Detail
-
execute
public void execute(EnforcerRuleHelper helper) throws EnforcerRuleException
Description copied from interface:EnforcerRuleThis 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
-
calculateChecksum
private java.lang.String calculateChecksum() throws EnforcerRuleException- Throws:
EnforcerRuleException
-
-