org.mule.tools.api.packager.sources

Class DefaultValuesMuleArtifactJsonGenerator

java.lang.Object

org.mule.tools.api.packager.sources.DefaultValuesMuleArtifactJsonGenerator

public class DefaultValuesMuleArtifactJsonGenerator
extends Object

Generates default value for any non-defined fields in a mule-artifact.json file

Field Summary

Fields

Modifier and Type	Field and Description
static String	COMPILED_JAVA_EXTENSION
static String	DEFAULT_PACKAGE_EXPORT
static String	EXPORTED_PACKAGES
static String	EXPORTED_RESOURCES
static String	PACKAGE_SEPARATOR

Constructor Summary

Constructors

Constructor and Description
DefaultValuesMuleArtifactJsonGenerator()

Method Summary

Modifier and Type	Method and Description
void	generate(MuleArtifactContentResolver muleArtifactContentResolver) Generates the default value for every non-defined fields in a mule-artifact.json file during build time and updates accordingly
void	generate(Path originFolder, Path destinationFolder, MuleArtifactContentResolver muleArtifactContentResolver) Generates the default value for every non-defined fields in a mule-artifact.json and copy this to the destination folder
protected org.mule.runtime.api.deployment.meta.MuleApplicationModel	generateMuleArtifactWithDefaultValues(org.mule.runtime.api.deployment.meta.MuleApplicationModel originalMuleArtifact, MuleArtifactContentResolver muleArtifactContentResolver) Generates a MuleApplicationModel with default values based on a MuleArtifactContentResolver.
protected org.mule.runtime.api.deployment.meta.MuleApplicationModel.MuleApplicationModelBuilder	getBuilderWithRequiredValues(org.mule.runtime.api.deployment.meta.MuleApplicationModel muleArtifact) Builds a MuleApplicationModel.MuleApplicationModelBuilder with the required values of a MuleApplicationModel.
protected org.mule.runtime.api.deployment.meta.MuleApplicationModel	getOriginalMuleArtifact(Path originFolder) Deserializes the mule-artifact.json to a MuleApplicationModel
protected Path	resolveMuleArtifactJsonLocation(ProjectStructure projectStructure) Resolves the mule-artifact.json location based on the project base folder during build time
protected void	setBuilderWithDefaultBundleDescriptorLoaderValue(org.mule.runtime.api.deployment.meta.MuleApplicationModel.MuleApplicationModelBuilder builder, org.mule.runtime.api.deployment.meta.MuleApplicationModel originalMuleArtifact) Updates a MuleApplicationModel.MuleApplicationModelBuilder bundleDescriptorLoader field with default the default value based on the MuleApplicationModel.
protected void	setBuilderWithDefaultConfigsValue(org.mule.runtime.api.deployment.meta.MuleApplicationModel.MuleApplicationModelBuilder builder, org.mule.runtime.api.deployment.meta.MuleApplicationModel originalMuleArtifact, MuleArtifactContentResolver muleArtifactContentResolver) Updates a MuleApplicationModel.MuleApplicationModelBuilder configs field with default values based on a MuleArtifactContentResolver.
protected void	setBuilderWithDefaultExportedPackagesValue(org.mule.runtime.api.deployment.meta.MuleApplicationModel.MuleApplicationModelBuilder builder, MuleArtifactContentResolver muleArtifactContentResolver) Updates a MuleApplicationModel.MuleApplicationModelBuilder exportedPackages in the attributes field with default values based on a MuleArtifactContentResolver.
protected void	setBuilderWithDefaultExportedResourcesValue(org.mule.runtime.api.deployment.meta.MuleApplicationModel.MuleApplicationModelBuilder builder, org.mule.runtime.api.deployment.meta.MuleApplicationModel originalMuleArtifact, MuleArtifactContentResolver muleArtifactContentResolver) Updates a MuleApplicationModel.MuleApplicationModelBuilder exportedResources in the attributes field with default values based on a MuleArtifactContentResolver.
protected void	setBuilderWithDefaultName(org.mule.runtime.api.deployment.meta.MuleApplicationModel.MuleApplicationModelBuilder builder, org.mule.runtime.api.deployment.meta.MuleApplicationModel originalMuleArtifact, MuleArtifactContentResolver muleArtifactContentResolver) Sets the name as groupId:artifactId:version if not set in the originalMuleArtifact
protected void	setBuilderWithDefaultRedeploymentEnabled(org.mule.runtime.api.deployment.meta.MuleApplicationModel.MuleApplicationModelBuilder builder, org.mule.runtime.api.deployment.meta.MuleApplicationModel originalMuleArtifact) Updates a MuleApplicationModel.MuleApplicationModelBuilder redeploymentEnabled field with default the default value based on the MuleApplicationModel.
protected void	setBuilderWithDefaultSecureProperties(org.mule.runtime.api.deployment.meta.MuleApplicationModel.MuleApplicationModelBuilder builder, org.mule.runtime.api.deployment.meta.MuleApplicationModel originalMuleArtifact) Sets the builder with an empty list of secure properties if not set in originalMuleArtifact
protected void	setBuilderWithDefaultValuesNotPresent(org.mule.runtime.api.deployment.meta.MuleApplicationModel.MuleApplicationModelBuilder builder, org.mule.runtime.api.deployment.meta.MuleApplicationModel originalMuleArtifact, MuleArtifactContentResolver muleArtifactContentResolver) Updates a MuleApplicationModel.MuleApplicationModelBuilder with default values based on a MuleArtifactContentResolver.
protected void	setBuilderWithIncludeTestDependencies(org.mule.runtime.api.deployment.meta.MuleApplicationModel.MuleApplicationModelBuilder builder, MuleArtifactContentResolver muleArtifactContentResolver)
protected void	writeMuleArtifactToFile(org.mule.runtime.api.deployment.meta.MuleApplicationModel muleArtifact, Path destinationFolder) Writes the mule artifact to the corresponding file

