flexmojos:wrapper

Full name:

org.sonatype.flexmojos:flexmojos-maven-plugin:3.5.0:wrapper

Description:

This goal generate the html wrapper to Flex applications, like what is done by flex builder.

Attributes:

  • Requires a Maven 2.0 project to be executed.
  • Since version: 1.0.
  • Binds by default to the lifecycle phase: generate-resources.

Optional Parameters

Name Type Since Description
htmlName String 1.0 final name of html file

This is now deprecated, and only supplied for backwards compatibility.
Default value is: ${project.build.finalName}.
outputDirectory File 1.0 output Directory to store final html

This is ignored if running in project with war packaging.
Default value is: ${project.build.directory}.
parameters Map 1.0 Used to define parameters that will be replaced. Usage:
 <parameters>
     <swf>${build.finalName}</swf>
     <width>100%</width>
     <height>100%</height>
 </parameters>
The following prameters wil be injected if not defined:
title
version_major
version_minor
version_revision
swf
width
height
bgcolor
application
If you are using a custom template, and wanna some extra parameters, this is the right place to define it.

This is ignored if running in project with war packaging.
targetPlayer String 1.0 specifies the version of the player the application is targeting. Features requiring a later version will not be compiled into the application. The minimum value supported is "9.0.0". If not defined will take the default value from current playerglobal dependency.
templateExclusions String[] 1.0 Files to not interpolate while copying files. Usually binary files. Accepts wild cards. By default, many common binary formats are excluded (see useDefaultBinaryExcludes). Usage:
 <templateExclusions>
     <String>**/*.xml</String>
     <String>some-directory/</String>
     <String>another-directory/**/*.jsp</String>
 </templateExclusions>
In the above, the following applies in order:
  1. Exclude all xml files
  2. Exclude everything in the directory 'some-directory'
  3. Exclude all jsp files in the directory 'another-directory'

templateInclusions String[] 1.0 Files to interpolate while copying files. Accepts wild cards. By default includes all files. Any patterns defined in templateExclusions, the default binaries excludes, or default plexus excludes (svn, cvs, temp files, etc) will be applied on top of this, so matching a pattern here does not force that file to be wrapped. Usage:
 <templateExclusions>
     <String>**/*.xml</String>
     <String>some-directory/</String>
     <String>another-directory/**/*.jsp</String>
 </templateExclusions>
In the above, the following applies in order:
  1. Include all xml files
  2. Include everything in the directory 'some-directory'
  3. Include all jsp files in the directory 'another-directory'

templateOutputDirectory File 1.0 output Directory to store final html

This is ignored if running in project with war packaging.
Default value is: ${project.build.directory}/html-wrapper-template.
templateURI String 1.0 The template URI.

You can point to a zip file, a folder or use one of the following embed templates:

embed:client-side-detection
embed:client-side-detection-with-history
embed:express-installation
embed:express-installation-with-history
embed:no-player-detection
embed:no-player-detection-with-history
To point to a zip file you must use a URI like this:
zip:/myTemplateFolder/template.zip
zip:c:/myTemplateFolder/template.zip
To point to a folder use a URI like this:
folder:/myTemplateFolder/
folder:c:/myTemplateFolder/

This mojo will look for index.template.html for replace parameters.

This is ignored if running in project with war packaging.


Default value is: embed:express-installation-with-history.
useDefaultBinaryExcludes boolean 1.0 Controls whether or not common binary file types are excluded by default when choosing what files to wrap. Useful to set to false if for some reason you decide to name a wrapped file something like "index.exe" or "html-wrapper.png" for some unanticipated reason.
Default value is: true.
wrapperArtifact Map 1.0 In the context of a war project, this specifies the external artifact that the wrapper parameters will be extracted from. Usage:
 <wrapperArtifact>
     <groupId>com.company</groupId>
     <artifactId>some-project</artifactId>
     <version>3.2.7%</version>
     <classifier>prod%</classifier>
 </wrapperArtifact>
Both groupId and artifactId are required, but version and classifier are optional and can be inferred from a dependency if present (for example when the copy-flex-resources goal is executed).

Parameter Details

htmlName:

final name of html file

