openfire:openfire-plugin

Build an Openfire Plugin jar.

Mojo Attributes:

  • Requires a Maven 2.0 project to execute.
  • Requires dependency resolution of artifacts in scope: runtime
  • Automatically executes within the lifecycle phase: package

Required Parameters

Name Type Description
databaseSourceDirectory File Single directory for Openfire Plugin database scripts.
i18nSourceDirectory File Single directory for Openfire Plugin i18n resources.
openfirePluginDirectory File The directory where the Openfire Plugin is built.
openfireSourceDirectory File Single directory for Openfire Plugin configuration files like plugin.xml, changelog.html and readme.html.
outputDirectory String The directory for the generated WAR.
warName String The name of the generated WAR.
warSourceDirectory File Single directory for extra files to include in the WAR.

Optional Parameters

Name Type Description
archive MavenArchiveConfiguration The maven archive configuration to use.
classifier String Classifier to add to the artifact generated. If given, the artifact will be an attachment instead.
filters List Filters (property files) to include during the interpolation of the pom.xml.
outputFileNameMapping String The file name mapping to use to copy libraries and tlds. If no file mapping is set (default) the file is copied with its standard name.
primaryArtifact boolean Whether this is the main artifact being built. Set to false if you don't want to install or deploy it to the local repository instead of the default one in an execution. Default value is true.
projectHelper MavenProjectHelper No description.
warSourceExcludes String The comma separated list of tokens to exclude from the WAR.
warSourceIncludes String The comma separated list of tokens to include in the WAR. Default is '**'.
webResources Resource[] The list of webResources we want to transfer.
webXml File The path to the web.xml file to use, original default was ${maven.war.webxml}.

Parameter Details

archive

The maven archive configuration to use.

  • Type: org.apache.maven.archiver.MavenArchiveConfiguration
  • Required: No

classifier

Classifier to add to the artifact generated. If given, the artifact will be an attachment instead.

  • Type: java.lang.String
  • Required: No

databaseSourceDirectory

Single directory for Openfire Plugin database scripts.

  • Type: java.io.File
  • Required: Yes
  • Expression: ${basedir}/src/main/database

filters

Filters (property files) to include during the interpolation of the pom.xml.

  • Type: java.util.List
  • Required: No
  • Expression: ${project.build.filters}

i18nSourceDirectory

Single directory for Openfire Plugin i18n resources.

  • Type: java.io.File
  • Required: Yes
  • Expression: ${basedir}/src/main/i18n

openfirePluginDirectory

The directory where the Openfire Plugin is built.

  • Type: java.io.File
  • Required: Yes
  • Expression: ${project.build.directory}/${project.build.finalName}

openfireSourceDirectory

Single directory for Openfire Plugin configuration files like plugin.xml, changelog.html and readme.html.

  • Type: java.io.File
  • Required: Yes
  • Expression: ${basedir}/src/main/openfire

outputDirectory

The directory for the generated WAR.

  • Type: java.lang.String
  • Required: Yes
  • Expression: ${project.build.directory}

outputFileNameMapping

The file name mapping to use to copy libraries and tlds. If no file mapping is set (default) the file is copied with its standard name.

  • Type: java.lang.String
  • Required: No

primaryArtifact

Whether this is the main artifact being built. Set to false if you don't want to install or deploy it to the local repository instead of the default one in an execution.

  • Type: boolean
  • Required: No
  • Expression: ${primaryArtifact}
  • Default: true

projectHelper

No Description.

  • Type: org.apache.maven.project.MavenProjectHelper
  • Required: No

warName

The name of the generated WAR.

  • Type: java.lang.String
  • Required: Yes
  • Expression: ${project.build.finalName}

warSourceDirectory

Single directory for extra files to include in the WAR.

  • Type: java.io.File
  • Required: Yes
  • Expression: ${basedir}/src/main/webapp

warSourceExcludes

The comma separated list of tokens to exclude from the WAR.

  • Type: java.lang.String
  • Required: No

warSourceIncludes

The comma separated list of tokens to include in the WAR. Default is '**'.

  • Type: java.lang.String
  • Required: No

webResources

The list of webResources we want to transfer.

  • Type: org.apache.maven.model.Resource[]
  • Required: No

webXml

The path to the web.xml file to use, original default was ${maven.war.webxml}.

  • Type: java.io.File
  • Required: No
  • Expression: ${basedir}/target/web.xml