Serialized Form

Package com.mindtree.techworks.insight.releng.mvn.nsis.actions

Class com.mindtree.techworks.insight.releng.mvn.nsis.actions.NsisActionExecutionException extends org.apache.maven.plugin.MojoExecutionException implements Serializable

serialVersionUID: -5245461032908599765L

Package com.mindtree.techworks.insight.releng.mvn.nsis.model

Class com.mindtree.techworks.insight.releng.mvn.nsis.model.ComponentsPageSettings extends java.lang.Object implements Serializable

Serialized Fields

textTop

java.lang.String textTop

See http://nsis.sourceforge.net/Docs/Modern%20UI/Readme.html .

textCompList

java.lang.String textCompList

See http://nsis.sourceforge.net/Docs/Modern%20UI/Readme.html .

textInstType

java.lang.String textInstType

See http://nsis.sourceforge.net/Docs/Modern%20UI/Readme.html .

textDescriptionTitle

java.lang.String textDescriptionTitle

See http://nsis.sourceforge.net/Docs/Modern%20UI/Readme.html .

textDescriptionInfo

java.lang.String textDescriptionInfo

See http://nsis.sourceforge.net/Docs/Modern%20UI/Readme.html .

Class com.mindtree.techworks.insight.releng.mvn.nsis.model.DependencySet extends SetBase implements Serializable

Serialized Fields

outputFileNameMapping

java.lang.String outputFileNameMapping

Sets the mapping pattern for all dependencies included in this assembly. Default is ${artifact.artifactId}-${artifact.version}${dashClassifier?}.${artifact.extension}. (Since 2.2-beta-2; 2.2-beta-1 uses ${artifactId}-${version}${dashClassifier?}.${extension}) .

unpack

boolean unpack

If set to true, this property will unpack all dependencies into the specified output directory. When set to false dependencies will be includes as archives (jars). Can only unpack jar, zip, tar.gz, and tar.bz archives. Default value is false.

unpackOptions

UnpackOptions unpackOptions

Allows the specification of includes and excludes, along with filtering options, for items unpacked from a dependency artifact. (Since 2.2) .

scope

java.lang.String scope

Sets the dependency scope for this dependencySet. Default scope value is "runtime".

useProjectArtifact

boolean useProjectArtifact

Determines whether the artifact produced during the current project's build should be included in this dependency set. Default value is true, for backward compatibility. (Since 2.2) .

useProjectAttachments

boolean useProjectAttachments

Determines whether the attached artifacts produced during the current project's build should be included in this dependency set. Default value is false. (Since 2.2) .

useTransitiveDependencies

boolean useTransitiveDependencies

Determines whether transitive dependencies will be included in the processing of the current dependency set. If true, includes/excludes/useTransitiveFiltering will apply to transitive dependency artifacts in addition to the main project dependency artifacts. If false, useTransitiveFiltering is meaningless, and includes/excludes only affect the immediate dependencies of the project. By default, this value is true. (Since 2.2) .

useTransitiveFiltering

boolean useTransitiveFiltering

Determines whether the include/exclude patterns in this dependency set will be applied to the transitive path of a given artifact. If true, and the current artifact is a transitive dependency brought in by another artifact which matches an inclusion or exclusion pattern, then the current artifact has the same inclusion/exclusion logic applied to it as well. By default, this value is false, in order to preserve backward compatibility with version 2.1. This means that includes/excludes only apply directly to the current artifact, and not to the transitive set of artifacts which brought it in. (Since 2.2) .

Class com.mindtree.techworks.insight.releng.mvn.nsis.model.DirectoryPageSettings extends java.lang.Object implements Serializable

Serialized Fields

textTop

java.lang.String textTop

See http://nsis.sourceforge.net/Docs/Modern%20UI/Readme.html .

textDestination

java.lang.String textDestination

See http://nsis.sourceforge.net/Docs/Modern%20UI/Readme.html .

variable

java.lang.String variable

See http://nsis.sourceforge.net/Docs/Modern%20UI/Readme.html .

verifyOnLeave

boolean verifyOnLeave

See http://nsis.sourceforge.net/Docs/Modern%20UI/Readme.html .