Methods inherited from class java.lang.Object

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

Field Detail

EXPORTED_PACKAGES

public static final String EXPORTED_PACKAGES

See Also:

Constant Field Values

EXPORTED_RESOURCES

public static final String EXPORTED_RESOURCES

See Also:

Constant Field Values

COMPILED_JAVA_EXTENSION

public static final String COMPILED_JAVA_EXTENSION

See Also:

Constant Field Values

PACKAGE_SEPARATOR

public static final String PACKAGE_SEPARATOR

See Also:

Constant Field Values

DEFAULT_PACKAGE_EXPORT

public static final String DEFAULT_PACKAGE_EXPORT

See Also:

Constant Field Values

Constructor Detail

DefaultValuesMuleArtifactJsonGenerator

public DefaultValuesMuleArtifactJsonGenerator()

Method Detail

generate

public void generate(MuleArtifactContentResolver muleArtifactContentResolver)
              throws IOException

Generates the default value for every non-defined fields in a mule-artifact.json file during build time and updates accordingly

Parameters:

muleArtifactContentResolver - muleArtifactContentResolver of project being built

Throws:

IOException

resolveMuleArtifactJsonLocation

protected Path resolveMuleArtifactJsonLocation(ProjectStructure projectStructure)

Resolves the mule-artifact.json location based on the project base folder during build time

Parameters:

projectStructure - projectStructure of project being built

generate

public void generate(Path originFolder,
                     Path destinationFolder,
                     MuleArtifactContentResolver muleArtifactContentResolver)
              throws IOException

Generates the default value for every non-defined fields in a mule-artifact.json and copy this to the destination folder

Parameters:

originFolder - folder location containing the original mule-artifact.json

destinationFolder - folder location where the updated mule-artifact.json is going to be written to

muleArtifactContentResolver - resolves all the contents that are going to be defaulted in the generated the mule-artifact.json

Throws:

IOException

writeMuleArtifactToFile

protected void writeMuleArtifactToFile(org.mule.runtime.api.deployment.meta.MuleApplicationModel muleArtifact,
                                       Path destinationFolder)
                                throws IOException

Writes the mule artifact to the corresponding file

Parameters:

muleArtifact - mule artifact that is going to be persisted

destinationFolder - destination folder where the mule-artifact.json file is going to be created

Throws:

IOException

getOriginalMuleArtifact

protected org.mule.runtime.api.deployment.meta.MuleApplicationModel getOriginalMuleArtifact(Path originFolder)
                                                                                     throws IOException

Deserializes the mule-artifact.json to a MuleApplicationModel

Parameters:

originFolder - folder path where the mule-artifact.json is located

Throws:

IOException

generateMuleArtifactWithDefaultValues

protected org.mule.runtime.api.deployment.meta.MuleApplicationModel generateMuleArtifactWithDefaultValues(org.mule.runtime.api.deployment.meta.MuleApplicationModel originalMuleArtifact,
                                                                                                          MuleArtifactContentResolver muleArtifactContentResolver)
                                                                                                   throws IOException

Generates a MuleApplicationModel with default values based on a MuleArtifactContentResolver.

Parameters:

originalMuleArtifact - original mule application model

muleArtifactContentResolver - the application content resolver

Throws:

IOException

setBuilderWithDefaultValuesNotPresent

protected void setBuilderWithDefaultValuesNotPresent(org.mule.runtime.api.deployment.meta.MuleApplicationModel.MuleApplicationModelBuilder builder,
                                                     org.mule.runtime.api.deployment.meta.MuleApplicationModel originalMuleArtifact,
                                                     MuleArtifactContentResolver muleArtifactContentResolver)
                                              throws IOException

Updates a MuleApplicationModel.MuleApplicationModelBuilder with default values based on a MuleArtifactContentResolver.

Parameters:

builder - builder for the generated mule artifact based on the original one

originalMuleArtifact - original mule application model

muleArtifactContentResolver - the application content resolver

Throws:

IOException

