Support for overriding out-of-the-box web resources and including 3rd party libs, #389

archetypes/alfresco-allinone-archetype/src/main/resources/META-INF/maven/archetype-metadata.xml

@@ -17,7 +17,7 @@
                 <fileSet filtered="false" packaged="false" encoding="UTF-8">
                     <directory>src/main/assembly</directory>
                     <includes>
-                        <include>**/*.xml</include>
+                        <include>**</include>
                     </includes>
                 </fileSet>
                 <fileSet filtered="true" packaged="true" encoding="UTF-8">
@@ -68,6 +68,12 @@
                 name="${rootArtifactId}-share-jar"
                 dir="__rootArtifactId__-share-jar" >
             <fileSets>
+                <fileSet filtered="false" packaged="false" encoding="UTF-8">
+                    <directory>src/main/assembly</directory>
+                    <includes>
+                        <include>**</include>
+                    </includes>
+                </fileSet>
                 <fileSet filtered="true" packaged="true" encoding="UTF-8">
                     <directory>src/main/java</directory>
                     <includes>

archetypes/alfresco-allinone-archetype/src/main/resources/archetype-resources/__rootArtifactId__-platform-jar/src/main/assembly/amp.xml

@@ -12,12 +12,38 @@
     <includeBaseDirectory>false</includeBaseDirectory>
 
     <files>
+        <!-- Filter module.properties and put at top level in the AMP -->
         <file>
             <source>src/main/resources/alfresco/module/${project.artifactId}/module.properties</source>
             <filtered>true</filtered>
         </file>
+        <!-- Include AMP -> WAR mapping file (needed for custom mappings) -->
+        <file>
+            <source>src/main/assembly/file-mapping.properties</source>
+            <filtered>false</filtered>
+        </file>
     </files>
 
+    <fileSets>
+        <!-- Anything in the assembly/lib directory will end up in the /lib directory in the AMP -->
+        <fileSet>
+            <directory>src/main/assembly/lib</directory>
+            <outputDirectory>lib</outputDirectory>
+            <excludes>
+                <exclude>README.md</exclude>
+            </excludes>
+        </fileSet>
+        <!-- Anything in the assembly/web directory will end up in the /web directory in the AMP -->
+        <fileSet>
+            <directory>src/main/assembly/web</directory>
+            <outputDirectory>web</outputDirectory>
+            <excludes>
+                <exclude>README.md</exclude>
+            </excludes>
+        </fileSet>
+    </fileSets>
+
+    <!-- Include the project artifact (JAR) in the /lib directory in the AMP -->
     <dependencySets>
         <dependencySet>
             <outputDirectory>lib</outputDirectory>

archetypes/alfresco-allinone-archetype/src/main/resources/archetype-resources/__rootArtifactId__-platform-jar/src/main/assembly/file-mapping.properties

@@ -0,0 +1,27 @@
+# Custom AMP to WAR location mappings
+
+#
+# The following property can be used to include the standard set of mappings.
+# The contents of this file will override any defaults.  The default is
+# 'true', i.e. the default mappings will be augmented or modified by values in
+# this file.
+#
+# Default mappings are:
+#
+# /config=/WEB-INF/classes
+# /lib=/WEB-INF/lib
+# /licenses=/WEB-INF/licenses
+# /web/jsp=/jsp
+# /web/css=/css
+# /web/images=/images
+# /web/scripts=/scripts
+# /web/php=/php
+#
+include.default=true
+
+#
+# Custom mappings.  If 'include.default' is false, then this is the complete set.
+# Map /web to / in AMP so we can override things like favicon.ico
+#
+/web=/
+

archetypes/alfresco-allinone-archetype/src/main/resources/archetype-resources/__rootArtifactId__-platform-jar/src/main/assembly/lib/README.md

@@ -0,0 +1,21 @@
+# 3rd party libraries (JARs) that should be included in WAR
+
+Put here any 3rd party libraries (JARs) that are needed by customizations, 
+but that are not part of the out-of-the-box libraries in the *alfresco/WEB-INF/lib* 
+directory. 
+
+**Note**. Module dependency needs to be set to amp for the libs to be applied by MMT:
+
+`
+<moduleDependency>
+    <groupId>${project.groupId}</groupId>
+    <artifactId>some-platform-jar</artifactId>
+    <version>${project.version}</version>
+    <type>amp</type>
+</moduleDependency>
+`
+  
+**Important**. If you need to use a library that is available out-of-the-box, then
+               include it as a *provided* dependency in the module.
+  
+ 

archetypes/alfresco-allinone-archetype/src/main/resources/archetype-resources/__rootArtifactId__-platform-jar/src/main/assembly/web/README.md

@@ -0,0 +1,22 @@
+# Web resources that should override out-of-the-box files
+
+Put here any web resources that should override out-of-the-box
+web resources, such as favicon.ico. They will then end up in the 
+*/web* directory in the AMP, and applied to the WAR, and override
+any existing web resources in the Alfresco.WAR.
+
+**Note**. Module dependency needs to be set to amp for the web resources to be applied by MMT:
+
+`
+<moduleDependency>
+    <groupId>${project.groupId}</groupId>
+    <artifactId>some-platform-jar</artifactId>
+    <version>${project.version}</version>
+    <type>amp</type>
+</moduleDependency>
+`
+   
+**Important**. New web resources should not be located here, but instead 
+               in the usual place in the *src/main/resources/META-INF/resources* directory.
+  
+ 