Class com.mindtree.techworks.insight.releng.mvn.nsis.model.FileItem extends SetBase implements Serializable

Serialized Fields

source

java.lang.String source

Sets the absolute or relative path from the module's directory of the file to be included in the assembly.

destName

java.lang.String destName

Sets the destination filename in the outputDirectory. Default is the same name as the source's file.

lineEnding

java.lang.String lineEnding

Sets the line-endings of the files in this file. Valid values are:

• "keep" - Preserve all line endings
• "unix" - Use Unix-style line endings
• "lf" - Use a single line-feed line endings
• "dos" - Use DOS-style line endings
• "crlf" - Use Carraige-return, line-feed line endings

filtered

boolean filtered

Sets whether to determine if the file is filtered.

Class com.mindtree.techworks.insight.releng.mvn.nsis.model.FileSet extends SetBase implements Serializable

Serialized Fields

directory

java.lang.String directory

Sets the absolute or relative location from the module's directory. For example, "src/main/bin" would select this subdirectory of the project in which this dependency is defined.

lineEnding

java.lang.String lineEnding

Sets the line-endings of the files in this fileSet. Valid values:

• "keep" - Preserve all line endings
• "unix" - Use Unix-style line endings
• "lf" - Use a single line-feed line endings
• "dos" - Use DOS-style line endings
• "crlf" - Use Carraige-return, line-feed line endings

filtered

boolean filtered

Whether to filter symbols in the files as they are copied, using properties from the build configuration. (Since 2.2) .

Class com.mindtree.techworks.insight.releng.mvn.nsis.model.FinishPageSettings extends java.lang.Object implements Serializable

Serialized Fields

title

java.lang.String title

See http://nsis.sourceforge.net/Docs/Modern%20UI/Readme.html .

title3Lines

boolean title3Lines

See http://nsis.sourceforge.net/Docs/Modern%20UI/Readme.html .

text

java.lang.String text

See http://nsis.sourceforge.net/Docs/Modern%20UI/Readme.html .

textLarge

boolean textLarge

See http://nsis.sourceforge.net/Docs/Modern%20UI/Readme.html .

button

java.lang.String button

See http://nsis.sourceforge.net/Docs/Modern%20UI/Readme.html .

cancelEnabled

boolean cancelEnabled

See http://nsis.sourceforge.net/Docs/Modern%20UI/Readme.html .

textReboot

java.lang.String textReboot

See http://nsis.sourceforge.net/Docs/Modern%20UI/Readme.html .

textRebootNow

java.lang.String textRebootNow

See http://nsis.sourceforge.net/Docs/Modern%20UI/Readme.html .

textRebootLater

java.lang.String textRebootLater

See http://nsis.sourceforge.net/Docs/Modern%20UI/Readme.html .

rebootLaterDefault

boolean rebootLaterDefault

See http://nsis.sourceforge.net/Docs/Modern%20UI/Readme.html .

run

java.lang.String run

See http://nsis.sourceforge.net/Docs/Modern%20UI/Readme.html. Variables in this field will be expanded.

runText

java.lang.String runText

See http://nsis.sourceforge.net/Docs/Modern%20UI/Readme.html .

runParameters

java.lang.String runParameters

See http://nsis.sourceforge.net/Docs/Modern%20UI/Readme.html .

runNotChecked

boolean runNotChecked

See http://nsis.sourceforge.net/Docs/Modern%20UI/Readme.html .

runFunction

java.lang.String runFunction

See http://nsis.sourceforge.net/Docs/Modern%20UI/Readme.html .

showReadme

java.lang.String showReadme

See http://nsis.sourceforge.net/Docs/Modern%20UI/Readme.html .

showReadmeText

java.lang.String showReadmeText

See http://nsis.sourceforge.net/Docs/Modern%20UI/Readme.html .

showReadmeNotChecked

boolean showReadmeNotChecked

See http://nsis.sourceforge.net/Docs/Modern%20UI/Readme.html .

showReadmeFunction

java.lang.String showReadmeFunction

See http://nsis.sourceforge.net/Docs/Modern%20UI/Readme.html .

link

java.lang.String link

See http://nsis.sourceforge.net/Docs/Modern%20UI/Readme.html .

linkLocation

java.lang.String linkLocation

See http://nsis.sourceforge.net/Docs/Modern%20UI/Readme.html .

linkColor

java.lang.String linkColor

See http://nsis.sourceforge.net/Docs/Modern%20UI/Readme.html .

noRebootSupport

boolean noRebootSupport

See http://nsis.sourceforge.net/Docs/Modern%20UI/Readme.html .

Class com.mindtree.techworks.insight.releng.mvn.nsis.model.FunctionDefinition extends java.lang.Object implements Serializable

Serialized Fields

name

java.lang.String name

The name of the function.

definition

java.lang.String definition

The function Definition.

Class com.mindtree.techworks.insight.releng.mvn.nsis.model.Functions extends java.lang.Object implements Serializable

Serialized Fields

useMutexForInstaller

boolean useMutexForInstaller

Indicates if a mutex is to be used to ensure a single instance of the installer .

multiInstallerInstanceMessage

java.lang.String multiInstallerInstanceMessage

The message to display when more than one instance of the installer is running.

installAppRunCheckFn

FunctionDefinition installAppRunCheckFn

User defined function to check if the application is running when the installer starts. If the value is not specified the check is not performed.

uninstallPrevVer

boolean uninstallPrevVer

If set to true, the installer will try to identify and uninstall any previous version of the application.

prevVerPresentPrompt

java.lang.String prevVerPresentPrompt

The prompt to the user when a previous version of the application is found. This values is used only when uninstallPreviousVersion is set to true .

prevVerUninstallAbortMsg

java.lang.String prevVerUninstallAbortMsg

Message displayed when the uninstall of the previous version is aborted by the user.

prevVerUninstallFailMsg

java.lang.String prevVerUninstallFailMsg

Message displayed when the uninstall of the previous version fails .

uninstallConfirmPrompt

java.lang.String uninstallConfirmPrompt

The prompt displayed to the user when the uninstaller is invoked.

uninstallAppRunCheckFn

FunctionDefinition uninstallAppRunCheckFn

User defined function to check if the application is running when the uninstaller starts. If the value is not specified the check is not performed.

uninstallSuccessMsg

java.lang.String uninstallSuccessMsg

Message displayed after successfully uninstalling the application.

Class com.mindtree.techworks.insight.releng.mvn.nsis.model.InstallationPageSettings extends java.lang.Object implements Serializable

Serialized Fields

finishHeaderText

java.lang.String finishHeaderText

See http://nsis.sourceforge.net/Docs/Modern%20UI/Readme.html .

finishHeaderSubText

java.lang.String finishHeaderSubText

See http://nsis.sourceforge.net/Docs/Modern%20UI/Readme.html .

abortHeaderText

java.lang.String abortHeaderText

See http://nsis.sourceforge.net/Docs/Modern%20UI/Readme.html .

abortHeaderSubText

java.lang.String abortHeaderSubText

See http://nsis.sourceforge.net/Docs/Modern%20UI/Readme.html .

Class com.mindtree.techworks.insight.releng.mvn.nsis.model.InstallerSections extends java.lang.Object implements Serializable

Serialized Fields

installTypes

java.util.List<E> installTypes

Field installTypes.

sections

java.util.List<E> sections

Field sections.

Class com.mindtree.techworks.insight.releng.mvn.nsis.model.InstallerSettings extends java.lang.Object implements Serializable

Serialized Fields

scriptName

java.lang.String scriptName

The name of the installer displayed by Windows. If not provided, this defaults to "${projectInfo.productName} ${projectInfo.productVersion}" .

outFile

java.lang.String outFile

The output file name. If not specified, it will default to "${project.build.finalName}-setup.exe" .

installDir

java.lang.String installDir

The default installation directory in use. Defaults to "$PROGRAMFILES\${projectInfo.publisher}\${projectInfo.productName}" .

installDirRegKey

java.lang.String installDirRegKey

The directory the installer will check for installation directory. If not supplied, the default value used is "Software\Microsoft\Windows\CurrentVersion\App Paths\${projectInfo.productName}.exe". For more information see http://nsis.sourceforge.net/Docs/Chapter4.html#4.8.1.22 .

showInstallerDetails

java.lang.String showInstallerDetails

