org.apache.archiva.policies

Class ChecksumPolicy

java.lang.Object

org.apache.archiva.policies.AbstractPolicy

org.apache.archiva.policies.ChecksumPolicy

All Implemented Interfaces:

DownloadPolicy, Policy, PostDownloadPolicy

@Service(value="postDownloadPolicy#checksum")
public class ChecksumPolicy
extends AbstractPolicy
implements PostDownloadPolicy

ChecksumPolicy - a policy applied after the download to see if the file has been downloaded successfully and completely (or not).

Field Summary

Fields

Modifier and Type	Field and Description
static ChecksumOption	FAIL The FAIL policy indicates that if the checksum does not match the downloaded file, then remove the downloaded artifact, and checksum files, and fail the transfer to the client side.
static ChecksumOption	FIX The FIX policy indicates that if the checksum does not match the downloaded file, then fix the checksum file locally, and return to the client side the corrected checksum.
static ChecksumOption	IGNORE The IGNORE policy indicates that if the checksum policy is ignored, and the state of, contents of, or validity of the checksum files are not checked.

Fields inherited from interface org.apache.archiva.policies.Policy

RESOURCE_BUNDLE

Constructor Summary

Constructors

Constructor and Description
ChecksumPolicy()

Method Summary

Modifier and Type	Method and Description
void	applyPolicy(PolicyOption policySetting, Properties request, StorageAsset localFile) Apply the download policy.
PolicyOption	getDefaultOption() Get the default option for this policy.
String	getId() Get the id for this policy.
List<PolicyOption>	getOptions() Get the list of options for this policy.

Methods inherited from class org.apache.archiva.policies.AbstractPolicy

getDescription, getName, getName, getOptionDescription, getOptionName, getOptionPrefix, getPolicyPrefix, setOptionPrefix, setPolicyPrefix

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.archiva.policies.Policy

getDescription, getName, getName, getOptionDescription, getOptionName

Field Detail

IGNORE

public static final ChecksumOption IGNORE

The IGNORE policy indicates that if the checksum policy is ignored, and the state of, contents of, or validity of the checksum files are not checked.

FAIL

public static final ChecksumOption FAIL

The FAIL policy indicates that if the checksum does not match the downloaded file, then remove the downloaded artifact, and checksum files, and fail the transfer to the client side.

FIX

public static final ChecksumOption FIX

The FIX policy indicates that if the checksum does not match the downloaded file, then fix the checksum file locally, and return to the client side the corrected checksum.

Constructor Detail

ChecksumPolicy

public ChecksumPolicy()

Method Detail

applyPolicy

public void applyPolicy(PolicyOption policySetting,
                        Properties request,
                        StorageAsset localFile)
                 throws PolicyViolationException,
                        PolicyConfigurationException

Description copied from interface: DownloadPolicy

Apply the download policy.

Specified by:

applyPolicy in interface DownloadPolicy

Parameters:

policySetting - the policy setting.

request - the list of request properties that the policy might use.

Throws:

PolicyViolationException - if the policy has been violated.

PolicyConfigurationException

getDefaultOption

public PolicyOption getDefaultOption()

Description copied from interface: Policy

Get the default option for this policy.

Specified by:

getDefaultOption in interface Policy

Returns:

the default policy for this policy.

getId

public String getId()

Description copied from interface: Policy

Get the id for this policy.

Specified by:

getId in interface Policy

Returns:

the id for this policy.

getOptions

public List<PolicyOption> getOptions()

Description copied from interface: Policy

Get the list of options for this policy.

Specified by:

getOptions in interface Policy

Returns:

the list of options for this policy.