org.mule.tools.api.validation

Class MuleArtifactJsonValidator

java.lang.Object

org.mule.tools.api.validation.MuleArtifactJsonValidator

public class MuleArtifactJsonValidator
extends Object

Constructor Summary

Constructors

Constructor and Description
MuleArtifactJsonValidator()

Method Summary

Modifier and Type	Method and Description
protected static void	checkClassLoaderModelDescriptor(org.mule.runtime.api.deployment.meta.MuleApplicationModel muleArtifact, List<String> missingFields) Checks that the classLoaderModelDescriptor field is present in the mule artifact instance.
protected static void	checkMinMuleVersionValue(org.mule.runtime.api.deployment.meta.MuleApplicationModel muleArtifact, List<String> missingFields, Optional<String> deployMuleVersion) Checks that the minMuleVersion field is present in the mule artifact instance.
protected static void	checkName(org.mule.runtime.api.deployment.meta.MuleApplicationModel muleArtifact, List<String> missingFields) Checks that the name field is present in the mule artifact instance.
static void	isMuleArtifactJsonPresent(Path projectBaseDir) It validates that the mandatory descriptor file is present.
static void	isMuleArtifactJsonValid(Path projectBaseDir, Optional<String> deployMuleVersion) It validates that the mandatory descriptor file is valid.
static void	validate(Path projectBaseDir, Optional<String> deployMuleVersion) It validates that the mandatory descriptor file is present and is valid.
protected static void	validateMuleArtifactMandatoryFields(org.mule.runtime.api.deployment.meta.MuleApplicationModel muleArtifact, Optional<String> deployMuleVersion) Validates that the mandatory fields in the mule-artifact.json file are present and have valid values.

Methods inherited from class java.lang.Object

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

Constructor Detail

MuleArtifactJsonValidator

public MuleArtifactJsonValidator()

Method Detail

validate

public static void validate(Path projectBaseDir,
                            Optional<String> deployMuleVersion)
                     throws ValidationException

It validates that the mandatory descriptor file is present and is valid.

Parameters:

projectBaseDir -

Throws:

ValidationException - if the project descriptor file is missing and/or is invalid

isMuleArtifactJsonPresent

public static void isMuleArtifactJsonPresent(Path projectBaseDir)
                                      throws ValidationException

It validates that the mandatory descriptor file is present.

Parameters:

projectBaseDir -

Throws:

ValidationException - if the project descriptor file(s) is/are missing

isMuleArtifactJsonValid

public static void isMuleArtifactJsonValid(Path projectBaseDir,
                                           Optional<String> deployMuleVersion)
                                    throws ValidationException

It validates that the mandatory descriptor file is valid. It assumes that the file exists.

Parameters:

projectBaseDir -

deployMuleVersion -

Throws:

ValidationException - if the project descriptor file is invalid

validateMuleArtifactMandatoryFields

protected static void validateMuleArtifactMandatoryFields(org.mule.runtime.api.deployment.meta.MuleApplicationModel muleArtifact,
                                                          Optional<String> deployMuleVersion)
                                                   throws ValidationException

Validates that the mandatory fields in the mule-artifact.json file are present and have valid values.

Parameters:

muleArtifact -

Throws:

ValidationException - if the project descriptor file does not have set all mandatory fields

checkName

protected static void checkName(org.mule.runtime.api.deployment.meta.MuleApplicationModel muleArtifact,
                                List<String> missingFields)

Checks that the name field is present in the mule artifact instance. If it is not defined, the field name is added to the missing fields list.

Parameters:

muleArtifact - the mule artifact to be checked

missingFields - list of required fields that are missing

checkMinMuleVersionValue

protected static void checkMinMuleVersionValue(org.mule.runtime.api.deployment.meta.MuleApplicationModel muleArtifact,
                                               List<String> missingFields,
                                               Optional<String> deployMuleVersion)
                                        throws ValidationException

Checks that the minMuleVersion field is present in the mule artifact instance. If it is not defined, the field name is added to the missing fields list.

Parameters:

muleArtifact - the mule artifact to be checked

missingFields - list of required fields that are missing

Throws:

ValidationException

checkClassLoaderModelDescriptor

protected static void checkClassLoaderModelDescriptor(org.mule.runtime.api.deployment.meta.MuleApplicationModel muleArtifact,
                                                      List<String> missingFields)

Checks that the classLoaderModelDescriptor field is present in the mule artifact instance. If it is not defined, the field name is added to the missing fields list. Also checks if the classLoaderModelDescriptor id is defined, and also adds it to the missing fields in case it is not defined.

Parameters:

muleArtifact - the mule artifact to be checked

missingFields - list of required fields that are missing