setBuilderWithDefaultSecureProperties

protected void setBuilderWithDefaultSecureProperties(org.mule.runtime.api.deployment.meta.MuleApplicationModel.MuleApplicationModelBuilder builder,
                                                     org.mule.runtime.api.deployment.meta.MuleApplicationModel originalMuleArtifact)

Sets the builder with an empty list of secure properties if not set in originalMuleArtifact

Parameters:

builder -

originalMuleArtifact -

setBuilderWithDefaultName

protected void setBuilderWithDefaultName(org.mule.runtime.api.deployment.meta.MuleApplicationModel.MuleApplicationModelBuilder builder,
                                         org.mule.runtime.api.deployment.meta.MuleApplicationModel originalMuleArtifact,
                                         MuleArtifactContentResolver muleArtifactContentResolver)

Sets the name as groupId:artifactId:version if not set in the originalMuleArtifact

Parameters:

builder -

originalMuleArtifact -

muleArtifactContentResolver -

setBuilderWithIncludeTestDependencies

protected void setBuilderWithIncludeTestDependencies(org.mule.runtime.api.deployment.meta.MuleApplicationModel.MuleApplicationModelBuilder builder,
                                                     MuleArtifactContentResolver muleArtifactContentResolver)
                                              throws IOException

Throws:

IOException

setBuilderWithDefaultExportedResourcesValue

protected void setBuilderWithDefaultExportedResourcesValue(org.mule.runtime.api.deployment.meta.MuleApplicationModel.MuleApplicationModelBuilder builder,
                                                           org.mule.runtime.api.deployment.meta.MuleApplicationModel originalMuleArtifact,
                                                           MuleArtifactContentResolver muleArtifactContentResolver)
                                                    throws IOException

Updates a MuleApplicationModel.MuleApplicationModelBuilder exportedResources in the attributes field with default values based on a MuleArtifactContentResolver.

Parameters:

builder - builder for the mule artifact that is going to be generated

muleArtifactContentResolver - the application content resolver

Throws:

IOException

setBuilderWithDefaultExportedPackagesValue

protected void setBuilderWithDefaultExportedPackagesValue(org.mule.runtime.api.deployment.meta.MuleApplicationModel.MuleApplicationModelBuilder builder,
                                                          MuleArtifactContentResolver muleArtifactContentResolver)
                                                   throws IOException

Updates a MuleApplicationModel.MuleApplicationModelBuilder exportedPackages in the attributes field with default values based on a MuleArtifactContentResolver.

Parameters:

builder - builder for the mule artifact that is going to be generated

muleArtifactContentResolver - the application content resolver

Throws:

IOException

setBuilderWithDefaultConfigsValue

protected void setBuilderWithDefaultConfigsValue(org.mule.runtime.api.deployment.meta.MuleApplicationModel.MuleApplicationModelBuilder builder,
                                                 org.mule.runtime.api.deployment.meta.MuleApplicationModel originalMuleArtifact,
                                                 MuleArtifactContentResolver muleArtifactContentResolver)
                                          throws IOException

Updates a MuleApplicationModel.MuleApplicationModelBuilder configs field with default values based on a MuleArtifactContentResolver.

Parameters:

builder - builder for the mule artifact that is going to be generated

originalMuleArtifact - original mule application model

muleArtifactContentResolver - the application content resolver

Throws:

IOException

setBuilderWithDefaultRedeploymentEnabled

protected void setBuilderWithDefaultRedeploymentEnabled(org.mule.runtime.api.deployment.meta.MuleApplicationModel.MuleApplicationModelBuilder builder,
                                                        org.mule.runtime.api.deployment.meta.MuleApplicationModel originalMuleArtifact)

Updates a MuleApplicationModel.MuleApplicationModelBuilder redeploymentEnabled field with default the default value based on the MuleApplicationModel.

Parameters:

builder - builder for the mule artifact that is going to be generated

originalMuleArtifact - the application content resolver

setBuilderWithDefaultBundleDescriptorLoaderValue

protected void setBuilderWithDefaultBundleDescriptorLoaderValue(org.mule.runtime.api.deployment.meta.MuleApplicationModel.MuleApplicationModelBuilder builder,
                                                                org.mule.runtime.api.deployment.meta.MuleApplicationModel originalMuleArtifact)

Updates a MuleApplicationModel.MuleApplicationModelBuilder bundleDescriptorLoader field with default the default value based on the MuleApplicationModel.

Parameters:

builder - builder for the mule artifact that is going to be generated

originalMuleArtifact - the application content resolver

getBuilderWithRequiredValues

protected org.mule.runtime.api.deployment.meta.MuleApplicationModel.MuleApplicationModelBuilder getBuilderWithRequiredValues(org.mule.runtime.api.deployment.meta.MuleApplicationModel muleArtifact)

Builds a MuleApplicationModel.MuleApplicationModelBuilder with the required values of a MuleApplicationModel.

Parameters:

muleArtifact - mule application model that is going to be used to generate the builder