This is now deprecated, and only supplied for backwards compatibility.
  • Type: java.lang.String
  • Since: 1.0
  • Required: No
  • Default: ${project.build.finalName}

outputDirectory:

output Directory to store final html

This is ignored if running in project with war packaging.
  • Type: java.io.File
  • Since: 1.0
  • Required: No
  • Default: ${project.build.directory}

parameters:

Used to define parameters that will be replaced. Usage:
 <parameters>
     <swf>${build.finalName}</swf>
     <width>100%</width>
     <height>100%</height>
 </parameters>
The following prameters wil be injected if not defined:
title
version_major
version_minor
version_revision
swf
width
height
bgcolor
application
If you are using a custom template, and wanna some extra parameters, this is the right place to define it.

This is ignored if running in project with war packaging.
  • Type: java.util.Map
  • Since: 1.0
  • Required: No

targetPlayer:

specifies the version of the player the application is targeting. Features requiring a later version will not be compiled into the application. The minimum value supported is "9.0.0". If not defined will take the default value from current playerglobal dependency.
  • Type: java.lang.String
  • Since: 1.0
  • Required: No

templateExclusions:

Files to not interpolate while copying files. Usually binary files. Accepts wild cards. By default, many common binary formats are excluded (see useDefaultBinaryExcludes). Usage:
 <templateExclusions>
     <String>**/*.xml</String>
     <String>some-directory/</String>
     <String>another-directory/**/*.jsp</String>
 </templateExclusions>
In the above, the following applies in order:
  1. Exclude all xml files
  2. Exclude everything in the directory 'some-directory'
  3. Exclude all jsp files in the directory 'another-directory'
  • Type: java.lang.String[]
  • Since: 1.0
  • Required: No

templateInclusions:

Files to interpolate while copying files. Accepts wild cards. By default includes all files. Any patterns defined in templateExclusions, the default binaries excludes, or default plexus excludes (svn, cvs, temp files, etc) will be applied on top of this, so matching a pattern here does not force that file to be wrapped. Usage:
 <templateExclusions>
     <String>**/*.xml</String>
     <String>some-directory/</String>
     <String>another-directory/**/*.jsp</String>
 </templateExclusions>
In the above, the following applies in order:
  1. Include all xml files
  2. Include everything in the directory 'some-directory'
  3. Include all jsp files in the directory 'another-directory'
  • Type: java.lang.String[]
  • Since: 1.0
  • Required: No

templateOutputDirectory:

output Directory to store final html

This is ignored if running in project with war packaging.
  • Type: java.io.File
  • Since: 1.0
  • Required: No
  • Default: ${project.build.directory}/html-wrapper-template

templateURI:

The template URI.

You can point to a zip file, a folder or use one of the following embed templates:

embed:client-side-detection
embed:client-side-detection-with-history
embed:express-installation
embed:express-installation-with-history
embed:no-player-detection
embed:no-player-detection-with-history
To point to a zip file you must use a URI like this:
zip:/myTemplateFolder/template.zip
zip:c:/myTemplateFolder/template.zip
To point to a folder use a URI like this:
folder:/myTemplateFolder/
folder:c:/myTemplateFolder/

This mojo will look for index.template.html for replace parameters.

This is ignored if running in project with war packaging.

  • Type: java.lang.String
  • Since: 1.0
  • Required: No
  • Default: embed:express-installation-with-history

useDefaultBinaryExcludes:

Controls whether or not common binary file types are excluded by default when choosing what files to wrap. Useful to set to false if for some reason you decide to name a wrapped file something like "index.exe" or "html-wrapper.png" for some unanticipated reason.
  • Type: boolean
  • Since: 1.0
  • Required: No
  • Default: true

wrapperArtifact:

In the context of a war project, this specifies the external artifact that the wrapper parameters will be extracted from. Usage:
 <wrapperArtifact>
     <groupId>com.company</groupId>
     <artifactId>some-project</artifactId>
     <version>3.2.7%</version>
     <classifier>prod%</classifier>
 </wrapperArtifact>
Both groupId and artifactId are required, but version and classifier are optional and can be inferred from a dependency if present (for example when the copy-flex-resources goal is executed).
  • Type: java.util.Map
  • Since: 1.0
  • Required: No