org.apache.archiva.configuration

Class DefaultArchivaConfiguration

java.lang.Object

org.apache.archiva.configuration.DefaultArchivaConfiguration

All Implemented Interfaces:

org.apache.archiva.components.registry.RegistryListener, ArchivaConfiguration

@Service(value="archivaConfiguration#default")
public class DefaultArchivaConfiguration
extends Object
implements ArchivaConfiguration, org.apache.archiva.components.registry.RegistryListener

Implementation of configuration holder that retrieves it from the registry.

The registry layers and merges the 2 configuration files: user, and application server.

Instead of relying on the model defaults, if the registry is empty a default configuration file is loaded and applied from a resource. The defaults are not loaded into the registry as the lists (eg repositories) could no longer be removed if that was the case.

When saving the configuration, it is saved to the location it was read from. If it was read from the defaults, it will be saved to the user location. However, if the configuration contains information from both sources, an exception is raised as this is currently unsupported. The reason for this is that it is not possible to identify where to re-save elements, and can result in list configurations (eg repositories) becoming inconsistent.

If the configuration is outdated, it will be upgraded when it is loaded. This is done by checking the version flag before reading it from the registry.

FIXME: The synchronization must be improved, the current impl may lead to inconsistent data or multiple getConfiguration() calls (martin_s@apache.org)

Field Summary

Fields inherited from interface org.apache.archiva.configuration.ArchivaConfiguration

USER_CONFIG_ENVVAR, USER_CONFIG_PROPERTY

Constructor Summary

Constructors

Constructor and Description
DefaultArchivaConfiguration()

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.
void	afterConfigurationChange(org.apache.archiva.components.registry.Registry registry, String propertyName, Object propertyValue)
void	beforeConfigurationChange(org.apache.archiva.components.registry.Registry registry, String propertyName, Object propertyValue)
String	getAltConfigFilename()
Path	getAppServerBaseDir()
Configuration	getConfiguration() Get the configuration.
Path	getDataDirectory() Returns the data directory where repositories and metadata reside
Locale	getDefaultLocale()
List<Locale.LanguageRange>	getLanguagePriorities()
org.apache.archiva.components.registry.Registry	getRegistry()
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.
String	getUserConfigFilename()
void	initialize()
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.
void	setAltConfigFilename(String altConfigFilename)
void	setRegistry(org.apache.archiva.components.registry.Registry registry)
void	setUserConfigFilename(String userConfigFilename)

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultArchivaConfiguration

public DefaultArchivaConfiguration()

Method Detail

getConfiguration

public Configuration getConfiguration()

Description copied from interface: ArchivaConfiguration

Get the configuration.

Specified by:

getConfiguration in interface ArchivaConfiguration

Returns:

the configuration

save

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

Description copied from interface: ArchivaConfiguration

Save any updated configuration.

Specified by:

save in interface ArchivaConfiguration

Parameters:

configuration - the configuration to save

Throws:

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

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

addListener

public void addListener(ConfigurationListener listener)

Description copied from interface: ArchivaConfiguration

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

Specified by:

addListener in interface ArchivaConfiguration

Parameters:

listener - the listener

removeListener

public void removeListener(ConfigurationListener listener)

Description copied from interface: ArchivaConfiguration

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

Specified by:

removeListener in interface ArchivaConfiguration

Parameters:

listener - the listener

addChangeListener

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

Description copied from interface: ArchivaConfiguration

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

Specified by:

addChangeListener in interface ArchivaConfiguration

Parameters:

listener - the listener TODO: Remove in future.

removeChangeListener

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

Specified by:

removeChangeListener in interface ArchivaConfiguration

initialize

@PostConstruct
public void initialize()

reload

public void reload()

Description copied from interface: ArchivaConfiguration

reload configuration from file included registry

Specified by:

reload in interface ArchivaConfiguration

getDefaultLocale

public Locale getDefaultLocale()

Specified by:

getDefaultLocale in interface ArchivaConfiguration

getLanguagePriorities

public List<Locale.LanguageRange> getLanguagePriorities()

Specified by:

getLanguagePriorities in interface ArchivaConfiguration

getAppServerBaseDir

public Path getAppServerBaseDir()

Specified by:

getAppServerBaseDir in interface ArchivaConfiguration

getRepositoryBaseDir

public Path getRepositoryBaseDir()

Description copied from interface: ArchivaConfiguration

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

Specified by:

getRepositoryBaseDir in interface ArchivaConfiguration

Returns:

getRemoteRepositoryBaseDir

public Path getRemoteRepositoryBaseDir()

Description copied from interface: ArchivaConfiguration

Returns the base directory for remote repositories

Specified by:

getRemoteRepositoryBaseDir in interface ArchivaConfiguration

Returns:

getRepositoryGroupBaseDir

public Path getRepositoryGroupBaseDir()

Description copied from interface: ArchivaConfiguration

Returns the base directory for repository group files.

Specified by:

getRepositoryGroupBaseDir in interface ArchivaConfiguration

Returns:

getDataDirectory

public Path getDataDirectory()

Description copied from interface: ArchivaConfiguration

Returns the data directory where repositories and metadata reside

Specified by:

getDataDirectory in interface ArchivaConfiguration

Returns:

beforeConfigurationChange

public void beforeConfigurationChange(org.apache.archiva.components.registry.Registry registry,
                                      String propertyName,
                                      Object propertyValue)

Specified by:

beforeConfigurationChange in interface org.apache.archiva.components.registry.RegistryListener

afterConfigurationChange

public void afterConfigurationChange(org.apache.archiva.components.registry.Registry registry,
                                     String propertyName,
                                     Object propertyValue)

Specified by:

afterConfigurationChange in interface org.apache.archiva.components.registry.RegistryListener

getUserConfigFilename

public String getUserConfigFilename()

getAltConfigFilename

public String getAltConfigFilename()

isDefaulted

public boolean isDefaulted()

Description copied from interface: ArchivaConfiguration

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

Specified by:

isDefaulted in interface ArchivaConfiguration

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

getRegistry

public org.apache.archiva.components.registry.Registry getRegistry()

setRegistry

public void setRegistry(org.apache.archiva.components.registry.Registry registry)

setUserConfigFilename

public void setUserConfigFilename(String userConfigFilename)

setAltConfigFilename

public void setAltConfigFilename(String altConfigFilename)