001/*
002 * (C) Copyright 2015 Nuxeo SA (http://nuxeo.com/) and others.
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 *     http://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 *
016 * Contributors:
017 *      Andre Justo
018 *      Anahide Tchertchian
019 */
020package org.nuxeo.runtime.services.config;
021
022import java.io.IOException;
023import java.io.Serializable;
024import java.util.Map;
025
026/**
027 * Service holding runtime configuration properties.
028 *
029 * @since 7.4
030 */
031public interface ConfigurationService {
032
033    public static final String LIST_SEPARATOR = ",";
034
035    /**
036     * Returns the given property value if any, otherwise null.
037     *
038     * @param key the property key
039     */
040    String getProperty(String key);
041
042    /**
043     * Returns the given property value if any, otherwise returns the given default value.
044     *
045     * @param key the property key
046     * @param defaultValue the default value for this key
047     */
048    String getProperty(String key, String defaultValue);
049
050    /**
051     * Returns the properties with key starting with the given namespace.
052     *
053     * @param namespace the namespace
054     * @return a map of properties with trimmed keys (namespace removed)
055     * @since 10.3
056     */
057    Map<String, Serializable> getProperties(String namespace);
058
059    /**
060     * Returns true if given property is true when compared to a boolean value.
061     */
062    boolean isBooleanPropertyTrue(String key);
063
064    /**
065     * Returns true if given property is false when compared to a boolean value.
066     */
067    boolean isBooleanPropertyFalse(String key);
068
069    /**
070     * Returns the json string representing the properties with key starting with the given namespace.
071     *
072     * @param namespace the namespace of the properties
073     * @throws IOException
074     * @since 10.3
075     */
076    String getPropertiesAsJson(String namespace) throws IOException;
077
078}