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 1228836 2012-01-08 12:59:53Z 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 )
             {
                 @SuppressWarnings( "unchecked" )
                 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 1228836 2012-01-08 12:59:53Z 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		@SuppressWarnings( "unchecked" )
119	0	Set<Artifact> candidates = ar.getArtifacts( groupId, artifactId, getType() );
120	0	if ( candidates.size() > 1 )
121		{
122	0	throw new MojoFailureException( "Artifact[" + this + "] has " + candidates.size()
123		+ " candidates, please provide a classifier." );
124		}
125		else
126		{
127	0	throw new MojoFailureException( "Artifact[" + this + "] is not a dependency of the project." );
128		}
129		}
130		}
131	0	}
132
133		public Artifact getArtifact()
134		{
135	0	return artifact;
136		}
137
138		public String getModuleId()
139		{
140	0	return moduleId;
141		}
142
143		public String getUri()
144		{
145	4	if ( uri == null )
146		{
147	0	if ( getBundleDir() == null )
148		{
149	0	uri = getBundleFileName();
150		}
151		else
152		{
153	0	uri = getBundleDir() + getBundleFileName();
154		}
155		}
156	4	return uri;
157		}
158
159		/**
160		* Returns the artifact's groupId.
161		*
162		* @return the group Id
163		*/
164		public String getGroupId()
165		{
166	0	return groupId;
167		}
168
169		/**
170		* Returns the artifact's Id.
171		*
172		* @return the artifact Id
173		*/
174		public String getArtifactId()
175		{
176	0	return artifactId;
177		}
178
179		/**
180		* Returns the artifact's classifier.
181		*
182		* @return the artifact classifier
183		*/
184		public String getClassifier()
185		{
186	0	return classifier;
187		}
188
189		/**
190		* Returns the bundle directory. If null, the module
191		* is bundled in the root of the EAR.
192		*
193		* @return the custom bundle directory
194		*/
195		public String getBundleDir()
196		{
197	0	if ( bundleDir != null )
198		{
199	0	bundleDir = cleanBundleDir( bundleDir );
200		}
201	0	return bundleDir;
202		}
203
204		/**
205		* Returns the bundle file name. If null, the artifact's
206		* file name is returned.
207		*
208		* @return the bundle file name
209		*/
210		public String getBundleFileName()
211		{
212	0	if ( bundleFileName == null )
213		{
214	0	bundleFileName = earExecutionContext.getFileNameMapping().mapFileName( artifact );
215		}
216	0	return bundleFileName;
217		}
218
219
220		/**
221		* The alt-dd element specifies an optional URI to the post-assembly version
222		* of the deployment descriptor file for a particular Java EE module. The URI
223		* must specify the full pathname of the deployment descriptor file relative
224		* to the application's root directory.
225		*
226		* @return the alternative deployment descriptor for this module
227		*/
228		public String getAltDeploymentDescriptor()
229		{
230	0	return altDeploymentDescriptor;
231		}
232
233		/**
234		* Specify whether this module should be excluded or not.
235		*
236		* @return true if this module should be skipped, false otherwise
237		*/
238		public boolean isExcluded()
239		{
240	4	return excluded.booleanValue();
241		}
242
243		public Boolean shouldUnpack()
244		{
245	0	return unpack;
246		}
247
248		/**
249		* Writes the alternative deployment descriptor if necessary.
250		*
251		* @param writer the writer to use
252		* @param version the java EE version in use
253		*/
254		protected void writeAltDeploymentDescriptor( XMLWriter writer, String version )
255		{
256	0	if ( getAltDeploymentDescriptor() != null )
257		{
258	0	writer.startElement( ALT_DD );
259	0	writer.writeText( getAltDeploymentDescriptor() );
260	0	writer.endElement();
261		}
262	0	}
263
264		/**
265		* Starts a new {@link #MODULE_ELEMENT} on the specified writer, possibly
266		* including an id attribute.
267		*
268		* @param writer the XML writer.
269		* @param generateId whether an id should be generated
270		*/
271		protected void startModuleElement( XMLWriter writer, Boolean generateId )
272		{
273	0	writer.startElement( MODULE_ELEMENT );
274
275		// If a moduleId is specified, always include it
276	0	if ( getModuleId() != null )
277		{
278	0	writer.addAttribute( "id", getModuleId() );
279		}
280	0	else if ( generateId.booleanValue() )
281		{
282		// No module id was specified but one should be generated.
283	0	Artifact artifact = getArtifact();
284	0	String generatedId =
285		artifact.getType().toUpperCase() + "_" + artifact.getGroupId() + "." + artifact.getArtifactId();
286	0	if ( null != artifact.getClassifier() && artifact.getClassifier().trim().length() > 0 )
287		{
288	0	generatedId += "-" + artifact.getClassifier().trim();
289		}
290	0	writer.addAttribute( "id", generatedId );
291		}
292	0	}
293
294		public String toString()
295		{
296	0	StringBuffer sb = new StringBuffer();
297	0	sb.append( getType() ).append( ":" ).append( groupId ).append( ":" ).append( artifactId );
298	0	if ( classifier != null )
299		{
300	0	sb.append( ":" ).append( classifier );
301		}
302	0	if ( artifact != null )
303		{
304	0	sb.append( ":" ).append( artifact.getVersion() );
305		}
306	0	return sb.toString();
307		}
308
309		/**
310		* Cleans the bundle directory so that it might be used
311		* properly.
312		*
313		* @param bundleDir the bundle directory to clean
314		* @return the cleaned bundle directory
315		*/
316		static String cleanBundleDir( String bundleDir )
317		{
318	5	if ( bundleDir == null )
319		{
320	0	return bundleDir;
321		}
322
323		// Using slashes
324	5	bundleDir = bundleDir.replace( '\\', '/' );
325
326		// Remove '/' prefix if any so that directory is a relative path
327	5	if ( bundleDir.startsWith( "/" ) )
328		{
329	3	bundleDir = bundleDir.substring( 1, bundleDir.length() );
330		}
331
332	5	if ( bundleDir.length() > 0 && !bundleDir.endsWith( "/" ) )
333		{
334		// Adding '/' suffix to specify a directory structure if it is not empty
335	2	bundleDir = bundleDir + "/";
336		}
337
338	5	return bundleDir;
339		}
340
341		/**
342		* Specify if the objects are both null or both equal.
343		*
344		* @param first the first object
345		* @param second the second object
346		* @return true if parameters are either both null or equal
347		*/
348		static boolean areNullOrEqual( Object first, Object second )
349		{
350	0	if ( first != null )
351		{
352	0	return first.equals( second );
353		}
354		else
355		{
356	0	return second == null;
357		}
358		}
359
360		/**
361		* Sets the URI of the module explicitly for testing purposes.
362		*
363		* @param uri the uri
364		*/
365		void setUri( String uri )
366		{
367	4	this.uri = uri;
368
369	4	}
370
371		public boolean changeManifestClasspath()
372		{
373	0	return true;
374		}
375
376		public String getLibDir()
377		{
378	0	return null;
379		}
380		}