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  
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  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          if ( Constants.PROJECT_PACKAGING_WAR.equals( config.getPackaging() ) ) //$NON-NLS-1$
90          {
91              writer.addAttribute( ATTR_MODULE_TYPE_ID, "jst.web" ); //$NON-NLS-1$
92  
93              writer.startElement( ELT_VERSION );
94  
95              writer.writeText( JeeUtils.resolveServletVersion( config.getProject() ) );
96              writer.endElement();
97  
98              String contextRoot = config.getContextName();
99  
100             writer.startElement( ELT_PROPERTY );
101             writer.addAttribute( ATTR_NAME, "context-root" ); //$NON-NLS-1$
102             writer.addAttribute( ATTR_VALUE, contextRoot );
103             writer.endElement();
104         }
105         else if ( Constants.PROJECT_PACKAGING_EJB.equals( config.getPackaging() ) ) //$NON-NLS-1$
106         {
107             writer.addAttribute( ATTR_MODULE_TYPE_ID, "jst.ejb" ); //$NON-NLS-1$
108 
109             writer.startElement( ELT_VERSION );
110             writer.writeText( JeeUtils.resolveEjbVersion( config.getProject() ) );
111 
112             writer.endElement();
113 
114             writer.startElement( ELT_PROPERTY );
115             writer.addAttribute( ATTR_NAME, "java-output-path" ); //$NON-NLS-1$
116             writer.addAttribute( ATTR_VALUE, "/" + //$NON-NLS-1$
117                 IdeUtils.toRelativeAndFixSeparator( config.getProject().getBasedir(), buildOutputDirectory, false ) );
118             writer.endElement();
119 
120         }
121         else if ( Constants.PROJECT_PACKAGING_EAR.equals( config.getPackaging() ) ) //$NON-NLS-1$
122         {
123             writer.addAttribute( ATTR_MODULE_TYPE_ID, "jst.ear" ); //$NON-NLS-1$
124 
125             writer.startElement( ELT_VERSION );
126             writer.writeText( JeeUtils.resolveJeeVersion( config.getProject() ) );
127             writer.endElement();
128         }
129         else
130         {
131             // jar
132             writer.addAttribute( ATTR_MODULE_TYPE_ID, "jst.utility" ); //$NON-NLS-1$
133 
134             writer.startElement( ELT_PROPERTY );
135             writer.addAttribute( ATTR_NAME, "java-output-path" ); //$NON-NLS-1$
136             writer.addAttribute( ATTR_VALUE, "/" + //$NON-NLS-1$
137                 IdeUtils.toRelativeAndFixSeparator( config.getProject().getBasedir(), buildOutputDirectory, false ) );
138             writer.endElement();
139         }
140     }
141 
142     /**
143      * Adds dependency for Eclipse WTP project.
144      * 
145      * @param writer
146      * @param artifact
147      * @param localRepository
148      * @param basedir
149      * @throws MojoExecutionException
150      */
151     protected void addDependency( XMLWriter writer, IdeDependency dep, ArtifactRepository localRepository,
152                                   File basedir, String deployPath )
153         throws MojoExecutionException
154     {
155         String handle;
156         String dependentObject = null;
157         String archiveName;
158 
159         // ejb's and wars must always be toplevel
160         if ( Constants.PROJECT_PACKAGING_WAR.equals( dep.getType() )
161             || Constants.PROJECT_PACKAGING_EJB.equals( dep.getType() ) )
162         {
163             deployPath = "/";
164         }
165 
166         if ( dep.isReferencedProject() )
167         {
168             // <dependent-module deploy-path="/WEB-INF/lib"
169             // handle="module:/resource/artifactid/artifactid">
170             // <dependency-type>uses</dependency-type>
171             // </dependent-module>
172 
173             handle = "module:/resource/" + dep.getEclipseProjectName() + "/" + dep.getEclipseProjectName(); //$NON-NLS-1$ //$NON-NLS-2$
174             if ( Constants.PROJECT_PACKAGING_EJB.equals( dep.getType() ) )
175             {
176                 dependentObject = "EjbModule_";
177             }
178             else if ( Constants.PROJECT_PACKAGING_WAR.equals( dep.getType() ) )
179             {
180                 dependentObject = "WebModule_";
181             }
182             archiveName = dep.getEclipseProjectName() + "." + dep.getType();
183         }
184         else
185         {
186             // <dependent-module deploy-path="/WEB-INF/lib"
187             // handle="module:/classpath/var/M2_REPO/cl/cl/2.1/cl-2.1.jar">
188             // <dependency-type>uses</dependency-type>
189             // </dependent-module>
190 
191             File artifactPath = dep.getFile();
192 
193             if ( artifactPath == null )
194             {
195                 log.error( Messages.getString( "EclipsePlugin.artifactpathisnull", dep.getId() ) ); //$NON-NLS-1$
196                 return;
197             }
198 
199             String fullPath = artifactPath.getPath();
200             File repoFile = new File( fullPath );
201 
202             if ( dep.isSystemScoped() )
203             {
204                 handle = "module:/classpath/lib/" //$NON-NLS-1$
205                     + IdeUtils.toRelativeAndFixSeparator( config.getEclipseProjectDirectory(), repoFile, false );
206             }
207             else
208             {
209                 File localRepositoryFile = new File( localRepository.getBasedir() );
210                 String relativePath = IdeUtils.toRelativeAndFixSeparator( localRepositoryFile, repoFile, false );
211 
212                 if ( !new File( relativePath ).isAbsolute() )
213                 {
214                     handle = "module:/classpath/var/M2_REPO/" //$NON-NLS-1$
215                         + relativePath;
216                 }
217                 else
218                 {
219                     handle = "module:/classpath/lib/" //$NON-NLS-1$
220                         + IdeUtils.toRelativeAndFixSeparator( config.getEclipseProjectDirectory(), repoFile, false );
221                 }
222             }
223             if ( Constants.PROJECT_PACKAGING_EAR.equals( this.config.getPackaging() ) && !"/".equals( deployPath ) )
224             {
225                 // This is a very ugly hack around a WTP bug! a delpoydir in the configuration file is duplicated.
226                 // a deploy dir like "lib" will be used as "lib/lib" the only workig workaround is to include a ..
227                 // in the archive name.
228                 archiveName = "../" + artifactPath.getName();
229             }
230             else
231             {
232                 archiveName = artifactPath.getName();
233             }
234         }
235 
236         writer.startElement( ELT_DEPENDENT_MODULE );
237 
238         writer.addAttribute( "archiveName", archiveName );
239 
240         writer.addAttribute( ATTR_DEPLOY_PATH, deployPath ); //$NON-NLS-1$
241         writer.addAttribute( ATTR_HANDLE, handle );
242 
243         if ( dependentObject != null && config.getWtpVersion() >= 2.0f )
244         {
245             writer.startElement( ELT_DEPENDENCY_OBJECT );
246             writer.writeText( dependentObject + System.identityHashCode( dep ) );
247             writer.endElement();
248         }
249 
250         writer.startElement( ELT_DEPENDENCY_TYPE );
251         writer.writeText( "uses" ); //$NON-NLS-1$
252         writer.endElement();
253 
254         writer.endElement();
255     }
256 
257     protected void writeWarOrEarResources( XMLWriter writer, MavenProject project, ArtifactRepository localRepository )
258         throws MojoExecutionException
259     {
260         // use /WEB-INF/lib for war projects and / or the configured defaultLibBundleDir for ear projects
261         String deployDir =
262             IdeUtils.getPluginSetting( config.getProject(), JeeUtils.ARTIFACT_MAVEN_EAR_PLUGIN, "defaultLibBundleDir",
263                                        "/" );
264 
265         if ( project.getPackaging().equals( Constants.PROJECT_PACKAGING_WAR ) )
266         {
267             deployDir = "/WEB-INF/lib";
268         }
269         // dependencies
270         for ( int j = 0; j < config.getDepsOrdered().length; j++ )
271         {
272             IdeDependency dep = config.getDepsOrdered()[j];
273             String type = dep.getType();
274 
275             // NB war is needed for ear projects, we suppose nobody adds a war dependency to a war/jar project
276             // exclude test and provided and system dependencies outside the project
277             if ( ( !dep.isTestDependency() && !dep.isProvided() && !dep.isSystemScopedOutsideProject( project ) )
278                 && ( Constants.PROJECT_PACKAGING_JAR.equals( type ) || Constants.PROJECT_PACKAGING_EJB.equals( type )
279                     || "ejb-client".equals( type ) || Constants.PROJECT_PACKAGING_WAR.equals( type ) ) ) //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$ //$NON-NLS-4$
280             {
281                 addDependency( writer, dep, localRepository, config.getProject().getBasedir(), deployDir );
282             }
283         }
284     }
285 
286 }