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.Properties;
020import java.util.function.Predicate;
021
022import org.apache.camel.Ordered;
023
024/**
025 * A source for properties that can be loaded all at once during initialization,
026 * such as loading .properties files.
027 * <p/>
028 * A source can implement {@link Ordered} to control the ordering of which sources are used by the Camel
029 * properties component. The source with the highest precedence (lowest number) will be used first.
030 */
031public interface LoadablePropertiesSource extends PropertiesSource {
032
033    /**
034     * Loads the properties from the source
035     *
036     * @return the loaded properties
037     */
038    Properties loadProperties();
039
040    /**
041     * Loads the properties from the source filtering them out according to a predicate.
042     *
043     * @param filter the predicate used to filter out properties based on the key.
044     * @return the properties loaded.
045     */
046    Properties loadProperties(Predicate<String> filter);
047}