Commit e8d52cb9 authored by mindthegab's avatar mindthegab
Browse files

-- having single sourced pom properties allow us to do 

archetype generation time filtering

git-svn-id: http://maven-alfresco-archetypes.googlecode.com/svn/trunk/maven-alfresco-archetypes/maven-alfresco-amp-archetype@29 04253f4f-3451-0410-a141-5562f1e59037
parents

pom.xml

0 → 100644
+40 −0
Original line number Diff line number Diff line 
<?xml version="1.0" encoding="UTF-8"?>

<!--

	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.

	

-->

<project>

  <modelVersion>4.0.0</modelVersion>

  <groupId>com.sourcesense.alfresco</groupId>

  <artifactId>maven-alfresco-amp-archetype</artifactId>

  <packaging>maven-archetype</packaging>

  <name>Maven Alfresco Amp Archetype</name>

  <version>1.0.0-SNAPSHOT</version>

  <parent>

		<groupId>com.sourcesense.alfresco</groupId>

		<artifactId>maven-alfresco-archetypes</artifactId>

		<version>1.0-SNAPSHOT</version>

  </parent>

  <build>

    <extensions>

      <extension>

        <groupId>org.apache.maven.archetype</groupId>

        <artifactId>archetype-packaging</artifactId>

        <version>2.0-alpha-3</version>

      </extension>

    </extensions>

  </build>

</project>
 
 No newline at end of file

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

0 → 100644
+70 −0
Original line number Diff line number Diff line 
<?xml version="1.0" encoding="UTF-8"?><archetype-descriptor name="demoamp">

<!--

	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.

	

