org.mule.runtime.config.spring.internal.LazyMuleArtifactContext Maven / Gradle / Ivy
/*
* Copyright (c) MuleSoft, Inc. All rights reserved. http://www.mulesoft.com
* The software in this package is published under the terms of the CPAL v1.0
* license, a copy of which has been included with this distribution in the
* LICENSE.txt file.
*/
package org.mule.runtime.config.spring.internal;
import static java.lang.String.format;
import static org.mule.runtime.api.connectivity.ConnectivityTestingService.CONNECTIVITY_TESTING_SERVICE_KEY;
import static org.mule.runtime.api.metadata.MetadataService.METADATA_SERVICE_KEY;
import static org.mule.runtime.api.value.ValueProviderService.VALUE_PROVIDER_SERVICE_KEY;
import static org.mule.runtime.config.spring.api.XmlConfigurationDocumentLoader.noValidationDocumentLoader;
import static org.mule.runtime.config.spring.internal.LazyConnectivityTestingService.NON_LAZY_CONNECTIVITY_TESTING_SERVICE;
import static org.mule.runtime.config.spring.internal.LazyMetadataService.NON_LAZY_METADATA_SERVICE;
import static org.mule.runtime.config.spring.internal.LazyValueProviderService.NON_LAZY_VALUE_PROVIDER_SERVICE;
import static org.mule.runtime.core.api.lifecycle.LifecycleUtils.initialiseIfNeeded;
import static org.mule.runtime.core.api.lifecycle.LifecycleUtils.startIfNeeded;
import static org.mule.runtime.core.api.util.ClassUtils.withContextClassLoader;
import org.mule.runtime.api.app.declaration.ArtifactDeclaration;
import org.mule.runtime.api.component.ConfigurationProperties;
import org.mule.runtime.api.component.location.Location;
import org.mule.runtime.api.exception.MuleException;
import org.mule.runtime.api.lifecycle.InitialisationException;
import org.mule.runtime.api.util.Reference;
import org.mule.runtime.config.spring.api.XmlConfigurationDocumentLoader;
import org.mule.runtime.config.spring.api.dsl.model.ApplicationModel;
import org.mule.runtime.config.spring.api.dsl.model.ComponentModel;
import org.mule.runtime.config.spring.internal.dsl.model.ConfigurationDependencyResolver;
import org.mule.runtime.config.spring.internal.dsl.model.MinimalApplicationModelGenerator;
import org.mule.runtime.core.api.MuleContext;
import org.mule.runtime.core.api.config.ConfigResource;
import org.mule.runtime.core.api.config.bootstrap.ArtifactType;
import org.mule.runtime.core.internal.connectivity.DefaultConnectivityTestingService;
import org.mule.runtime.core.internal.metadata.MuleMetadataService;
import org.mule.runtime.core.internal.value.MuleValueProviderService;
import org.springframework.beans.BeansException;
import org.springframework.beans.factory.support.DefaultListableBeanFactory;
import java.util.List;
import java.util.Map;
import java.util.Optional;
/**
* Implementation of {@link MuleArtifactContext} that allows to create configuration components lazily.
*
* Components will be created upon request to use the from the exposed services.
*
* @since 4.0
*/
public class LazyMuleArtifactContext extends MuleArtifactContext implements LazyComponentInitializer {
/**
* Parses configuration files creating a spring ApplicationContext which is used as a parent registry using the SpringRegistry
* registry implementation to wraps the spring ApplicationContext
*
* @param muleContext the {@link MuleContext} that own this context
* @param artifactDeclaration the mule configuration defined programmatically
* @param optionalObjectsController the {@link OptionalObjectsController} to use. Cannot be {@code null} @see
* org.mule.runtime.config.spring.internal.SpringRegistry
* @param parentConfigurationProperties
* @since 4.0
*/
public LazyMuleArtifactContext(MuleContext muleContext, ConfigResource[] artifactConfigResources,
ArtifactDeclaration artifactDeclaration, OptionalObjectsController optionalObjectsController,
Map artifactProperties, ArtifactType artifactType,
List pluginsClassLoaders,
Optional parentConfigurationProperties)
throws BeansException {
super(muleContext, artifactConfigResources, artifactDeclaration, optionalObjectsController, artifactProperties,
artifactType, pluginsClassLoaders, parentConfigurationProperties);
this.applicationModel.executeOnEveryMuleComponentTree(componentModel -> componentModel.setEnabled(false));
muleContext.getCustomizationService().overrideDefaultServiceImpl(CONNECTIVITY_TESTING_SERVICE_KEY,
new LazyConnectivityTestingService(this,
() -> muleContext
.getRegistry()
.get(NON_LAZY_CONNECTIVITY_TESTING_SERVICE)));
muleContext.getCustomizationService().registerCustomServiceClass(NON_LAZY_CONNECTIVITY_TESTING_SERVICE,
DefaultConnectivityTestingService.class);
muleContext.getCustomizationService().overrideDefaultServiceImpl(METADATA_SERVICE_KEY,
new LazyMetadataService(this,
() -> muleContext
.getRegistry()
.get(NON_LAZY_METADATA_SERVICE)));
muleContext.getCustomizationService().registerCustomServiceClass(NON_LAZY_METADATA_SERVICE, MuleMetadataService.class);
muleContext.getCustomizationService().overrideDefaultServiceImpl(VALUE_PROVIDER_SERVICE_KEY,
new LazyValueProviderService(this,
() -> muleContext
.getRegistry()
.get(NON_LAZY_VALUE_PROVIDER_SERVICE),
muleContext::getConfigurationComponentLocator));
muleContext.getCustomizationService().registerCustomServiceClass(NON_LAZY_VALUE_PROVIDER_SERVICE,
MuleValueProviderService.class);
}
@Override
protected XmlConfigurationDocumentLoader newXmlConfigurationDocumentLoader() {
return noValidationDocumentLoader();
}
private void createComponents(DefaultListableBeanFactory beanFactory, ApplicationModel applicationModel, boolean mustBeRoot) {
applyLifecycle(super.createApplicationComponents(beanFactory, applicationModel, mustBeRoot));
}
private void applyLifecycle(List createdComponentModels) {
muleContext.withLifecycleLock(() -> {
if (muleContext.isInitialised()) {
for (String createdComponentModelName : createdComponentModels) {
Object object = muleContext.getRegistry().get(createdComponentModelName);
try {
initialiseIfNeeded(object, true, muleContext);
} catch (InitialisationException e) {
throw new RuntimeException(e);
}
}
}
if (muleContext.isStarted()) {
for (String createdComponentModelName : createdComponentModels) {
Object object = muleContext.getRegistry().get(createdComponentModelName);
try {
startIfNeeded(object);
} catch (MuleException e) {
throw new RuntimeException(e);
}
}
}
});
}
/**
* {@inheritDoc}
*/
@Override
public void initializeComponent(Location location) {
applyLifecycle(createComponents(location));
}
/**
* {@inheritDoc}
*/
@Override
public void createComponent(Location location) {
createComponents(location);
}
private List createComponents(Location location) {
Reference> createdComponents = new Reference<>();
withContextClassLoader(muleContext.getExecutionClassLoader(), () -> {
ConfigurationDependencyResolver dependencyResolver = new ConfigurationDependencyResolver(this.applicationModel,
componentBuildingDefinitionRegistry);
MinimalApplicationModelGenerator minimalApplicationModelGenerator =
new MinimalApplicationModelGenerator(dependencyResolver);
// First unregister any already initialized/started component
unregisterComponents(dependencyResolver.resolveComponentModelDependencies());
ApplicationModel minimalApplicationModel = minimalApplicationModelGenerator.getMinimalModel(location);
List applicationComponents =
super.createApplicationComponents((DefaultListableBeanFactory) this.getBeanFactory(), minimalApplicationModel, false);
createdComponents.set(applicationComponents);
// This is required to force the execution of postProcessAfterInitialization() for each created component
applicationComponents.forEach(component -> muleContext.getRegistry().get(component));
});
return createdComponents.get();
}
private void unregisterComponents(List componentModels) {
if (muleContext.isStarted()) {
componentModels.forEach(componentModel -> {
final String nameAttribute = componentModel.getNameAttribute();
if (nameAttribute != null) {
try {
muleContext.getRegistry().unregisterObject(nameAttribute);
} catch (Exception e) {
logger
.warn(format("Exception unregistering an object during lazy initialization of component %s, exception message is %s",
nameAttribute, e.getMessage()));
if (logger.isDebugEnabled()) {
logger.debug(e.getMessage(), e);
}
}
}
});
}
applicationModel.executeOnEveryMuleComponentTree(componentModel -> componentModel.setEnabled(false));
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy