Package org.craftercms.studio.api.v1.asset.processing

Interface AssetProcessingConfigReader

All Known Implementing Classes:

AssetProcessingConfigReaderImpl

public interface AssetProcessingConfigReader

Reads the configuration from an input stream or a Apache Commons Configuration object and maps it to actual asset processing configuration objects like ProcessorPipelineConfiguration and ProcessorConfiguration.

Author:

avasquez

Method Summary

Modifier and Type	Method	Description
List<ProcessorPipelineConfiguration>	readConfig(InputStream in)	Reads the configuration from the input stream and maps it to ProcessorPipelineConfiguration objects.
List<ProcessorPipelineConfiguration>	readConfig(org.apache.commons.configuration2.HierarchicalConfiguration config)	Reads the configuration from the Apache Commons Configuration and maps it to ProcessorPipelineConfiguration objects.

Method Details

readConfig

List<ProcessorPipelineConfiguration> readConfig(InputStream in)
                                         throws AssetProcessingConfigurationException

Reads the configuration from the input stream and maps it to ProcessorPipelineConfiguration objects.

Parameters:

in - the input stream of the configuration

Returns:

the list with the pipeline configurations.

Throws:

AssetProcessingConfigurationException - if the configuration couldn't be read because of an error

readConfig

List<ProcessorPipelineConfiguration> readConfig(org.apache.commons.configuration2.HierarchicalConfiguration config)
                                         throws AssetProcessingConfigurationException

Reads the configuration from the Apache Commons Configuration and maps it to ProcessorPipelineConfiguration objects.

Parameters:

config - the Apache Commons Configuration

Returns:

the list with the pipeline configurations.

Throws:

AssetProcessingConfigurationException - if the configuration couldn't be read because of an error