org.mule.runtime.properties.api

Class DefaultConfigurationPropertiesProvider

java.lang.Object

org.mule.runtime.api.component.AbstractComponent

org.mule.runtime.properties.api.DefaultConfigurationPropertiesProvider

All Implemented Interfaces:

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

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:

1.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 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 String	createValue(String key, String value)
String	getDescription()
protected InputStream	getResourceInputStream(String file)
void	initialise()
Optional<ConfigurationProperty>	provide(String configurationAttributeKey)

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

Constructor Detail

DefaultConfigurationPropertiesProvider

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

DefaultConfigurationPropertiesProvider

public DefaultConfigurationPropertiesProvider(String fileLocation,
                                              ResourceProvider resourceProvider)

Method Detail

provide

public Optional<ConfigurationProperty> provide(String configurationAttributeKey)

Specified by:

provide 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

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

createValue

protected String createValue(String key,
                             String value)