io.openliberty.tools.maven.PrepareFeatureSupport Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of liberty-maven-plugin Show documentation
Liberty Maven Plugin : Install, Start/Stop, Package, Create Server, Deploy/Undeploy applications
There is a newer version: 3.11.1
/**
 * (C) Copyright IBM Corporation 2021, 2023.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package io.openliberty.tools.maven;

import java.io.File;
import java.util.ArrayList;
import java.util.List;
import org.apache.maven.plugin.MojoExecutionException;

import io.openliberty.tools.common.plugins.util.PluginExecutionException;
import io.openliberty.tools.common.plugins.util.PluginScenarioException;
import io.openliberty.tools.common.plugins.util.PrepareFeatureUtil;

public abstract class PrepareFeatureSupport extends BasicSupport {
	
	
	private PrepareFeatureUtil util;

    protected class PrepareFeatureMojoUtil extends PrepareFeatureUtil {
        public PrepareFeatureMojoUtil(String openLibertyVersion)
                throws PluginScenarioException, PluginExecutionException {
            super(installDirectory, openLibertyVersion);
        }

        @Override
        public void debug(String msg) {
            getLog().debug(msg);
        }
        
        @Override
        public void debug(String msg, Throwable e) {
            getLog().debug(msg, e);
        }
        
        @Override
        public void debug(Throwable e) {
            getLog().debug(e);
        }
        
        @Override
        public void warn(String msg) {
            getLog().warn(msg);
        }

        @Override
        public void info(String msg) {
            getLog().info(msg);
        }
        
        @Override
        public boolean isDebugEnabled() {
            return getLog().isDebugEnabled();
        }

        @Override
        public void error(String msg) {
            getLog().error(msg);
        }

        @Override
        public void error(String msg, Throwable e) {
            getLog().error(msg, e);
        }
        
        @Override
        public File downloadArtifact(String groupId, String artifactId, String type, String version) throws PluginExecutionException {
            try {
                // Look for and replace maven props in the coordinates. This is necessary when called from 
                // PrepareFeatureUtil.downloadArtifactsFromBOM(File) because that bom file will not have been processed by maven.
                return getArtifact(resolvePropertyReferences(groupId), 
                                    resolvePropertyReferences(artifactId), 
                                    type, 
                                    resolvePropertyReferences(version)).getFile();
            } catch (MojoExecutionException e) {
                throw new PluginExecutionException(e);
            }
        }
    }
    
    private void createNewPrepareFeatureUtil(String openLibertyVersion) 
            throws PluginExecutionException {
        try {
            util = new PrepareFeatureMojoUtil(openLibertyVersion);
        } catch (PluginScenarioException e) {
        	throw new PluginExecutionException(e);
        }
    }
    
    /**
     * Retrieves list of DependencyManagement listed BOM artifacts
     * 
     * @return the list of DependencyManagement listed BOMs
     */
    protected List getDependencyBOMs() {
        List result = new ArrayList();
        org.apache.maven.model.DependencyManagement dependencyManagement = project.getDependencyManagement();
        if (dependencyManagement != null) {
        	List dependencyManagementArtifacts = dependencyManagement.getDependencies();
            for (org.apache.maven.model.Dependency dependencyArtifact: dependencyManagementArtifacts){
                if (("pom").equals(dependencyArtifact.getType()) && ("features-bom").equals(dependencyArtifact.getArtifactId()) ) {
                	String coordinate = String.format("%s:%s:%s",
                    		dependencyArtifact.getGroupId(), dependencyArtifact.getArtifactId(), dependencyArtifact.getVersion());
                    result.add(coordinate);
                    getLog().debug("Dependency BOM: " + coordinate);
                }
            }
        }
        return result;
    }

    /**
     * Get a new instance of PrepareFeatureUtil
     * 
     * @param openLibertyVersion The version of the Open Liberty runtime
     * @return instance of PrepareFeatureUtil
     */
    protected PrepareFeatureUtil getPrepareFeatureUtil(String openLibertyVersion)
            throws PluginExecutionException {
    	createNewPrepareFeatureUtil(openLibertyVersion);
        return util;
    }

}