/*
* 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.module.deployment.impl.internal.plugin;
import static com.google.common.collect.Maps.newHashMap;
import static java.lang.String.format;
import static java.lang.System.lineSeparator;
import static java.util.Optional.empty;
import static java.util.Optional.of;
import static java.util.stream.Collectors.groupingBy;
import static java.util.stream.Collectors.joining;
import static org.apache.commons.lang3.StringUtils.isNotBlank;
import static org.mule.runtime.api.i18n.I18nMessageFactory.createStaticMessage;
import static org.mule.runtime.api.util.Preconditions.checkNotNull;
import org.mule.runtime.api.exception.MuleException;
import org.mule.runtime.api.exception.MuleRuntimeException;
import org.mule.runtime.core.registry.SpiServiceRegistry;
import org.mule.runtime.deployment.model.api.plugin.LoaderDescriber;
import org.mule.runtime.extension.api.loader.ExtensionModelLoader;
import org.mule.runtime.module.artifact.classloader.ArtifactClassLoader;
import org.mule.runtime.module.extension.internal.loader.ExtensionModelLoaderManager;
import java.util.Collection;
import java.util.Map;
import java.util.Optional;
import java.util.stream.Collectors;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
* Implementation of {@link MuleExtensionModelLoaderManager} that uses SPI to look for the {@link ExtensionModelLoader} available
* from the container.
*
* @since 4.0
*/
public class MuleExtensionModelLoaderManager implements ExtensionModelLoaderManager {
protected final Logger logger = LoggerFactory.getLogger(this.getClass());
private final ArtifactClassLoader containerClassLoader;
private final Map<String, ExtensionModelLoader> extensionModelLoaders = newHashMap();
/**
* Creates an instance of the manager.
*
* @param containerClassLoader {@link ClassLoader} from the container.
*/
public MuleExtensionModelLoaderManager(ArtifactClassLoader containerClassLoader) {
checkNotNull(containerClassLoader, "containerClassLoader cannot be null");
this.containerClassLoader = containerClassLoader;
}
/**
* Will look through SPI every class that implements the {@code providerClass} and if there are repeated IDs, it will
* collect them all to throw an exception with the detailed message.
* <p/>
* The exception, if thrown, will have the following message:
* <pre>
* There are several loaders that return the same ID when looking up providers for 'org.mule.runtime.module.artifact.ExtensionModelLoader'. Full error list:
* ID [some-id] is being returned by the following classes [org.foo.FooLoader, org.bar.BarLoader]
* ID [another-id] is being returned by the following classes [org.foo2.FooLoader2, org.bar2.BarLoader2]
* </pre>
*
* @throws IllegalStateException if there are loaders with repeated IDs.
*/
@Override
public void start() throws MuleException {
final Class<ExtensionModelLoader> providerClass = ExtensionModelLoader.class;
final SpiServiceRegistry spiServiceRegistry = new SpiServiceRegistry();
final ClassLoader classLoader = containerClassLoader.getClassLoader();
final Collection<ExtensionModelLoader> extensionModelLoaders =
spiServiceRegistry.lookupProviders(providerClass, classLoader);
final StringBuilder sb = new StringBuilder();
extensionModelLoaders.stream().collect(groupingBy(ExtensionModelLoader::getId))
.entrySet().stream().filter(entry -> entry.getValue().size() > 1)
.forEach(
entry -> {
// At this point we are sure there are at least 2 classes that return the same ID, we will append it to the builder
final String classes = entry.getValue().stream()
.map(extensionModelLoader -> extensionModelLoader.getClass().getName()).collect(Collectors.joining(", "));
sb.append(lineSeparator()).append("ID [").append(entry.getKey())
.append("] is being returned by the following classes [").append(classes).append("]");
});
if (isNotBlank(sb.toString())) {
throw new MuleRuntimeException(createStaticMessage(format(
"There are several loaders that return the same identifier when looking up providers for '%s'. Full error list: %s",
providerClass.getName(), sb.toString())));
}
extensionModelLoaders.stream()
.forEach(extensionModelLoader -> this.extensionModelLoaders.put(extensionModelLoader.getId(), extensionModelLoader));
if (logger.isDebugEnabled()) {
logger.debug("ExtensionModelLoader registered identifiers: {}", printExtensionModelLoaderIDs());
}
}
@Override
public void stop() throws MuleException {
extensionModelLoaders.clear();
}
@Override
public Optional<ExtensionModelLoader> getExtensionModelLoader(LoaderDescriber loaderDescriber) {
return extensionModelLoaders.containsKey(loaderDescriber.getId()) ? of(extensionModelLoaders.get(loaderDescriber.getId()))
: empty();
}
private String printExtensionModelLoaderIDs() {
return extensionModelLoaders.keySet().stream().collect(joining(", "));
}
@Override
public String toString() {
return format("%s[extensionModelLoaders=%s]", getClass().getName(), printExtensionModelLoaderIDs());
}
}