org.mule.runtime.module.artifact.api.descriptor

Class AbstractArtifactDescriptorFactory<M extends AbstractMuleArtifactModel,T extends ArtifactDescriptor>

java.lang.Object

org.mule.runtime.module.artifact.api.descriptor.AbstractArtifactDescriptorFactory<M,T>

Type Parameters:

M - type of the artifact model that owns the descriptor

T - type of descriptor being created

All Implemented Interfaces:

ArtifactDescriptorFactory<T>

@NoInstantiate
public abstract class AbstractArtifactDescriptorFactory<M extends AbstractMuleArtifactModel,T extends ArtifactDescriptor>
extends Object
implements ArtifactDescriptorFactory<T>

Base class to create artifact descriptors

Since:

4.0

Field Summary

Fields

Modifier and Type	Field and Description
static String	ARTIFACT_DESCRIPTOR_DOES_NOT_EXISTS_ERROR
protected DescriptorLoaderRepository	descriptorLoaderRepository

Constructor Summary

Constructors

Constructor and Description
AbstractArtifactDescriptorFactory(DescriptorLoaderRepository descriptorLoaderRepository, ArtifactDescriptorValidatorBuilder artifactDescriptorValidatorBuilder) Creates a new factory

Method Summary

Modifier and Type	Method and Description
T	create(File artifactFolder, Optional<Properties> deploymentProperties) Creates an artifact descriptor from a folder.
protected T	createArtifact(File artifactFolder, Optional<Properties> deploymentProperties, M artifactModel)
protected abstract T	createArtifactDescriptor(File artifactLocation, String name, Optional<Properties> deploymentProperties)
protected M	createArtifactModel(File artifactFolder)
protected abstract void	doDescriptorConfig(M artifactModel, T descriptor, File artifactLocation) Allows subclasses to customize descriptor based on the provided model
protected abstract ArtifactType	getArtifactType()
protected abstract AbstractMuleArtifactModelJsonSerializer<M>	getMuleArtifactModelJsonSerializer()
static String	invalidBundleDescriptorLoaderIdError(File artifactFolder, MuleArtifactLoaderDescriptor bundleDescriptorLoader)
static String	invalidClassLoaderModelIdError(File artifactFolder, MuleArtifactLoaderDescriptor classLoaderModelLoaderDescriptor)
protected T	loadFromJsonDescriptor(File artifactLocation, M artifactModel, Optional<Properties> deploymentProperties) Loads a descriptor from an artifact model
protected M	loadModelFromJson(String jsonString) Generates an artifact model from a given JSON descriptor

Methods inherited from class java.lang.Object

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

Field Detail

ARTIFACT_DESCRIPTOR_DOES_NOT_EXISTS_ERROR

public static final String ARTIFACT_DESCRIPTOR_DOES_NOT_EXISTS_ERROR

See Also:

Constant Field Values

descriptorLoaderRepository

protected final DescriptorLoaderRepository descriptorLoaderRepository

Constructor Detail

AbstractArtifactDescriptorFactory

public AbstractArtifactDescriptorFactory(DescriptorLoaderRepository descriptorLoaderRepository,
                                         ArtifactDescriptorValidatorBuilder artifactDescriptorValidatorBuilder)

Creates a new factory

Parameters:

descriptorLoaderRepository - contains all the ClassLoaderModelLoader registered on the container. Non null

artifactDescriptorValidatorBuilder - ArtifactDescriptorValidatorBuilder to create the ArtifactDescriptorValidator in order to check the state of the descriptor once loaded.

Method Detail

create

public T create(File artifactFolder,
                Optional<Properties> deploymentProperties)
         throws ArtifactDescriptorCreateException

Description copied from interface: ArtifactDescriptorFactory

Creates an artifact descriptor from a folder.

Specified by:

create in interface ArtifactDescriptorFactory<T extends ArtifactDescriptor>

Parameters:

artifactFolder - an existing folder containing artifact files

deploymentProperties - properties provided for the deployment process.

Returns:

a non null descriptor

Throws:

ArtifactDescriptorCreateException - if the factory is not able to create a descriptor from the folder.

createArtifact

protected T createArtifact(File artifactFolder,
                           Optional<Properties> deploymentProperties,
                           M artifactModel)

createArtifactModel

protected M createArtifactModel(File artifactFolder)

getArtifactType

protected abstract ArtifactType getArtifactType()

Returns:

the type of artifact begin created

loadFromJsonDescriptor

protected final T loadFromJsonDescriptor(File artifactLocation,
                                         M artifactModel,
                                         Optional<Properties> deploymentProperties)

Loads a descriptor from an artifact model

Parameters:

artifactLocation - folder where the artifact is located, it can be a folder or file depending on the artifact type.

artifactModel - model representing the artifact.

Returns:

a descriptor matching the provided model.

loadModelFromJson

protected M loadModelFromJson(String jsonString)

Generates an artifact model from a given JSON descriptor

Parameters:

jsonString - artifact descriptor in JSON format

Returns:

the artifact model matching the provided JSON content.

getMuleArtifactModelJsonSerializer

protected abstract AbstractMuleArtifactModelJsonSerializer<M> getMuleArtifactModelJsonSerializer()

Returns:

the serializer for the artifact model

doDescriptorConfig

protected abstract void doDescriptorConfig(M artifactModel,
                                           T descriptor,
                                           File artifactLocation)

Allows subclasses to customize descriptor based on the provided model

Parameters:

artifactModel - artifact model created from the JSON descriptor

descriptor - descriptor created from the model and configured with common attributes

artifactLocation - folder where the artifact is located, it can be a folder or file depending on the artifact type.

createArtifactDescriptor

protected abstract T createArtifactDescriptor(File artifactLocation,
                                              String name,
                                              Optional<Properties> deploymentProperties)

Parameters:

artifactLocation - folder where the artifact is located, it can be a folder or file depending on the artifact type.

name - name for the created artifact

deploymentProperties - properties provided for the deployment process.

Returns:

a new descriptor of the type required by the factory.

invalidClassLoaderModelIdError

public static String invalidClassLoaderModelIdError(File artifactFolder,
                                                    MuleArtifactLoaderDescriptor classLoaderModelLoaderDescriptor)

invalidBundleDescriptorLoaderIdError

public static String invalidBundleDescriptorLoaderIdError(File artifactFolder,
                                                          MuleArtifactLoaderDescriptor bundleDescriptorLoader)