Package org.apache.camel.spi

Interface PropertiesComponent

  • All Superinterfaces:
    AutoCloseable, Service, StaticService
    public interface PropertiesComponent
extends StaticService
    Component for property placeholders and loading properties from sources (such as .properties file from classpath or file system)

    • Method Detail

      • parseUri

        String parseUri​(String uri)
        Parses the input text and resolve all property placeholders from within the text.
        Parameters:
        uri - input text
        Returns:
        text with resolved property placeholders
        Throws:
        IllegalArgumentException - is thrown if error during parsing

      • resolveProperty

        Optional<String> resolveProperty​(String key)
        Looks up the property with the given key
        Parameters:
        key - the name of the property
        Returns:
        the property value if present

      • loadProperties

        Properties loadProperties()
        Loads the properties from the default locations and sources.
        Returns:
        the properties loaded.

      • loadProperties

        Properties loadProperties​(Predicate<String> filter)
        Loads the properties from the default locations and sources filtering them out according to a predicate. 

        
     PropertiesComponent pc = getPropertiesComponent();
     Properties props = pc.loadProperties(key -> key.startsWith("camel.component.seda"));
        Parameters:
        filter - the predicate used to filter out properties based on the key.
        Returns:
        the properties loaded.

      • getLocations

        List<String> getLocations()
        Gets the configured properties locations. This may be empty if the properties component has only been configured with PropertiesSource.

      • setLocation

        void setLocation​(String location)
        A list of locations to load properties. You can use comma to separate multiple locations. This option will override any default locations and only use the locations from this option.

      • addLocation

        void addLocation​(String location)
        Adds the list of locations to the current locations, where to load properties. You can use comma to separate multiple locations.

      • addPropertiesSource

        void addPropertiesSource​(PropertiesSource propertiesSource)
        Adds a custom PropertiesSource to use as source for loading and/or looking up property values.

      • setIgnoreMissingLocation

        void setIgnoreMissingLocation​(boolean ignoreMissingLocation)
        Whether to silently ignore if a location cannot be located, such as a properties file not found.

      • setInitialProperties

        void setInitialProperties​(Properties initialProperties)
        Sets initial properties which will be added before any property locations are loaded.

      • setOverrideProperties

        void setOverrideProperties​(Properties overrideProperties)
        Sets a special list of override properties that take precedence and will use first, if a property exist.

      • setEncoding

        void setEncoding​(String encoding)
        Encoding to use when loading properties file from the file system or classpath.

        If no encoding has been set, then the properties files is loaded using ISO-8859-1 encoding (latin-1) as documented by Properties.load(java.io.InputStream)

        Important you must set encoding before setting locations.