enterprise/maven.j2ee/src/org/netbeans/modules/maven/j2ee/ContainerCPModifierImpl.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you 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 org.netbeans.modules.maven.j2ee;

import java.util.Collections;
import java.util.HashMap;
import java.util.Map;
import java.util.logging.Level;
import java.util.logging.Logger;
import javax.swing.SwingUtilities;
import org.apache.maven.artifact.Artifact;
import org.netbeans.api.j2ee.core.Profile;
import org.netbeans.api.java.classpath.ClassPath;
import org.netbeans.api.project.Project;
import org.netbeans.modules.j2ee.api.ejbjar.EjbJar;
import org.netbeans.modules.j2ee.core.api.support.classpath.ContainerClassPathModifier;
import org.netbeans.modules.maven.api.ModelUtils;
import org.netbeans.modules.maven.api.NbMavenProject;
import org.netbeans.modules.maven.api.classpath.ProjectSourcesClassPathProvider;
import org.netbeans.modules.maven.model.ModelOperation;
import org.netbeans.modules.maven.model.Utilities;
import org.netbeans.modules.maven.model.pom.Dependency;
import org.netbeans.modules.maven.model.pom.POMModel;
import org.netbeans.modules.web.api.webmodule.WebModule;
import org.netbeans.spi.java.classpath.support.ClassPathSupport;
import org.netbeans.spi.project.ProjectServiceProvider;
import org.openide.filesystems.FileObject;


@ProjectServiceProvider(service = ContainerClassPathModifier.class, projectType={
    "org-netbeans-modules-maven/" + NbMavenProject.TYPE_WAR,
    "org-netbeans-modules-maven/" + NbMavenProject.TYPE_EJB,
    "org-netbeans-modules-maven/" + NbMavenProject.TYPE_EAR,
    "org-netbeans-modules-maven/" + NbMavenProject.TYPE_APPCLIENT,
    "org-netbeans-modules-maven/" + NbMavenProject.TYPE_OSGI
})
public class ContainerCPModifierImpl implements ContainerClassPathModifier {

    private static final Logger LOGGER = Logger.getLogger(ContainerCPModifierImpl.class.getName());
    private final Project project;


    public ContainerCPModifierImpl(Project prj) {
        project = prj;
    }

    @Override
    public void extendClasspath(final FileObject file, final String[] symbolicNames) {
        if (symbolicNames == null) {
            return;
        }
        final Boolean[] added = new Boolean[1];
        added[0] = Boolean.FALSE;
        ModelOperation<POMModel> operation = new ModelOperation<POMModel>() {

            @Override
            public void performOperation(POMModel model) {
                Map<String, Item> items = createItemList();
                ProjectSourcesClassPathProvider prv = project.getLookup().lookup(ProjectSourcesClassPathProvider.class);
                ClassPath[] cps = prv.getProjectClassPaths(ClassPath.COMPILE);
                ClassPath cp = ClassPathSupport.createProxyClassPath(cps);
                Profile version = Profile.JAVA_EE_5; //sort of fallback
                WebModule wm = WebModule.getWebModule(file);
                if (wm != null) {
                    version = wm.getJ2eeProfile();
                } else {
                    EjbJar ejb = EjbJar.getEjbJar(file);
                    if (ejb != null) {
                        version = ejb.getJ2eeProfile();
                    }
                }

                for (String name : symbolicNames) {
                    Item item = items.get(name + ":" + version.toPropertiesString()); //NOI18N
                    if (item != null) {
                        if (item.classToCheck != null) {
                            FileObject fo = cp.findResource(item.classToCheck);
                            if (fo != null) {
                                //skip, already on CP somehow..
                                continue;
                            }
                        }
                        Dependency dep = ModelUtils.checkModelDependency(model, item.groupId, item.artifactId, true);
                        dep.setVersion(item.version);
                        dep.setScope(Artifact.SCOPE_PROVIDED);
                        added[0] = Boolean.TRUE;
                    } else {
                        LOGGER.log(Level.WARNING, "Cannot process api with symbolic name: {0}. Nothing will be added to project''s classpath.", name);
                    }
                }
            }
        };
        FileObject pom = project.getProjectDirectory().getFileObject("pom.xml"); //NOI18N
        Utilities.performPOMModelOperations(pom, Collections.singletonList(operation));
        if (added[0]) {
            if (!SwingUtilities.isEventDispatchThread()) {
                project.getLookup().lookup(NbMavenProject.class).downloadDependencyAndJavadocSource(true);
            }
        }
    }