-->

  <fileSets>

    <fileSet filtered="true" packaged="true" encoding="UTF-8">

      <directory>src/main/java</directory>

      <includes>

        <include>**/*.java</include>

      </includes>

    </fileSet>

    <fileSet filtered="true" encoding="UTF-8">

      <directory>src/main/webapp</directory>

      <includes>

        <include>**/*.txt</include>

        <include>**/*.jsp</include>

      </includes>

    </fileSet>

    <fileSet filtered="true" encoding="UTF-8">

      <directory>src/main/resources</directory>

      <includes>

        <include>**/*.xml</include>

        <include>**/*.properties</include>

      </includes>

    </fileSet>

    <fileSet encoding="UTF-8">

      <directory>src/main/webapp</directory>

      <includes>

        <include>**/*.js</include>

        <include>**/*.gif</include>

        <include>**/*.css</include>

      </includes>

    </fileSet>

    <fileSet filtered="true" encoding="UTF-8">

      <directory>src/test/properties</directory>

      <includes>

        <include>**/*.properties</include>

      </includes>

    </fileSet>

    <fileSet filtered="true" encoding="UTF-8">

      <directory>src/test/resources</directory>

      <includes>

        <include>**/*.xml</include>

        <include>**/*.properties</include>

      </includes>

    </fileSet>

    <fileSet filtered="true" encoding="UTF-8">

      <directory></directory>

      <includes>

        <include>module.properties</include>

        <include>README.txt</include>

        <include>TODO.txt</include>

      </includes>

    </fileSet>

  </fileSets>

</archetype-descriptor>
 
 No newline at end of file

src/main/resources/META-INF/maven/archetype.xml

0 → 100644
+44 −0
Original line number Diff line number Diff line 
<?xml version="1.0" encoding="UTF-8"?>

<!--

	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.

	

-->

<archetype>

  <id>maven-alfresco-amp-archetype</id>

  <sources>

    <source>src/main/java/Demo.java</source>

    <source>src/main/java/DemoComponent.java</source>

  </sources>

  <resources>

    <resource>src/main/resources/alfresco/module/org.alfresco.module.demoamp/context/service-context.xml</resource>

    <resource>src/main/resources/alfresco/module/org.alfresco.module.demoamp/log4j.properties</resource>

    <resource>src/main/resources/alfresco/module/org.alfresco.module.demoamp/module-context.xml</resource>

    <resource>src/main/webapp/css/demoamp.css</resource>

    <resource>src/main/webapp/images/sourcesense.gif</resource>

    <resource>src/main/webapp/jsp/demoamp.jsp</resource>

    <resource>src/main/webapp/licenses/README-licenses.txt</resource>

    <resource>src/main/webapp/scripts/demoamp.js</resource>

    <resource>module.properties</resource>

    <resource>README.txt</resource>

    <resource>TODO.txt</resource>

  </resources>

  <testResources>

    <resource>src/test/properties/local/application.properties</resource>

    <resource>src/test/resources/alfresco/extension/custom-repository-context.xml</resource>

    <resource>src/test/resources/alfresco/extension/file-servers-custom.xml</resource>

    <resource>src/test/resources/log4j.properties</resource>

  </testResources>

</archetype>
 
 No newline at end of file

src/main/resources/archetype-resources/README.txt

0 → 100644
+129 −0
Original line number Diff line number Diff line 
======================================================================

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.

======================================================================





---------------------------------------

Archetype Release: Archetype - maven-amp-archetype

Author: g.columbro@sourcesense.com

http://forge.alfresco.com/m2alfresco



Contacts: 

- alfresco-dev@lists.sourcesense.com (developer)

- alfresco@sourcesense.com (commercial)



See Also:

http://wiki.alfresco.com/wiki/Module_Management_Tool

-----------------------------------------------------







M2 Instructions for Alfresco AMP:

--------------------------------



The project can be built using Maven2.





Alfresco maven2 AMP build

-------------------------





One command quickstart:

$ MAVEN_OPTS="-Xms256m -Xmx512m -XX:PermSize=128m" mvn  clean integration-test -P webapp 



Runs the jetty embedded with overlayed the currently developed AMP





FEATURES:

---------



- AMP customized build : 										 mvn clean package

- AMP dependencies management: 									'mvn clean package' can take care of overlay deps

- Alfresco webapp integration via war creation					 mvn clean package -P webapp

- jetty embedded build for fast testing,						 mvn clean integration-test -P webapp

- install/deployment of Alfresco compatible AMPs on a m2 repo    mvn install / deploy  [ params ]



- using the maven-amp-plugin (http://forge.alfresco.com/maven4alfresco) WAR can depend on AMP artifacts and have them overlayed within the maven

lifecycle, avoiding the boring MMT run.



Specific dependencies and different Alfresco versions can be specified in 'webapp' profile dependecies. Alfresco test webapp is overlayed (apart with 

all AMP and WAR dependencies specified) also with a sensible default 'alfresco/extension' folder to have a clean safe reproduceable and portable 

default alfresco run. Find these test configuaration files in 'src/test/resources' and environment dependent properties in src/test/properties/<env>/application.properties





SOON TO COME:

------------



- Shared configuration (site + release + plugin config) with maven-alfresco-extension-archetype via super POM 





PROJECT LAYOUT

--------------



src --------------------------------------------------------> (source folder)

		|

		|__ main ___ __ resources --------------------------> mapped in the classpath  (alfresco module config goes here, as well as other classpath resources) 

		|			|			  |							  NB: best practice groupId.artifactId=moduleId is used by the archetype and by the AMP unpacker

		|			|			  |__ ex: alfresco/module/com.sourcesense.${artifactId} ---> Example Alfresco module config 

		|			|

		|			|

		|			|__ java ------------------------------->  customization java classes

		|			|

		|			|__ webapp -----------------------------> AMP overlay folder - this folder is overlayed (so may overwrite other dependent AMPs)



		|			

		|__ test __ __ resources 

						  |

		|			|	  |__ alfresco/extension ---> alfresco overriding Spring contexts

		|			|__ properties ------------------------->  environment aware application properties files  

		|			|			  |

		|			|			  |__ local  ------------->  default application.properties

		|			|



target - Project build dir





FAQ:

----

--- Eclipse configuration

-Run ' mvn eclipse:eclipse ' 

-hit "Refresh" on your Eclipse project



--- Db access problems:

Remember to setup appropriate permissions for selected db / build profile.

You can either edit accordingly and then run: mysql -u root < tools/mysql/db_setup.sql 



or if you use POM property 'alfresco.db.name' you have sql files already filtered (after process-resources phase) in



mysql -u root -p < target/classes/tools/[db_setup,db_remove].sql   



--- Out of memory errors:

Run your build with :

MAVEN_OPTS="-Xms256m -Xmx512m -XX:PermSize=128m" mvn ... ...



--- Content integrity errors on restore running with jetty embedded

Did you remove also alf_data_jetty apart from the alf_jetty db ?



--- Release Problems with LC_ALL

If underlying svn complains about LC_ALL variable please consider running your release prepending:

LC_ALL="C"  (macosx environments, see http://svn.haxx.se/users/archive-2006-07/0320.shtml)



-- Deploy a generally available AMP into a maven repo for dependency usage



mvn deploy:deploy-file -DrepositoryId=repo

-Dfile=/Users/youruser/projectz/alfresco/alfresco-recordsmanagement-2.1.0.amp 

-DgroupId=org.alfresco.community -DartifactId=recordsmanagement -Dversion=2.1.0 

-Dpackaging=amp -Durl=scp://...
 
 No newline at end of file

src/main/resources/archetype-resources/TODO.txt

0 → 100644
+42 −0
Original line number Diff line number Diff line 
======================================================================

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.

======================================================================



Known Issues:

-------------







MAJOR:

- maven-amp-plugin filtering broken





MINOR:

- cannot use maven SNAPSHOT versioning as it's copied over in the module.properties

file and not accepted by alfresco as valid module version number





TRIVIAL:

- Slighly different deployment for AMP and test WAR. In the test jetty

war java classes are *not* packed in the war as in the AMP specification,

but this *must* not have functional impacts on the application



IMPROVEMENTS:

- maven-amp-plugin is *heavily* redundant. must be simplified to package an 

amp and process overlays

- maven-amp-plugin could read maven dependencies and turn them into

module dependencies in module.properties

- maven-sql-plugin to autocreate jetty db