Coverage Report

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

Classes in this File

Line Coverage

Branch Coverage

Complexity

AbstractEarModule

0/78

0/44

2.095

 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 992817 2010-09-05 16:32:58Z snicoll $
  */
 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;
     }
 
     public void resolveArtifact( Set 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 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 explicitely for testing purposes.
      *
      * @param uri the uri
      */
     void setUri( String uri )
     {
         this.uri = uri;
 
     }
 }

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