Coverage Report - org.apache.maven.plugin.eclipse.writers.wtp.AbstractWtpResourceWriter
 
Classes in this File Line Coverage Branch Coverage Complexity
AbstractWtpResourceWriter
32%
31/94
35%
19/54
10.333
 
 1   
 /*
 2   
  * Licensed to the Apache Software Foundation (ASF) under one
 3   
  * or more contributor license agreements.  See the NOTICE file
 4   
  * distributed with this work for additional information
 5   
  * regarding copyright ownership.  The ASF licenses this file
 6   
  * to you under the Apache License, Version 2.0 (the
 7   
  * "License"); you may not use this file except in compliance
 8   
  * with the License.  You may obtain a copy of the License at
 9   
  *
 10   
  *   http://www.apache.org/licenses/LICENSE-2.0
 11   
  *
 12   
  * Unless required by applicable law or agreed to in writing,
 13   
  * software distributed under the License is distributed on an
 14   
  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 15   
  * KIND, either express or implied.  See the License for the
 16   
  * specific language governing permissions and limitations
 17   
  * under the License.
 18   
  */
 19   
 package org.apache.maven.plugin.eclipse.writers.wtp;
 20   
 
 21   
 import java.io.File;
 22   
 
 23   
 import org.apache.maven.artifact.repository.ArtifactRepository;
 24   
 import org.apache.maven.plugin.MojoExecutionException;
 25   
 import org.apache.maven.plugin.eclipse.Constants;
 26   
 import org.apache.maven.plugin.eclipse.Messages;
 27   
 import org.apache.maven.plugin.eclipse.writers.AbstractEclipseWriter;
 28   
 import org.apache.maven.plugin.ide.IdeDependency;
 29   
 import org.apache.maven.plugin.ide.IdeUtils;
 30   
 import org.apache.maven.plugin.ide.JeeUtils;
 31   
 import org.apache.maven.project.MavenProject;
 32   
 import org.codehaus.plexus.util.xml.XMLWriter;
 33   
 
 34   
 /**
 35   
  * Base class to hold common constants used by extending classes.
 36   
  *
 37   
  * @author <a href="mailto:rahul.thakur.xdev@gmail.com">Rahul Thakur</a>
 38   
  * @author <a href="mailto:fgiust@users.sourceforge.net">Fabrizio Giustina</a>
 39   
  */
 40  1 
 public abstract class AbstractWtpResourceWriter
 41   
     extends AbstractEclipseWriter
 42   
 {
 43   
 
 44   
     private static final String ELT_DEPENDENCY_OBJECT = "dependent-object"; //$NON-NLS-1$
 45   
 
 46   
     private static final String ELT_DEPENDENCY_TYPE = "dependency-type"; //$NON-NLS-1$
 47   
 
 48   
     private static final String ATTR_HANDLE = "handle"; //$NON-NLS-1$
 49   
 
 50   
     private static final String ELT_DEPENDENT_MODULE = "dependent-module"; //$NON-NLS-1$
 51   
 
 52   
     protected static final String ATTR_VALUE = "value"; //$NON-NLS-1$
 53   
 
 54   
     protected static final String ATTR_NAME = "name"; //$NON-NLS-1$
 55   
 
 56   
     protected static final String ELT_PROPERTY = "property"; //$NON-NLS-1$
 57   
 
 58   
     protected static final String ELT_VERSION = "version"; //$NON-NLS-1$
 59   
 
 60   
     protected static final String ATTR_MODULE_TYPE_ID = "module-type-id"; //$NON-NLS-1$
 61   
 
 62   
     protected static final String ATTR_SOURCE_PATH = "source-path"; //$NON-NLS-1$
 63   
 
 64   
     protected static final String ATTR_DEPLOY_PATH = "deploy-path"; //$NON-NLS-1$
 65   
 
 66   
     protected static final String ELT_WB_RESOURCE = "wb-resource"; //$NON-NLS-1$
 67   
 
 68   
     protected static final String ELT_MODULE_TYPE = "module-type"; //$NON-NLS-1$
 69   
 
 70   
     protected static final String ATTR_DEPLOY_NAME = "deploy-name"; //$NON-NLS-1$
 71   
 
 72   
     protected static final String ELT_WB_MODULE = "wb-module"; //$NON-NLS-1$
 73   
 
 74   
     protected static final String ATTR_MODULE_ID = "id"; //$NON-NLS-1$
 75   
 
 76   
     protected static final String ATTR_PROJECT_VERSION = "project-version"; //$NON-NLS-1$
 77   
 
 78   
     protected static final String ELT_PROJECT_MODULES = "project-modules"; //$NON-NLS-1$
 79   
 
 80   
     /**
 81   
      * @param project
 82   
      * @param writer
 83   
      * @throws MojoExecutionException
 84   
      */
 85   
     protected void writeModuleTypeAccordingToPackaging( MavenProject project, XMLWriter writer,
 86   
                                                         File buildOutputDirectory )
 87   
         throws MojoExecutionException
 88   
     {
 89  0 
         if ( Constants.PROJECT_PACKAGING_WAR.equals( config.getPackaging() ) ) //$NON-NLS-1$
 90   
         {
 91  0 
             writer.addAttribute( ATTR_MODULE_TYPE_ID, "jst.web" ); //$NON-NLS-1$
 92   
 
 93  0 
             writer.startElement( ELT_VERSION );
 94   
             String servletVersion;
 95  0 
             if ( config.getJeeVersion() != null )
 96   
             {
 97  0 
                 servletVersion = JeeUtils.getJeeDescriptorFromJeeVersion( config.getJeeVersion() ).getServletVersion();
 98   
             }
 99   
             else
 100   
             {
 101  0 
                 servletVersion = JeeUtils.resolveServletVersion( config.getProject() );
 102   
             }
 103  0 
             writer.writeText( servletVersion );
 104  0 
             writer.endElement();
 105   
 
 106  0 
             String contextRoot = config.getContextName();
 107   
 
 108  0 
             writer.startElement( ELT_PROPERTY );
 109  0 
             writer.addAttribute( ATTR_NAME, "context-root" ); //$NON-NLS-1$
 110  0 
             writer.addAttribute( ATTR_VALUE, contextRoot );
 111  0 
             writer.endElement();
 112  0 
         }
 113  0 
         else if ( Constants.PROJECT_PACKAGING_EJB.equals( config.getPackaging() ) ) //$NON-NLS-1$
 114   
         {
 115  0 
             writer.addAttribute( ATTR_MODULE_TYPE_ID, "jst.ejb" ); //$NON-NLS-1$
 116   
 
 117  0 
             writer.startElement( ELT_VERSION );
 118   
 
 119   
             String ejbVersion;
 120  0 
             if ( config.getJeeVersion() != null )
 121   
             {
 122  0 
                 ejbVersion = JeeUtils.getJeeDescriptorFromJeeVersion( config.getJeeVersion() ).getEjbVersion();
 123   
             }
 124   
             else
 125   
             {
 126  0 
                 ejbVersion = JeeUtils.resolveEjbVersion( config.getProject() );
 127   
             }
 128  0 
             writer.writeText( ejbVersion );
 129   
 
 130  0 
             writer.endElement();
 131   
 
 132  0 
             writer.startElement( ELT_PROPERTY );
 133  0 
             writer.addAttribute( ATTR_NAME, "java-output-path" ); //$NON-NLS-1$
 134  0 
             writer.addAttribute( ATTR_VALUE, "/" + //$NON-NLS-1$
 135   
                 IdeUtils.toRelativeAndFixSeparator( config.getProject().getBasedir(), buildOutputDirectory, false ) );
 136  0 
             writer.endElement();
 137   
 
 138  0 
         }
 139  0 
         else if ( Constants.PROJECT_PACKAGING_EAR.equals( config.getPackaging() ) ) //$NON-NLS-1$
 140   
         {
 141  0 
             writer.addAttribute( ATTR_MODULE_TYPE_ID, "jst.ear" ); //$NON-NLS-1$
 142   
 
 143  0 
             writer.startElement( ELT_VERSION );
 144   
             String jeeVersion;
 145  0 
             if ( config.getJeeVersion() != null )
 146   
             {
 147  0 
                 jeeVersion = JeeUtils.getJeeDescriptorFromJeeVersion( config.getJeeVersion() ).getJeeVersion();
 148   
             }
 149   
             else
 150   
             {
 151  0 
                 jeeVersion = JeeUtils.resolveJeeVersion( config.getProject() );
 152   
             }
 153  0 
             writer.writeText( jeeVersion );
 154  0 
             writer.endElement();
 155  0 
         }
 156   
         else
 157   
         {
 158   
             // jar
 159  0 
             writer.addAttribute( ATTR_MODULE_TYPE_ID, "jst.utility" ); //$NON-NLS-1$
 160   
 
 161  0 
             writer.startElement( ELT_PROPERTY );
 162  0 
             writer.addAttribute( ATTR_NAME, "java-output-path" ); //$NON-NLS-1$
 163  0 
             writer.addAttribute( ATTR_VALUE, "/" + //$NON-NLS-1$
 164   
                 IdeUtils.toRelativeAndFixSeparator( config.getProject().getBasedir(), buildOutputDirectory, false ) );
 165  0 
             writer.endElement();
 166   
         }
 167  0 
     }
 168   
 
 169   
     /**
 170   
      * Adds dependency for Eclipse WTP project.
 171   
      *
 172   
      * @param writer
 173   
      * @param artifact
 174   
      * @param localRepository
 175   
      * @param basedir
 176   
      * @throws MojoExecutionException
 177   
      */
 178   
     protected void addDependency( XMLWriter writer, IdeDependency dep, ArtifactRepository localRepository,
 179   
                                   File basedir, String deployPath )
 180   
         throws MojoExecutionException
 181   
     {
 182   
         String handle;
 183  2 
         String dependentObject = null;
 184   
         String archiveName;
 185   
 
 186   
         // ejb's and wars must always be toplevel
 187  2 
         if ( Constants.PROJECT_PACKAGING_WAR.equals( dep.getType() )
 188   
             || Constants.PROJECT_PACKAGING_EJB.equals( dep.getType() ) )
 189   
         {
 190  1 
             deployPath = "/";
 191   
         }
 192   
 
 193  2 
         if ( dep.isReferencedProject() )
 194   
         {
 195   
             // <dependent-module deploy-path="/WEB-INF/lib"
 196   
             // handle="module:/resource/artifactid/artifactid">
 197   
             // <dependency-type>uses</dependency-type>
 198   
             // </dependent-module>
 199   
 
 200  2 
             handle = "module:/resource/" + dep.getEclipseProjectName() + "/" + dep.getEclipseProjectName(); //$NON-NLS-1$ //$NON-NLS-2$
 201   
 
 202  2 
             String archiveExtension = dep.getType();
 203  2 
             if ( Constants.PROJECT_PACKAGING_EJB.equals( dep.getType() ) )
 204   
             {
 205  1 
                 dependentObject = "EjbModule_";
 206   
                 // an EJB module is packed as a .jar file
 207  1 
                 archiveExtension = Constants.PROJECT_PACKAGING_JAR;
 208   
             }
 209  1 
             else if ( Constants.PROJECT_PACKAGING_WAR.equals( dep.getType() ) )
 210   
             {
 211  0 
                 dependentObject = "WebModule_";
 212   
             }
 213  2 
             archiveName = dep.getEclipseProjectName() + "." + archiveExtension;
 214  2 
         }
 215   
         else
 216   
         {
 217   
             // <dependent-module deploy-path="/WEB-INF/lib"
 218   
             // handle="module:/classpath/var/M2_REPO/cl/cl/2.1/cl-2.1.jar">
 219   
             // <dependency-type>uses</dependency-type>
 220   
             // </dependent-module>
 221   
 
 222  0 
             File artifactPath = dep.getFile();
 223   
 
 224  0 
             if ( artifactPath == null )
 225   
             {
 226  0 
                 log.error( Messages.getString( "EclipsePlugin.artifactpathisnull", dep.getId() ) ); //$NON-NLS-1$
 227  0 
                 return;
 228   
             }
 229   
 
 230  0 
             String fullPath = artifactPath.getPath();
 231  0 
             File repoFile = new File( fullPath );
 232   
 
 233  0 
             if ( dep.isSystemScoped() )
 234   
             {
 235  0 
                 handle = "module:/classpath/lib/" //$NON-NLS-1$
 236   
                     + IdeUtils.toRelativeAndFixSeparator( config.getEclipseProjectDirectory(), repoFile, false );
 237   
             }
 238   
             else
 239   
             {
 240  0 
                 File localRepositoryFile = new File( localRepository.getBasedir() );
 241  0 
                 String relativePath = IdeUtils.toRelativeAndFixSeparator( localRepositoryFile, repoFile, false );
 242   
 
 243  0 
                 if ( !new File( relativePath ).isAbsolute() )
 244   
                 {
 245  0 
                     handle = "module:/classpath/var/M2_REPO/" //$NON-NLS-1$
 246   
                         + relativePath;
 247   
                 }
 248   
                 else
 249   
                 {
 250  0 
                     handle = "module:/classpath/lib/" //$NON-NLS-1$
 251   
                         + IdeUtils.toRelativeAndFixSeparator( config.getEclipseProjectDirectory(), repoFile, false );
 252   
                 }
 253   
             }
 254  0 
             if ( Constants.PROJECT_PACKAGING_EAR.equals( this.config.getPackaging() ) && !"/".equals( deployPath ) )
 255   
             {
 256   
                 // This is a very ugly hack around a WTP bug! a delpoydir in the configuration file is duplicated.
 257   
                 // a deploy dir like "lib" will be used as "lib/lib" the only workig workaround is to include a ..
 258   
                 // in the archive name.
 259  0 
                 archiveName = "../" + artifactPath.getName();
 260   
             }
 261   
             else
 262   
             {
 263  0 
                 archiveName = artifactPath.getName();
 264   
             }
 265   
         }
 266   
 
 267  2 
         writer.startElement( ELT_DEPENDENT_MODULE );
 268   
 
 269  2 
         writer.addAttribute( "archiveName", archiveName );
 270   
 
 271  2 
         writer.addAttribute( ATTR_DEPLOY_PATH, deployPath ); //$NON-NLS-1$
 272  2 
         writer.addAttribute( ATTR_HANDLE, handle );
 273   
 
 274  2 
         if ( dependentObject != null && config.getWtpVersion() >= 2.0f )
 275   
         {
 276  0 
             writer.startElement( ELT_DEPENDENCY_OBJECT );
 277  0 
             writer.writeText( dependentObject + System.identityHashCode( dep ) );
 278  0 
             writer.endElement();
 279   
         }
 280   
 
 281  2 
         writer.startElement( ELT_DEPENDENCY_TYPE );
 282  2 
         writer.writeText( "uses" ); //$NON-NLS-1$
 283  2 
         writer.endElement();
 284   
 
 285  2 
         writer.endElement();
 286  2 
     }
 287   
 
 288   
     protected void writeWarOrEarResources( XMLWriter writer, MavenProject project, ArtifactRepository localRepository )
 289   
         throws MojoExecutionException
 290   
     {
 291   
         // use /WEB-INF/lib for war projects and / or the configured defaultLibBundleDir for ear projects
 292  1 
         String deployDir =
 293   
             IdeUtils.getPluginSetting( config.getProject(), JeeUtils.ARTIFACT_MAVEN_EAR_PLUGIN, "defaultLibBundleDir",
 294   
                                        "/" );
 295   
 
 296  1 
         if ( project.getPackaging().equals( Constants.PROJECT_PACKAGING_WAR ) )
 297   
         {
 298  0 
             deployDir = "/WEB-INF/lib";
 299   
         }
 300   
         // dependencies
 301  3 
         for ( int j = 0; j < config.getDeps().length; j++ )
 302   
         {
 303  2 
             IdeDependency dep = config.getDeps()[j];
 304  2 
             String type = dep.getType();
 305   
 
 306   
             // NB war is needed for ear projects, we suppose nobody adds a war dependency to a war/jar project
 307   
             // exclude test and provided and system dependencies outside the project
 308  2 
             if ( ( !dep.isTestDependency() && !dep.isProvided() && !dep.isSystemScopedOutsideProject( project ) )
 309   
                 && ( Constants.PROJECT_PACKAGING_JAR.equals( type ) || Constants.PROJECT_PACKAGING_EJB.equals( type )
 310   
                     || "ejb-client".equals( type ) || Constants.PROJECT_PACKAGING_WAR.equals( type ) ) ) //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$ //$NON-NLS-4$
 311   
             {
 312  2 
                 addDependency( writer, dep, localRepository, config.getProject().getBasedir(), deployDir );
 313   
             }
 314   
         }
 315  1 
     }
 316   
 
 317   
 }
Report generated by Cobertura 1.9.4.1 on 1/13/12 9:34 AM.