- package org.apache.archiva.configuration;
-
- /*
- * Licensed to the Apache Software Foundation (ASF) under one
- * or more contributor license agreements. See the NOTICE file
- * distributed with this work for additional information
- * regarding copyright ownership. The ASF licenses this file
- * to you under the Apache License, Version 2.0 (the
- * "License"); you may not use this file except in compliance
- * with the License. You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing,
- * software distributed under the License is distributed on an
- * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- * KIND, either express or implied. See the License for the
- * specific language governing permissions and limitations
- * under the License.
- */
-
- import org.apache.archiva.components.registry.Registry;
- import org.apache.archiva.components.registry.RegistryException;
- import org.apache.archiva.components.registry.RegistryListener;
-
- import java.nio.file.Path;
- import java.util.List;
- import java.util.Locale;
-
- /**
- * Configuration holder for the model read from the registry.
- */
- public interface ArchivaConfiguration
- {
-
-
- String USER_CONFIG_PROPERTY = "archiva.user.configFileName";
- String USER_CONFIG_ENVVAR = "ARCHIVA_USER_CONFIG_FILE";
-
- /**
- * Get the configuration.
- *
- * @return the configuration
- */
- Configuration getConfiguration();
-
- /**
- * Save any updated configuration.
- *
- * @param configuration the configuration to save
- * @throws org.apache.archiva.components.registry.RegistryException
- * if there is a problem saving the registry data
- * @throws IndeterminateConfigurationException
- * if the configuration cannot be saved because it was read from two sources
- */
- void save( Configuration configuration )
- throws RegistryException, IndeterminateConfigurationException;
-
- /**
- * Save any updated configuration. This method allows to add a tag to the thrown event.
- * This allows to verify the origin if the caller is the same as the listener.
- *
- * @param configuration the configuration to save
- * @param eventTag the tag to add to the thrown event
- * @throws org.apache.archiva.components.registry.RegistryException
- * if there is a problem saving the registry data
- * @throws IndeterminateConfigurationException
- * if the configuration cannot be saved because it was read from two sources
- */
- void save( Configuration configuration, String eventTag )
- throws RegistryException, IndeterminateConfigurationException;
-
- /**
- * Determines if the configuration in use was as a result of a defaulted configuration.
- *
- * @return 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
- */
- boolean isDefaulted();
-
- /**
- * Add a configuration listener to notify of changes to the configuration.
- *
- * @param listener the listener
- */
- void addListener( ConfigurationListener listener );
-
- /**
- * Remove a configuration listener to stop notifications of changes to the configuration.
- *
- * @param listener the listener
- */
- void removeListener( ConfigurationListener listener );
-
- /**
- * Add a registry listener to notify of events in spring-registry.
- *
- * @param listener the listener
- * TODO: Remove in future.
- */
- void addChangeListener( RegistryListener listener );
-
- void removeChangeListener( RegistryListener listener );
-
- /**
- * reload configuration from file included registry
- *
- * @since 1.4-M1
- */
- void reload();
-
- public Locale getDefaultLocale();
-
- public List<Locale.LanguageRange> getLanguagePriorities();
-
- public Path getAppServerBaseDir();
-
- /**
- * Returns the base directory for repositories that have a relative location path set.
- * @return
- */
- public Path getRepositoryBaseDir();
-
- /**
- * Returns the base directory for remote repositories
- * @return
- */
- public Path getRemoteRepositoryBaseDir();
-
- /**
- * Returns the base directory for repository group files.
- * @return
- */
- public Path getRepositoryGroupBaseDir();
-
- /**
- * Returns the data directory where repositories and metadata reside
- * @return
- */
- public Path getDataDirectory();
-
- /**
- * Return the used configuration registry
- * @return
- */
- Registry getRegistry( );
- }
-
|