See http://nsis.sourceforge.net/Docs/Chapter4.html#4.8.1.34. Valid values are hide, show and nevershow. Defaults to hide .

showUnInstallerDetails

java.lang.String showUnInstallerDetails

See http://nsis.sourceforge.net/Docs/Chapter4.html#4.8.1.35. Valid values are hide, show and nevershow. Defaults to hide .

uninstallerIcon

java.lang.String uninstallerIcon

The icon displayed on the Windows Add/Remove programs Section .

Class com.mindtree.techworks.insight.releng.mvn.nsis.model.LicensePageSettings extends java.lang.Object implements Serializable

Serialized Fields

licenseFileDestination

java.lang.String licenseFileDestination

The end destination of the license file .

licenseFile

java.lang.String licenseFile

The location of the license file, should be relative to the project root or an absolute path.

textTop

java.lang.String textTop

See http://nsis.sourceforge.net/Docs/Modern%20UI/Readme.html .

textBottom

java.lang.String textBottom

See http://nsis.sourceforge.net/Docs/Modern%20UI/Readme.html .

button

java.lang.String button

See http://nsis.sourceforge.net/Docs/Modern%20UI/Readme.html .

checkBox

boolean checkBox

See http://nsis.sourceforge.net/Docs/Modern%20UI/Readme.html .

checkboxText

java.lang.String checkboxText

See http://nsis.sourceforge.net/Docs/Modern%20UI/Readme.html .

radioButtons

boolean radioButtons

See http://nsis.sourceforge.net/Docs/Modern%20UI/Readme.html .

radioButtonsTextAccept

java.lang.String radioButtonsTextAccept

See http://nsis.sourceforge.net/Docs/Modern%20UI/Readme.html .

radioButtonsTextDecline

java.lang.String radioButtonsTextDecline

See http://nsis.sourceforge.net/Docs/Modern%20UI/Readme.html .

Class com.mindtree.techworks.insight.releng.mvn.nsis.model.MuiInstallerSettings extends java.lang.Object implements Serializable

Serialized Fields

installerIcon

java.lang.String installerIcon

The installer icon. If none is supplied, the default used will be ${NSISDIR}\Contrib\Graphics\Icons\modern-install-colorful.ico If specified, the path should be relative to the project root directory, or should be relative to a NSIS variable.

uninstallerIcon

java.lang.String uninstallerIcon

The uninstaller icon. If none is supplied, the default used will be ${NSISDIR}\Contrib\Graphics\Icons\modern-uninstall-colorful.ico If a value is specified, the path should be relative to the project root directory, or should be relative to a NSIS variable.

useHeaderImage

boolean useHeaderImage

Flag to indicate if a configured header image is being used.

headerImageBmp

java.lang.String headerImageBmp

The location of the header image being used. It defaults to ${NSISDIR}\Contrib\Graphics\Header\win.bmp The recommended size of the image is 150x57 pixels. This property is read only if

Class com.mindtree.techworks.insight.releng.mvn.nsis.model.MuiPages extends java.lang.Object implements Serializable

Serialized Fields

pageHeaderText

java.lang.String pageHeaderText

Text to display on the header of the page. If not present, defaults to ${artifactid} ${version} .

pageHeaderSubText

java.lang.String pageHeaderSubText

Sub text to display on the header of the page. If not present, defaults to ${organization.name} .

welcomePageSettings

WelcomePageSettings welcomePageSettings

To add a newline to any of these texts, use \r\n instead of $\r$\n .

licensePageSettings

java.util.List<E> licensePageSettings

Field licensePageSettings.

componentsPageSettings

ComponentsPageSettings componentsPageSettings

To add a newline to any of these texts, use \r\n instead of $\r$\n .

directoryPageSettings

DirectoryPageSettings directoryPageSettings

To add a newline to any of these texts, use \r\n instead of $\r$\n .

startMenuFolderPageSettings

StartMenuFolderPageSettings startMenuFolderPageSettings

To add a newline to any of these texts, use \r\n instead of $\r$\n .

installationPageSettings

InstallationPageSettings installationPageSettings

To add a newline to any of these texts, use \r\n instead of $\r$\n .

finishPageSettings

