Coverage Report

Coverage Report - org.apache.maven.plugin.ear.AbstractEarModule

Classes in this File

Line Coverage

Branch Coverage

Complexity

AbstractEarModule

26%

21/80

18%

8/44

2.13

 package org.apache.maven.plugin.ear;
 
 /*
  * 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.
  */
 
 import org.apache.maven.artifact.Artifact;
 import org.apache.maven.plugin.MojoFailureException;
 import org.apache.maven.plugin.ear.util.ArtifactRepository;
 import org.codehaus.plexus.util.xml.XMLWriter;
 
 import java.util.Set;
 
 /**
  * A base implementation of an {@link EarModule}.
  *
  * @author <a href="snicoll@apache.org">Stephane Nicoll</a>
  * @version $Id: AbstractEarModule.java 1345595 2012-06-02 21:58:15Z rfscholte $
  */
 public abstract class AbstractEarModule
     implements EarModule
 {
 
     protected static final String MODULE_ELEMENT = "module";
 
     protected static final String JAVA_MODULE = "java";
 
     protected static final String ALT_DD = "alt-dd";
 
     private Artifact artifact;
 
     // Those are set by the configuration
 
     private String groupId;
 
     private String artifactId;
 
     private String classifier;
 
     protected String bundleDir;
 
     protected String bundleFileName;
 
     protected Boolean excluded = Boolean.FALSE;
 
     private String uri;
 
     protected Boolean unpack = null;
 
     protected String altDeploymentDescriptor;
 
     private String moduleId;
 
     // This is injected once the module has been built.
 
     protected EarExecutionContext earExecutionContext;
 
     /**
      * Empty constructor to be used when the module
      * is built based on the configuration.
      */
     public AbstractEarModule()
     {
     }
 
     /**
      * Creates an ear module from the artifact.
      *
      * @param a the artifact
      */
     public AbstractEarModule( Artifact a )
     {
         this.artifact = a;
         this.groupId = a.getGroupId();
         this.artifactId = a.getArtifactId();
         this.classifier = a.getClassifier();
         this.bundleDir = null;
     }
 
     public void setEarExecutionContext( EarExecutionContext earExecutionContext )
     {
         this.earExecutionContext = earExecutionContext;
     }
 
     /** {@inheritDoc} */
     public void resolveArtifact( Set<Artifact> artifacts )
         throws EarPluginException, MojoFailureException
     {
         // If the artifact is already set no need to resolve it
         if ( artifact == null )
         {
             // Make sure that at least the groupId and the artifactId are specified
             if ( groupId == null || artifactId == null )
             {
                 throw new MojoFailureException(
                     "Could not resolve artifact[" + groupId + ":" + artifactId + ":" + getType() + "]" );
             }
             final ArtifactRepository ar = earExecutionContext.getArtifactRepository();
             artifact = ar.getUniqueArtifact( groupId, artifactId, getType(), classifier );
             // Artifact has not been found
             if ( artifact == null )
             {
                 Set<Artifact> candidates = ar.getArtifacts( groupId, artifactId, getType() );
                 if ( candidates.size() > 1 )
                 {
                     throw new MojoFailureException( "Artifact[" + this + "] has " + candidates.size()
                                                         + " candidates, please provide a classifier." );
                 }
                 else
                 {
                     throw new MojoFailureException( "Artifact[" + this + "] is not a dependency of the project." );
                 }
             }
         }
     }
 
     public Artifact getArtifact()
     {
         return artifact;
     }
 
     public String getModuleId()
     {
         return moduleId;
     }
 
     public String getUri()
     {
         if ( uri == null )
         {
             if ( getBundleDir() == null )
             {
                 uri = getBundleFileName();
             }
             else
             {
                 uri = getBundleDir() + getBundleFileName();
             }
         }
         return uri;
     }
 
     /**
      * Returns the artifact's groupId.
      *
      * @return the group Id
      */
     public String getGroupId()
     {
         return groupId;
     }
 
     /**
      * Returns the artifact's Id.
      *
      * @return the artifact Id
      */
     public String getArtifactId()
     {
         return artifactId;
     }
 
     /**
      * Returns the artifact's classifier.
      *
      * @return the artifact classifier
      */
     public String getClassifier()
     {
         return classifier;
     }
 
     /**
      * Returns the bundle directory. If null, the module
      * is bundled in the root of the EAR.
      *
      * @return the custom bundle directory
      */
     public String getBundleDir()
     {
         if ( bundleDir != null )
         {
             bundleDir = cleanBundleDir( bundleDir );
         }
         return bundleDir;
     }
 
     /**
      * Returns the bundle file name. If null, the artifact's
      * file name is returned.
      *
      * @return the bundle file name
      */
     public String getBundleFileName()
     {
         if ( bundleFileName == null )
         {
             bundleFileName = earExecutionContext.getFileNameMapping().mapFileName( artifact );
         }
         return bundleFileName;
     }
 
 
     /**
      * The alt-dd element specifies an optional URI to the post-assembly version
      * of the deployment descriptor file for a particular Java EE module. The URI
      * must specify the full pathname of the deployment descriptor file relative
      * to the application's root directory.
      *
      * @return the alternative deployment descriptor for this module
      */
     public String getAltDeploymentDescriptor()
     {
         return altDeploymentDescriptor;
     }
 
     /**
      * Specify whether this module should be excluded or not.
      *
      * @return true if this module should be skipped, false otherwise
      */
     public boolean isExcluded()
     {
         return excluded.booleanValue();
     }
 
     public Boolean shouldUnpack()
     {
         return unpack;
     }
 
     /**
      * Writes the alternative deployment descriptor if necessary.
      *
      * @param writer  the writer to use
      * @param version the java EE version in use
      */
     protected void writeAltDeploymentDescriptor( XMLWriter writer, String version )
     {
         if ( getAltDeploymentDescriptor() != null )
         {
             writer.startElement( ALT_DD );
             writer.writeText( getAltDeploymentDescriptor() );
             writer.endElement();
         }
     }
 
     /**
      * Starts a new {@link #MODULE_ELEMENT} on the specified writer, possibly
      * including an id attribute.
      *
      * @param writer     the XML writer.
      * @param generateId whether an id should be generated
      */
     protected void startModuleElement( XMLWriter writer, Boolean generateId )
     {
         writer.startElement( MODULE_ELEMENT );
 
         // If a moduleId is specified, always include it
         if ( getModuleId() != null )
         {
             writer.addAttribute( "id", getModuleId() );
         }
         else if ( generateId.booleanValue() )
         {
             // No module id was specified but one should be generated.
             Artifact artifact = getArtifact();
             String generatedId =
                 artifact.getType().toUpperCase() + "_" + artifact.getGroupId() + "." + artifact.getArtifactId();
             if ( null != artifact.getClassifier() && artifact.getClassifier().trim().length() > 0 )
             {
                 generatedId += "-" + artifact.getClassifier().trim();
             }
             writer.addAttribute( "id", generatedId );
         }
     }
 
     public String toString()
     {
         StringBuffer sb = new StringBuffer();
         sb.append( getType() ).append( ":" ).append( groupId ).append( ":" ).append( artifactId );
         if ( classifier != null )
         {
             sb.append( ":" ).append( classifier );
         }
         if ( artifact != null )
         {
             sb.append( ":" ).append( artifact.getVersion() );
         }
         return sb.toString();
     }
 
     /**
      * Cleans the bundle directory so that it might be used
      * properly.
      *
      * @param bundleDir the bundle directory to clean
      * @return the cleaned bundle directory
      */
     static String cleanBundleDir( String bundleDir )
     {
         if ( bundleDir == null )
         {
             return bundleDir;
         }
 
         // Using slashes
         bundleDir = bundleDir.replace( '\\', '/' );
 
         // Remove '/' prefix if any so that directory is a relative path
         if ( bundleDir.startsWith( "/" ) )
         {
             bundleDir = bundleDir.substring( 1, bundleDir.length() );
         }
 
         if ( bundleDir.length() > 0 && !bundleDir.endsWith( "/" ) )
         {
             // Adding '/' suffix to specify a directory structure if it is not empty
             bundleDir = bundleDir + "/";
         }
 
         return bundleDir;
     }
 
     /**
      * Specify if the objects are both null or both equal.
      *
      * @param first  the first object
      * @param second the second object
      * @return true if parameters are either both null or equal
      */
     static boolean areNullOrEqual( Object first, Object second )
     {
         if ( first != null )
         {
             return first.equals( second );
         }
         else
         {
             return second == null;
         }
     }
 
     /**
      * Sets the URI of the module explicitly for testing purposes.
      *
      * @param uri the uri
      */
     void setUri( String uri )
     {
         this.uri = uri;
 
     }
 
     public boolean changeManifestClasspath()
     {
         return true;
     }
 
     public String getLibDir()
     {
         return null;
     }
 }