archetypes/alfresco-allinone-archetype/src/main/resources/archetype-resources/__rootArtifactId__-share-jar/pom.xml

@@ -30,7 +30,15 @@
             <groupId>org.alfresco.surf</groupId>
             <artifactId>spring-surf-api</artifactId>
         </dependency>
-
     </dependencies>
 
+    <build>
+        <plugins>
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-assembly-plugin</artifactId>
+            </plugin>
+        </plugins>
+    </build>
+
 </project>

archetypes/alfresco-allinone-archetype/src/main/resources/archetype-resources/__rootArtifactId__-share-jar/src/main/assembly/amp.xml

@@ -10,13 +10,40 @@
     </formats>
 
     <includeBaseDirectory>false</includeBaseDirectory>
+
     <files>
+        <!-- Filter module.properties and put at top level in the AMP -->
         <file>
-            <source>${project.basedir}/src/main/resources/alfresco/module/${project.artifactId}/module.properties</source>
+            <source>src/main/resources/alfresco/module/${project.artifactId}/module.properties</source>
             <filtered>true</filtered>
         </file>
+        <!-- Include AMP -> WAR mapping file (needed for custom mappings) -->
+        <file>
+            <source>src/main/assembly/file-mapping.properties</source>
+            <filtered>false</filtered>
+        </file>
     </files>
 
+    <fileSets>
+        <!-- Anything in the assembly/lib directory will end up in the /lib directory in the AMP -->
+        <fileSet>
+            <directory>src/main/assembly/lib</directory>
+            <outputDirectory>lib</outputDirectory>
+            <excludes>
+                <exclude>README.md</exclude>
+            </excludes>
+        </fileSet>
+        <!-- Anything in the assembly/web directory will end up in the /web directory in the AMP -->
+        <fileSet>
+            <directory>src/main/assembly/web</directory>
+            <outputDirectory>web</outputDirectory>
+            <excludes>
+                <exclude>README.md</exclude>
+            </excludes>
+        </fileSet>
+    </fileSets>
+
+    <!-- Include the project artifact (JAR) in the /lib directory in the AMP -->
     <dependencySets>
         <dependencySet>
             <outputDirectory>lib</outputDirectory>

archetypes/alfresco-allinone-archetype/src/main/resources/archetype-resources/__rootArtifactId__-share-jar/src/main/assembly/file-mapping.properties