FinishPageSettings finishPageSettings

To add a newline to any of these texts, use \r\n instead of $\r$\n .

uninstallConfirmPageSettings

UninstallConfirmPageSettings uninstallConfirmPageSettings

To add a newline to any of these texts, use \r\n instead of $\r$\n .

Class com.mindtree.techworks.insight.releng.mvn.nsis.model.NsisProject extends java.lang.Object implements Serializable

Serialized Fields

projectInfo

ProjectInfo projectInfo

Contains the basic information about the project to create the root level information. If not provided, most of this informaiton can be derived from the pom.xml .

installerSettings

InstallerSettings installerSettings

General Installer Settings .

muiInstallerSettings

MuiInstallerSettings muiInstallerSettings

NSIS MUI Settings. See http://nsis.sourceforge.net/Docs/Modern%20UI/Readme.html .

muiPages

MuiPages muiPages

The pages to display in the installer.

sections

InstallerSections sections

The sections.

functions

Functions functions

The installer initialization and un-installer initialization functions.

modelEncoding

java.lang.String modelEncoding

Field modelEncoding.

Class com.mindtree.techworks.insight.releng.mvn.nsis.model.ProjectInfo extends java.lang.Object implements Serializable

Serialized Fields

productName

java.lang.String productName

The name of the product, if not provided, defaults to the artifactId in the pom.xml. However to maintain Windowz conventions, the first character is converted to the upper case.

productVersion

java.lang.String productVersion

The version of the application. If not provided, defaults to the version in the pom.xml .

publisher

java.lang.String publisher

The publisher of the application, if not provided, defaults to the organization/name from the pom .

webSite

java.lang.String webSite

The product web site. If not provided, defaults to the url from the pom .

readmeFile

java.lang.String readmeFile

The readme file.

defaultInstallerLanguage

java.lang.String defaultInstallerLanguage

This is the language of the installer for single language installers and the default language for multi lingual installers. The value of this should be one of the available languages in the 'Contrib/Language files' directory of your NSIS Installation. The language name should be case sensitive. It defaults to 'English' if not set.

Class com.mindtree.techworks.insight.releng.mvn.nsis.model.Section extends java.lang.Object implements Serializable

Serialized Fields

name

java.lang.String name

The name of the section.

description

java.lang.String description

The descriptive name of the section.

optional

boolean optional

Checks if the section is optional.

bold

boolean bold

Indicates if the section is bold.

hidden

boolean hidden

Indicates if the section is hidden .

inInsTypes

java.util.List<E> inInsTypes

Field inInsTypes.

fileSets

java.util.List<E> fileSets

Field fileSets.

files

java.util.List<E> files

Field files.

dependencySets

java.util.List<E> dependencySets

Field dependencySets.

shortcuts

java.util.List<E> shortcuts

Field shortcuts.

Class com.mindtree.techworks.insight.releng.mvn.nsis.model.SetBase extends java.lang.Object implements Serializable

Serialized Fields

useStrictFiltering

boolean useStrictFiltering

When specified as true, any include/exclude patterns which aren't used to filter an actual artifact during assembly creation will cause the build to fail with an error. This is meant to highlight obsolete inclusions or exclusions, or else signal that the assembly descriptor is incorrectly configured. (Since 2.2) .

useDefaultExcludes

boolean useDefaultExcludes

Whether standard exclusion patterns, such as those matching CVS and Subversion metadata files, should be used when calculating the files affected by this set. For backward compatibility, the default value is true. (Since 2.2) .

outputDirectory

java.lang.String outputDirectory

Sets the output directory relative to the root of the root directory of the assembly. For example, "log" will put the specified files in the log directory.

includes

java.util.List<E> includes

Field includes.

excludes

java.util.List<E> excludes

Field excludes.

fileMode

java.lang.String fileMode

Similar to a UNIX permission, sets the file mode of the files included. Format: (User)(Group)(Other) where each component is a sum of Read = 4, Write = 2, and Execute = 1. For example, the default value of 0644 translates to User read-write, Group and Other read-only. (more on unix-style permissions)

directoryMode

java.lang.String directoryMode

