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 org.apache.camel.Component;
020
021public interface PropertiesComponent extends Component {
022
023    /**
024     * The default prefix token.
025     */
026    String DEFAULT_PREFIX_TOKEN = "{{";
027
028    /**
029     * The default suffix token.
030     */
031    String DEFAULT_SUFFIX_TOKEN = "}}";
032
033    /**
034     * Has the component been created as a default by {@link org.apache.camel.CamelContext} during starting up Camel.
035     */
036    String DEFAULT_CREATED = "PropertiesComponentDefaultCreated";
037
038    String getPrefixToken();
039
040    String getSuffixToken();
041
042    String parseUri(String uri) throws Exception;
043
044    String parseUri(String uri, String... uris) throws Exception;
045
046    /**
047     * A list of locations to load properties. You can use comma to separate multiple locations.
048     * This option will override any default locations and only use the locations from this option.
049     */
050    void setLocation(String location);
051
052}