org.apache.archiva.policies

Class AbstractUpdatePolicy

java.lang.Object

org.apache.archiva.policies.AbstractPolicy

org.apache.archiva.policies.AbstractUpdatePolicy

All Implemented Interfaces:

DownloadPolicy, Policy, PreDownloadPolicy

Direct Known Subclasses:

ReleasesPolicy, SnapshotsPolicy

public abstract class AbstractUpdatePolicy
extends AbstractPolicy
implements PreDownloadPolicy

AbstractUpdatePolicy

Field Summary

Fields

Modifier and Type	Field and Description
static PolicyOption	ALWAYS The ALWAYS policy setting means that the artifact is always updated from the remote repo.
static UpdateOption	DAILY The DAILY policy means that the artifact retrieval occurs only if one of the following conditions are met...
static UpdateOption	HOURLY The HOURLY policy means that the artifact retrieval occurs only if one of the following conditions are met...
static PolicyOption	NEVER The NEVER policy setting means that the artifact is never updated from the remote repo.
static UpdateOption	ONCE The ONCE policy means that the artifact retrieval occurs only if the local artifact is not present.

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

RESOURCE_BUNDLE

Constructor Summary

Constructors

Constructor and Description
AbstractUpdatePolicy()

Method Summary

Modifier and Type	Method and Description
void	applyPolicy(PolicyOption policySetting, Properties request, StorageAsset localFile) Apply the download policy.
List<PolicyOption>	getOptions() Get the list of options for this policy.
protected abstract String	getUpdateMode()
protected abstract boolean	isSnapshotPolicy()

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

getDefaultOption, getDescription, getId, getName, getName, getOptionDescription, getOptionName

Field Detail

ALWAYS

public static final PolicyOption ALWAYS

The ALWAYS policy setting means that the artifact is always updated from the remote repo.

NEVER

public static final PolicyOption NEVER

The NEVER policy setting means that the artifact is never updated from the remote repo.

DAILY

public static final UpdateOption DAILY

The DAILY policy means that the artifact retrieval occurs only if one of the following conditions are met...

• The local artifact is not present.
• The local artifact has a last modified timestamp older than (now - 1 day).

HOURLY

public static final UpdateOption HOURLY

The HOURLY policy means that the artifact retrieval occurs only if one of the following conditions are met...

• The local artifact is not present.
• The local artifact has a last modified timestamp older than (now - 1 hour).

ONCE

public static final UpdateOption ONCE

The ONCE policy means that the artifact retrieval occurs only if the local artifact is not present. This means that the retrieval can only occur once.

Constructor Detail

AbstractUpdatePolicy

public AbstractUpdatePolicy()

Method Detail

isSnapshotPolicy

protected abstract boolean isSnapshotPolicy()

getUpdateMode

protected abstract String getUpdateMode()

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.

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