PlaceholderResolver.java

/*
 * 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.
 */
package org.apache.karaf.profile;

import java.util.Map;

public interface PlaceholderResolver {

    String CATCH_ALL_SCHEME = "*";

    /**
     * The placeholder scheme.
     *
     * @return The placeholder scheme.
     */
    String getScheme();

    /**
     * Resolve the placeholder found inside the value, for the specific key of the pid.
     *
     * @param profile The current profile.
     * @param pid The pid that contains the placeholder.
     * @param key The key of the configuration value that contains the placeholder.
     * @param value The value with the placeholder.
     * @return The resolved value or EMPTY_STRING.
     */
    String resolve(Map<String, Map<String, String>> profile, String pid, String key, String value);

}