org.eclipse.m2e.wtp/src/org/eclipse/m2e/wtp/earmodules/EarModuleFactory.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.eclipse.m2e.wtp.earmodules;


import static org.eclipse.m2e.wtp.DomUtils.getBooleanChildValue;
import static org.eclipse.m2e.wtp.DomUtils.getChildValue;

import java.util.Set;

import org.apache.maven.artifact.Artifact;
import org.codehaus.plexus.util.StringUtils;
import org.codehaus.plexus.util.xml.Xpp3Dom;
import org.eclipse.jst.j2ee.project.facet.IJ2EEFacetConstants;
import org.eclipse.m2e.wtp.namemapping.FileNameMapping;
import org.eclipse.m2e.wtp.namemapping.FileNameMappingFactory;
import org.eclipse.wst.common.project.facet.core.IProjectFacetVersion;


/**
 * This class was derived from maven-ear-plugin's org.apache.maven.plugin.ear.EarModuleFactory
 * 
 * Builds an {@link EarModule} based on an <tt>Artifact</tt>.
 * 
 * @author <a href="snicoll@apache.org">Stephane Nicoll</a>
 */
public final class EarModuleFactory {
  
  private ArtifactTypeMappingService artifactTypeMappingService;

  private FileNameMapping fileNameMapping;

  private ArtifactRepository artifactRepository;

  private EarModuleFactory(ArtifactTypeMappingService artifactTypeMappingService, FileNameMapping fileNameMapping,
      ArtifactRepository artifactRepository) {
    this.artifactTypeMappingService = artifactTypeMappingService;
    this.artifactRepository = artifactRepository;
    this.fileNameMapping = fileNameMapping;
  }

  public static EarModuleFactory createEarModuleFactory(ArtifactTypeMappingService artifactTypeMappingService,
      FileNameMapping fileNameMapping, String mainArtifactId, Set<Artifact> artifacts) throws EarPluginException {
    if(artifactTypeMappingService == null) {
      artifactTypeMappingService = new ArtifactTypeMappingService(null);
    }
    if(fileNameMapping == null) {
      fileNameMapping = FileNameMappingFactory.getDefaultFileNameMapping();
    }
    ArtifactRepository artifactRepository = new ArtifactRepository(artifacts, mainArtifactId,
        artifactTypeMappingService);

    return new EarModuleFactory(artifactTypeMappingService, fileNameMapping, artifactRepository);
  }

  /**
   * Creates a new {@link EarModule} based on the specified {@link Artifact} and the specified execution configuration.
   * 
   * @param artifact the artifact
   * @param defaultLibBundleDir the default bundle dir for {@link JarModule}
   * @param javaEEVersion 
   * @return an ear module for this artifact
   */
  public EarModule newEarModule(Artifact artifact, String defaultLibBundleDir, IProjectFacetVersion javaEEVersion, 
      boolean defaultIncludeInApplicationXml) throws UnknownArtifactTypeException {
    // Get the standard artifact type based on default config and user-defined mapping(s)
    final String artifactType = artifactTypeMappingService.getStandardType(artifact.getType());
    AbstractEarModule earModule = null;
    if("jar".equals(artifactType)) { //$NON-NLS-1$
      earModule = new JarModule(artifact);
      ((JarModule)earModule).setIncludeInApplicationXml(defaultIncludeInApplicationXml);
      ((JarModule)earModule).setLibBundleDir(defaultLibBundleDir);
    } else if("ejb".equals(artifactType) || "ejb3".equals(artifactType)) { //$NON-NLS-1$ //$NON-NLS-2$
      earModule  = new EjbModule(artifact);
    } else if("par".equals(artifactType)) { //$NON-NLS-1$
      earModule  = new ParModule(artifact);
    } else if("ejb-client".equals(artifactType)) { //$NON-NLS-1$
      earModule  = new EjbClientModule(artifact);
      if (javaEEVersion.compareTo(IJ2EEFacetConstants.ENTERPRISE_APPLICATION_14) >  0)
      {
        ((EjbClientModule)earModule).setLibBundleDir(defaultLibBundleDir);
      }
    } else if("rar".equals(artifactType)) { //$NON-NLS-1$
      earModule  = new RarModule(artifact);
    } else if("war".equals(artifactType)) { //$NON-NLS-1$
      earModule  = new WebModule(artifact);
    } else if("sar".equals(artifactType)) { //$NON-NLS-1$
      earModule  = new SarModule(artifact);
    } else if("wsr".equals(artifactType)) { //$NON-NLS-1$
      earModule  = new WsrModule(artifact);
    } else if("har".equals(artifactType)) { //$NON-NLS-1$
      earModule  = new HarModule(artifact);
    } else if("app-client".equals(artifactType)) { //$NON-NLS-1$
        earModule  = new AppClientModule(artifact);
    } else {
      throw new IllegalStateException("Could not handle artifact type[" + artifactType + "]"); //$NON-NLS-1$ //$NON-NLS-2$
    }

    earModule.setBundleFileName(fileNameMapping.mapFileName(artifact));
    
    return earModule;

  }