    // String is conbination of symbolic name + ":" + j2ee level
    private Map<String, Item> createItemList() {
        HashMap<String, Item> toRet = new HashMap<String, Item>();
        String key = ContainerClassPathModifier.API_SERVLET + ":" + Profile.J2EE_14.toPropertiesString(); //NOI18N
        Item item = new Item();
        item.groupId = "javax.servlet"; //NOI18N
        item.artifactId = "servlet-api"; //NOI18N
        item.version = "2.4"; //NOI18N
        item.classToCheck = "javax/servlet/http/HttpServlet.class"; //NOI18N
        toRet.put(key, item);
        key = ContainerClassPathModifier.API_SERVLET + ":" + Profile.JAVA_EE_5.toPropertiesString(); //NOI18N
        item = new Item();
        item.groupId = "javax.servlet"; //NOI18N
        item.artifactId = "servlet-api"; //NOI18N
        item.version = "2.5"; //NOI18N
        item.classToCheck = "javax/servlet/http/HttpServlet.class"; //NOI18N
        toRet.put(key, item);

        key = ContainerClassPathModifier.API_JSP + ":" + Profile.J2EE_14.toPropertiesString();
        item = new Item();
        item.groupId = "javax.servlet.jsp"; //NOI18N
        item.artifactId = "jsp-api"; //NOI18N
        item.version = "2.1"; //NOI18N
        item.classToCheck = "javax/servlet/jsp/tagext/BodyContent.class"; //NOI18N
        toRet.put(key, item);
        key = ContainerClassPathModifier.API_JSP + ":" + Profile.JAVA_EE_5.toPropertiesString(); //NOI18N
        item = new Item();
        item.groupId = "javax.servlet.jsp"; //NOI18N
        item.artifactId = "jsp-api"; //NOI18N
        item.version = "2.1"; //NOI18N
        item.classToCheck = "javax/servlet/jsp/tagext/BodyContent.class"; //NOI18N
        toRet.put(key, item);

        key = ContainerClassPathModifier.API_JSF + ":" + Profile.J2EE_14.toPropertiesString();
        item = new Item();
        item.groupId = "javax.faces"; //NOI18N
        item.artifactId = "jsf-api"; //NOI18N
        item.version = "1.2"; //NOI18N
        item.classToCheck = "javax.faces.application.StateManagerWrapper"; //NOI18N
        toRet.put(key, item);
        key = ContainerClassPathModifier.API_JSF + ":" + Profile.JAVA_EE_5.toPropertiesString(); //NOI18N
        item = new Item();
        item.groupId = "javax.faces"; //NOI18N
        item.artifactId = "jsf-api"; //NOI18N
        item.version = "2.0"; //NOI18N
        item.classToCheck = "javax.faces.application.ProjectStage"; //NOI18N
        toRet.put(key, item);

        key = ContainerClassPathModifier.API_J2EE + ":" + Profile.J2EE_14.toPropertiesString();
        item = new Item();
        item.groupId = "org.apache.geronimo.specs"; //NOI18N
        item.artifactId = "geronimo-j2ee_1.4_spec"; //NOI18N
        item.version = "1.0"; //NOI18N
        toRet.put(key, item);
        key = ContainerClassPathModifier.API_J2EE + ":" + Profile.JAVA_EE_5.toPropertiesString(); //NOI18N
        item = new Item();
        item.groupId = "javaee"; //NOI18N
        item.artifactId = "javaee-api"; //NOI18N
        item.version = "5"; //NOI18N
        toRet.put(key, item);

        key = ContainerClassPathModifier.API_TRANSACTION + ":" + Profile.J2EE_14.toPropertiesString(); //NOI18N
        item = new Item();
        item.groupId = "javax.transaction"; //NOI18N
        item.artifactId = "jta"; //NOI18N
        item.version = "1.0.1B"; //NOI18N
        item.classToCheck = "javax/transaction/UserTransaction.class"; //NOI18N
        toRet.put(key, item);
        key = ContainerClassPathModifier.API_TRANSACTION + ":" + Profile.JAVA_EE_5.toPropertiesString(); //NOI18N
        item = new Item();
        item.groupId = "javax.transaction"; //NOI18N
        item.artifactId = "jta"; //NOI18N
        item.version = "1.1"; //NOI18N
        item.classToCheck = "javax/transaction/UserTransaction.class"; //NOI18N
        toRet.put(key, item);

        key = ContainerClassPathModifier.API_PERSISTENCE + ":" + Profile.J2EE_14.toPropertiesString(); //NOI18N
        item = new Item();
        item.groupId = "javax.persistence"; //NOI18N
        item.artifactId = "persistence-api"; //NOI18N
        item.version = "1.0"; //NOI18N
        item.classToCheck = "javax/persistence/PersistenceContext.class"; //NOI18N
        toRet.put(key, item);
        key = ContainerClassPathModifier.API_PERSISTENCE + ":" + Profile.JAVA_EE_5.toPropertiesString(); //NOI18N
        item = new Item();
        item.groupId = "javax.persistence"; //NOI18N
        item.artifactId = "persistence-api"; //NOI18N
        item.version = "1.0"; //NOI18N
        item.classToCheck = "javax/persistence/PersistenceContext.class"; //NOI18N
        toRet.put(key, item);

        key = ContainerClassPathModifier.API_ANNOTATION + ":" + Profile.J2EE_14.toPropertiesString(); //NOI18N
        item = new Item();
        item.groupId = "javax.annotation"; //NOI18N
        item.artifactId = "jsr250-api"; //NOI18N
        item.version = "1.0"; //NOI18N
        item.classToCheck = "javax/annotation/Resource.class"; //NOI18N
        toRet.put(key, item);
        key = ContainerClassPathModifier.API_ANNOTATION + ":" + Profile.JAVA_EE_5.toPropertiesString(); //NOI18N
        item = new Item();
        item.groupId = "javax.annotation"; //NOI18N
        item.artifactId = "jsr250-api"; //NOI18N
        item.version = "1.0"; //NOI18N
        item.classToCheck = "javax/annotation/Resource.class"; //NOI18N
        toRet.put(key, item);

        key = ContainerClassPathModifier.API_EJB + ":" + Profile.J2EE_14.toPropertiesString(); //NOI18N
        item = new Item();
        item.groupId = "org.apache.geronimo.specs"; //NOI18N
        item.artifactId = "geronimo-ejb_2.1_spec"; //NOI18N
        item.version = "1.1"; //NOI18N
        item.classToCheck = "javax/ejb/EJB.class"; //NOI18N
        toRet.put(key, item);
        key = ContainerClassPathModifier.API_EJB + ":" + Profile.JAVA_EE_5.toPropertiesString(); //NOI18N
        item = new Item();
        item.groupId = "org.apache.geronimo.specs"; //NOI18N
        item.artifactId = "geronimo-ejb_3.0_spec"; //NOI18N
        item.version = "1.0.1"; //NOI18N
        item.classToCheck = "javax/ejb/EJB.class"; //NOI18N
        toRet.put(key, item);
        return toRet;
    }


    private static class Item {
        String classToCheck;
        String groupId;
        String artifactId;
        String version;
//        String repositoryurl;
    }

}