org.apache.archiva.configuration

Interface ArchivaConfiguration

All Known Implementing Classes:

DefaultArchivaConfiguration

public interface ArchivaConfiguration

Configuration holder for the model read from the registry.

Field Summary

Fields

Modifier and Type	Field and Description
static String	USER_CONFIG_ENVVAR
static String	USER_CONFIG_PROPERTY

Method Summary

Modifier and Type	Method and Description
void	addChangeListener(org.apache.archiva.components.registry.RegistryListener listener) Add a registry listener to notify of events in spring-registry.
void	addListener(ConfigurationListener listener) Add a configuration listener to notify of changes to the configuration.
Path	getAppServerBaseDir()
Configuration	getConfiguration() Get the configuration.
Path	getDataDirectory() Returns the data directory where repositories and metadata reside
Locale	getDefaultLocale()
List<Locale.LanguageRange>	getLanguagePriorities()
Path	getRemoteRepositoryBaseDir() Returns the base directory for remote repositories
Path	getRepositoryBaseDir() Returns the base directory for repositories that have a relative location path set.
Path	getRepositoryGroupBaseDir() Returns the base directory for repository group files.
boolean	isDefaulted() Determines if the configuration in use was as a result of a defaulted configuration.
void	reload() reload configuration from file included registry
void	removeChangeListener(org.apache.archiva.components.registry.RegistryListener listener)
void	removeListener(ConfigurationListener listener) Remove a configuration listener to stop notifications of changes to the configuration.
void	save(Configuration configuration) Save any updated configuration.

Field Detail

USER_CONFIG_PROPERTY

static final String USER_CONFIG_PROPERTY

See Also:

Constant Field Values

USER_CONFIG_ENVVAR

static final String USER_CONFIG_ENVVAR

See Also:

Constant Field Values

Method Detail

getConfiguration

Configuration getConfiguration()

Get the configuration.

Returns:

the configuration

save

void save(Configuration configuration)
   throws org.apache.archiva.components.registry.RegistryException,
          IndeterminateConfigurationException

Save any updated configuration.

Parameters:

configuration - the configuration to save

Throws:

org.apache.archiva.components.registry.RegistryException - if there is a problem saving the registry data

IndeterminateConfigurationException - if the configuration cannot be saved because it was read from two sources

isDefaulted

boolean isDefaulted()

Determines if the configuration in use was as a result of a defaulted configuration.

Returns:

true if the configuration was created from the default-archiva.xml as opposed to being loaded from the usual locations of ${user.home}/.m2/archiva.xml or ${appserver.base}/conf/archiva.xml

addListener

void addListener(ConfigurationListener listener)

Add a configuration listener to notify of changes to the configuration.

Parameters:

listener - the listener

removeListener

void removeListener(ConfigurationListener listener)

Remove a configuration listener to stop notifications of changes to the configuration.

Parameters:

listener - the listener

addChangeListener

void addChangeListener(org.apache.archiva.components.registry.RegistryListener listener)

Add a registry listener to notify of events in spring-registry.

Parameters:

listener - the listener TODO: Remove in future.

removeChangeListener

void removeChangeListener(org.apache.archiva.components.registry.RegistryListener listener)

reload

void reload()

reload configuration from file included registry

Since:

1.4-M1

getDefaultLocale

Locale getDefaultLocale()

getLanguagePriorities

List<Locale.LanguageRange> getLanguagePriorities()

getAppServerBaseDir

Path getAppServerBaseDir()

getRepositoryBaseDir

Path getRepositoryBaseDir()

Returns the base directory for repositories that have a relative location path set.

Returns:

getRemoteRepositoryBaseDir

Path getRemoteRepositoryBaseDir()

Returns the base directory for remote repositories

Returns:

getRepositoryGroupBaseDir

Path getRepositoryGroupBaseDir()

Returns the base directory for repository group files.

Returns:

getDataDirectory

Path getDataDirectory()

Returns the data directory where repositories and metadata reside

Returns: