ArchivaConfiguration

This project has retired. For details please refer to its Attic page.

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.apache.maven.archiva.configuration
Interface ArchivaConfiguration

Package class diagram package ArchivaConfiguration

All Known Implementing Classes:: DefaultArchivaConfiguration

public interface ArchivaConfiguration

Configuration holder for the model read from the registry.

Field Summary

static java.lang.String ROLE


Method Summary

void addChangeListener(org.codehaus.plexus.registry.RegistryListener listener)
          Add a registry listener to notify of events in plexus-registry.

void addListener(ConfigurationListener listener)
          Add a configuration listener to notify of changes to the configuration.

org.apache.maven.archiva.configuration.Configuration getConfiguration()
          Get the configuration.

boolean isDefaulted()
          Determines if the configuration in use was as a result of a defaulted configuration.

void removeListener(ConfigurationListener listener)
          Remove a configuration listener to stop notifications of changes to the configuration.

void save(org.apache.maven.archiva.configuration.Configuration configuration)
          Save any updated configuration.

Field Summary
`static java.lang.String`	`ROLE`

Method Summary
`void`	`addChangeListener(org.codehaus.plexus.registry.RegistryListener listener)` Add a registry listener to notify of events in plexus-registry.
`void`	`addListener(ConfigurationListener listener)` Add a configuration listener to notify of changes to the configuration.
`org.apache.maven.archiva.configuration.Configuration`	`getConfiguration()` Get the configuration.
`boolean`	`isDefaulted()` Determines if the configuration in use was as a result of a defaulted configuration.
`void`	`removeListener(ConfigurationListener listener)` Remove a configuration listener to stop notifications of changes to the configuration.
`void`	`save(org.apache.maven.archiva.configuration.Configuration configuration)` Save any updated configuration.

Field Detail

ROLE

static final java.lang.String ROLE

Method Detail

getConfiguration

org.apache.maven.archiva.configuration.Configuration getConfiguration()

Get the configuration.

Returns:: the configuration

save

void save(org.apache.maven.archiva.configuration.Configuration configuration)
          throws org.codehaus.plexus.registry.RegistryException,
                 IndeterminateConfigurationException

Save any updated configuration.

Parameters:: configuration - the configuration to save
Throws:: org.codehaus.plexus.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.codehaus.plexus.registry.RegistryListener listener)

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

Parameters:: listener - the listener TODO: Remove in future.