@@ -0,0 +1,27 @@
+# Custom AMP to WAR location mappings
+
+#
+# The following property can be used to include the standard set of mappings.
+# The contents of this file will override any defaults.  The default is
+# 'true', i.e. the default mappings will be augmented or modified by values in
+# this file.
+#
+# Default mappings are:
+#
+# /config=/WEB-INF/classes
+# /lib=/WEB-INF/lib
+# /licenses=/WEB-INF/licenses
+# /web/jsp=/jsp
+# /web/css=/css
+# /web/images=/images
+# /web/scripts=/scripts
+# /web/php=/php
+#
+include.default=true
+
+#
+# Custom mappings.  If 'include.default' is false, then this is the complete set.
+# Map /web to / in AMP so we can override things like favicon.ico
+#
+/web=/
+

archetypes/alfresco-allinone-archetype/src/main/resources/archetype-resources/__rootArtifactId__-share-jar/src/main/assembly/lib/README.md

@@ -0,0 +1,19 @@
+# 3rd party libraries (JARs) that should be included in WAR
+
+Put here any 3rd party libraries (JARs) that are needed by customizations, 
+but that are not part of the out-of-the-box libraries in the *share/WEB-INF/lib* 
+directory. 
+
+**Note**. Module dependency needs to be set to amp for the libs to be applied by MMT:
+
+`
+<moduleDependency>
+    <groupId>${project.groupId}</groupId>
+    <artifactId>some-share-jar</artifactId>
+    <version>${project.version}</version>
+    <type>amp</type>
+</moduleDependency>
+`
+  
+**Important**. If you need to use a library that is available out-of-the-box, then
+               include it as a *provided* dependency in the module.

archetypes/alfresco-allinone-archetype/src/main/resources/archetype-resources/__rootArtifactId__-share-jar/src/main/assembly/web/README.md

@@ -0,0 +1,22 @@
+# Web resources that should override out-of-the-box files
+
+Put here any web resources that should override out-of-the-box
+web resources, such as favicon.ico. They will then end up in the 
+*/web* directory in the AMP, and applied to the WAR, and override
+any existing web resources in the Share.WAR.
+
+**Note**. Module dependency needs to be set to amp for the web resources to be applied by MMT:
+
+`
+<moduleDependency>
+    <groupId>${project.groupId}</groupId>
+    <artifactId>some-share-jar</artifactId>
+    <version>${project.version}</version>
+    <type>amp</type>
+</moduleDependency>
+`
+   
+**Important**. New web resources should not be located here, but instead 
+               in the usual place in the *src/main/resources/META-INF/resources/<module-id>/* directory.
+  
+ 

archetypes/alfresco-platform-jar-archetype/src/main/resources/META-INF/maven/archetype-metadata.xml

@@ -14,7 +14,7 @@
         <fileSet filtered="false" packaged="false" encoding="UTF-8">
             <directory>src/main/assembly</directory>
             <includes>
-                <include>**/*.xml</include>
+                <include>**</include>
             </includes>
         </fileSet>
         <fileSet filtered="true" packaged="true" encoding="UTF-8">

archetypes/alfresco-platform-jar-archetype/src/main/resources/archetype-resources/src/main/assembly/amp.xml

@@ -12,12 +12,38 @@
     <includeBaseDirectory>false</includeBaseDirectory>
 
     <files>
+        <!-- Filter module.properties and put at top level in the AMP -->
         <file>
             <source>src/main/resources/alfresco/module/${project.artifactId}/module.properties</source>
             <filtered>true</filtered>
         </file>
+        <!-- Include AMP -> WAR mapping file (needed for custom mappings) -->
+        <file>
+            <source>src/main/assembly/file-mapping.properties</source>
+            <filtered>false</filtered>
+        </file>
     </files>
 
