001/*
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements.  See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache License, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License.  You may obtain a copy of the License at
008 *
009 *      http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017package org.apache.camel.spi;
018
019import java.util.Map;
020import java.util.function.Consumer;
021import java.util.function.Supplier;
022
023import org.apache.camel.CamelContext;
024
025/**
026 * A configurer for properties on a given object.
027 * <p/>
028 * This is used in Camel to have fast property configuration of Camel EIP patterns, which
029 * are using property placeholders (eg {{foo}} style).
030 */
031public interface PropertyPlaceholderConfigurer extends PropertyConfigurer {
032
033    /**
034     * Gets the options which supports property placeholders and can be resolved.
035     * This will be all the string based options.
036     *
037     * @return key/values of options
038     */
039    Map<String, Supplier<String>> getReadPropertyPlaceholderOptions(CamelContext camelContext);
040
041    /**
042     * To update an existing property using the function with the key/value and returning the changed value
043     * This will be all the string based options.
044     */
045    Map<String, Consumer<String>> getWritePropertyPlaceholderOptions(CamelContext camelContext);
046
047}