2 * ============LICENSE_START====================================================
\r
4 * ===========================================================================
\r
5 * Copyright (c) 2018 AT&T Intellectual Property. All rights reserved.
\r
6 * ===========================================================================
\r
7 * Licensed under the Apache License, Version 2.0 (the "License");
\r
8 * you may not use this file except in compliance with the License.
\r
9 * You may obtain a copy of the License at
\r
11 * http://www.apache.org/licenses/LICENSE-2.0
\r
13 * Unless required by applicable law or agreed to in writing, software
\r
14 * distributed under the License is distributed on an "AS IS" BASIS,
\r
15 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
\r
16 * See the License for the specific language governing permissions and
\r
17 * limitations under the License.
\r
18 * ============LICENSE_END====================================================
\r
22 package org.onap.aaf.misc.env;
\r
24 import java.util.Map;
\r
26 public interface EnvProps extends Env {
\r
27 public interface EnvProperty {
\r
28 public String getProperty(String input);
\r
32 * Obtain a Property (String) based on a Key. Implementor decides how
\r
33 * that works, i.e. from a complex set of Configurations, or just
\r
34 * "System" (Java standard)
\r
37 * @return APIException
\r
39 public String getProperty(String key);
\r
42 * Obtain a Property (String) based on a Key. Implementor decides how
\r
43 * that works, i.e. from a complex set of Configurations, or just
\r
44 * "System" (Java standard)
\r
46 * If Property Value is null, then default will be used.
\r
48 * @return APIException
\r
50 public String getProperty(String tag, String defaultValue);
\r
53 * Set a Property (String) based on a Key accessible to all in Env. Implementor decides how
\r
54 * that works, i.e. from a complex set of Configurations, or just
\r
55 * "System" (Java standard)
\r
58 * @return APIException
\r
60 public String setProperty(String key, String value);
\r
63 * Get the SubProperties based on key.
\r
65 * use "false" to remove prefix, "true" to leave prefix in.
\r
68 * @return APIException
\r
69 * Given a known property set (or in this case, properties starting with key),
\r
70 * return map of all properties with appropriate key names
\r
72 public Map<String, String> getSubProperties(String key, boolean includePrefix);
\r
75 * Get all of the properties in the Environment
\r
78 public Map<String, String> getProperties();
\r