source.dussan.org Git - archiva.git/blob

   1 package org.apache.archiva.configuration;
   2
   3 /*
   4  * Licensed to the Apache Software Foundation (ASF) under one
   5  * or more contributor license agreements.  See the NOTICE file
   6  * distributed with this work for additional information
   7  * regarding copyright ownership.  The ASF licenses this file
   8  * to you under the Apache License, Version 2.0 (the
   9  * "License"); you may not use this file except in compliance
  10  * with the License.  You may obtain a copy of the License at
  11  *
  12  *   http://www.apache.org/licenses/LICENSE-2.0
  13  *
  14  * Unless required by applicable law or agreed to in writing,
  15  * software distributed under the License is distributed on an
  16  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
  17  * KIND, either express or implied.  See the License for the
  18  * specific language governing permissions and limitations
  19  * under the License.
  20  */
  21
  22 import org.apache.archiva.components.registry.Registry;
  23 import org.apache.archiva.components.registry.RegistryException;
  24 import org.apache.archiva.components.registry.RegistryListener;
  25
  26 import java.nio.file.Path;
  27 import java.util.List;
  28 import java.util.Locale;
  29
  30 /**
  31  * Configuration holder for the model read from the registry.
  32  */
  33 public interface ArchivaConfiguration
  34 {
  35
  36
  37     String USER_CONFIG_PROPERTY = "archiva.user.configFileName";
  38     String USER_CONFIG_ENVVAR = "ARCHIVA_USER_CONFIG_FILE";
  39
  40     /**
  41      * Get the configuration.
  42      *
  43      * @return the configuration
  44      */
  45     Configuration getConfiguration();
  46
  47     /**
  48      * Save any updated configuration.
  49      *
  50      * @param configuration the configuration to save
  51      * @throws org.apache.archiva.components.registry.RegistryException
  52      *          if there is a problem saving the registry data
  53      * @throws IndeterminateConfigurationException
  54      *          if the configuration cannot be saved because it was read from two sources
  55      */
  56     void save( Configuration configuration )
  57         throws RegistryException, IndeterminateConfigurationException;
  58
  59     /**
  60      * Save any updated configuration. This method allows to add a tag to the thrown event.
  61      * This allows to verify the origin if the caller is the same as the listener.
  62      *
  63      * @param configuration the configuration to save
  64      * @param eventTag the tag to add to the thrown event
  65      * @throws org.apache.archiva.components.registry.RegistryException
  66      *          if there is a problem saving the registry data
  67      * @throws IndeterminateConfigurationException
  68      *          if the configuration cannot be saved because it was read from two sources
  69      */
  70     void save( Configuration configuration, String eventTag )
  71         throws RegistryException, IndeterminateConfigurationException;
  72
  73     /**
  74      * Determines if the configuration in use was as a result of a defaulted configuration.
  75      *
  76      * @return true if the configuration was created from the default-archiva.xml as opposed
  77      *         to being loaded from the usual locations of ${user.home}/.m2/archiva.xml or
  78      *         ${appserver.base}/conf/archiva.xml
  79      */
  80     boolean isDefaulted();
  81
  82     /**
  83      * Add a configuration listener to notify of changes to the configuration.
  84      *
  85      * @param listener the listener
  86      */
  87     void addListener( ConfigurationListener listener );
  88
  89     /**
  90      * Remove a configuration listener to stop notifications of changes to the configuration.
  91      *
  92      * @param listener the listener
  93      */
  94     void removeListener( ConfigurationListener listener );
  95
  96     /**
  97      * Add a registry listener to notify of events in spring-registry.
  98      *
  99      * @param listener the listener
 100      *                 TODO: Remove in future.
 101      */
 102     void addChangeListener( RegistryListener listener );
 103
 104     void removeChangeListener( RegistryListener listener );
 105
 106     /**
 107      * reload configuration from file included registry
 108      *
 109      * @since 1.4-M1
 110      */
 111     void reload();
 112
 113     public Locale getDefaultLocale();
 114
 115     public List<Locale.LanguageRange> getLanguagePriorities();
 116
 117     public Path getAppServerBaseDir();
 118
 119     /**
 120      * Returns the base directory for repositories that have a relative location path set.
 121      * @return
 122      */
 123     public Path getRepositoryBaseDir();
 124
 125     /**
 126      * Returns the base directory for remote repositories
 127      * @return
 128      */
 129     public Path getRemoteRepositoryBaseDir();
 130
 131     /**
 132      * Returns the base directory for repository group files.
 133      * @return
 134      */
 135     public Path getRepositoryGroupBaseDir();
 136
 137     /**
 138      * Returns the data directory where repositories and metadata reside
 139      * @return
 140      */
 141     public Path getDataDirectory();
 142
 143     /**
 144      * Return the used configuration registry
 145      * @return
 146      */
 147     Registry getRegistry( );
 148 }
 149