org.mule.tools.apikit

Class ScaffolderAPI

java.lang.Object

org.mule.tools.apikit.ScaffolderAPI

public class ScaffolderAPI
extends Object

Constructor Summary

Constructors

Constructor and Description
ScaffolderAPI()

Method Summary

Modifier and Type	Method and Description
ScaffolderReport	run(List<org.apache.maven.model.Dependency> dependencyList, ScaffolderResourceLoader scaffolderResourceLoader, File appDir, File domainDir, String minMuleVersion, RuntimeEdition runtimeEdition) Modifies or creates the Mule config files which are contained in the appDir directory by running the scaffolder on the ramlFiles contained at gavs passed as parameter.
ScaffolderReport	run(List<File> ramlFiles, File appDir) Modifies or creates the Mule config files which are contained in the appDir directory by running the scaffolder on the ramlFiles passed as parameter.
ScaffolderReport	run(List<File> ramlFiles, File appDir, File domainDir) Modifies or creates the Mule config files which are contained in the appDir directory by running the scaffolder on the ramlFiles passed as parameter.
ScaffolderReport	run(List<File> ramlFiles, File appDir, File domainDir, String minMuleVersion, RuntimeEdition runtimeEdition) Looks for an extension point and executes it, relying on the execute method otherwise.

Methods inherited from class java.lang.Object

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

Constructor Detail

ScaffolderAPI

public ScaffolderAPI()

Method Detail

run

public ScaffolderReport run(List<File> ramlFiles,
                            File appDir)

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

run

public ScaffolderReport run(List<File> ramlFiles,
                            File appDir,
                            File domainDir)

Modifies or creates the Mule config files which are contained in the appDir directory by running the scaffolder on the ramlFiles passed as parameter. Looks for an extension point and executes it, relying on the execute method otherwise.

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

run

public ScaffolderReport run(List<File> ramlFiles,
                            File appDir,
                            File domainDir,
                            String minMuleVersion,
                            RuntimeEdition runtimeEdition)

Looks for an extension point and executes it, relying on the execute method otherwise.

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

minMuleVersion - currently unused, will be useful in future improvements

runtimeEdition - the Mule Runtime Edition, this will be used to decide if generate CE or EE code

run

public ScaffolderReport run(List<org.apache.maven.model.Dependency> dependencyList,
                            ScaffolderResourceLoader scaffolderResourceLoader,
                            File appDir,
                            File domainDir,
                            String minMuleVersion,
                            RuntimeEdition runtimeEdition)

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

Parameters:

dependencyList - the dependencies that contains the raml files to which the scaffolder will be run on

scaffolderResourceLoader - a resource to load the raml files from the gav list

minMuleVersion - currently unused, will be useful in future improvements

runtimeEdition - the Mule Runtime Edition, this will be used to decide if generate CE or EE code