Optional: Building and Installing Jetspeed-2 Maven Plugins

Because Jetspeed Maven Plugins and Archetype Plugins will be automatically downloaded by Maven-2, you don't need to build and install those from the Jetspeed-2 source.

Note: you may skip this section for simplicity in normal cases.

However, if you want this for some reasons, you can build and install the Jetspeed-2 Maven Plugins and Archetype Plugins from the source of Jetspeed-2 with the following command in the root directory of Jetspeed-2 source:

$mvn install -P init

This will ensure the required Jetspeed-2 Maven plugins are build and installed as well as the jetspeed-portal-resources artifact.

Using the jetspeed-archetype Maven Plugin

To use jetspeed-archetype Maven Plugin, you can run a command like the following:

mvn org.apache.maven.plugins:maven-archetype-plugin:2.0-alpha-4:generate \
    -DarchetypeGroupId=org.apache.portals.jetspeed-2 \
    -DarchetypeArtifactId=jetspeed-archetype \
    -DarchetypeVersion=2.3.0 \
    -DartifactId=hello \
    -Dpackage=org.example \
    -DgroupId=org.example -Dversion=1.0.0

In the above command, the variables, "artifactId", "package" and "groupId", are project-specific ones. So you should provide variables for your project.

By the way, the other variables in the above command are from the Maven Archetype Plugin Specification. Please refer to Maven Archetype Plugin homepage for details.

Generating Hello Portal Application Example

To build a custom portal project named 'hello', you may need to move to a folder under which your project folder should be located. For example,

$ cd ~/projects
$ mvn org.apache.maven.plugins:maven-archetype-plugin:2.0-alpha-4:generate \
-DarchetypeGroupId=org.apache.portals.jetspeed-2 \
-DarchetypeArtifactId=jetspeed-archetype \
-DarchetypeVersion=2.3.0 \
-DartifactId=hello \
-Dpackage=org.example \
-DgroupId=org.example -Dversion=1.0.0
          

Note: After running the above command, you will meet a prompt for confirmation. By pressing enter key it will continue to generate a custom portal project.

With the above command, the jetspeed-archetype generates a complete Maven-2 project directory structure for developing a custom portal as well as portlet applications. Here is an overview of directories created by the jetspeed-archetype (directories are relative to the custom portal root):

Building Hello Portal Application Example

To configure the generated portal project, you need to edit jetspeed-mvn-settings.xml file in the project root directory and change the following:

Initially, the jetspeed-archetype generates a jetspeed-mvn-settings.xml to use Apache Derby like the following example:

<settings xmlns="http://maven.apache.org/POM/4.0.0">
  <profiles>
    <profile>
    
      ...
      
      <properties>
        <org.apache.jetspeed.server.home>/change/this/apache-tomcat-6.0.33/</org.apache.jetspeed.server.home>
        <org.apache.jetspeed.catalina.version.major>6</org.apache.jetspeed.catalina.version.major>
        <org.apache.jetspeed.production.jdbc.driver.groupId>org.apache.derby</org.apache.jetspeed.production.jdbc.driver.groupId>
        <org.apache.jetspeed.production.jdbc.driver.artifactId>derby</org.apache.jetspeed.production.jdbc.driver.artifactId>
        <org.apache.jetspeed.production.jdbc.driver.version>10.3.2.1</org.apache.jetspeed.production.jdbc.driver.version>
        <org.apache.jetspeed.production.database.default.name>derby</org.apache.jetspeed.production.database.default.name>
        <org.apache.jetspeed.production.database.url>jdbc:derby:/tmp/jetspeed/derby/productiondb;create=true</org.apache.jetspeed.production.database.url>
        <org.apache.jetspeed.production.database.driver>org.apache.derby.jdbc.EmbeddedDriver</org.apache.jetspeed.production.database.driver>
        <org.apache.jetspeed.production.database.user></org.apache.jetspeed.production.database.user>
        <org.apache.jetspeed.production.database.password></org.apache.jetspeed.production.database.password>
      </properties>
    </profile>
  </profiles>
</settings>
          

So, if you want to deploy your custom portal to other Tomcat location and to use other database, you should change the "org.apache.jetspeed.server.home" property and the other database-related properties. For example, the following shows one usage with MySQL database:

<settings xmlns="http://maven.apache.org/POM/4.0.0">
  <profiles>
    <profile>
    
      ...
      
      <properties>
        <org.apache.jetspeed.server.home>C:/apache-tomcat-6.0.33/</org.apache.jetspeed.server.home>
        <org.apache.jetspeed.catalina.version.major>6</org.apache.jetspeed.catalina.version.major>
        <org.apache.jetspeed.production.jdbc.driver.groupId>mysql</org.apache.jetspeed.production.jdbc.driver.groupId>
        <org.apache.jetspeed.production.jdbc.driver.artifactId>mysql-connector-java</org.apache.jetspeed.production.jdbc.driver.artifactId>
        <org.apache.jetspeed.production.jdbc.driver.version>5.1.6</org.apache.jetspeed.production.jdbc.driver.version>
        <org.apache.jetspeed.production.database.default.name>mysql5</org.apache.jetspeed.production.database.default.name>
        <org.apache.jetspeed.production.database.url>jdbc:mysql://127.0.0.1/jetspeed?useServerPrepStmts=false&amp;jdbcCompliantTruncation=false</org.apache.jetspeed.production.database.url>
        <org.apache.jetspeed.production.database.driver>com.mysql.jdbc.Driver</org.apache.jetspeed.production.database.driver>
        <org.apache.jetspeed.production.database.user>username</org.apache.jetspeed.production.database.user>
        <org.apache.jetspeed.production.database.password>password</org.apache.jetspeed.production.database.password>
      </properties>
    </profile>
  </profiles>
</settings>
          

You can build and deploy your custom portal to your Tomcat installation by using the following command:

$mvn org.apache.portals.jetspeed-2:jetspeed-mvn-maven-plugin:mvn -Dtarget=all

<settings xmlns="http://maven.apache.org/POM/4.0.0">
<pluginGroups>
<!-- add the following line to shorten the command invoking the Jetspeed Maven Plugin. -->
<pluginGroup>org.apache.portals.jetspeed-2</pluginGroup>
</pluginGroups>
</settings>

$mvn jetspeed:mvn -Dtarget=all

Start your Tomcat:
Note that the setting of CATALINA_OPTS is optional in the following examples. (See Note on Permanent Generation Size of Your JVM for detail.)

$ cd $TOMCAT_HOME/bin
$ export CATALINA_OPTS="-Xmx256m -XX:MaxPermSize=128m"
$ ./catalina.sh run
            

Use your custom portal: http://localhost:8080/hello

Note on Permanent Generation Size of Your JVM

Note: You may need to increase the permanent generation size of your JVM when there are a lot of Servlets, JSP's or when script portlets are used, in order to avoid OutOfMemoryError errors. By default, it is 64MB. Increasing it to be -XX:MaxPermSize=128m might be a good start. Please see http://wiki.apache.org/tomcat/FAQ/Memory for detail.

Advanced Build Options

By the command, `$mvn jetspeed:mvn -Dtarget=all', the jetspeed-archtype will build and install your custom portal project, initialize your database and finally deploy your portal and portlet application to your Tomcat. However, during your continuous development, doing all tasks by the above command could be regarded as inefficient.

Therefore, jetspeed-archetype provides more advanced build options to fulfill various needs. You can build by setting a proper target you need in the following table: