org.apache.archiva.policies

Class PropagateErrorsOnUpdateDownloadPolicy

java.lang.Object

org.apache.archiva.policies.AbstractPolicy

org.apache.archiva.policies.PropagateErrorsOnUpdateDownloadPolicy

All Implemented Interfaces:

DownloadErrorPolicy, Policy

@Service(value="downloadErrorPolicy#propagate-errors-on-update")
public class PropagateErrorsOnUpdateDownloadPolicy
extends AbstractPolicy
implements DownloadErrorPolicy

PropagateErrorsPolicy - a policy applied on error to determine how to treat the error.

Field Summary

Fields

Modifier and Type	Field and Description
static DownloadErrorOption	ALWAYS Signifies any error should cause a failure whether the artifact is already present or not.
static DownloadErrorOption	NOT_PRESENT Signifies any error should cause a failure only if the artifact is not already present.

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

RESOURCE_BUNDLE

Constructor Summary

Constructors

Constructor and Description
PropagateErrorsOnUpdateDownloadPolicy()

Method Summary

Modifier and Type	Method and Description
boolean	applyPolicy(PolicyOption policySetting, Properties request, StorageAsset localFile, Exception exception, Map<String,Exception> previousExceptions) Apply the download error 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

ALWAYS

public static final DownloadErrorOption ALWAYS

Signifies any error should cause a failure whether the artifact is already present or not.

NOT_PRESENT

public static final DownloadErrorOption NOT_PRESENT

Signifies any error should cause a failure only if the artifact is not already present.

Constructor Detail

PropagateErrorsOnUpdateDownloadPolicy

public PropagateErrorsOnUpdateDownloadPolicy()

Method Detail

applyPolicy

public boolean applyPolicy(PolicyOption policySetting,
                           Properties request,
                           StorageAsset localFile,
                           Exception exception,
                           Map<String,Exception> previousExceptions)
                    throws PolicyConfigurationException

Description copied from interface: DownloadErrorPolicy

Apply the download error policy.

Specified by:

applyPolicy in interface DownloadErrorPolicy

Parameters:

policySetting - the policy setting.

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

exception - the exception that triggered the error

previousExceptions - any previously triggered exceptions

Returns:

True, if the exception should be processed, False if the exception should be ignored.

Throws:

PolicyConfigurationException - if the policy is improperly configured

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.