+    <fileSets>
+        <!-- Anything in the assembly/lib directory will end up in the /lib directory in the AMP -->
+        <fileSet>
+            <directory>src/main/assembly/lib</directory>
+            <outputDirectory>lib</outputDirectory>
+            <excludes>
+                <exclude>README.md</exclude>
+            </excludes>
+        </fileSet>
+        <!-- Anything in the assembly/web directory will end up in the /web directory in the AMP -->
+        <fileSet>
+            <directory>src/main/assembly/web</directory>
+            <outputDirectory>web</outputDirectory>
+            <excludes>
+                <exclude>README.md</exclude>
+            </excludes>
+        </fileSet>
+    </fileSets>
+
+    <!-- Include the project artifact (JAR) in the /lib directory in the AMP -->
     <dependencySets>
         <dependencySet>
             <outputDirectory>lib</outputDirectory>

archetypes/alfresco-platform-jar-archetype/src/main/resources/archetype-resources/src/main/assembly/file-mapping.properties

@@ -0,0 +1,27 @@
+# Custom AMP to WAR location mappings
+
+#
+# The following property can be used to include the standard set of mappings.
+# The contents of this file will override any defaults.  The default is
+# 'true', i.e. the default mappings will be augmented or modified by values in
+# this file.
+#
+# Default mappings are:
+#
+# /config=/WEB-INF/classes
+# /lib=/WEB-INF/lib
+# /licenses=/WEB-INF/licenses
+# /web/jsp=/jsp
+# /web/css=/css
+# /web/images=/images
+# /web/scripts=/scripts
+# /web/php=/php
+#
+include.default=true
+
+#
+# Custom mappings.  If 'include.default' is false, then this is the complete set.
+# Map /web to / in AMP so we can override things like favicon.ico
+#
+/web=/
+

archetypes/alfresco-platform-jar-archetype/src/main/resources/archetype-resources/src/main/assembly/lib/README.md

@@ -0,0 +1,21 @@
+# 3rd party libraries (JARs) that should be included in WAR
+
+Put here any 3rd party libraries (JARs) that are needed by customizations, 
+but that are not part of the out-of-the-box libraries in the *alfresco/WEB-INF/lib* 
+directory. 
+
+**Note**. Module dependency needs to be set to amp for the libs to be applied by MMT:
+
+`
+<moduleDependency>
+    <groupId>${project.groupId}</groupId>
+    <artifactId>some-platform-jar</artifactId>
+    <version>${project.version}</version>
+    <type>amp</type>
+</moduleDependency>
+`
+  
+**Important**. If you need to use a library that is available out-of-the-box, then
+               include it as a *provided* dependency in the module.
+  
+ 

archetypes/alfresco-platform-jar-archetype/src/main/resources/archetype-resources/src/main/assembly/web/README.md

@@ -0,0 +1,22 @@
+# Web resources that should override out-of-the-box files
+
+Put here any web resources that should override out-of-the-box
+web resources, such as favicon.ico. They will then end up in the 
+*/web* directory in the AMP, and applied to the WAR, and override
+any existing web resources in the Alfresco.WAR.
+
+**Note**. Module dependency needs to be set to amp for the web resources to be applied by MMT:
+
+`
+<moduleDependency>
+    <groupId>${project.groupId}</groupId>
+    <artifactId>some-platform-jar</artifactId>
+    <version>${project.version}</version>
+    <type>amp</type>
+</moduleDependency>
+`
+   
+**Important**. New web resources should not be located here, but instead 
+               in the usual place in the *src/main/resources/META-INF/resources* directory.
+  
+ 

archetypes/alfresco-share-jar-archetype/src/main/resources/META-INF/maven/archetype-metadata.xml

@@ -14,7 +14,7 @@
         <fileSet filtered="false" packaged="false" encoding="UTF-8">
             <directory>src/main/assembly</directory>
             <includes>