  public EarModule newEarModule(Xpp3Dom domModule, String defaultLibBundleDir, IProjectFacetVersion javaEEVersion, boolean defaultIncludeInApplicationXml) throws EarPluginException {
    String artifactType = domModule.getName();
    String groupId      = getChildValue(domModule, "groupId"); //$NON-NLS-1$
    String artifactId   = getChildValue(domModule, "artifactId"); //$NON-NLS-1$
    String classifier   = getChildValue(domModule, "classifier"); //$NON-NLS-1$
    
    AbstractEarModule earModule = null;
    // Get the standard artifact type based on default config and user-defined mapping(s)
    if ( "jarModule".equals(artifactType) || "javaModule".equals(artifactType)) { //$NON-NLS-1$ //$NON-NLS-2$
      JarModule jarModule = new JarModule();
      jarModule.setBundleDir(defaultLibBundleDir);
      
      if (domModule.getChild("includeInApplicationXml") == null) { //$NON-NLS-1$
        jarModule.setIncludeInApplicationXml(defaultIncludeInApplicationXml);
      } else {
        jarModule.setIncludeInApplicationXml(getBooleanChildValue(domModule, "includeInApplicationXml"));   //$NON-NLS-1$
      }
      earModule = jarModule;
    } 
    else if ( "ejbModule".equals(artifactType) || "ejb3Module".equals(artifactType)) { //$NON-NLS-1$ //$NON-NLS-2$
      earModule  = new EjbModule();
    } 
    else if ( "webModule".equals(artifactType)){ //$NON-NLS-1$
      WebModule webModule  = new WebModule();
      webModule.setContextRoot(getChildValue(domModule, "contextRoot")); //$NON-NLS-1$
      earModule = webModule;
    }
    else if ( "parModule".equals(artifactType)){ //$NON-NLS-1$
      earModule = new ParModule();
    }
    else if ( "ejbClientModule".equals(artifactType)){ //$NON-NLS-1$
      earModule = new EjbClientModule();
      if (javaEEVersion.compareTo(IJ2EEFacetConstants.ENTERPRISE_APPLICATION_14) >  0)
      {
        ((EjbClientModule)earModule).setLibBundleDir(defaultLibBundleDir);
      }
    }
    else if ( "rarModule".equals(artifactType)){ //$NON-NLS-1$
      earModule = new RarModule();
    }
    else if ( "warModule".equals(artifactType)){ //$NON-NLS-1$
      earModule = new WebModule();
    }
    else if ( "sarModule".equals(artifactType)){ //$NON-NLS-1$
      earModule = new SarModule();
    }
    else if ( "wsrModule".equals(artifactType)){ //$NON-NLS-1$
      earModule = new WsrModule();
    }
    else if ( "harModule".equals(artifactType)){ //$NON-NLS-1$
      earModule = new HarModule();
    }
    else if ( "appClientModule".equals(artifactType)){ //$NON-NLS-1$
        earModule = new AppClientModule();
    }
    else {
        throw new IllegalStateException( "Could not handle artifact type[" + artifactType + "]" ); //$NON-NLS-1$ //$NON-NLS-2$
    }
    
    Artifact artifact   = artifactRepository.resolveArtifact(groupId, artifactId, earModule.getType(), classifier);
    earModule.setArtifact(artifact);
    
    String bundleDir = getChildValue(domModule, "bundleDir"); //$NON-NLS-1$
    if (StringUtils.isNotBlank(bundleDir)){
      earModule.setBundleDir(bundleDir);      
    }
    //To this point, we're sure to have a valid earModule ...
    String bundleFileName  = getChildValue(domModule, "bundleFileName"); //$NON-NLS-1$
    if (null==bundleFileName){
      bundleFileName = fileNameMapping.mapFileName(artifact);
    }
    earModule.setBundleFileName(bundleFileName);
    earModule.setUri(getChildValue(domModule, "uri")); //$NON-NLS-1$
    earModule.setExcluded(getBooleanChildValue(domModule, "excluded")); //$NON-NLS-1$

    earModule.setAltDeploymentDescriptor(getChildValue(domModule, "altDeploymentDescriptor")); //$NON-NLS-1$
    
    //The following will be ignored by WTP - so far
    String unpack = getChildValue(domModule, "unpack"); //$NON-NLS-1$
    earModule.setShouldUnpack(unpack==null?null:Boolean.valueOf(unpack));
    
    return earModule;
  }

}