Coverage Report - org.apache.maven.plugin.eclipse.writers.wtp.EclipseWtpComponentWriter
 
Classes in this File Line Coverage Branch Coverage Complexity
EclipseWtpComponentWriter
48%
30/63
39%
7/18
2,8
 
 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  
 import java.io.FileOutputStream;
 23  
 import java.io.IOException;
 24  
 import java.io.OutputStreamWriter;
 25  
 import java.io.Writer;
 26  
 
 27  
 import org.apache.maven.artifact.repository.ArtifactRepository;
 28  
 import org.apache.maven.plugin.MojoExecutionException;
 29  
 import org.apache.maven.plugin.eclipse.Constants;
 30  
 import org.apache.maven.plugin.eclipse.EclipseSourceDir;
 31  
 import org.apache.maven.plugin.eclipse.Messages;
 32  
 import org.apache.maven.plugin.ide.IdeUtils;
 33  
 import org.apache.maven.plugin.ide.JeeUtils;
 34  
 import org.codehaus.plexus.util.IOUtil;
 35  
 import org.codehaus.plexus.util.xml.PrettyPrintXMLWriter;
 36  
 import org.codehaus.plexus.util.xml.XMLWriter;
 37  
 import org.codehaus.plexus.util.xml.Xpp3Dom;
 38  
 
 39  
 /**
 40  
  * Creates a .settings folder for Eclipse WTP 1.x release and writes out the configuration under it.
 41  
  * 
 42  
  * @author <a href="mailto:rahul.thakur.xdev@gmail.com">Rahul Thakur</a>
 43  
  * @author <a href="mailto:fgiust@apache.org">Fabrizio Giustina</a>
 44  
  * @version $Id: EclipseWtpComponentWriter.java 798342 2009-07-28 00:17:00Z aheritier $
 45  
  */
 46  6
 public class EclipseWtpComponentWriter
 47  
     extends AbstractWtpResourceWriter
 48  
 {
 49  
 
 50  
     /**
 51  
      * Context root attribute.
 52  
      */
 53  
     public static final String ATTR_CONTEXT_ROOT = "context-root"; //$NON-NLS-1$
 54  
 
 55  
     /**
 56  
      * The .settings folder for Web Tools Project 1.x release.
 57  
      */
 58  
     public static final String DIR_WTP_SETTINGS = ".settings"; //$NON-NLS-1$
 59  
 
 60  
     /**
 61  
      * File name where the WTP component settings will be stored for our Eclipse Project.
 62  
      * 
 63  
      * @return <code>.component</code>
 64  
      */
 65  
     protected String getComponentFileName()
 66  
     {
 67  0
         return ".component"; //$NON-NLS-1$
 68  
     }
 69  
 
 70  
     /**
 71  
      * Version number added to component configuration.
 72  
      * 
 73  
      * @return <code>1.0</code>
 74  
      */
 75  
     protected String getProjectVersion()
 76  
     {
 77  0
         return null;
 78  
     }
 79  
 
 80  
     /**
 81  
      * @see org.apache.maven.plugin.eclipse.writers.EclipseWriter#write()
 82  
      */
 83  
     public void write()
 84  
         throws MojoExecutionException
 85  
     {
 86  
 
 87  
         // create a .settings directory (if not existing)
 88  6
         File settingsDir = new File( config.getEclipseProjectDirectory(), DIR_WTP_SETTINGS );
 89  6
         settingsDir.mkdirs();
 90  
 
 91  
         Writer w;
 92  
         try
 93  
         {
 94  6
             w =
 95  
                 new OutputStreamWriter( new FileOutputStream( new File( settingsDir, getComponentFileName() ) ),
 96  
                                         "UTF-8" );
 97  
         }
 98  0
         catch ( IOException ex )
 99  
         {
 100  0
             throw new MojoExecutionException( Messages.getString( "EclipsePlugin.erroropeningfile" ), ex ); //$NON-NLS-1$
 101  6
         }
 102  
 
 103  
         // create a .component file and write out to it
 104  6
         XMLWriter writer = new PrettyPrintXMLWriter( w );
 105  
 
 106  6
         writeModuleTypeComponent( writer, config.getPackaging(), config.getBuildOutputDirectory(),
 107  
                                   config.getSourceDirs(), config.getLocalRepository() );
 108  
 
 109  6
         IOUtil.close( w );
 110  6
     }
 111  
 
 112  
     /**
 113  
      * Writes out the module type settings for a Web Tools Project to a component file.
 114  
      * 
 115  
      * @param writer
 116  
      * @param packaging
 117  
      * @param buildOutputDirectory
 118  
      * @param sourceDirs
 119  
      * @param localRepository
 120  
      * @throws MojoExecutionException
 121  
      */
 122  
     private void writeModuleTypeComponent( XMLWriter writer, String packaging, File buildOutputDirectory,
 123  
                                            EclipseSourceDir[] sourceDirs, ArtifactRepository localRepository )
 124  
         throws MojoExecutionException
 125  
     {
 126  6
         writer.startElement( ELT_PROJECT_MODULES );
 127  6
         writer.addAttribute( ATTR_MODULE_ID, "moduleCoreId" ); //$NON-NLS-1$
 128  6
         if ( getProjectVersion() != null )
 129  
         {
 130  6
             writer.addAttribute( ATTR_PROJECT_VERSION, getProjectVersion() );
 131  
         }
 132  6
         writer.startElement( ELT_WB_MODULE );
 133  
 
 134  
         // we should use the eclipse project name as the deploy name.
 135  6
         writer.addAttribute( ATTR_DEPLOY_NAME, this.config.getEclipseProjectName() );
 136  
 
 137  
         // deploy-path is "/" for utility and ejb projects, "/WEB-INF/classes" for webapps
 138  6
         String target = "/"; //$NON-NLS-1$
 139  
 
 140  6
         if ( Constants.PROJECT_PACKAGING_WAR.equalsIgnoreCase( packaging ) ) //$NON-NLS-1$
 141  
         {
 142  0
             target = "/WEB-INF/classes"; //$NON-NLS-1$
 143  
 
 144  0
             File warSourceDirectory =
 145  
                 new File( IdeUtils.getPluginSetting( config.getProject(), JeeUtils.ARTIFACT_MAVEN_WAR_PLUGIN,
 146  
                                                      "warSourceDirectory", //$NON-NLS-1$
 147  
                                                      config.getProject().getBasedir() + "/src/main/webapp" ) ); //$NON-NLS-1$
 148  
 
 149  0
             writeContextRoot( writer );
 150  
 
 151  0
             writer.startElement( ELT_WB_RESOURCE );
 152  0
             writer.addAttribute( ATTR_DEPLOY_PATH, "/" ); //$NON-NLS-1$
 153  0
             writer.addAttribute( ATTR_SOURCE_PATH,
 154  
                                  IdeUtils.toRelativeAndFixSeparator( config.getEclipseProjectDirectory(),
 155  
                                                                      warSourceDirectory, false ) );
 156  0
             writer.endElement();
 157  
 
 158  
             // add web resources over the top of the war source directory
 159  0
             Xpp3Dom[] webResources =
 160  
                 IdeUtils.getPluginConfigurationDom( config.getProject(), JeeUtils.ARTIFACT_MAVEN_WAR_PLUGIN,
 161  
                                                     new String[] { "webResources", "resource" } );
 162  0
             for ( int index = 0; index < webResources.length; index++ )
 163  
             {
 164  0
                 File webResourceDirectory = new File( webResources[index].getChild( "directory" ).getValue() );
 165  0
                 writer.startElement( ELT_WB_RESOURCE );
 166  0
                 writer.addAttribute( ATTR_DEPLOY_PATH, "/" ); //$NON-NLS-1$
 167  0
                 writer.addAttribute( ATTR_SOURCE_PATH,
 168  
                                      IdeUtils.toRelativeAndFixSeparator( config.getEclipseProjectDirectory(),
 169  
                                                                          webResourceDirectory, false ) );
 170  0
                 writer.endElement();
 171  
             }
 172  
 
 173  
             // @todo is this really needed?
 174  0
             writer.startElement( ELT_PROPERTY );
 175  0
             writer.addAttribute( ATTR_NAME, "java-output-path" ); //$NON-NLS-1$
 176  0
             writer.addAttribute( ATTR_VALUE, "/" //$NON-NLS-1$
 177  
                 + IdeUtils.toRelativeAndFixSeparator( config.getProject().getBasedir(), buildOutputDirectory, false ) );
 178  0
             writer.endElement(); // property
 179  
 
 180  0
         }
 181  6
         else if ( Constants.PROJECT_PACKAGING_EAR.equalsIgnoreCase( packaging ) ) //$NON-NLS-1$
 182  
         {
 183  
 
 184  6
             String defaultApplicationXML =
 185  
                 config.getWtpapplicationxml() ? "/target/eclipseEar" : "/src/main/application";
 186  
 
 187  6
             String earSourceDirectory =
 188  
                 IdeUtils.getPluginSetting( config.getProject(), JeeUtils.ARTIFACT_MAVEN_EAR_PLUGIN,
 189  
                                            "earSourceDirectory", //$NON-NLS-1$
 190  
                                            config.getProject().getBasedir() + defaultApplicationXML ); //$NON-NLS-1$
 191  6
             writer.startElement( ELT_WB_RESOURCE );
 192  6
             writer.addAttribute( ATTR_DEPLOY_PATH, "/" ); //$NON-NLS-1$
 193  6
             writer.addAttribute( ATTR_SOURCE_PATH,
 194  
                                  IdeUtils.toRelativeAndFixSeparator( config.getEclipseProjectDirectory(),
 195  
                                                                      new File( earSourceDirectory ), false ) );
 196  6
             writer.endElement();
 197  
         }
 198  
 
 199  6
         if ( Constants.PROJECT_PACKAGING_WAR.equalsIgnoreCase( packaging )
 200  
             || Constants.PROJECT_PACKAGING_EAR.equalsIgnoreCase( packaging ) ) //$NON-NLS-1$ //$NON-NLS-2$
 201  
         {
 202  
             // write out the dependencies.
 203  6
             writeWarOrEarResources( writer, config.getProject(), localRepository );
 204  
 
 205  
         }
 206  
 
 207  6
         for ( int j = 0; j < sourceDirs.length; j++ )
 208  
         {
 209  0
             EclipseSourceDir dir = sourceDirs[j];
 210  
             // test src/resources are not added to wtpmodules
 211  0
             if ( !dir.isTest() )
 212  
             {
 213  
                 // <wb-resource deploy-path="/" source-path="/src/java" />
 214  0
                 writer.startElement( ELT_WB_RESOURCE );
 215  0
                 writer.addAttribute( ATTR_DEPLOY_PATH, target );
 216  0
                 writer.addAttribute( ATTR_SOURCE_PATH, dir.getPath() );
 217  0
                 writer.endElement();
 218  
             }
 219  
         }
 220  
 
 221  6
         writer.endElement(); // wb-module
 222  6
         writer.endElement(); // project-modules
 223  6
     }
 224  
 
 225  
     /**
 226  
      * @param writer
 227  
      */
 228  
     protected void writeContextRoot( XMLWriter writer )
 229  
     {
 230  0
         writer.startElement( ELT_PROPERTY );
 231  0
         writer.addAttribute( ATTR_CONTEXT_ROOT, config.getContextName() );
 232  0
         writer.endElement(); // property
 233  0
     }
 234  
 
 235  
 }