-                <include>**/*.xml</include>
+                <include>**</include>
             </includes>
         </fileSet>
         <fileSet filtered="true" packaged="true" encoding="UTF-8">

archetypes/alfresco-share-jar-archetype/src/main/resources/archetype-resources/src/main/assembly/amp.xml

@@ -10,13 +10,40 @@
     </formats>
 
     <includeBaseDirectory>false</includeBaseDirectory>
+
     <files>
+        <!-- Filter module.properties and put at top level in the AMP -->
         <file>
-            <source>${project.basedir}/src/main/resources/alfresco/module/${project.artifactId}/module.properties</source>
+            <source>src/main/resources/alfresco/module/${project.artifactId}/module.properties</source>
             <filtered>true</filtered>
         </file>
+        <!-- Include AMP -> WAR mapping file (needed for custom mappings) -->
+        <file>
+            <source>src/main/assembly/file-mapping.properties</source>
+            <filtered>false</filtered>
+        </file>
     </files>
 
+    <fileSets>
+        <!-- Anything in the assembly/lib directory will end up in the /lib directory in the AMP -->
+        <fileSet>
+            <directory>src/main/assembly/lib</directory>
+            <outputDirectory>lib</outputDirectory>
+            <excludes>
+                <exclude>README.md</exclude>
+            </excludes>
+        </fileSet>
+        <!-- Anything in the assembly/web directory will end up in the /web directory in the AMP -->
+        <fileSet>
+            <directory>src/main/assembly/web</directory>
+            <outputDirectory>web</outputDirectory>
+            <excludes>
+                <exclude>README.md</exclude>
+            </excludes>
+        </fileSet>
+    </fileSets>
+
+    <!-- Include the project artifact (JAR) in the /lib directory in the AMP -->
     <dependencySets>
         <dependencySet>
             <outputDirectory>lib</outputDirectory>

archetypes/alfresco-share-jar-archetype/src/main/resources/archetype-resources/src/main/assembly/file-mapping.properties

@@ -0,0 +1,27 @@
+# Custom AMP to WAR location mappings
+
+#
+# The following property can be used to include the standard set of mappings.
+# The contents of this file will override any defaults.  The default is
+# 'true', i.e. the default mappings will be augmented or modified by values in
+# this file.
+#
+# Default mappings are:
+#
+# /config=/WEB-INF/classes
+# /lib=/WEB-INF/lib
+# /licenses=/WEB-INF/licenses
+# /web/jsp=/jsp
+# /web/css=/css
+# /web/images=/images
+# /web/scripts=/scripts
+# /web/php=/php
+#
+include.default=true
+
+#
+# Custom mappings.  If 'include.default' is false, then this is the complete set.
+# Map /web to / in AMP so we can override things like favicon.ico
+#
+/web=/
+

archetypes/alfresco-share-jar-archetype/src/main/resources/archetype-resources/src/main/assembly/lib/README.md

@@ -0,0 +1,19 @@
+# 3rd party libraries (JARs) that should be included in WAR
+
+Put here any 3rd party libraries (JARs) that are needed by customizations, 
+but that are not part of the out-of-the-box libraries in the *share/WEB-INF/lib* 
+directory. 
+
+**Note**. Module dependency needs to be set to amp for the libs to be applied by MMT:
+
+`
+<moduleDependency>
+    <groupId>${project.groupId}</groupId>
+    <artifactId>some-share-jar</artifactId>
+    <version>${project.version}</version>
+    <type>amp</type>
+</moduleDependency>
+`
+  
+**Important**. If you need to use a library that is available out-of-the-box, then
+               include it as a *provided* dependency in the module.

archetypes/alfresco-share-jar-archetype/src/main/resources/archetype-resources/src/main/assembly/web/README.md

@@ -0,0 +1,22 @@
+# Web resources that should override out-of-the-box files
+
+Put here any web resources that should override out-of-the-box
+web resources, such as favicon.ico. They will then end up in the 
+*/web* directory in the AMP, and applied to the WAR, and override
+any existing web resources in the Share.WAR.
+
+**Note**. Module dependency needs to be set to amp for the web resources to be applied by MMT:
+
+`
+<moduleDependency>
+    <groupId>${project.groupId}</groupId>
+    <artifactId>some-share-jar</artifactId>
+    <version>${project.version}</version>
+    <type>amp</type>
+</moduleDependency>
+`
+   
+**Important**. New web resources should not be located here, but instead 
+               in the usual place in the *src/main/resources/META-INF/resources/<module-id>/* directory.
+  
+