Similar to a UNIX permission, sets the directory mode of the directories included. Format: (User)(Group)(Other) where each component is a sum of Read = 4, Write = 2, and Execute = 1. For example, the default value of 0755 translates to User read-write, Group and Other read-only. (more on unix-style permissions)

overWritePolicy

java.lang.String overWritePolicy

The SetOverwrite directive policy.

Class com.mindtree.techworks.insight.releng.mvn.nsis.model.ShortCut extends java.lang.Object implements Serializable

Serialized Fields

link

java.lang.String link

The link with the complete path. For start menu items start the link with $SMPROGRAMS\$ICONS_GROUP\Link Name.lnk. For desktop shortcuts start with $DESKTOP.

targetFile

java.lang.String targetFile

The target file that will be opened by the link. This will be variable resolved. For paths relative to the install directory start the path with $INSTDIR .

parameters

java.lang.String parameters

The parameters to pass to the target.

icon

java.lang.String icon

The icon file.

iconIndexNumber

java.lang.String iconIndexNumber

The index in a multi icon file.

startOptions

java.lang.String startOptions

The startup options. The supported options are: SW_SHOWNORMAL, SW_SHOWMAXIMIZED, SW_SHOWMINIMIZED .

keyboardShortcut

java.lang.String keyboardShortcut

The keyboard shortcut. should be in the form of 'flag|c' where flag can be a combination (using |) of: ALT, CONTROL, EXT, or SHIFT. c is the character to use (a-z, A-Z, 0-9, F1-F24, etc). Note that no spaces are allowed in this string. A good example is "ALT|CONTROL|F8" .

description

java.lang.String description

The description of the link.

Class com.mindtree.techworks.insight.releng.mvn.nsis.model.StartMenuFolderPageSettings extends java.lang.Object implements Serializable

Serialized Fields

textTop

java.lang.String textTop

See http://nsis.sourceforge.net/Docs/Modern%20UI/Readme.html .

textCheckbox

java.lang.String textCheckbox

See http://nsis.sourceforge.net/Docs/Modern%20UI/Readme.html .

defaultFolder

java.lang.String defaultFolder

See http://nsis.sourceforge.net/Docs/Modern%20UI/Readme.html .

noDisable

boolean noDisable

See http://nsis.sourceforge.net/Docs/Modern%20UI/Readme.html .

registryRoot

java.lang.String registryRoot

See http://nsis.sourceforge.net/Docs/Modern%20UI/Readme.html .

registryKey

java.lang.String registryKey

See http://nsis.sourceforge.net/Docs/Modern%20UI/Readme.html .

registryValueName

java.lang.String registryValueName

See http://nsis.sourceforge.net/Docs/Modern%20UI/Readme.html .

Class com.mindtree.techworks.insight.releng.mvn.nsis.model.UninstallConfirmPageSettings extends java.lang.Object implements Serializable

Serialized Fields

textTop

java.lang.String textTop

See http://nsis.sourceforge.net/Docs/Modern%20UI/Readme.html .

textLocation

java.lang.String textLocation

See http://nsis.sourceforge.net/Docs/Modern%20UI/Readme.html .

Class com.mindtree.techworks.insight.releng.mvn.nsis.model.UnpackOptions extends java.lang.Object implements Serializable

Serialized Fields

includes

java.util.List<E> includes

Field includes.

excludes

java.util.List<E> excludes

Field excludes.

filtered

boolean filtered

Whether to filter symbols in the files as they are unpacked from the archive, using properties from the build configuration. (Since 2.2) .

Class com.mindtree.techworks.insight.releng.mvn.nsis.model.WelcomePageSettings extends java.lang.Object implements Serializable

Serialized Fields

title

java.lang.String title

Title to display on the top of the page .

title3Lines

boolean title3Lines

Extra space for the title area .

text

java.lang.String text

Text to display on the page .

Package com.mindtree.techworks.insight.releng.mvn.nsis.resources

Class com.mindtree.techworks.insight.releng.mvn.nsis.resources.CopiedResources extends java.lang.Object implements Serializable

serialVersionUID: 6216556676452746374L

Serialized Fields

sectionName

java.lang.String sectionName

The name of the section for which the resources are being copied.

resources

java.util.List<E> resources

The list of resources with relative path to the temporary directory.