1 package org.apache.maven.plugin.javadoc;
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22 import org.apache.maven.archiver.MavenArchiveConfiguration;
23 import org.apache.maven.archiver.MavenArchiver;
24 import org.apache.maven.artifact.DependencyResolutionRequiredException;
25 import org.apache.maven.artifact.handler.ArtifactHandler;
26 import org.apache.maven.plugin.MojoExecutionException;
27 import org.apache.maven.project.MavenProjectHelper;
28 import org.apache.maven.reporting.MavenReportException;
29 import org.apache.maven.model.Resource;
30 import org.codehaus.plexus.archiver.ArchiverException;
31 import org.codehaus.plexus.archiver.jar.JarArchiver;
32 import org.codehaus.plexus.archiver.jar.ManifestException;
33
34 import java.io.File;
35 import java.io.IOException;
36 import java.util.List;
37 import java.util.Locale;
38
39
40
41
42
43
44
45
46
47
48 public class JavadocJar
49 extends AbstractJavadocMojo
50 {
51
52 private static final String[] DEFAULT_INCLUDES = new String[] { "**/**" };
53
54
55
56
57
58
59
60
61
62
63 private static final String[] DEFAULT_EXCLUDES =
64 new String[] { DEBUG_JAVADOC_SCRIPT_NAME, OPTIONS_FILE_NAME, PACKAGES_FILE_NAME, ARGFILE_FILE_NAME,
65 FILES_FILE_NAME };
66
67
68
69
70
71
72
73
74
75
76 private MavenProjectHelper projectHelper;
77
78
79
80
81
82
83
84 private JarArchiver jarArchiver;
85
86
87
88
89
90
91
92
93
94
95
96
97 private File destDir;
98
99
100
101
102
103
104 private String jarOutputDirectory;
105
106
107
108
109
110
111
112 private String finalName;
113
114
115
116
117
118
119
120 private boolean attach;
121
122
123
124
125
126
127
128
129 private MavenArchiveConfiguration archive = new MavenArchiveConfiguration();
130
131
132
133
134
135
136
137
138
139
140 private File defaultManifestFile;
141
142
143
144
145
146
147
148
149 private boolean useDefaultManifestFile;
150
151
152 public void execute()
153 throws MojoExecutionException
154 {
155 if ( skip )
156 {
157 getLog().info( "Skipping javadoc generation" );
158 return;
159 }
160
161 File innerDestDir = this.destDir;
162 if ( innerDestDir == null )
163 {
164 innerDestDir = new File( getOutputDirectory() );
165 }
166
167 if ( !( "pom".equalsIgnoreCase( project.getPackaging() ) && isAggregator() ) )
168 {
169 ArtifactHandler artifactHandler = project.getArtifact().getArtifactHandler();
170 if ( !"java".equals( artifactHandler.getLanguage() ) )
171 {
172 getLog().info( "Not executing Javadoc as the project is not a Java classpath-capable package" );
173 return;
174 }
175 }
176
177 try
178 {
179 executeReport( Locale.getDefault() );
180
181 if ( innerDestDir.exists() )
182 {
183 File outputFile = generateArchive( innerDestDir, finalName + "-" + getClassifier() + ".jar" );
184
185 if ( !attach )
186 {
187 getLog().info( "NOT adding javadoc to attached artifacts list." );
188 }
189 else
190 {
191
192
193 projectHelper.attachArtifact( project, "javadoc", getClassifier(), outputFile );
194 }
195 }
196 }
197 catch ( ArchiverException e )
198 {
199 failOnError( "ArchiverException: Error while creating archive", e );
200 }
201 catch ( IOException e )
202 {
203 failOnError( "IOException: Error while creating archive", e );
204 }
205 catch ( MavenReportException e )
206 {
207 failOnError( "MavenReportException: Error while creating archive", e );
208 }
209 catch ( RuntimeException e )
210 {
211 failOnError( "RuntimeException: Error while creating archive", e );
212 }
213 }
214
215
216
217
218
219
220
221
222 protected String getClassifier()
223 {
224 return "javadoc";
225 }
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240 private File generateArchive( File javadocFiles, String jarFileName )
241 throws ArchiverException, IOException
242 {
243 File javadocJar = new File( jarOutputDirectory, jarFileName );
244
245 if ( javadocJar.exists() )
246 {
247 javadocJar.delete();
248 }
249
250 MavenArchiver archiver = new MavenArchiver();
251 archiver.setArchiver( jarArchiver );
252 archiver.setOutputFile( javadocJar );
253
254 File contentDirectory = javadocFiles;
255 if ( !contentDirectory.exists() )
256 {
257 getLog().warn( "JAR will be empty - no content was marked for inclusion!" );
258 }
259 else
260 {
261 archiver.getArchiver().addDirectory( contentDirectory, DEFAULT_INCLUDES, DEFAULT_EXCLUDES );
262 }
263
264 List<Resource> resources = project.getBuild().getResources();
265
266 for ( Resource r : resources )
267 {
268 if ( r.getDirectory().endsWith( "maven-shared-archive-resources" ) )
269 {
270 archiver.getArchiver().addDirectory( new File( r.getDirectory() ) );
271 }
272 }
273
274 if ( useDefaultManifestFile && defaultManifestFile.exists() && archive.getManifestFile() == null )
275 {
276 getLog().info( "Adding existing MANIFEST to archive. Found under: " + defaultManifestFile.getPath() );
277 archive.setManifestFile( defaultManifestFile );
278 }
279
280 try
281 {
282
283 archive.setAddMavenDescriptor( false );
284 archiver.createArchive( project, archive );
285 }
286 catch ( ManifestException e )
287 {
288 throw new ArchiverException( "ManifestException: " + e.getMessage(), e );
289 }
290 catch ( DependencyResolutionRequiredException e )
291 {
292 throw new ArchiverException( "DependencyResolutionRequiredException: " + e.getMessage(), e );
293 }
294
295 return javadocJar;
296 }
297 }