Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Info

Work in progress--this page will replace Struts Maven Archetypes once completed.

Struts 2 provides several Maven archetypes that create a starting point for our own applications.

Table of Contents
minLevel2
maxLevel3
outlinetrue
indent1em
stylenone

Available Archetypes

The Blank Archetype (struts2-archetype-blank)


Excerpt Include
WW:Struts 2 Blank Archetype
WW:Struts 2 Blank Archetype
nopaneltrue

See the Struts 2 Blank Archetype page for more information.

The Starter Archetype (struts2-archetype-starter) (warning) Not yet updated for 2.1.6

The Starter archetype creates a more featured application using several common technologies used in production applications.

Features

  • Sitemesh integration
  • Action example (instantiated both through Spring and Struts)
  • Spring integration
  • Validation example (action and action-alias level)
  • Conversion example (global and action level)
  • Resource bundle (both global, action and package level)

The Portlet Blank Archetype (struts2-archetype-portlet) (warning) Not yet updated for 2.1.6

The Portlet blank archetype creates a minimally populated JSR 168 portlet.

Features

  • View, Edit, and Help mode examples
  • Simple form for preferences in Edit mode
  • Can be deployed as a servlet or portlet application
  • Can use Maven Jetty plugin to deploy as a servlet webapp

The Portlet Database Archetype (struts2-archetype-dbportlet) (warning) Not yet updated for 2.1.6

The Portlet database archetype creates a simple JSR 168 portlet that displays the contents of a database table.

Features

  • Uses Spring and Hsql to show a real database query
  • Builtin caching of query results
  • View, Edit, and Help mode examples
  • Simple form for preferences in Edit mode
  • Can be deployed as a servlet or portlet application
  • Can use Maven Jetty plugin to deploy as a servlet webapp

Creating an Application Using a Maven Archetype

Run the following command from your new project's parent directory. The project will be created in a sub-directory named after the artifactId parameter.

The first two parameters, groupId and artifactId, should be set according to your needs:

  • groupId
    This should be the root package of your application, e.g., com.mycompany.myapp.
  • artifactId
    Names the project directory that will be created in the current directory.
Code Block
mvn archetype:generate -B \
                       -DgroupId=tutorial \
                       -DartifactId=tutorial \
                       -DarchetypeGroupId=org.apache.struts \
                       -DarchetypeArtifactId=struts2-archetype-blank \
                       -DarchetypeVersion=2.1.6

Archetype Parameters

The -B option runs archetype:generate in batch mode; it avoids a prompt to confirm our settings.

Parameter

Description

groupId

The id for the group the application belongs to. Usually is the root package for applications in your company, e.g. com.mycompany

artifactId

The id for the project. The project will be created a sub-directory named after this parameter.

archetypeGroupId

The group id of the archetype. Will always be org.apache.struts for Struts archetypes

archetypeArtifactId

The id of the archetype

archetypeVersion

The version of the archetype

package

(Optional) The base Java package to use for generated source code. Defaults to archetypeGroupId if not specified.

remoteRepositories

(Optional) A list of remote repositories that contain the archetype.

Command Quick Reference

These commands are used from the directory created by the archetype plugin (the project's sub-directory that was created in the previous step).

  • To build
Code Block
   mvn install
  • To create IntelliJ IDEA project files
Code Block
   mvn idea:idea
  • To create Eclipse project files
Code Block
   mvn eclipse:eclipse
  • To run test cases
Code Block
   mvn test
  • To clean up (removes generated artifacts)
Code Block
   mvn clean
  • To package (creates a WAR file)
Code Block
   mvn package
  • To grab necessary JAR files etc.
Code Block
   mvn initialize
  • To run it with Jetty
Code Block
   mvn jetty:run