lutece:site-assembly

Full name:

fr.paris.lutece.tools:maven-lutece-plugin:2.0.2-SNAPSHOT:site-assembly

Description:

Builds a site's final WAR from a Lutece core artifact and a set of Lutece plugin artifacts.
Note that the Lutece dependencies (core and plugins) will only be updated the first time the WAR is created. Subsequent calls to this goal will only update the site's specific files.
If you wish to force webapp re-creation (for instance, if you changed the version of a dependency), call the clean phase before this goal.

Attributes:

  • Requires a Maven 2.0 project to be executed.
  • Requires dependency resolution of artifacts in scope: compile.

Required Parameters

Name Type Since Description
classesDirectory File - The directory containing the Java classes.
defaultConfDirectory File - The directory containing the default configuration files.
explodedDirectory File - A temporary directory used to hold the exploded version of the webapp.
finalName String - The name of the generated WAR file.
outputDirectory File - The project's output directory
utcTimestampPattern String - The output date format.
Default value is: yyyyMMdd.HHmmss.
webappSourceDirectory File - The source directory for webapp components.

Optional Parameters

Name Type Since Description
archive MavenArchiveConfiguration - The maven archive configuration to use. See the Javadocs for MavenArchiveConfiguration.
forceCreation boolean - Whether creating the archive should be forced.
Default value is: false.
localConfDirectory File - The directory containing the local, user-specific configuration files.
Default value is: ${user.home}/lutece/conf/${project.artifactId}.
localRepository ArtifactRepository - The local repository.
remoteRepositories List - The remote repositories.
siteDirectory File - The directory containing the default user documentation.
sqlDirectory File - The directory containing the database sql script.
testWebappDirectory File - The directory where to explode the test webapp.
Default value is: ${project.build.directory}/lutece.

Parameter Details

archive:

The maven archive configuration to use. See the Javadocs for MavenArchiveConfiguration.
  • Type: org.apache.maven.archiver.MavenArchiveConfiguration
  • Required: No

classesDirectory:

The directory containing the Java classes.
  • Type: java.io.File
  • Required: Yes
  • Expression: ${project.build.outputDirectory}

defaultConfDirectory:

The directory containing the default configuration files.
  • Type: java.io.File
  • Required: Yes
  • Expression: ${basedir}/src/conf/default

explodedDirectory:

A temporary directory used to hold the exploded version of the webapp.
  • Type: java.io.File
  • Required: Yes
  • Expression: ${project.build.directory}/${project.build.finalName}

finalName:

The name of the generated WAR file.
  • Type: java.lang.String
  • Required: Yes
  • Expression: ${project.build.finalName}

forceCreation:

Whether creating the archive should be forced.
  • Type: boolean
  • Required: No
  • Expression: ${jar.forceCreation}
  • Default: false

localConfDirectory:

The directory containing the local, user-specific configuration files.
  • Type: java.io.File
  • Required: No
  • Default: ${user.home}/lutece/conf/${project.artifactId}

localRepository:

The local repository.
  • Type: org.apache.maven.artifact.repository.ArtifactRepository
  • Required: No
  • Expression: ${localRepository}

outputDirectory:

The project's output directory
  • Type: java.io.File
  • Required: Yes
  • Expression: ${project.build.directory}

remoteRepositories:

The remote repositories.
  • Type: java.util.List
  • Required: No
  • Expression: ${project.remoteArtifactRepositories}

siteDirectory:

The directory containing the default user documentation.
  • Type: java.io.File
  • Required: No
  • Expression: ${basedir}/src/site

sqlDirectory:

The directory containing the database sql script.
  • Type: java.io.File
  • Required: No
  • Expression: ${basedir}/src/sql

testWebappDirectory:

The directory where to explode the test webapp.
  • Type: java.io.File
  • Required: No
  • Expression: ${testWebappDirectory}
  • Default: ${project.build.directory}/lutece

utcTimestampPattern:

The output date format.
  • Type: java.lang.String
  • Required: Yes
  • Default: yyyyMMdd.HHmmss

webappSourceDirectory:

The source directory for webapp components.
  • Type: java.io.File
  • Required: Yes
  • Expression: ${basedir}/webapp