org.mule.runtime.config.api.dsl.model.properties

Class DefaultConfigurationPropertiesProvider

java.lang.Object

org.mule.runtime.api.component.AbstractComponent

org.mule.runtime.config.api.dsl.model.properties.DefaultConfigurationPropertiesProvider

All Implemented Interfaces:

org.mule.runtime.api.component.Component, org.mule.runtime.api.lifecycle.Initialisable, ConfigurationPropertiesProvider

@NoExtend
public class DefaultConfigurationPropertiesProvider
extends org.mule.runtime.api.component.AbstractComponent
implements ConfigurationPropertiesProvider, org.mule.runtime.api.lifecycle.Initialisable

Artifact attributes configuration. This class represents a single configuration-attributes element from the configuration.

Since:

4.0

Nested Class Summary

Nested classes/interfaces inherited from interface org.mule.runtime.api.component.Component

org.mule.runtime.api.component.Component.Annotations

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<String,ConfigurationProperty>	configurationAttributes
protected String	encoding
protected String	fileLocation
protected static String	PROPERTIES_EXTENSION
protected ResourceProvider	resourceProvider
protected static String	UNKNOWN
protected static String	YAML_EXTENSION

Fields inherited from class org.mule.runtime.api.component.AbstractComponent

ANNOTATION_NAME, LOCATION_KEY, ROOT_CONTAINER_NAME_KEY

Fields inherited from interface org.mule.runtime.api.lifecycle.Initialisable

PHASE_NAME

Fields inherited from interface org.mule.runtime.api.component.Component

ANNOTATIONS_PROPERTY_NAME, NS_MULE_DOCUMENTATION, NS_MULE_PARSER_METADATA

Constructor Summary

Constructors

Constructor and Description
DefaultConfigurationPropertiesProvider(String fileLocation, ResourceProvider resourceProvider)
DefaultConfigurationPropertiesProvider(String fileLocation, String encoding, ResourceProvider resourceProvider)

Method Summary

Modifier and Type	Method and Description
protected void	createAttributesFromYamlObject(String parentPath, Object parentYamlObject, Object yamlObject)
protected String	createKey(String parentKey, String key)
protected String	createValue(String key, String value)
Optional<ConfigurationProperty>	getConfigurationProperty(String configurationAttributeKey)
String	getDescription()
protected InputStream	getResourceInputStream(String file)
protected InputStreamReader	getResourceInputStreamReader(String file)
void	initialise()
protected void	readAttributesFromFile(InputStreamReader is)

Methods inherited from class org.mule.runtime.api.component.AbstractComponent

getAnnotation, getAnnotations, getDslSource, getIdentifier, getLocation, getRepresentation, getRootContainerLocation, initRootContainerName, setAnnotations

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

PROPERTIES_EXTENSION

protected static final String PROPERTIES_EXTENSION

See Also:

Constant Field Values

YAML_EXTENSION

protected static final String YAML_EXTENSION

See Also:

Constant Field Values

UNKNOWN

protected static final String UNKNOWN

See Also:

Constant Field Values

configurationAttributes

protected final Map<String,ConfigurationProperty> configurationAttributes

fileLocation

protected String fileLocation

encoding

protected String encoding

resourceProvider

protected ResourceProvider resourceProvider

Constructor Detail

DefaultConfigurationPropertiesProvider

public DefaultConfigurationPropertiesProvider(String fileLocation,
                                              String encoding,
                                              ResourceProvider resourceProvider)

DefaultConfigurationPropertiesProvider

public DefaultConfigurationPropertiesProvider(String fileLocation,
                                              ResourceProvider resourceProvider)

Method Detail

getConfigurationProperty

public Optional<ConfigurationProperty> getConfigurationProperty(String configurationAttributeKey)

Specified by:

getConfigurationProperty in interface ConfigurationPropertiesProvider

Parameters:

configurationAttributeKey - the key of the configuration attribute.

Returns:

the ConfigurationProperty associated with the key. May be empty if that key is not present.

getDescription

public String getDescription()

Specified by:

getDescription in interface ConfigurationPropertiesProvider

Returns:

a meaningful description of the provider. This is used for error reporting.

getResourceInputStream

protected InputStream getResourceInputStream(String file)
                                      throws IOException

Throws:

IOException

getResourceInputStreamReader

protected InputStreamReader getResourceInputStreamReader(String file)
                                                  throws IOException

Throws:

IOException

initialise

public void initialise()
                throws org.mule.runtime.api.lifecycle.InitialisationException

Specified by:

initialise in interface org.mule.runtime.api.lifecycle.Initialisable

Throws:

org.mule.runtime.api.lifecycle.InitialisationException

readAttributesFromFile

protected void readAttributesFromFile(InputStreamReader is)
                               throws IOException

Throws:

IOException

createAttributesFromYamlObject

protected void createAttributesFromYamlObject(String parentPath,
                                              Object parentYamlObject,
                                              Object yamlObject)

createKey

protected String createKey(String parentKey,
                           String key)

createValue

protected String createValue(String key,
                             String value)