org.apache.maven.plugins.enforcer

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

Direct Known Subclasses:

RequireTextFileChecksum

public class RequireFileChecksum
extends AbstractNonCacheableEnforcerRule

Rule to validate a binary file to match the specified checksum.

Author:

Edward Samson, Lyubomyr Shaydariv

See Also:

RequireTextFileChecksum

Field Summary

Fields

Modifier and Type	Field and Description
protected File	file

Constructor Summary

Constructors

Constructor and Description
RequireFileChecksum()

Method Summary

Modifier and Type	Method and Description
protected String	calculateChecksum()
protected String	calculateChecksum(InputStream inputStream)
void	execute(EnforcerRuleHelper helper) This is the interface into the rule.
void	setChecksum(String checksum) The expected checksum value.
void	setFile(File file) The file to check.
void	setNonexistentFileMessage(String nonexistentFileMessage) The friendly message to use when the file does not exist.
void	setType(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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

file

protected File file

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(File file)

The file to check.

Parameters:

file - file

setChecksum

public void setChecksum(String checksum)

The expected checksum value.

Parameters:

checksum - checksum

setType

public void setType(String type)

The checksum algorithm to use. Possible values: "md5", "sha1", "sha256", "sha384", "sha512".

Parameters:

type - algorithm

setNonexistentFileMessage

public void setNonexistentFileMessage(String nonexistentFileMessage)

The friendly message to use when the file does not exist.

Parameters:

nonexistentFileMessage - message

calculateChecksum

protected String calculateChecksum()
                            throws EnforcerRuleException

Throws:

EnforcerRuleException

calculateChecksum

protected String calculateChecksum(InputStream inputStream)
                            throws IOException,
                                   EnforcerRuleException

Throws:

IOException

EnforcerRuleException