1		package org.apache.maven.plugin.ear;
2
3		/*
4		* Licensed to the Apache Software Foundation (ASF) under one
5		* or more contributor license agreements. See the NOTICE file
6		* distributed with this work for additional information
7		* regarding copyright ownership. The ASF licenses this file
8		* to you under the Apache License, Version 2.0 (the
9		* "License"); you may not use this file except in compliance
10		* with the License. You may obtain a copy of the License at
11		*
12		* http://www.apache.org/licenses/LICENSE-2.0
13		*
14		* Unless required by applicable law or agreed to in writing,
15		* software distributed under the License is distributed on an
16		* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17		* KIND, either express or implied. See the License for the
18		* specific language governing permissions and limitations
19		* under the License.
20		*/
21
22		import org.apache.maven.artifact.Artifact;
23		import org.apache.maven.plugin.MojoFailureException;
24		import org.apache.maven.plugin.ear.util.ArtifactRepository;
25		import org.codehaus.plexus.util.xml.XMLWriter;
26
27		import java.util.Set;
28
29		/**
30		* A base implementation of an {@link EarModule}.
31		*
32		* @author <a href="snicoll@apache.org">Stephane Nicoll</a>
33		* @version $Id: AbstractEarModule.java 1345595 2012-06-02 21:58:15Z rfscholte $
34		*/
35		public abstract class AbstractEarModule
36		implements EarModule
37		{
38
39		protected static final String MODULE_ELEMENT = "module";
40
41		protected static final String JAVA_MODULE = "java";
42
43		protected static final String ALT_DD = "alt-dd";
44
45		private Artifact artifact;
46
47		// Those are set by the configuration
48
49		private String groupId;
50
51		private String artifactId;
52
53		private String classifier;
54
55		protected String bundleDir;
56
57		protected String bundleFileName;
58
59	4	protected Boolean excluded = Boolean.FALSE;
60
61		private String uri;
62
63	4	protected Boolean unpack = null;
64
65		protected String altDeploymentDescriptor;
66
67		private String moduleId;
68
69		// This is injected once the module has been built.
70
71		protected EarExecutionContext earExecutionContext;
72
73		/**
74		* Empty constructor to be used when the module
75		* is built based on the configuration.
76		*/
77		public AbstractEarModule()
78	0	{
79	0	}
80
81		/**
82		* Creates an ear module from the artifact.
83		*
84		* @param a the artifact
85		*/
86		public AbstractEarModule( Artifact a )
87	4	{
88	4	this.artifact = a;
89	4	this.groupId = a.getGroupId();
90	4	this.artifactId = a.getArtifactId();
91	4	this.classifier = a.getClassifier();
92	4	this.bundleDir = null;
93	4	}
94
95		public void setEarExecutionContext( EarExecutionContext earExecutionContext )
96		{
97	0	this.earExecutionContext = earExecutionContext;
98	0	}
99
100		/** {@inheritDoc} */
101		public void resolveArtifact( Set<Artifact> artifacts )
102		throws EarPluginException, MojoFailureException
103		{
104		// If the artifact is already set no need to resolve it
105	0	if ( artifact == null )
106		{
107		// Make sure that at least the groupId and the artifactId are specified
108	0	if ( groupId == null \|\| artifactId == null )
109		{
110	0	throw new MojoFailureException(
111		"Could not resolve artifact[" + groupId + ":" + artifactId + ":" + getType() + "]" );
112		}
113	0	final ArtifactRepository ar = earExecutionContext.getArtifactRepository();
114	0	artifact = ar.getUniqueArtifact( groupId, artifactId, getType(), classifier );
115		// Artifact has not been found
116	0	if ( artifact == null )
117		{
118	0	Set<Artifact> candidates = ar.getArtifacts( groupId, artifactId, getType() );
119	0	if ( candidates.size() > 1 )
120		{
121	0	throw new MojoFailureException( "Artifact[" + this + "] has " + candidates.size()
122		+ " candidates, please provide a classifier." );
123		}
124		else
125		{
126	0	throw new MojoFailureException( "Artifact[" + this + "] is not a dependency of the project." );
127		}
128		}
129		}
130	0	}
131
132		public Artifact getArtifact()
133		{
134	0	return artifact;
135		}
136
137		public String getModuleId()
138		{
139	0	return moduleId;
140		}
141
142		public String getUri()
143		{
144	4	if ( uri == null )
145		{
146	0	if ( getBundleDir() == null )
147		{
148	0	uri = getBundleFileName();
149		}
150		else
151		{
152	0	uri = getBundleDir() + getBundleFileName();
153		}
154		}
155	4	return uri;
156		}
157
158		/**
159		* Returns the artifact's groupId.
160		*
161		* @return the group Id
162		*/
163		public String getGroupId()
164		{
165	0	return groupId;
166		}
167
168		/**
169		* Returns the artifact's Id.
170		*
171		* @return the artifact Id
172		*/
173		public String getArtifactId()
174		{
175	0	return artifactId;
176		}
177
178		/**
179		* Returns the artifact's classifier.
180		*
181		* @return the artifact classifier
182		*/
183		public String getClassifier()
184		{
185	0	return classifier;
186		}
187
188		/**
189		* Returns the bundle directory. If null, the module
190		* is bundled in the root of the EAR.
191		*
192		* @return the custom bundle directory
193		*/
194		public String getBundleDir()
195		{
196	0	if ( bundleDir != null )
197		{
198	0	bundleDir = cleanBundleDir( bundleDir );
199		}
200	0	return bundleDir;
201		}
202
203		/**
204		* Returns the bundle file name. If null, the artifact's
205		* file name is returned.
206		*
207		* @return the bundle file name
208		*/
209		public String getBundleFileName()
210		{
211	0	if ( bundleFileName == null )
212		{
213	0	bundleFileName = earExecutionContext.getFileNameMapping().mapFileName( artifact );
214		}
215	0	return bundleFileName;
216		}
217
218
219		/**
220		* The alt-dd element specifies an optional URI to the post-assembly version
221		* of the deployment descriptor file for a particular Java EE module. The URI
222		* must specify the full pathname of the deployment descriptor file relative
223		* to the application's root directory.
224		*
225		* @return the alternative deployment descriptor for this module
226		*/
227		public String getAltDeploymentDescriptor()
228		{
229	0	return altDeploymentDescriptor;
230		}
231
232		/**
233		* Specify whether this module should be excluded or not.
234		*
235		* @return true if this module should be skipped, false otherwise
236		*/
237		public boolean isExcluded()
238		{
239	4	return excluded.booleanValue();
240		}
241
242		public Boolean shouldUnpack()
243		{
244	0	return unpack;
245		}
246
247		/**
248		* Writes the alternative deployment descriptor if necessary.
249		*
250		* @param writer the writer to use
251		* @param version the java EE version in use
252		*/
253		protected void writeAltDeploymentDescriptor( XMLWriter writer, String version )
254		{
255	0	if ( getAltDeploymentDescriptor() != null )
256		{
257	0	writer.startElement( ALT_DD );
258	0	writer.writeText( getAltDeploymentDescriptor() );
259	0	writer.endElement();
260		}
261	0	}
262
263		/**
264		* Starts a new {@link #MODULE_ELEMENT} on the specified writer, possibly
265		* including an id attribute.
266		*
267		* @param writer the XML writer.
268		* @param generateId whether an id should be generated
269		*/
270		protected void startModuleElement( XMLWriter writer, Boolean generateId )
271		{
272	0	writer.startElement( MODULE_ELEMENT );
273
274		// If a moduleId is specified, always include it
275	0	if ( getModuleId() != null )
276		{
277	0	writer.addAttribute( "id", getModuleId() );
278		}
279	0	else if ( generateId.booleanValue() )
280		{
281		// No module id was specified but one should be generated.
282	0	Artifact artifact = getArtifact();
283	0	String generatedId =
284		artifact.getType().toUpperCase() + "_" + artifact.getGroupId() + "." + artifact.getArtifactId();
285	0	if ( null != artifact.getClassifier() && artifact.getClassifier().trim().length() > 0 )
286		{
287	0	generatedId += "-" + artifact.getClassifier().trim();
288		}
289	0	writer.addAttribute( "id", generatedId );
290		}
291	0	}
292
293		public String toString()
294		{
295	0	StringBuffer sb = new StringBuffer();
296	0	sb.append( getType() ).append( ":" ).append( groupId ).append( ":" ).append( artifactId );
297	0	if ( classifier != null )
298		{
299	0	sb.append( ":" ).append( classifier );
300		}
301	0	if ( artifact != null )
302		{
303	0	sb.append( ":" ).append( artifact.getVersion() );
304		}
305	0	return sb.toString();
306		}
307
308		/**
309		* Cleans the bundle directory so that it might be used
310		* properly.
311		*
312		* @param bundleDir the bundle directory to clean
313		* @return the cleaned bundle directory
314		*/
315		static String cleanBundleDir( String bundleDir )
316		{
317	5	if ( bundleDir == null )
318		{
319	0	return bundleDir;
320		}
321
322		// Using slashes
323	5	bundleDir = bundleDir.replace( '\\', '/' );
324
325		// Remove '/' prefix if any so that directory is a relative path
326	5	if ( bundleDir.startsWith( "/" ) )
327		{
328	3	bundleDir = bundleDir.substring( 1, bundleDir.length() );
329		}
330
331	5	if ( bundleDir.length() > 0 && !bundleDir.endsWith( "/" ) )
332		{
333		// Adding '/' suffix to specify a directory structure if it is not empty
334	2	bundleDir = bundleDir + "/";
335		}
336
337	5	return bundleDir;
338		}
339
340		/**
341		* Specify if the objects are both null or both equal.
342		*
343		* @param first the first object
344		* @param second the second object
345		* @return true if parameters are either both null or equal
346		*/
347		static boolean areNullOrEqual( Object first, Object second )
348		{
349	0	if ( first != null )
350		{
351	0	return first.equals( second );
352		}
353		else
354		{
355	0	return second == null;
356		}
357		}
358
359		/**
360		* Sets the URI of the module explicitly for testing purposes.
361		*
362		* @param uri the uri
363		*/
364		void setUri( String uri )
365		{
366	4	this.uri = uri;
367
368	4	}
369
370		public boolean changeManifestClasspath()
371		{
372	0	return true;
373		}
374
375		public String getLibDir()
376		{
377	0	return null;
378		}
379		}