com.mulesoft.citizen.platform.connectors_models.mojo.internal

Class CustomizationService

java.lang.Object

com.mulesoft.citizen.platform.connectors_models.mojo.internal.CustomizationService

public class CustomizationService
extends Object

Constructor Summary

Constructors

Constructor and Description
CustomizationService(String generatorName)

Method Summary

Modifier and Type	Method and Description
String	generate(String extensionModel, org.apache.maven.artifact.Artifact artifact, List<String> sourceExcludedParameterNames, List<String> operationExcludedParameterNames, List<String> excludedOperations) Given the extension model json content, artifact, and list of excluded parameters for sources and operations it generates the customization descriptor yaml content based by inferring values from the extension model.
void	initialize()
String	overlay(String source, String overlay) Given a customization descriptor as input and an overlay content for the descriptor it will take any overlayed value from the overlay input and generate the model merged with these values.

Methods inherited from class java.lang.Object

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

Constructor Detail

CustomizationService

public CustomizationService(String generatorName)

Method Detail

initialize

public void initialize()

generate

public String generate(String extensionModel,
                       org.apache.maven.artifact.Artifact artifact,
                       List<String> sourceExcludedParameterNames,
                       List<String> operationExcludedParameterNames,
                       List<String> excludedOperations)

Given the extension model json content, artifact, and list of excluded parameters for sources and operations it generates the customization descriptor yaml content based by inferring values from the extension model. Every operation and source defined in the extension model will be included in the customization descriptor, same for its parameters except for those excluded by the given lists.

Parameters:

extensionModel - the input model for the connector to generates its customization model.

artifact - Maven artifact to access its GAV.

sourceExcludedParameterNames - list of parameters to be excluded from the customization fields definition in sources. Mostly used for synthetic parameters defined by Mule Runtime.

operationExcludedParameterNames - list of parameters to be excluded from the customization fields definition in operations. Mostly used for synthetic parameters defined by Mule Runtime.

Returns:

the customization descriptor content.

overlay

public String overlay(String source,
                      String overlay)

Given a customization descriptor as input and an overlay content for the descriptor it will take any overlayed value from the overlay input and generate the model merged with these values. It will also allow to append/add fields to sources or parameters if the overlay defines a field that is not present in the input descriptor. It doesn't support to append/add sources or operations if they are only defined in the overlay descriptor.

Parameters:

source - the input model for the connector to generates its customization model.

overlay - Maven artifact to access its GAV.

Returns:

the customization descriptor content with the overlays.