org.mule.module.apikit.spi

Interface ScaffolderService

public interface ScaffolderService

Extension (SPI) for the APIKit Maven Module

Method Summary

Modifier and Type	Method and Description
void	executeScaffolder(List<File> ramlFiles, File appDir, File domainDir, String muleVersion, RuntimeEdition runtimeEdition) Modifies or creates the Mule config files which are contained in the appDir directory by running the scaffolder on the ramlFiles passed as parameter.

Method Detail

executeScaffolder

void executeScaffolder(List<File> ramlFiles,
                       File appDir,
                       File domainDir,
                       String muleVersion,
                       RuntimeEdition runtimeEdition)

Modifies or creates the Mule config files which are contained in the appDir directory by running the scaffolder on the ramlFiles passed as parameter.

Parameters:

ramlFiles - the ramlFiles to which the scaffolder will be run on

appDir - the directory which contained the generated Mule config files

domainDir - the directory which contained the domain used by the mule config files

muleVersion - used to know which type of endpoint (InboundEndpoint or Listener) that the scaffolder should create in case the xml is not provided. If this param is null, listeners will be used.

runtimeEdition - used to know which runtime edition is running, "CE" or "EE". If this param is null, "CE" will be used.