Properties

This guide provides details on the properties available for the various goals in the following sections:

Basic Settings

Property Optional? Description
maven.was5.conntype Yes Specifies the type of connection to be used. The Default type is SOAP. The valid values are SOAP, RMI, JMS, and NONE. NONE means that no server connection is made.
maven.was5.failonerror Yes If set to true causes the build to stop if the task has an error.
maven.was5.home Yes*

Directory containing the WebSphere AppServer installation. *This is requred if the WAS_HOME environment variable is not set.
maven.was5.installed.application Yes The name of the application for install, uninstall, start and stop.
maven.was5.password Yes The password of the admin user to authenticate with for administrative access.
maven.was5.port Yes This is the administration TCP port on the host to connect to.
maven.was5.profile Yes A script file to be executed before processing begins. See WebSphere AppServer documentation for more detail.
maven.was5.properties Yes A java properties file containing attributes to set in the JVM System properties. See WebSphere AppServer documentation for more detail.
maven.was5.quiet Yes If true, the task will not print any status information.
maven.was5.server Yes

Default server name. The goals that require a server name (startServer, stopServer, serverStatus) allow a more specific server to be specifed using ${maven.was5.<goal>.server}.
maven.was5.statusPort Yes The TCP Port the server should send status messages to.
maven.was5.trace Yes If true, the task with print trace information.
maven.was5.username Yes The id of the admin user to authenticate with for administrative access.
maven.was5.version Yes The version of WebSphere being used. Default to was5. Note that this property is not used to differentiate releases, it is simply used as part of the directory structure for various goals.

ejbDeploy Settings

Property Optional? Description
maven.was5.ejbDeploy Yes

Set this property to have the ejbDeploy goal attained as part of the ejb:ejb goal. ie. to run ejbdeploy on your EJB artifact.
maven.was5.ejbDeploy.file Yes The input ejb jar file to be used during the ejbDeploy process (generating code used by the container at runtime). This defaults to ${maven.build.dir}/${maven.final.name}.jar
maven.was5.ejbDeploy.file.out Yes The output ejb jar file generated as a result of the ejbDeploy process (generating code used by the container at runtime). This defaults to ${maven.build.dir}/${maven.was5.version}/${maven.final.name}.jar
maven.was5.ejbDeploy.workingdir Yes The directory that temporary files are written to during the ejbDeploy process. This defaults to ${maven.build.dir}/${maven.was5.version}/ejbdeploy

installApp Settings

Property Optional? Description
maven.was5.installApp.conntype Yes The type of connection to be used. The Default type is SOAP. The valid values are SOAP, RMI, and NONE. NONE means that no server connection is made. Defaults to ${maven.was5.conntype}.
maven.was5.installApp.ear Yes The location of the ear file on the server to install. Defaults to ${maven.build.dir}/${maven.final.name}.ear
maven.was5.installApp.host Yes The hostname of the machine to connect to. Defaults to ${maven.was5.host}.
maven.was5.installApp.password Yes The password of the admin user to authenticate with for administrative access. Defaults to ${maven.was5.password}
maven.was5.installApp.port Yes This is the administration TCP port on the host to connect to. Defaults to ${maven.was5.port}
maven.was5.installApp.username Yes The id of the admin user to authenticate with for administrative access. Defaults to ${maven.was5.username}
maven.was5.installApp.options Yes Options to pass to wsadmin when installing the application. See WebSphere Application Server documentation for more information. Defaults to -appname ${maven.was5.installed.application}

listApps Settings

Property Optional? Description
maven.was5.listApps.conntype Yes The type of connection to be used. The Default type is SOAP. The valid values are SOAP, RMI, and NONE. NONE means that no server connection is made. Defaults to ${maven.was5.conntype}.
maven.was5.listApps.host Yes The hostname of the machine to connect to. Defaults to ${maven.was5.host}.
maven.was5.listApps.password Yes The password of the admin user to authenticate with for administrative access. Defaults to ${maven.was5.password}
maven.was5.listApps.port Yes This is the administration TCP port on the host to connect to. Defaults to ${maven.was5.port}
maven.was5.listApps.profile Yes A script file to be executed before processing begins. Defaults to ${maven.was5.profile}.
maven.was5.listApps.properties Yes A java properties file containing attributes to set in the JVM System properties. Defaults to ${maven.was5.properties}.
maven.was5.listApps.username Yes The id of the admin user to authenticate with for administrative access. Defaults to ${maven.was5.username}

runScript Settings

Property Optional? Description
maven.was5.script.args Yes A list of variables (space delimited) whose values will be passed as arguments to the script.
maven.was5.script.conntype Yes The type of connection to be used. The Default type is SOAP. The valid values are SOAP, RMI, and NONE. NONE means that no server connection is made.
maven.was5.script.host Yes Only specified if the conntype is specified. It contains the hostname of the machine to connect to.
maven.was5.script.lang Yes the language to be used to interpret scripts. The supported values are jacl, javascript, and jpython.
maven.was5.script.password Yes The password to authenticate with the server.
maven.was5.script.port Yes Only specified if the conntype is specified. This is the port on the host to connect to. Defaults to ${maven.was5.port}
maven.was5.script.profile Yes A script file to be executed before processing begins.
maven.was5.script.properties Yes A java properties file containing attributes to set in the JVM System properties.
maven.was5.script.username Yes The id of the admin user to authenticate with for administrative access.

serverStatus Settings

Property Optional? Description
maven.was5.serverStatus.failonerror Yes If set to true causes the build to stop if the task has an error. Defaults to ${maven.was5.failonerror}
maven.was5.serverStatus.server Yes The server to get the status. Defaults to ${maven.was5.server}
maven.was5.serverStatus.statusPort Yes The TCP Port the server should send status messages to. Defaults to ${maven.was5.statusPort}
maven.was5.serverStatus.trace Yes If true, the task with print trace information. Defaults to ${maven.was5.trace}

