Hacking Maven Archiva

- So, you wanna start hacking away at Archiva huh? -

- -

- These pages are for you! -

- -

- Be sure to read the sections for Database, Configuration, and - Concepts. Beyond that, the - Javadoc - is your friend. -

- -

- Developer reference docs for the latest snapshot - can be found starting - here. -

- -

- If you don't see the topic covered here, ask! Ask in the - archiva-dev mailing list, - or in the #archiva - irc channel. -

- - -

- First, you'll need the source code. It is stored in subversion on - the public svn.apache.org site. You can use the - basic subversion access steps, - or follow the steps below... -

- -

-[code]$ svn checkout http://svn.apache.org/repos/asf/maven/archiva/trunk archiva
-A    archiva/archiva-database
-A    archiva/archiva-database/src
-A    archiva/archiva-database/src/test
-A    archiva/archiva-database/src/test/java
-... (snip hundreds of checkout entries) ...
-A    archiva/archiva-scheduled/src/main/resources/META-INF/plexus
-A    archiva/archiva-scheduled/src/main/resources/META-INF/plexus/components.xml
-A    archiva/archiva-scheduled/pom.xml
- U   archiva
-Checked out revision 539934.
-
-[code]$ ls
-archiva
-
-[code]$ cd archiva
-
-[code/archiva]$ ls
-archiva-base/      archiva-reporting/  archiva-web/       maven-meeper/
-archiva-cli/       archiva-scheduled/  archiva-workflow/  pom.xml
-archiva-database/  archiva-site/       design/
-

- - - -

- You will need the following tools. -

Maven 2.0.5 (or newer)
Java SDK 1.5.0_10 (or newer)
An IDE (or plain editor) of your choice.

- - - -

- Archiva uses the Maven tool suite to do all things within - the build. (compile, test, archive, install, deploy, etc...) - The standard goals apply here. -

- There are 2 non-distributable artifacts in use within archiva, - that cannot be placed on the public / global repository system - by anyone but Sun. In order to build archiva, you will need to - manually install these artifact into your local repository. - Follow the steps below. -

The javax.resource:connector:1.0:jar artifact

Download the 1.0 connector zip from: http://java.sun.com/j2ee/connector/download.html
Unpack the zip to gain access to the jar file.
Install it: mvn install:install-file -DgroupId=javax.resource -DartifactId=connector -Dversion=1.0 -Dpackaging=jar -Dfile=connector.jar

The javax.transaction:jta:1.0.1B:jar artifact

Download the 1.0.1B jta zip from: http://java.sun.com/products/jta/
Install it: mvn install:install-file -DgroupId=javax.transaction -DartifactId=jta -Dversion=1.0.1B -Dpackaging=jar -Dfile=jta-1_0_1B-classes.zip

- - - -

- Archiva uses the standard maven goals. Use them. -

-[archiva]$ mvn clean install
-[INFO] Scanning for projects...
-[INFO] Reactor build order: 
-[INFO]   Archiva
-
-... (snip output) ...
-
-[INFO] ------------------------------------------------------------------------
-[INFO] BUILD SUCCESSFUL
-[INFO] ------------------------------------------------------------------------
-[INFO] Total time: 4 minutes 29 seconds
-[INFO] Finished at: Sun May 20 17:00:09 EDT 2007
-[INFO] Final Memory: 50M/61M
-[INFO] ------------------------------------------------------------------------
-

- -

- NOTE: Your first compile will take the longest, as maven will - download all the missing dependencies into your local repository - at this point. -

- - - -

- You have a few ways (in development time) to run archiva. -

- -

Using the jetty:run plugin w/default settings.

- -

