org.mule.apikit.scaffolding.api

Interface ScaffoldingResult

All Known Implementing Classes:

ScaffoldingResultImpl

public interface ScaffoldingResult

Method Summary

Modifier and Type	Method and Description
Map<String,List<String>>	additionalInformation()
List<ScaffoldingDependency>	dependencies()
List<ScaffoldingError>	errors()
Map<String,InputStream>	generatedMuleXmls()
Map<String,InputStream>	generatedPropertiesFiles()
boolean	success() Check if the scaffolding process was successful

Method Detail

success

boolean success()

Check if the scaffolding process was successful

generatedMuleXmls

Map<String,InputStream> generatedMuleXmls()

Returns:

Map with fileNames and Contents as InputStream

generatedPropertiesFiles

Map<String,InputStream> generatedPropertiesFiles()

Returns:

Map with fileNames and Contents as InputStream

errors

List<ScaffoldingError> errors()

Returns:

List of errors in case scaffolding was not success, otherwise emptyList

dependencies

List<ScaffoldingDependency> dependencies()

Returns:

List of module/connector dependencies (only applies to asyncapi, otherwise empty)

additionalInformation

Map<String,List<String>> additionalInformation()

Returns:

Map of additional information used for metrics evaluation to indicate that an API Specification contains a certain element type or conditions which are not provided by Exchange or is required at scaffolding time. Note: It is always recommended to use Exchange information if available for metrics for data consistency, this information is only meant for scenarios where this data does not exist or won't be included in Exchange.