was6:installApp

Full name:

org.codehaus.mojo:was6-maven-plugin:1.0:installApp

Description:

Installs an EAR into WebSphere Application Server.

Attributes:

  • Requires a Maven 2.0 project to be executed.

Required Parameters

Name Type Since Description
applicationName String - The name of the application that you wish to administer. Default value is: ${project.build.finalName}.
conntype String - Specifies the type of connection to be used. Valid values are: SOAP, RMI or NONE. Default value is: NONE.
host String - The host to connect to. This will also be used as the keys to lookup userId/password from settings.xml, if not specified in the username and/or password parameter in the plugin. Default value is: localhost.
wasHome File - Root install location of WebSphere 6.1 Default value is: ${env.WAS_HOME}.
workingDirectory File - Working directory for plugin.

Optional Parameters

Name Type Since Description
earFile File - EAR archive to deploy. Default value is: ${project.artifact.file}.
failOnError boolean - Keep on going even if calling task fails. Default value is: true.
logFile File - Optional log file to log execution of ws_ant to.
password String - Password to authenticate with. This takes precedence over values defined in settings.xml.
port Integer - The port on the host to connect to.
profile String - Optional script file to be executed before the main command or file.
profileName String - The profile name of the desired server.
properties File - Optional java properties file containing attributes to set in the JVM System properties
targetCell String - The target cell for deployment.
targetCluster String - Name of target cluster to deploy to.
targetNode String - The target node for deployment.
targetServer String - The target server for deployment.
updateExisting boolean - Flag for updating existing application or installing a brand new. Default value is: true.
username String - user ID to authenticate with. This takes precedence over values defined in settings.xml.
verbose boolean - Specifies a verbose execution to help debug. Default value is: false.

Parameter Details

applicationName:

The name of the application that you wish to administer.
  • Type: java.lang.String
  • Required: Yes
  • Expression: ${was6.applicationName}
  • Default: ${project.build.finalName}

conntype:

Specifies the type of connection to be used. Valid values are: SOAP, RMI or NONE.
  • Type: java.lang.String
  • Required: Yes
  • Expression: ${was6.conntype}
  • Default: NONE

earFile:

EAR archive to deploy.
  • Type: java.io.File
  • Required: No
  • Expression: ${was6.earFile}
  • Default: ${project.artifact.file}

failOnError:

Keep on going even if calling task fails.
  • Type: boolean
  • Required: No
  • Expression: ${was6.failOnError}
  • Default: true

host:

The host to connect to. This will also be used as the keys to lookup userId/password from settings.xml, if not specified in the username and/or password parameter in the plugin.
  • Type: java.lang.String
  • Required: Yes
  • Expression: ${was6.host}
  • Default: localhost

logFile:

Optional log file to log execution of ws_ant to.
  • Type: java.io.File
  • Required: No
  • Expression: ${was6.logFile}

password:

Password to authenticate with. This takes precedence over values defined in settings.xml.
  • Type: java.lang.String
  • Required: No
  • Expression: ${was6.password}

port:

The port on the host to connect to.
  • Type: java.lang.Integer
  • Required: No
  • Expression: ${was6.port}

profile:

Optional script file to be executed before the main command or file.
  • Type: java.lang.String
  • Required: No
  • Expression: ${was6.profile}

profileName:

The profile name of the desired server.
  • Type: java.lang.String
  • Required: No
  • Expression: ${was6.profileName}

properties:

Optional java properties file containing attributes to set in the JVM System properties
  • Type: java.io.File
  • Required: No
  • Expression: ${was6.properties}

targetCell:

The target cell for deployment.
  • Type: java.lang.String
  • Required: No
  • Expression: ${was6.targetCell}

targetCluster:

Name of target cluster to deploy to.
  • Type: java.lang.String
  • Required: No
  • Expression: ${was6.targetCluster}

targetNode:

The target node for deployment.
  • Type: java.lang.String
  • Required: No
  • Expression: ${was6.targetNode}

targetServer:

The target server for deployment.
  • Type: java.lang.String
  • Required: No
  • Expression: ${was6.targetServer}

updateExisting:

Flag for updating existing application or installing a brand new.
  • Type: boolean
  • Required: No
  • Expression: ${was6.updateExisting}
  • Default: true

username:

user ID to authenticate with. This takes precedence over values defined in settings.xml.
  • Type: java.lang.String
  • Required: No
  • Expression: ${was6.username}

verbose:

Specifies a verbose execution to help debug.
  • Type: boolean
  • Required: No
  • Expression: ${was6.verbose}
  • Default: false

wasHome:

Root install location of WebSphere 6.1
  • Type: java.io.File
  • Required: Yes
  • Expression: ${was6.wasHome}
  • Default: ${env.WAS_HOME}

workingDirectory:

Working directory for plugin.
  • Type: java.io.File
  • Required: Yes
  • Expression: ${project.build.directory}/was6-maven-plugin