-[archiva]$ cd archiva-web/archiva-webapp
-
-[archiva-webapp]$ mvn clean jetty:run
-[INFO] Scanning for projects...
-[INFO] Searching repository for plugin with prefix: 'jetty'.
-[INFO] ---------------------------------------------------------------------
-[INFO] Building Archiva Web :: Application
-[INFO]    task-segment: [clean, jetty:run]
-[INFO] ---------------------------------------------------------------------
-[INFO] [clean:clean]
-
-... ( snip lots of output ) ...
-
-2007-05-20 18:47:49.790:/:INFO:  Initializing org.codehaus.plexus.webdav.simple.SimpleDavServerComponent
-2007-05-20 18:47:49.813::INFO:  Started SelectChannelConnector @ 0.0.0.0:9091
-[INFO] Started Jetty Server
-[INFO] Starting scanner at interval of 10 seconds.
-

At this point you can use your browser to goto http://localhost:9091/

Using the jetty:run plugin w/mysql settings. - -

-[archiva]$ cd archiva-web/archiva-webapp
-
-[archiva-webapp]$ mvn -Pmysql clean jetty:run
-[INFO] Scanning for projects...
-[INFO] Searching repository for plugin with prefix: 'jetty'.
-[INFO] ---------------------------------------------------------------------
-[INFO] Building Archiva Web :: Application
-[INFO]    task-segment: [clean, jetty:run]
-[INFO] ---------------------------------------------------------------------
-[INFO] [clean:clean]
-
-... ( snip lots of output ) ...
-
-2007-05-20 18:47:49.790:/:INFO:  Initializing org.codehaus.plexus.webdav.simple.SimpleDavServerComponent
-2007-05-20 18:47:49.813::INFO:  Started SelectChannelConnector @ 0.0.0.0:9091
-[INFO] Started Jetty Server
-[INFO] Starting scanner at interval of 10 seconds.
-

Using the built plexus-application standalone binary. - -

-[archiva]$ cd archiva-web/archiva-standalone/archiva-plexus-runtime/target
-
-[target]$ tar -zxvf archiva-1.0-alpha-1-SNAPSHOT-bin.tar.gz
-
-[target]$ cd archiva-1.0-alpha-1-SNAPSHOT/bin
-
-[bin]$ ls
-linux-x86-32         plexus.bat        solaris-sparc-64
-linux-x86-64         plexus.sh         solaris-x86-32
-macosx-universal-32  solaris-sparc-32  windows-x86-32
-
-[bin]$ cd linux-x86-32
-
-[linux-x86-32]$ ls
-libwrapper.so  run.sh  wrapper  wrapper.conf
-
-[linux-x86-32]$ ./run.sh start
-

- -

Modules & Source Tree
Plexus Basics

Purpose
Role & Hint
Descriptors

META-INF/plexus/components.xml
META-INF/plexus/application.xml
src/test/resources/${package}/${test}.xml

plexus-maven-plugin

generated and/or merge
javadoc tags

Model

Heirarchy of artifacts.

Project: ( group Id + artifact Id )
Versioned: ( project + version )
Artifact: ( versioned + classifier + type )

Types of objects.

Archiva Project Model
Archiva Artifact

Java Platform Extension

Archiva Repository
Archiva Reposiotry Metadata
Repository Statistics
Repository Problem

Types of Repositories

Managed

file://... URLs only
Indexed
Statistics

Remote

Database / Persistence

JDO / JPox
Query / Constraints

Declarative
Simple

Scheduling

How plexus-quartz & plexus-taskqueue fit in.
Types of Jobs

Repository Scanning

Known Files
Ignored Files
Unknown Files

Database Updates

Periodic

Unprocesed Process
Cleanup

Nightly

Consumers

Purpose
Discovery
Configuration
Types of Consumers

Repository Artifact
Database Unprocessed
Database Cleanup

Repository Connectors

Proxy Connector

Pre Download Policies
Post Download Policies

Maven Artifact / Project Libraries

Bidirectional Repository Layout
Project Readers
Project Filters
Project Resolvers

Indexer

Bytecode
File Content
Hashcodes
Analyze / Index
Search / Query