Added: websites/production/maven/content/plugins-archives/maven-remote-resources-plugin-1.5/supplemental-models.html ============================================================================== --- websites/production/maven/content/plugins-archives/maven-remote-resources-plugin-1.5/supplemental-models.html (added) +++ websites/production/maven/content/plugins-archives/maven-remote-resources-plugin-1.5/supplemental-models.html Sun Sep 1 11:14:08 2013 @@ -0,0 +1,279 @@ + + + + + Apache Maven Remote Resources Plugin - Supplementing Missing POM Information + + + + + + + + + + + + + + +
+ +
+
+
+

Supplementing Missing POM Information

Note: This feature was added in version 1.0-alpha-5.

One of Maven's great strengths is that it allows you, the user, to build directly on the work of others with minimal effort. For instance, by adding five lines (or less) to your POM, you can declare a dependency on someone else's library, and instruct Maven to use that library during the build for your own project. Since the library's JAR is usually accompanied by a POM of its own, your project doesn't need to provide an exhaustive listing of all libraries used by all of your direct dependencies.

However, this approach of reusing POM metadata from your dependencies can be inhibited by a dependency POM that provides less-than-complete information about its project. While most POMs provide reasonably accurate information about their dependencies, they sometimes leave out some information critical to assembling licensing and dependency notice files.

For example, the templates used by many Apach e distributions assemble a listing of project dependencies according to their organization name (and URL), along with the URL each project's website. When dependency POMs are missing this information, the dependency notice file that the Remote Resources Plugin renders can be invalid.

To compensate for incomplete dependency POMs, you can use the supplemental models support, introduced to the Remote Resources Plugin in version 1.0-alpha-5, and improved in version 1.1.

Fixing Incomplete POMs: Using Supplemental Models

For those cases where your project's dependencies don't list organization name, organization URL, project URL, or whatever other metadata you require for you legal notice files, the Remote Resources Plugin allows you to configure a series of supplemental models. These models consist of one or more model files, each of which contains one or more POM fragments that can b e merged into existing dependency POMs to supplement the metadata provided there. The plugin uses the key groupId:artifactId to match each supplemental model with the dependency POM into which it should be merged.

For example, imagine that your project's POM has declared the following two dependencies:

    <dependency>
+      <groupId>org.foo</groupId>
+      <artifactId>missing-org-info</artifactId>
+      <version>1</version>
+    </dependency>
+    <dependency>
+      <groupId>org.foo</groupId>
+      <artifactId>missing-project-url</artifactId>
+      <version>1</version>
+    </dependency>
+

Now imagine that your project needs to include a file in its distribution that lists organization and project URLs for each dependency, in a format like this:

From: Apache Software Foundation (http://www.apache.org/)
+
+ - Commons FOO (http://commons.apache.org/foo/) org.apache.commons.foo:foo:1
+ - Commons BAR (http://commons.apache.org/bar/) org.apache.commons.bar:bar:1
+

However, as you try generating these licensing resources for your project, you quickly learn that your dependencies provide POMs that don't always include all the information needed by this format. The first dependency is missing all of the information provided by the organization element of the POM, and the second is missing a project- specific URL (the url element of the POM).

To fix these omissions for the purposes of resource generation, we can simply provide a supplemental-model file that contains the missing information. The file, located at src/main/appended-resources/supplemental-models.xml, would look something like this:

<?xml version="1.0" encoding="UTF-8"?>
+<supplementalDataModels xmlns="http://maven.apache.org/supplemental-model/1.0.0"
+                        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+                        xsi:schemaLocation="http://maven.apache.org/supplemental-model/1.0.0 http://maven.apache.org/xsd/supplemental-model-1.0.0.xsd">
+  <supplement>
+    <project>
+      <groupId>org.foo</groupId>
+      <artifactId>missing-org-info</artifactId>
+      
+      <organization>
+        <name>FOO, Inc.</name>
+        <url>http://www.foo.org/</url>
+      </organization>
+    </project>
+  </supplement>
+  <supplement>
+    <project>
+      <groupId>org.foo</groupId>
+      <artifactId>missing-project-url</artifactId>
+      
+      <url>http://www.foo.org/projects/missing-project-url/</url>
+    </project>
+  </supplement>
+</supplementalDataModels>
+

Finally, we tell the Remote Resources Plugin to use the new supplemental-model file:

      <plugin>
+        <artifactId>maven-remote-resources-plugin</artifactId>
+        <version>1.5</version>
+        <executions>
+          <execution>
+            <id>process-remote-resources</id>
+            <goals>
+              <goal>process</goal>
+            </goals>
+            <configuration>
+              <supplementalModels>
+                <supplementalModel>supplemental-models.xml</supplementalModel>
+              </supplementalModels>
+              [...]
+            </configuration>
+          </execution>
+        </executions>
+      </plugin>
+

After re-running the project build, the supplemental information we provided will be merged with the metadata from the dependency POMs, providing enough information to complete the dependencies listing.

Publishing and Reusing Supplemental Models

Note: This feature was added in version 1.1.

The configuration above is fine for single projects that need to address deficiencies in their dependencies' metadata. But what happens when your organization wants to use these same deficient dependencies across multiple projects? The configuration we just examined cannot handle reuse of supplemental-model files.

To address this shortcoming, version 1.1 of the Remote Resources Plugin introduces a new parameter: supplementalModelArtifacts. When combined with the supplementalModels parameter used above, this new parameter allows the Remote Resources P lugin to resolve artifacts containing supplemental model information, then search those artifacts for the paths given in the supplementalModels listing.

To make the supplemental models above reusable using this mechanism, we first publish them in their own project:

<?xml version="1.0" encoding="UTF-8"?>
+<project xmlns="http://maven.apache.org/POM/4.0.0"
+         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+  <modelVersion>4.0.0</modelVersion>
+  
+  <groupId>org.myco</groupId>
+  <artifactId>dependency-resource-supplement</artifactId>
+  <version>1</version>
+</project>
+

Note that this is just a simple, unadorned JAR artifact. We then move the above POM and supplemental-models.xml file into a separate project directory structure:

|-- pom.xml
+`-- src
+    `-- main
+        `-- resources
+            `-- supplemental-models.xml
+

Once we install this new project, we can reference it from the configuration for the Remote Resources Plugin, like this:

      <plugin>
+        <artifactId>maven-remote-resources-plugin</artifactId>
+        <version>1.5</version>
+        <executions>
+          <execution>
+            <id>process-remote-resources</id>
+            <goals>
+              <goal>process</goal>
+            </goals>
+            <configuration>
+              <!-- Reference the supplemental-model artifact from above -->
+              <supplementalModelArtifacts>
+                <supplementalModelArtifact>org.myco:dependency-resource-supplement:1</supplementalModelArtifact>
+              </supplementalModelArtifacts>
+
+              <!-- Specify the path, relative to the JAR root, where the supplemental model file is located -->
+              <supplementalModels>
+                <supplementalModel>supplemental-models.xml</supplementalModel>
+              </supplementalModels>
+              [...]
+            </configuration>
+          </execution>
+        </executions>
+      </plugin>
+

Once the supplemental-model project is released and deployed, any number of projects can then make use of the supplemental information it provides.

+
+
+
+
+
+ + + \ No newline at end of file Added: websites/production/maven/content/plugins-archives/maven-remote-resources-plugin-1.5/surefire-report.html ============================================================================== --- websites/production/maven/content/plugins-archives/maven-remote-resources-plugin-1.5/surefire-report.html (added) +++ websites/production/maven/content/plugins-archives/maven-remote-resources-plugin-1.5/surefire-report.html Sun Sep 1 11:14:08 2013 @@ -0,0 +1,236 @@ + + + + + Apache Maven Remote Resources Plugin - Surefire Report + + + + + + + + + + + + +
+ +
+
+
+

Surefire Report

Summary

[Summary] [Package List] [Test Cases]


TestsErrors FailuresSkippedSuccess RateTime
10000100%2.557

Note: failures are anticipated and checked for with assertions while errors are unanticipated.


Package List

[Summary] [Package List] [Test Cases]


PackageTestsErrors FailuresSkippedSuccess RateTime
org.apache.maven.plugin.resources.remote10000100%2.557

Note: package statistics are not computed recursively, they only sum up all of its testsuites numbers.

org.apache.maven.plugin.resources.remote

ClassTestsErrors FailuresSkippedSuccess RateTime
RemoteResourcesMojoTest10000100%2.557

Test Cases

[Summary] [Package List] [Test Cases]

RemoteResourcesMojoTest

testTestEnvironment0.951
testNoBundles0.618
testCreateBundle0.031
testSimpleBundles0.168
testSimpleBundlesWithType0.113
testSimpleBundlesWithClassifier0.099
testVelocityUTF80.122
testVelocityISO885910.142
testFilteredBundles0.163
testFilteredBundlesWithProjectProperties0.15

+
+
+
+
+
+ + + \ No newline at end of file Added: websites/production/maven/content/plugins-archives/maven-remote-resources-plugin-1.5/taglist.html ============================================================================== --- websites/production/maven/content/plugins-archives/maven-remote-resources-plugin-1.5/taglist.html (added) +++ websites/production/maven/content/plugins-archives/maven-remote-resources-plugin-1.5/taglist.html Sun Sep 1 11:14:08 2013 @@ -0,0 +1,220 @@ + + + + + Apache Maven Remote Resources Plugin - Tag List report + + + + + + + + + + + + +
+ +
+
+
+

Tag List Report

The following document contains the listing of user tags found in the code. Below is the summary of the occurrences per tag.

Tag ClassTotal number of occurrencesTag strings used by tag class
@todo0@todo
TODO3TODO

Each tag is detailed below:

TODO

Number of occurrences found in the code: 3

org.apache.maven.plugin.resources.remote.ProcessRemoteResourcesMojoLine
- really should use the resource includes/excludes and name mapping828
org.apache.maven.plugin.resources.remote.stub.MavenProjectBuildStubLine
handle exception299
handle exception here337
+
+
+
+
+
+ + + \ No newline at end of file Added: websites/production/maven/content/plugins-archives/maven-remote-resources-plugin-1.5/team-list.html ============================================================================== --- websites/production/maven/content/plugins-archives/maven-remote-resources-plugin-1.5/team-list.html (added) +++ websites/production/maven/content/plugins-archives/maven-remote-resources-plugin-1.5/team-list.html Sun Sep 1 11:14:08 2013 @@ -0,0 +1,288 @@ + + + + + Apache Maven Remote Resources Plugin - Team list + + + + + + + + + + + + +
+ +
+
+
+

The Team

A successful project requires many people to play many roles. Some members write code or documentation, while others are valuable as testers, submitting patches and suggestions.

The team is comprised of Members and Contributors. Members have direct access to the source of a project and actively evolve the code-base. Contributors improve the project through submission of patches and suggestions to the Members. The number of Contributors to the project is unbounded. Get involved today. All contributions to the project are greatly appreciated.

Members

The following is a list of developers with commit privileges that have directly contributed to the project in one way or another.

ImageIdNameEmailOrganizationRo lesTime ZoneActual Time (GMT)
olamyOlivier Lamyolamy@apache.org-PMC ChairEurope/ParisEurope/Paris
aheritierArnaud Héritieraheritier@apache.org-PMC Member+1+1
baerrachBarrie Treloarbaerrach@apache.org-PMC MemberAustralia/AdelaideAustralia/Adelaide
bimarguliesBenson Marguliesbimargulies@apache.org-PMC MemberAmerica/New_YorkAmerica/New_York
brettBrett Porterbrett@apache.orgASFPMC Member+10+10
brianfBrian Foxbrianf@apache.orgSonatypePMC Member-5-5
carlosCarlos Sanchezcarlos@apache.orgASFPMC Member+1+1
dennislDennis Lundbergdennisl@apache.orgASFPMC Member+1+1
dfabulichDaniel Fabulichdfabulich@apache.org-PMC Member-8-8
dkulpDaniel Kulpdkulp@apache.orgASFPMC Member-5-5
evenisseEmmanuel Venisseevenisse@apache.orgASFPMC Member+1+1
hboutemyHervé Boutemyhboutemy@apache.orgASFPMC MemberEurope/ParisEurope/Paris
jdcaseyJohn Caseyjdcasey@apache.orgASFPMC Member-5-5
krosenvoldKristian Rosenvoldkrosenvold@apache.org-PMC Member+1+1
markhMark Hobsonmarkh@apache.org-PMC Member00
mkleintMilos Kleint--PMC Member--
ochingMaria Odea B. Ching--PMC Member--
pgierPaul Gierpgier@apache.orgRed HatPMC Member-6-6
rfscholteRobert Scholterfscholte@apache.org-PMC MemberEurope/AmsterdamEurope/Amsterdam
rgoersRalph Goersrgoers@apache.orgIntuitPMC Member-8-8
snicollStephane Nicollsnicoll@apache.orgASFPMC Member+1+1
stephencStephen Connollystephenc@apache.org-PMC Member00
strubergMark Strubergstruberg@apache.org-PMC Member--
vsivetonVincent Sivetonvsiveton@apache.orgASFPMC Member-5-5
wfayWayne Faywfay@apache.orgASFPMC Member-6-6
andhamAnders Hammarandham@apache.org-Committer+1+1
bdemersBrian Demersbdemers@apache.orgSonatypeCommitter-5-5
bellingardFabrice Bellingard--Committer--
bentmannBenjamin Bentmannbentmann@apache.orgSonatypeCommitter+1+1
cstamasTamas Cservenakcstamas@apache.orgSonatypeCommitter+1+1
dantranDan Tran--Committer --
dbradicichDamian Bradicichdbradicich@apache.orgSonatypeCommitter-5-5
fgiustFabrizio Giustinafgiust@apache.orgopenmindCommitter+1+1
godinEvgeny Mandrikovgodin@apache.orgSonarSourceCommitter+3+3
handyandeAndrew Williamshandyande@apache.org-Committer00
ifedorenkoIgor Fedorenkoigor@ifedorenko.comSonatypeCommitter-5-5
jjensenJeff Jensen--Committer--
jvanzylJason van Zyl--Committer-5-5
ltheusslLukas Theusslltheussl@apache.org-Committer+1+1
mauroM auro Talevi--Committer--
nicolasNicolas de Loof--Committer--
rafaleRaphaël Piéronirafale@apache.orgDexemCommitter+1+1
simonetripodiSimone Tripodisimonetripodi@apache.org-Committer+1+1
tchemitTony Chemittchemit@apache.orgCodeLutinCommitterEurope/ParisEurope/Paris
vmassolVincent Massolvmassol@apache.orgASFCommitter+1+1
aramirezAllan Q. Ramirez--Emeritus--
bayardHenri Yandell--Emeritus--
chrisjsChris Stevenson--Emeritus--
dblevinsDavid Blevins--Emeritus--
dlrDaniel Rall--Emeritus--
epunzalanEdwin Punzalanepunzalan@apache.org-Emeritus-8-8
felipealFelipe Leme--Emeritus--
jmcconnellJesse McConnelljmcconnell@apache.orgASFEmeritus-6-6
joakimeJoakim Erdfeltjoakime@apache.orgASFEmeritus-5-5
jstrachanJames Strachan--Emeritus--
jtolentinoErnesto Tolentino Jr.jtolentino@apache.orgASFEmeritus+8+8
mperhamMike Perhammperham@gmail.comIBMEmeritus-6-6
ogusakovOleg Gusakov--Emeritus--
pschneiderPatrick Schneiderpschneider@gmail.com-Emeritus-6-6
ptahchievPetar Tahchievptahchiev@apache.org-Emeritus+2+2
rinkuRahul Thakur--Emeritus--
shinobuShinobu Kuwai--Emeritus--
smorgravTorbjorn Eikli Smorgrav--Emeritus--
trygvisTrygve Laugstoltrygvis@apache.orgASFEmeritus+1+1
wsmoakWendy Smoakwsmoak@apache.org-Emeritus-7-7
jruizJohnny Ruiz IIIjruiz@apache.org-Emeritus--
kenneyKenney Westerhofkenney@apache.orgNeonicsEmeritus+1+1< /span>

Contributors

There are no contributors listed for this project. Please check back again later.

+
+
+
+
+
+ + + \ No newline at end of file Added: websites/production/maven/content/plugins-archives/maven-remote-resources-plugin-1.5/testapidocs/allclasses-frame.html ============================================================================== --- websites/production/maven/content/plugins-archives/maven-remote-resources-plugin-1.5/testapidocs/allclasses-frame.html (added) +++ websites/production/maven/content/plugins-archives/maven-remote-resources-plugin-1.5/testapidocs/allclasses-frame.html Sun Sep 1 11:14:08 2013 @@ -0,0 +1,64 @@ + + + + + + +All Classes (Apache Maven Remote Resources Plugin 1.5 Test API) + + + + + + + + + + +All Classes +
+ + + + + +
AbstractIT +
+ArtifactStub +
+BootstrapInstaller +
+IT_BadDependencyPoms +
+IT_CustomFilterDelimiter +
+IT_FilterLocalOverride +
+IT_GenerateFromBundle +
+IT_GenerateFromBundleWithTypeAndClassifier +
+IT_GenerateFromOverride +
+IT_GetDependencyProjects +
+IT_RunOnlyAtExecutionRoot +
+IT_SupplementalArtifact +
+MavenProjectBasicStub +
+MavenProjectBuildStub +
+MavenProjectResourcesStub +
+ModelStub +
+RemoteResourcesMojoTest +
+TestUtils +
+
+ + + \ No newline at end of file