startApp Settings

Property Optional? Description
maven.was5.startApp.application Yes The name of the application to start. Defaults to ${maven.was5.installed.application}
maven.was5.startApp.conntype Yes Specifies the type of connection to be used. The Default type is SOAP. The valid values are SOAP, RMI, JMS, and NONE. NONE means that no server connection is made. Defaults to ${maven.was5.conntype}
maven.was5.startApp.host Yes The hostname of the machine to connect to. Defaults to ${maven.was5.host}.
maven.was5.startApp.password Yes The password of the admin user to authenticate with for administrative access. Defaults to ${maven.was5.password}
maven.was5.startApp.port Yes This is the administration TCP port on the host to connect to. Defaults to ${maven.was5.port}
maven.was5.startApp.profile Yes A script file to be executed before processing begins. See WebSphere AppServer documentation for more detail.
maven.was5.startApp.properties Yes A java properties file containing attributes to set in the JVM System properties. See WebSphere AppServer documentation for more detail.
maven.was5.startApp.server Yes The server on which the app to start in installed. Defaults to ${maven.was5.server}
maven.was5.startApp.username Yes The id of the admin user to authenticate with for administrative access. Defaults to ${maven.was5.username}

startServer Settings

Property Optional? Description
maven.was5.startServer.failonerror Yes If set to true causes the build to stop if the task has an error. Defaults to ${maven.was5.failonerror}
maven.was5.startServer.password Yes The password of the admin user to authenticate with for administrative access. Defaults to ${maven.was5.password}
maven.was5.startServer.quiet Yes If true, the task will not print any status information. Defaults to ${maven.was5.quiet}
maven.was5.startServer.server Yes The server to start. Defaults to ${maven.was5.server}
maven.was5.startServer.statusPort Yes The TCP Port the server should send status messages to. Defaults to ${maven.was5.statusPort}
maven.was5.startServer.trace Yes If true, the task with print trace information. Defaults to ${maven.was5.trace}
maven.was5.startServer.username Yes The id of the admin user to authenticate with for administrative access. Defaults to ${maven.was5.username}

stopApp Settings

Property Optional? Description
maven.was5.stopApp.application Yes The name of the application to stop. Defaults to ${maven.was5.installed.application}
maven.was5.stopApp.conntype Yes Specifies the type of connection to be used. The Default type is SOAP. The valid values are SOAP, RMI, JMS, and NONE. NONE means that no server connection is made. Defaults to ${maven.was5.conntype}
maven.was5.stopApp.host Yes The hostname of the machine to connect to. Defaults to ${maven.was5.host}.
maven.was5.stopApp.password Yes The password of the admin user to authenticate with for administrative access. Defaults to ${maven.was5.password}
maven.was5.stopApp.port Yes This is the administration TCP port on the host to connect to. Defaults to ${maven.was5.port}
maven.was5.stopApp.profile Yes A script file to be executed before processing begins. See WebSphere AppServer documentation for more detail.
maven.was5.stopApp.properties Yes A java properties file containing attributes to set in the JVM System properties. See WebSphere AppServer documentation for more detail.
maven.was5.stopApp.server Yes The server on which the app to stop in installed. Defaults to ${maven.was5.server}
maven.was5.stopApp.username Yes The id of the admin user to authenticate with for administrative access. Defaults to ${maven.was5.username}

stopServer Settings

Property Optional? Description
maven.was5.stopServer.conntype Yes The type of connection to be used. The Default type is SOAP. The valid values are SOAP, RMI, and NONE. NONE means that no server connection is made. Defaults to ${maven.was5.conntype}.
maven.was5.stopServer.failonerror Yes If set to true causes the build to stop if the task has an error. Defaults to ${maven.was5.failonerror}
maven.was5.stopServer.host Yes The hostname of the machine to connect to. Defaults to ${maven.was5.host}.
maven.was5.stopServer.password Yes The password of the admin user to authenticate with for administrative access. Defaults to ${maven.was5.password}
maven.was5.stopServer.port Yes This is the administration TCP port on the host to connect to. Defaults to ${maven.was5.port}
maven.was5.stopServer.quiet Yes If true, the task will not print any status information. Defaults to ${maven.was5.quiet}
maven.was5.stopServer.server Yes The server to stop. Defaults to ${maven.was5.server}
maven.was5.stopServer.statusPort Yes The TCP Port the server should send status messages to. Defaults to ${maven.was5.statusPort}
maven.was5.stopServer.trace Yes If true, the task with print trace information. Defaults to ${maven.was5.trace}
maven.was5.stopServer.username Yes The id of the admin user to authenticate with for administrative access. Defaults to ${maven.was5.username}

uninstallApp Settings

Property Optional? Description
maven.was5.uninstallApp.application Yes The name of the application for uninstall. Defaults to ${maven.was5.installed.application}
maven.was5.uninstallApp.conntype Yes The type of connection to be used. The Default type is SOAP. The valid values are SOAP, RMI, and NONE. NONE means that no server connection is made. Defaults to ${maven.was5.conntype}.
maven.was5.uninstallApp.host Yes The hostname of the machine to connect to. Defaults to ${maven.was5.host}.
maven.was5.uninstallApp.password Yes The password of the admin user to authenticate with for administrative access. Defaults to ${maven.was5.password}
maven.was5.uninstallApp.port Yes This is the administration TCP port on the host to connect to. Defaults to ${maven.was5.port}
maven.was5.uninstallApp.username Yes The id of the admin user to authenticate with for administrative access. Defaults to ${maven.was5.username}