org.apache.archiva.policies

Interface Policy

All Known Subinterfaces:

DownloadErrorPolicy, DownloadPolicy, PostDownloadPolicy, PreDownloadPolicy

All Known Implementing Classes:

AbstractPolicy, AbstractUpdatePolicy, CachedFailuresPolicy, ChecksumPolicy, PropagateErrorsDownloadPolicy, PropagateErrorsOnUpdateDownloadPolicy, ReleasesPolicy, SnapshotsPolicy

public interface Policy

This is a generic interface for policies. Policies define different actions to apply to artifacts during the repository lifecycle, e.g. download, upload, errors.

Field Summary

Fields

Modifier and Type	Field and Description
static String	RESOURCE_BUNDLE

Method Summary

Modifier and Type	Method and Description
PolicyOption	getDefaultOption() Get the default option for this policy.
String	getDescription(Locale locale) Return a description of the policy.
String	getId() Get the id for this policy.
String	getName() Get the display name for this policy.
String	getName(Locale locale) Get the policy name in the language of the given locale.
String	getOptionDescription(Locale locale, PolicyOption option) Returns a description for the given option.
String	getOptionName(Locale locale, PolicyOption option) Returns a name for the given option.
List<PolicyOption>	getOptions() Get the list of options for this policy.

Field Detail

RESOURCE_BUNDLE

static final String RESOURCE_BUNDLE

See Also:

Constant Field Values

Method Detail

getOptions

List<PolicyOption> getOptions()

Get the list of options for this policy.

Returns:

the list of options for this policy.

getDefaultOption

PolicyOption getDefaultOption()

Get the default option for this policy.

Returns:

the default policy for this policy.

getId

String getId()

Get the id for this policy.

Returns:

the id for this policy.

getName

String getName()

Get the display name for this policy.

Returns:

the name for this policy

getName

String getName(Locale locale)

Get the policy name in the language of the given locale.

Parameters:

locale - The locale

Returns:

The policy name

getDescription

String getDescription(Locale locale)

Return a description of the policy.

Parameters:

locale - The language

Returns:

The description

getOptionDescription

String getOptionDescription(Locale locale,
                            PolicyOption option)
                     throws MissingResourceException

Returns a description for the given option.

Parameters:

locale - The locale for the description.

option - The option to ask the description for.

Returns:

A description of the option in the requested language.

Throws:

MissingResourceException - if the option is not known by this policy.

getOptionName

String getOptionName(Locale locale,
                     PolicyOption option)
              throws MissingResourceException

Returns a name for the given option.

Parameters:

locale - The locale for the name

option - The option identifier

Returns:

A name in the requested language.

Throws:

MissingResourceException - if the option is not known by this policy.