View Javadoc

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 720443 2008-11-25 08:48:22Z rinku $
45   */
46  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          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          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          File settingsDir = new File( config.getEclipseProjectDirectory(), DIR_WTP_SETTINGS );
89          settingsDir.mkdirs();
90  
91          Writer w;
92          try
93          {
94              w =
95                  new OutputStreamWriter( new FileOutputStream( new File( settingsDir, getComponentFileName() ) ),
96                                          "UTF-8" );
97          }
98          catch ( IOException ex )
99          {
100             throw new MojoExecutionException( Messages.getString( "EclipsePlugin.erroropeningfile" ), ex ); //$NON-NLS-1$
101         }
102 
103         // create a .component file and write out to it
104         XMLWriter writer = new PrettyPrintXMLWriter( w );
105 
106         writeModuleTypeComponent( writer, config.getPackaging(), config.getBuildOutputDirectory(),
107                                   config.getSourceDirs(), config.getLocalRepository() );
108 
109         IOUtil.close( w );
110     }
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         writer.startElement( ELT_PROJECT_MODULES );
127         writer.addAttribute( ATTR_MODULE_ID, "moduleCoreId" ); //$NON-NLS-1$
128         if ( getProjectVersion() != null )
129         {
130             writer.addAttribute( ATTR_PROJECT_VERSION, getProjectVersion() );
131         }
132         writer.startElement( ELT_WB_MODULE );
133 
134         // we should use the eclipse project name as the deploy name.
135         writer.addAttribute( ATTR_DEPLOY_NAME, this.config.getEclipseProjectName() );
136 
137         // deploy-path is "/" for utility and ejb projects, "/WEB-INF/classes" for webapps
138         String target = "/"; //$NON-NLS-1$
139 
140         if ( Constants.PROJECT_PACKAGING_WAR.equalsIgnoreCase( packaging ) ) //$NON-NLS-1$
141         {
142             target = "/WEB-INF/classes"; //$NON-NLS-1$
143 
144             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             writeContextRoot( writer );
150 
151             writer.startElement( ELT_WB_RESOURCE );
152             writer.addAttribute( ATTR_DEPLOY_PATH, "/" ); //$NON-NLS-1$
153             writer.addAttribute( ATTR_SOURCE_PATH,
154                                  IdeUtils.toRelativeAndFixSeparator( config.getEclipseProjectDirectory(),
155                                                                      warSourceDirectory, false ) );
156             writer.endElement();
157             
158             // add web resources over the top of the war source directory
159             Xpp3Dom[] webResources = IdeUtils.getPluginConfigurationDom( config.getProject(), JeeUtils.ARTIFACT_MAVEN_WAR_PLUGIN,
160                     new String[] { "webResources", "resource" } );
161             for ( int index = 0; index < webResources.length; index++ )
162             {
163                 File webResourceDirectory = new File( webResources[index].getChild( "directory" ).getValue() );
164             	writer.startElement( ELT_WB_RESOURCE );
165                 writer.addAttribute( ATTR_DEPLOY_PATH, "/" ); //$NON-NLS-1$
166                 writer.addAttribute( ATTR_SOURCE_PATH,
167                                      IdeUtils.toRelativeAndFixSeparator( config.getEclipseProjectDirectory(),
168                                     		 webResourceDirectory, false ) );
169                 writer.endElement();
170             }
171 
172             // @todo is this really needed?
173             writer.startElement( ELT_PROPERTY );
174             writer.addAttribute( ATTR_NAME, "java-output-path" ); //$NON-NLS-1$
175             writer.addAttribute( ATTR_VALUE, "/" //$NON-NLS-1$
176                 + IdeUtils.toRelativeAndFixSeparator( config.getProject().getBasedir(), buildOutputDirectory, false ) );
177             writer.endElement(); // property
178 
179         }
180         else if ( Constants.PROJECT_PACKAGING_EAR.equalsIgnoreCase( packaging ) ) //$NON-NLS-1$
181         {
182 
183             String defaultApplicationXML =
184                 config.getWtpapplicationxml() ? "/target/eclipseEar" : "/src/main/application";
185 
186             String earSourceDirectory =
187                 IdeUtils.getPluginSetting( config.getProject(), JeeUtils.ARTIFACT_MAVEN_EAR_PLUGIN,
188                                            "earSourceDirectory", //$NON-NLS-1$
189                                            config.getProject().getBasedir() + defaultApplicationXML ); //$NON-NLS-1$
190             writer.startElement( ELT_WB_RESOURCE );
191             writer.addAttribute( ATTR_DEPLOY_PATH, "/" ); //$NON-NLS-1$
192             writer.addAttribute( ATTR_SOURCE_PATH,
193                                  IdeUtils.toRelativeAndFixSeparator( config.getEclipseProjectDirectory(),
194                                                                      new File( earSourceDirectory ), false ) );
195             writer.endElement();
196         }
197 
198         if ( Constants.PROJECT_PACKAGING_WAR.equalsIgnoreCase( packaging )
199             || Constants.PROJECT_PACKAGING_EAR.equalsIgnoreCase( packaging ) ) //$NON-NLS-1$ //$NON-NLS-2$
200         {
201             // write out the dependencies.
202             writeWarOrEarResources( writer, config.getProject(), localRepository );
203 
204         }
205 
206         for ( int j = 0; j < sourceDirs.length; j++ )
207         {
208             EclipseSourceDir dir = sourceDirs[j];
209             // test src/resources are not added to wtpmodules
210             if ( !dir.isTest() )
211             {
212                 // <wb-resource deploy-path="/" source-path="/src/java" />
213                 writer.startElement( ELT_WB_RESOURCE );
214                 writer.addAttribute( ATTR_DEPLOY_PATH, target );
215                 writer.addAttribute( ATTR_SOURCE_PATH, dir.getPath() );
216                 writer.endElement();
217             }
218         }
219 
220         writer.endElement(); // wb-module
221         writer.endElement(); // project-modules
222     }
223 
224     /**
225      * @param writer
226      */
227     protected void writeContextRoot( XMLWriter writer )
228     {
229         writer.startElement( ELT_PROPERTY );
230         writer.addAttribute( ATTR_CONTEXT_ROOT, config.getContextName() );
231         writer.endElement(); // property
232     }
233 
234 }