View Javadoc
1   package org.apache.maven.archetype.generator;
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.archetype.old.OldArchetype;
23  import org.apache.maven.archetype.ArchetypeGenerationRequest;
24  import org.apache.maven.archetype.ArchetypeGenerationResult;
25  import org.apache.maven.archetype.common.ArchetypeArtifactManager;
26  import org.apache.maven.archetype.exception.ArchetypeException;
27  import org.apache.maven.archetype.exception.ArchetypeGenerationFailure;
28  import org.apache.maven.archetype.exception.ArchetypeNotDefined;
29  import org.apache.maven.archetype.exception.UnknownArchetype;
30  import org.apache.maven.artifact.repository.ArtifactRepository;
31  import org.apache.maven.artifact.repository.ArtifactRepositoryPolicy;
32  import org.apache.maven.artifact.repository.MavenArtifactRepository;
33  import org.apache.maven.artifact.repository.layout.ArtifactRepositoryLayout;
34  import org.codehaus.plexus.component.annotations.Component;
35  import org.codehaus.plexus.component.annotations.Requirement;
36  import org.codehaus.plexus.logging.AbstractLogEnabled;
37  import org.codehaus.plexus.util.StringUtils;
38  import org.codehaus.plexus.util.xml.pull.XmlPullParserException;
39  import org.dom4j.DocumentException;
40  
41  import java.io.File;
42  import java.io.IOException;
43  import java.util.ArrayList;
44  import java.util.List;
45  
46  @Component( role = ArchetypeGenerator.class )
47  public class DefaultArchetypeGenerator
48      extends AbstractLogEnabled
49      implements ArchetypeGenerator
50  {
51      /**
52       * Determines whether the layout is legacy or not.
53       */
54      @Requirement
55      private ArtifactRepositoryLayout defaultArtifactRepositoryLayout;
56  
57      @Requirement
58      private ArchetypeArtifactManager archetypeArtifactManager;
59  
60      @Requirement
61      private FilesetArchetypeGenerator filesetGenerator;
62  
63      @Requirement
64      private OldArchetype oldArchetype;
65  
66      private File getArchetypeFile( ArchetypeGenerationRequest request, ArtifactRepository localRepository )
67          throws IOException, ArchetypeException, XmlPullParserException, DocumentException
68      {
69          if ( !isArchetypeDefined( request ) )
70          {
71              throw new ArchetypeNotDefined( "The archetype is not defined" );
72          }
73  
74          List<ArtifactRepository> repos = new ArrayList<ArtifactRepository>();
75  
76          ArtifactRepository remoteRepo = null;
77          if ( request != null && request.getArchetypeRepository() != null )
78          {
79              remoteRepo =
80                  createRepository( request.getArchetypeRepository(),
81                                                             request.getArchetypeArtifactId() + "-repo" );
82  
83              repos.add( remoteRepo );
84          }
85  
86          if ( !archetypeArtifactManager.exists( request.getArchetypeGroupId(), request.getArchetypeArtifactId(),
87                                                 request.getArchetypeVersion(), remoteRepo, localRepository, repos,
88                                                 request.getProjectBuildingRequest() ) )
89          {
90              throw new UnknownArchetype( "The desired archetype does not exist (" + request.getArchetypeGroupId() + ":"
91                  + request.getArchetypeArtifactId() + ":" + request.getArchetypeVersion() + ")" );
92          }
93  
94          File archetypeFile =
95              archetypeArtifactManager.getArchetypeFile( request.getArchetypeGroupId(), request.getArchetypeArtifactId(),
96                                                         request.getArchetypeVersion(), remoteRepo, localRepository,
97                                                         repos, request.getProjectBuildingRequest() );
98          return archetypeFile;
99      }
100 
101     private void generateArchetype( ArchetypeGenerationRequest request, File archetypeFile )
102         throws IOException, ArchetypeException, XmlPullParserException, DocumentException
103     {
104         if ( archetypeArtifactManager.isFileSetArchetype( archetypeFile ) )
105         {
106             processFileSetArchetype( request, archetypeFile );
107         }
108         else if ( archetypeArtifactManager.isOldArchetype( archetypeFile ) )
109         {
110             processOldArchetype( request, archetypeFile );
111         }
112         else
113         {
114             throw new ArchetypeGenerationFailure( "The defined artifact is not an archetype" );
115         }
116     }
117 
118     /** Common */
119     public String getPackageAsDirectory( String packageName )
120     {
121         return StringUtils.replace( packageName, ".", "/" );
122     }
123 
124     private boolean isArchetypeDefined( ArchetypeGenerationRequest request )
125     {
126         return StringUtils.isNotEmpty( request.getArchetypeGroupId() )
127             && StringUtils.isNotEmpty( request.getArchetypeArtifactId() )
128             && StringUtils.isNotEmpty( request.getArchetypeVersion() );
129     }
130 
131     /** FileSetArchetype */
132     private void processFileSetArchetype( ArchetypeGenerationRequest request, File archetypeFile )
133         throws ArchetypeException
134     {
135         filesetGenerator.generateArchetype( request, archetypeFile );
136     }
137 
138     private void processOldArchetype( ArchetypeGenerationRequest request, File archetypeFile )
139         throws UnknownArchetype, ArchetypeGenerationFailure
140     {
141         oldArchetype.createArchetype( request, archetypeFile );
142     }
143 
144     public void generateArchetype( ArchetypeGenerationRequest request, File archetypeFile,
145                                    ArchetypeGenerationResult result )
146     {
147         try
148         {
149             generateArchetype( request, archetypeFile );
150         }
151         catch ( IOException ex )
152         {
153             result.setCause( ex );
154         }
155         catch ( ArchetypeException ex )
156         {
157             result.setCause( ex );
158         }
159         catch ( XmlPullParserException ex )
160         {
161             result.setCause( ex );
162         }
163         catch ( DocumentException ex )
164         {
165             result.setCause( ex );
166         }
167     }
168 
169     public void generateArchetype( ArchetypeGenerationRequest request, ArchetypeGenerationResult result )
170     {
171         try
172         {
173             File archetypeFile = getArchetypeFile( request, request.getLocalRepository() );
174 
175             generateArchetype( request, archetypeFile, result );
176         }
177         catch ( IOException ex )
178         {
179             result.setCause( ex );
180         }
181         catch ( ArchetypeException ex )
182         {
183             result.setCause( ex );
184         }
185         catch ( XmlPullParserException ex )
186         {
187             result.setCause( ex );
188         }
189         catch ( DocumentException ex )
190         {
191             result.setCause( ex );
192         }
193     }
194     
195     private ArtifactRepository createRepository( String url, String repositoryId )
196     {
197         
198         
199         // snapshots vs releases
200         // offline = to turning the update policy off
201 
202         // TODO: we'll need to allow finer grained creation of repositories but this will do for now
203 
204         String updatePolicyFlag = ArtifactRepositoryPolicy.UPDATE_POLICY_ALWAYS;
205 
206         String checksumPolicyFlag = ArtifactRepositoryPolicy.CHECKSUM_POLICY_WARN;
207 
208         ArtifactRepositoryPolicy snapshotsPolicy =
209             new ArtifactRepositoryPolicy( true, updatePolicyFlag, checksumPolicyFlag );
210 
211         ArtifactRepositoryPolicy releasesPolicy =
212             new ArtifactRepositoryPolicy( true, updatePolicyFlag, checksumPolicyFlag );
213         
214         return new MavenArtifactRepository( repositoryId, url, defaultArtifactRepositoryLayout, snapshotsPolicy,
215                                             releasesPolicy );
216     }
217 }