Package org.apache.maven.enforcer.rules.checksum

Class RequireFileChecksum

java.lang.Object

org.apache.maven.enforcer.rule.api.AbstractEnforcerRule

org.apache.maven.enforcer.rules.AbstractStandardEnforcerRule

org.apache.maven.enforcer.rules.checksum.RequireFileChecksum

All Implemented Interfaces:

EnforcerRuleBase

Direct Known Subclasses:

RequireTextFileChecksum

@Named("requireFileChecksum")
public class RequireFileChecksum
extends AbstractStandardEnforcerRule

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

Author:

Edward Samson, Lyubomyr Shaydariv

See Also:

• RequireTextFileChecksum

Constructor Summary

Constructors

Constructor	Description
RequireFileChecksum()

Method Summary

Modifier and Type	Method	Description
protected String	calculateChecksum()
protected String	calculateChecksum(InputStream inputStream)
void	execute()
String	getChecksum()
File	getFile()
EnforcerLogger	getLog()
String	getNonexistentFileMessage()
String	getType()
void	setChecksum(String checksum)	The expected checksum value.
void	setFile(File file)	The file to check.
void	setLog(EnforcerLogger arg0)
void	setNonexistentFileMessage(String nonexistentFileMessage)	The friendly message to use when the file does not exist.
void	setType(String type)	The checksum algorithm to use.
String	toString()

Methods inherited from class org.apache.maven.enforcer.rules.AbstractStandardEnforcerRule

formatLocation, getMessage, setMessage

Methods inherited from class org.apache.maven.enforcer.rule.api.AbstractEnforcerRule

getCacheId, getLevel, getRuleName

Methods inherited from class java.lang.Object

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

Constructor Details

RequireFileChecksum

public RequireFileChecksum()

Method Details

execute

public void execute()
             throws EnforcerRuleException

Specified by:

execute in class AbstractEnforcerRule

Throws:

EnforcerRuleException

setFile

public void setFile(File file)

The file to check.

Parameters:

file - file

getFile

public File getFile()

setChecksum

public void setChecksum(String checksum)

The expected checksum value.

Parameters:

checksum - checksum

getChecksum

public String getChecksum()

setType

public void setType(String type)

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

Parameters:

type - algorithm

getType

public String getType()

setNonexistentFileMessage

public void setNonexistentFileMessage(String nonexistentFileMessage)

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

Parameters:

nonexistentFileMessage - message

getNonexistentFileMessage

public String getNonexistentFileMessage()

calculateChecksum

protected String calculateChecksum()
                            throws EnforcerRuleException

Throws:

EnforcerRuleException

calculateChecksum

protected String calculateChecksum(InputStream inputStream)
                            throws IOException,
EnforcerRuleException

Throws:

IOException

EnforcerRuleException

toString

public String toString()

Overrides:

toString in class Object

setLog

public void setLog(EnforcerLogger arg0)

Specified by:

setLog in interface EnforcerRuleBase

getLog

public EnforcerLogger getLog()