View Javadoc

1   /*
2    * Copyright 2012-2013 smartics, Kronseder & Reiner GmbH
3    *
4    * Licensed under the Apache License, Version 2.0 (the "License");
5    * you may not use this file except in compliance with the License.
6    * You may obtain a copy of the License at
7    *
8    *     http://www.apache.org/licenses/LICENSE-2.0
9    *
10   * Unless required by applicable law or agreed to in writing, software
11   * distributed under the License is distributed on an "AS IS" BASIS,
12   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13   * See the License for the specific language governing permissions and
14   * limitations under the License.
15   */
16  package de.smartics.properties.core.services;
17  
18  import javax.annotation.CheckForNull;
19  
20  /**
21   * Provides access to the configuration information configured into the runtime
22   * by an administation process.
23   */
24  public interface AdminRuntime
25  {
26    // ********************************* Fields *********************************
27  
28    // --- constants ------------------------------------------------------------
29  
30    // ****************************** Initializer *******************************
31  
32    // ****************************** Inner Classes *****************************
33  
34    // ********************************* Methods ********************************
35  
36    // --- get&set --------------------------------------------------------------
37  
38    /**
39     * Returns the name of the selected configuration.
40     *
41     * @return the name of the selected configuration. May be <code>null</code>,
42     *         if no configuration is selected. In this case the configuration
43     *         name found in the boot properties is used.
44     */
45    @CheckForNull
46    String getConfigurationName();
47  
48    // --- business -------------------------------------------------------------
49  
50    // --- object basics --------------------------------------------------------
51  
52  }