WebLogic Server Maven Plugin

WebLogic Server Maven Plugin provides capabilities to install the Server, configure a domain, compile and deploy applications.

Coordinates

groupId: com.oracle.weblogic

artifactId: wls-maven-plugin

version:12.1.1.0

Goals summary

Goal	Description
appc	The appc compiler generates and compiles the classes needed to deploy EJBs and JSPs to WebLogic Server. It also validates the deployment descriptors for compliance with the current specifications at both the individual module level and the application level.
deploy	To deploy a weblogic server application (supports all formats WAR,JAR etc..)
create-domain	Create a domain for WebLogic Server using the default domain template. For more complex domain creation use the WLST goal.
help	Provides a list of all the goals supported by the wls-maven-plugin
install	Install WebLogic Server
list-apps	Lists the deployment names for applications and stand-alone modules deployed distributed, or installed to the domain
redeploy	Redeploys a running application or part of a running application
start-app	Starts an application deployed on weblogic server.
start-server	Start WebLogic Server
stop-app	Stops an application
stop-server	Stop Weblogic Server
undeploy	Undeploys the application from weblogic server. Stops the deployment unit and removes staged files from target servers
update-app	Updates an application's deployment plan by redistributing the plan files and reconfiguring the application based on the new plan contents.
wlst	WLST wrapper for Maven

Plugin description

The latest version of this html file can be located inside the wls-maven-plugin.jar or WebLogic Server documentation.

The WebLogic Server maven plugin is located under "${MW_HOME}/wlserver*/server/lib" folder of the server installation.


    wls-maven-plugin.jar
    pom.xml

Installing the plugin to a local repository


  $ cd $MW_HOME/wlserver*/server/lib

  $ mvn install (this ensures that the plugin has the proper 'wls' prefix)

  $ mvn install:install-file -Dfile="wls-maven-plugin.jar"

Uploading the plugin to a remote repository


  $ cd $MW_HOME/wlserver*/server/lib

  $ mvn deploy:deploy-file \
      -Dfile=wls-maven-plugin.jar \
      -Durl=http://host:port/url-to-remote-repo \
      -DrepositoryId=your-repo-id \
      -DpomFile=pom.xml

Plugin prefix
(Installs the dev zip distro at a http url to location /home/myhome/mywls) The WebLogic Server Maven Plugin can be prefixed as 'wls' for ease of use. Installing the plugin in the local repository with the afore mentioned steps will result in the setup of a proper prefix. In the case the plugin prefix isn't working properly, you can configure the prefix in your Maven settings.xml file as below


  <pluginGroups>
    <pluginGroup> org.codehaus.modello </pluginGroup>
  </pluginGroups>

You can always use the full coordinates if you don't intend to use the prefix or can't setup the prefix.


  $ mvn com.oracle.weblogic:wls-maven-plugin:help

Usage
After the plugin is installed you can use the 'help' goal for usage of the plugin goals.


$ mvn wls:help
$ mvn wls:help -Dgoal="install" -Ddetail="true"

Goal Name: appc

The appc compiler generates and compiles the classes needed to deploy EJBs and JSPs to WebLogic Server. It also validates the deployment descriptors for compliance with the current specifications at both the individual module level and the application level.

Name	Type	Required	Description
altappdd	`java.lang.String`	false	Location of the alternate application deployment descriptor.
altwlsappdd	`java.lang.String`	false	Location of the alternate WebLogic application deployment descriptor.
basicClientJar	`boolean`	false	Do not include deployment descriptors in client jars generated for EJBs. Default value is: `false`
classpath	`java.lang.String`	false	Add a list of comma separated directories that make up the desired CLASSPATH. Include directories containing any classes required by the JSP.
clientJarOutputDir	`java.lang.String`	false	Specifies a directory to put generated client jars.
commentary	`boolean`	false	Causes the JSP compiler to include comments from the JSP in the generated HTML page. If this option is omitted, comments do not appear in the generated HTML page. Default value is: `false`
compiler	`java.lang.String`	false	Specifies the Java compiler to be used to compile the class file from the generated Java source code. The default compiler used is javac. The Java compiler program should be in your PATH unless you specify the absolute path to the compiler explicitly.
compilerClass	`java.lang.String`	false	<com.sun.tools.javac.Main> Compiler class to invoke.
continueCompilation	`boolean`	false	Continues compilation even when there are errors in jsp. Default value is: `false`
debug	`boolean`	false	Compile debugging info into class file. Default value is: `false`
deprecation	`boolean`	false	Warn about the use of deprecated methods in the generated Java source file when compiling the source file into a class file. Default value is: `false`
destdir	`java.io.File`	false	Specifies the destination of the compiled output (that is, the class file). Use this option as a shortcut for placing the compiled classes in a directory that is already in your CLASSPATH.
enableHotCodeGen	`boolean`	false	Default value is: `false`
forceGeneration	`boolean`	false	Force generation of EJB and JSP classes. Without this flag the classes may not be regenerated if it is determined to be unnecessary. Default value is: `false`
idl	`boolean`	false	Generate idl for EJB remote interfaces Default value is: `false` Default value is: `false` Default value is: `false` Default value is: `false` Default value is: `false` Default value is: `false` Default value is: `false` Default value is: `false`
idlDirectory	`java.lang.String`	false	Specify the directory where IDL files will be created (default : target directory or jar
idlFactories	`boolean`	false	Generate factory methods for valuetypes. Default value is: `false`
idlMethodSignatures	`java.lang.String`	false	Specify the method signatures used to trigger idl code generation.
idlNoAbstractInterfaces	`boolean`	false	Do not generate abstract interfaces and methods/attributes that contain them. Default value is: `false`
idlNoValueTypes	`boolean`	false	Do not generate valuetypes and methods/attributes that contain them. Default value is: `false`
idlOrbix	`boolean`	false	Generate IDL somewhat compatible with Orbix 2000 2.0 C++. Default value is: `false`
idlOverwrite	`boolean`	false	Always overwrite existing IDL files. Default value is: `false`
idlVerbose	`boolean`	false	Display verbose information for IDL generation. Default value is: `false`
idlVisibroker	`boolean`	false	Generate IDL somewhat compatible with visibroker 4.5 C++. Default value is: `false`
ignorePlanValidation	`boolean`	false	Ignore the plan file if it doesn't exist.
iiop	`boolean`	false	Generate CORBA stubs for EJBs. Default value is: `false`
iiopDirectory	`java.lang.String`	false	Specify the directory where IIOP stub files will be written (default : target directory or jar
keepgenerated	`boolean`	false	Keep the generated .java files. Default value is: `false`
libraries	`java.lang.String`	false	comma-separated list of libraries.
librarydir	`java.io.File`	false	Registers all files in specified directory as libraries.
lineNumbers	`boolean`	false	Add JSP line numbers to generated class files to aid in debugging. Default value is: `false`
manifest	`java.io.File`	false	Include manifest information from specified manifest file.
maxfiles	`java.lang.Integer`	false	Maximum number of generated java files to be compiled at one time.
middlewareHome	`java.lang.String`	false	The home directory for Oracle WebLogic Server or Fusion Middleware installation. Required unless WLS was installed in the default location selected by the WLS Maven Plugin's install goal. Default value is: `${basedir}/Oracle/Software`
noexit	`boolean`	false	Default value is: `true`
normi	`boolean`	false	Passed through to Symantec's sj. Default value is: `false`
nowarn	`boolean`	false	Compile without warnings. Default value is: `false`
nowrite	`boolean`	false	Sends the output to stdout instead of writeLicense.txt Default value is: `false`
optimize	`boolean`	false	Compile with optimization on. Default value is: `false`
output	`java.io.File`	false
plan	`java.io.File`	false	Specifies an optional deployment plan.
quiet	`boolean`	false	Turns off output except for errors.
runtimeFlags	`java.lang.String`	false	Takes a list of options that are passed to your compiler.
serverClasspath	`java.lang.String`	false	Add additional jars and directories to the classpath making the resources and classes they contain available to the wls-maven-plugin.
source	`java.io.File`	false	The source location to be compiled. Default value is: `${project.build.directory}/${project.artifactId}.${project.packaging}`
sourceVersion	`java.lang.String`	false	Source version.
supressCompiler	`boolean`	false	Default value is: `true`
targetVersion	`java.lang.String`	false	Target version.
verbose	`boolean`	false	Passes the verbose flag to the Java compiler specified with the compiler flag. See the compiler documentation for more information. Default value is: `false` Default value is: `false`
verboseJavac	`boolean`	false	Enable Java compiler verbose output. Default value is: `false`
weblogicHome	`java.lang.String`	false	Location of the WLS install. It can be an absolute path or relative to the 'middlewareHome'. This setting is optional, in the case where the defaults are used and the 'weblogicHome' is a child folder of 'middlewareHome'. If the user has more than one WebLogic Home, or if it is not a child folder of 'middlewareHome'it is mandatory to provide this value.
writeInferredDescriptors	`boolean`	false	Write out the descriptors with inferred information including annotations.

Examples:

Goal Name: deploy

To deploy a weblogic server application (supports all formats WAR,JAR etc..)

Name	Type	Required	Description
adminurl	`java.lang.String`	false	The -adminurl value must specify the listen address and listen port of the Administration Server.
advanced	`boolean`	false	Print advanced usage options.
debug	`boolean`	false	Display debug level messages to the standard output. Default value is: `false`
enableSecurityValidation	`boolean`	false	Enables validation of security data. Default value is: `false`
examples	`boolean`	false	Displays example usage of this tool.
external_stage	`boolean`	false	Indicates that the user wants to copy the application in the server staging area externally or using a third-party tool.When specified, WebLogic Server looks for the application under "StagingDirectoryName (of target server)/applicationName." Default value is: `false`
failOnError	`boolean`	false	Boolean value to force the Mojo to fail the build upon encountering an error if it would otherwise just log the error Default value is: `true`
id	`java.lang.String`	false	Optional client supplied unique identifier for the deployment task. Default value is: `false` Default value is: `${basedir}/Oracle/Software`
middlewareHome	`java.lang.String`	false	The home directory for Oracle WebLogic Server or Fusion Middleware installation. Required unless WLS was installed in the default location selected by the WLS Maven Plugin's install goal. Default value is: `${basedir}/Oracle/Software`
name	`java.lang.String`	false	Specifies the deployment name to assign to a newly-deployed application or stand-alone module.
nostage	`boolean`	false	This application will not be staged and deployed from the source location. When specified, the application must be available at the location provided in the "-source" option on all target servers. Default: "nostage" for admin server and "stage" for managed server targets.
noversion	`boolean`	false	Indicates that weblogic.Deployer should ignore all version related code paths on the Administration Server. Default value is: `false`
nowait	`boolean`	false	This option is used to initiate multiple tasks and then monitor them later with the -list action.
password	`java.lang.String`	false	Password of the Administrator user.
plan	`java.lang.String`	false	<Deployment plan path> Specifies location of deployment plan.
purgetasks	`boolean`	false	Flush out deploymenttasks that are retired java weblogic.Deployer -adminurl url -username username -password password -purgetasks
remote	`boolean`	false	Indicates that the tool is not running on the same machine as the admin server and the "-source" path is the actual path on the server. By default, this tool assumes any "-source" path to be valid on the local machine. In that case, the "-upload" option must be used if the tool needs to copy the application over to the admin server.
retiretimeout	`java.lang.Integer`	false	<The retirement timeout in seconds> The retirement timeout in seconds for timeout retirement policy. If not specified, graceful retirement policy is assumed. Default value is: `-1`
securityModel	`java.lang.String`	false	<DDOnly\|CustomRoles\|CustomRolesAndPolicies\|Advanced> Security model to be used for this deployment.
serverClasspath	`java.lang.String`	false	Add additional jars and directories to the classpath making the resources and classes they contain available to the wls-maven-plugin.
source	`java.lang.String`	false	The address of the artifact. This can be one of the following - 1.) A file or directory on the local system, can be an exploded archive 2.) A ':' separated maven coordinates of the form (groupId:artifactId:packaging:classifier:version) Default value is: `${project.build.directory}/${project.build.finalName}.${project.packaging}`
stage	`boolean`	false	Indicates that the application needs to be copied into the target server staging area before deployment. Default: "nostage" for admin server and "stage" for managed server targets. Default value is: `false`
submoduletargets	`java.lang.String`	false	<submod@mod-jms.xml@target \| submoduleName@target> SubModule level targets for JMS Modules.
targets	`java.lang.String`	false	A comma separated list of targets for the current operation. If not specified, all configured targets are used. For a new application, the default target is the administration server.
timeout	`java.lang.Integer`	false	Maximum time, in seconds, to wait for the deployment task to complete. Default value is: `-1` Default value is: `-1`
upload	`boolean`	false	Causes the specified source file(s) to be transferred to the administration server. This is used when the Deployer tools is not being used on the same machine as the administration server or the user does not otherwise have access to place the targeted files on the administration server. Default value is: `false`
user	`java.lang.String`	false	Administrator username
userConfigFile	`java.lang.String`	false	Location of a user configuration file to use for the administrative username and password. Instead of using user and password directly.
userKeyFile	`java.lang.String`	false	Specifies the location of a user key file to use for encrypting and decrypting the username and password stored in a user configuration file.
verbose	`boolean`	false	Displays additional status during the deployment process. Default value is: `false`
version	`boolean`	false	Prints version information. Default value is: `false`
weblogicHome	`java.lang.String`	false	Location of the WLS install. It can be an absolute path or relative to the 'middlewareHome'. This setting is optional, in the case where the defaults are used and the 'weblogicHome' is a child folder of 'middlewareHome'. If the user has more than one WebLogic Home, or if it is not a child folder of 'middlewareHome'it is mandatory to provide this value.

Goal Name: create-domain

Create a domain for WebLogic Server using the default domain template. For more complex domain creation use the WLST goal.

Name	Type	Required	Description
domainHome	`java.lang.String`	false	Location of WLS domain Default value is: `${basedir}/Oracle/Domains/mydomain`
domainTemplate	`java.lang.String`	false	The domain template file to use for creating the domain. Defaults to the the default domain template included in WLS.
failOnDomainExists	`boolean`	false	Boolean value specifying if the application's build should fail when domain already exists at domainHome. The default value is false. When failOnDomainExists is false, returns build successful without overwriting existing domainHome. If failOnDomainExists is true, returns build unsuccessful throwing an exception. Default value is: `false`
middlewareHome	`java.lang.String`	false	The home directory for Oracle WebLogic Server or Fusion Middleware installation. Required unless WLS was installed in the default location selected by the WLS Maven Plugin's install goal. Default value is: `${basedir}/Oracle/Software`
password	`java.lang.String`	true	Password for adminstrator user.
serverClasspath	`java.lang.String`	false	Add additional jars and directories to the classpath making the resources and classes they contain available to the wls-maven-plugin.
user	`java.lang.String`	true	Username for adminstrator user.
weblogicHome	`java.lang.String`	false	Location of the WLS install. It can be an absolute path or relative to the 'middlewareHome'. This setting is optional, in the case where the defaults are used and the 'weblogicHome' is a child folder of 'middlewareHome'. If the user has more than one WebLogic Home, or if it is not a child folder of 'middlewareHome'it is mandatory to provide this value.

Goal Name: help

Provides a list of all the goals supported by the wls-maven-plugin

Name	Type	Required	Description
detail	`boolean`	false	Print detailed help of goals Default value is: `false`
goal	`java.lang.String`	false	Print help of a specific goal. When not set displays help of all goals.

Goal Name: install

Install WebLogic Server

Name	Type	Required	Description
artifactLocation	`java.lang.String`	true	The address of the artifact. This can be one of the following - 1) A ':' separated maven coordinates of the form (groupId:artifactId:packaging:classifier:version) 2) A file on the local system (/home/prash/myapps/helloworld.war)3) A remote http url (http://foo/a/b.zip)
domainHome	`java.lang.String`	false	Location of WLS domain Default value is: `${basedir}/Oracle/Domains/mydomain`
installCommand	`java.lang.String`	false	The command to use to install the product when using an 'executable' installer. The following macros are supported - @INSTALLER_FILE@ - the path to the installer file, @JAVA_HOME@ - path to the java home. eg: @JAVA_HOME@ -Xms512m -Xmx1024m -jar @INSTALLER_FILE@ one two
localRepository	`org.apache.maven.artifact.repository.ArtifactRepository`	true	The absolute path of a local maven repository.
middlewareHome	`java.lang.String`	false	The home directory for Oracle WebLogic Server or Fusion Middleware installation. Required unless WLS was installed in the default location selected by the WLS Maven Plugin's install goal. Default value is: `${basedir}/Oracle/Software`

Examples:


    $ mvn wls:install -DmiddlewareHome=/home/myhome/mywls -DartifactLocation=/home/myhome/wls1211_dev.zip
    (Installs the dev zip distro from local file /home/myhome/wls1211_dev.zip to location /home/myhome/mywls)

    $ mvn wls:install -DmiddlewareHome=/home/myhome/mywls -DartifactLocation=http://myhost/foo/bar/wls1211_dev.zip
    (Installs the dev zip distro from a remote http url to location /home/myhome/mywls)

    $ mvn wls:install -DmiddlewareHome=/home/myhome/mywls -DartifactLocation=com.foo.bar:wls-installers:12.1.1.0
    (Installs the dev zip distro from a local/remote maven repo to location /home/myhome/mywls)


The following shows a snippet of pom.xml which performs the installation.

  <build>
    <plugins>  
      <plugin>
        <groupId>com.oracle.weblogic</groupId>
        <artifactId>wls-maven-plugin</artifactId>
        <version>12.1.1.0</version>
          <executions>
            <execution>
              <phase>pre-integration-test</phase>
              <goals> <goal>install</goal> </goals>
            </execution>
          </executions>
          <configuration>
            <artifactLocation>http://myhost/foo/bar/wls1211_dev.zip</artifactLocation>
            <middlewareHome>/home/myhome/mywls</middlewareHome>
          </configuration>
        </plugin>
      </plugins>
  </build>

Goal Name: list-apps

Lists the deployment names for applications and stand-alone modules deployed distributed, or installed to the domain

Name	Type	Required	Description
adminurl	`java.lang.String`	false	The -adminurl value must specify the listen address and listen port of the Administration Server.
advanced	`boolean`	false	Print advanced usage options.
debug	`boolean`	false	Display debug level messages to the standard output. Default value is: `false`
examples	`boolean`	false	Displays example usage of this tool.
failOnError	`boolean`	false	Boolean value to force the Mojo to fail the build upon encountering an error if it would otherwise just log the error Default value is: `true`
middlewareHome	`java.lang.String`	false	The home directory for Oracle WebLogic Server or Fusion Middleware installation. Required unless WLS was installed in the default location selected by the WLS Maven Plugin's install goal. Default value is: `${basedir}/Oracle/Software`
noversion	`boolean`	false	Indicates that weblogic.Deployer should ignore all version related code paths on the Administration Server. Default value is: `false`
nowait	`boolean`	false	This option is used to initiate multiple tasks and then monitor them later with the -list action.
password	`java.lang.String`	false	Password of the Administrator user.
purgetasks	`boolean`	false	Flush out deploymenttasks that are retired java weblogic.Deployer -adminurl url -username username -password password -purgetasks
remote	`boolean`	false	Indicates that the tool is not running on the same machine as the admin server and the "-source" path is the actual path on the server. By default, this tool assumes any "-source" path to be valid on the local machine. In that case, the "-upload" option must be used if the tool needs to copy the application over to the admin server.
serverClasspath	`java.lang.String`	false	Add additional jars and directories to the classpath making the resources and classes they contain available to the wls-maven-plugin.
timeout	`java.lang.Integer`	false	Maximum time, in seconds, to wait for the deployment task to complete. Default value is: `-1`
user	`java.lang.String`	false	Administrator username
userConfigFile	`java.lang.String`	false	Location of a user configuration file to use for the administrative username and password. Instead of using user and password directly.
userKeyFile	`java.lang.String`	false	Specifies the location of a user key file to use for encrypting and decrypting the username and password stored in a user configuration file.
verbose	`boolean`	false	Displays additional status during the deployment process. Default value is: `false`
version	`boolean`	false	Prints version information. Default value is: `false`
weblogicHome	`java.lang.String`	false	Location of the WLS install. It can be an absolute path or relative to the 'middlewareHome'. This setting is optional, in the case where the defaults are used and the 'weblogicHome' is a child folder of 'middlewareHome'. If the user has more than one WebLogic Home, or if it is not a child folder of 'middlewareHome'it is mandatory to provide this value.

Goal Name: redeploy

Redeploys a running application or part of a running application

Name	Type	Required	Description
adminurl	`java.lang.String`	false	The -adminurl value must specify the listen address and listen port of the Administration Server.
deleteFiles	`java.lang.String`	false	Causes the server to remove the files that are specified in the file list and leave the application activated. This option is valid only for unarchived Web applications.
examples	`boolean`	false	Displays example usage of this tool.
failOnError	`boolean`	false	Boolean value to force the Mojo to fail the build upon encountering an error if it would otherwise just log the error Default value is: `true`
id	`java.lang.String`	false	Optional client supplied unique identifier for the deployment task. Default value is: `${basedir}/Oracle/Software`
middlewareHome	`java.lang.String`	false	The home directory for Oracle WebLogic Server or Fusion Middleware installation. Required unless WLS was installed in the default location selected by the WLS Maven Plugin's install goal. Default value is: `${basedir}/Oracle/Software`
name	`java.lang.String`	false	Specifies the deployment name to assign to a newly-deployed application or stand-alone module.
password	`java.lang.String`	false	Password of the Administrator user.
plan	`java.lang.String`	false	<Deployment plan path> Specifies location of deployment plan.
remote	`boolean`	false	Indicates that the tool is not running on the same machine as the admin server and the "-source" path is the actual path on the server. By default, this tool assumes any "-source" path to be valid on the local machine. In that case, the "-upload" option must be used if the tool needs to copy the application over to the admin server.
retiretimeout	`java.lang.Integer`	false	<The retirement timeout in seconds> The retirement timeout in seconds for timeout retirement policy. If not specified, graceful retirement policy is assumed. Default value is: `-1`
rmiGracePeriod	`java.lang.Integer`	false	<The RMI grace period in seconds> Grace period for RMI requests during graceful shutdown. Can be used with -graceful option only. Default is no grace period. Default value is: `-1`
serverClasspath	`java.lang.String`	false	Add additional jars and directories to the classpath making the resources and classes they contain available to the wls-maven-plugin.
source	`java.lang.String`	false	The address of the artifact. This can be one of the following - 1.) A file or directory on the local system, can be an exploded archive 2.) A ':' separated maven coordinates of the form (groupId:artifactId:packaging:classifier:version) Default value is: `${project.build.directory}/${project.build.finalName}.${project.packaging}`
submoduletargets	`java.lang.String`	false	<submod@mod-jms.xml@target \| submoduleName@target> SubModule level targets for JMS Modules.
targets	`java.lang.String`	false	A comma separated list of targets for the current operation. If not specified, all configured targets are used. For a new application, the default target is the administration server.
timeout	`java.lang.Integer`	false	Maximum time, in seconds, to wait for the deployment task to complete. Default value is: `-1` Default value is: `-1`
upload	`boolean`	false	Causes the specified source file(s) to be transferred to the administration server. This is used when the Deployer tools is not being used on the same machine as the administration server or the user does not otherwise have access to place the targeted files on the administration server. Default value is: `false`
user	`java.lang.String`	false	Administrator username
userConfigFile	`java.lang.String`	false	Location of a user configuration file to use for the administrative username and password. Instead of using user and password directly.
userKeyFile	`java.lang.String`	false	Specifies the location of a user key file to use for encrypting and decrypting the username and password stored in a user configuration file.
verbose	`boolean`	false	Displays additional status during the deployment process. Default value is: `false`
version	`boolean`	false	Prints version information.
weblogicHome	`java.lang.String`	false	Location of the WLS install. It can be an absolute path or relative to the 'middlewareHome'. This setting is optional, in the case where the defaults are used and the 'weblogicHome' is a child folder of 'middlewareHome'. If the user has more than one WebLogic Home, or if it is not a child folder of 'middlewareHome'it is mandatory to provide this value.

Goal Name: start-app

Starts an application deployed on weblogic server.

Name	Type	Required	Description
adminmode	`boolean`	false	The administration mode. If not specified, production mode is assumed. Default value is: `false`
adminurl	`java.lang.String`	false	The -adminurl value must specify the listen address and listen port of the Administration Server.
advanced	`boolean`	false	Print advanced usage options.
appversion	`java.lang.String`	false	<application version> The version identifier of the application. If not specified, the currently active version of the application is assumed.
debug	`boolean`	false	Display debug level messages to the standard output. Default value is: `false`
domainHome	`java.lang.String`	false	Location of WLS domain Default value is: `${basedir}/Oracle/Domains/mydomain`
examples	`boolean`	false	Displays example usage of this tool.
failOnError	`boolean`	false	Boolean value to force the Mojo to fail the build upon encountering an error if it would otherwise just log the error Default value is: `true`
id	`java.lang.String`	false	Optional client supplied unique identifier for the deployment task. Default value is: `${basedir}/Oracle/Software`
middlewareHome	`java.lang.String`	false	The home directory for Oracle WebLogic Server or Fusion Middleware installation. Required unless WLS was installed in the default location selected by the WLS Maven Plugin's install goal. Default value is: `${basedir}/Oracle/Software`
name	`java.lang.String`	false	Specifies the deployment name to assign to a newly-deployed application or stand-alone module.
noversion	`boolean`	false	Indicates that weblogic.Deployer should ignore all version related code paths on the Administration Server. Default value is: `false`
nowait	`boolean`	false	This option is used to initiate multiple tasks and then monitor them later with the -list action.
password	`java.lang.String`	false	Password of the Administrator user.
planversion	`java.lang.String`	false	<deployment plan version> The version identifier of the deployment plan. If not specified, the currently active version of the applications deployment plan is assumed.
purgetasks	`boolean`	false	Flush out deploymenttasks that are retired java weblogic.Deployer -adminurl url -username username -password password -purgetasks
remote	`boolean`	false	Indicates that the tool is not running on the same machine as the admin server and the "-source" path is the actual path on the server. By default, this tool assumes any "-source" path to be valid on the local machine. In that case, the "-upload" option must be used if the tool needs to copy the application over to the admin server.
retiretimeout	`java.lang.Integer`	false	<The retirement timeout in seconds> The retirement timeout in seconds for timeout retirement policy. If not specified, graceful retirement policy is assumed. Default value is: `-1`
serverClasspath	`java.lang.String`	false	Add additional jars and directories to the classpath making the resources and classes they contain available to the wls-maven-plugin.
submoduletargets	`java.lang.String`	false	<submod@mod-jms.xml@target \| submoduleName@target> SubModule level targets for JMS Modules.
targets	`java.lang.String`	false	A comma separated list of targets for the current operation. If not specified, all configured targets are used. For a new application, the default target is the administration server.
timeout	`java.lang.Integer`	false	Maximum time, in seconds, to wait for the deployment task to complete. Default value is: `-1` Default value is: `-1`
user	`java.lang.String`	false	Administrator username
userConfigFile	`java.lang.String`	false	Location of a user configuration file to use for the administrative username and password. Instead of using user and password directly.
userKeyFile	`java.lang.String`	false	Specifies the location of a user key file to use for encrypting and decrypting the username and password stored in a user configuration file.
verbose	`boolean`	false	Displays additional status during the deployment process. Default value is: `false`
version	`boolean`	false	Prints version information. Default value is: `false`
weblogicHome	`java.lang.String`	false	Location of the WLS install. It can be an absolute path or relative to the 'middlewareHome'. This setting is optional, in the case where the defaults are used and the 'weblogicHome' is a child folder of 'middlewareHome'. If the user has more than one WebLogic Home, or if it is not a child folder of 'middlewareHome'it is mandatory to provide this value.

Goal Name: start-server

Start WebLogic Server

Name	Type	Required	Description
command	`[Ljava.lang.String;`	false	The startWebLogic script to execute. Defaults to startWebLogic.sh or startWebLogic.cmd based on platform
domainHome	`java.lang.String`	false	Location of WLS domain Default value is: `${basedir}/Oracle/Domains/mydomain`
httpPingUrl	`java.lang.String`	false	The URL to ping to check if server is running
middlewareHome	`java.lang.String`	false	The home directory for Oracle WebLogic Server or Fusion Middleware installation. Required unless WLS was installed in the default location selected by the WLS Maven Plugin's install goal. Default value is: `${basedir}/Oracle/Software`
serverClasspath	`java.lang.String`	false	Add additional jars and directories to the classpath making the resources and classes they contain available to the wls-maven-plugin.
timeoutSecs	`java.lang.Integer`	false	The timeout for the script. Valid when waitForExit is 'true'. A '0' or negative value indicates that script will not timeout Default value is: `-1`
weblogicHome	`java.lang.String`	false	Location of the WLS install. It can be an absolute path or relative to the 'middlewareHome'. This setting is optional, in the case where the defaults are used and the 'weblogicHome' is a child folder of 'middlewareHome'. If the user has more than one WebLogic Home, or if it is not a child folder of 'middlewareHome'it is mandatory to provide this value.

Goal Name: stop-app

Stops an application

Name	Type	Required	Description
adminmode	`boolean`	false	The administration mode. If not specified, production mode is assumed. Default value is: `false`
adminurl	`java.lang.String`	false	The -adminurl value must specify the listen address and listen port of the Administration Server.
advanced	`boolean`	false	Print advanced usage options.
appversion	`java.lang.String`	false	<application version> The version identifier of the application. If not specified, the currently active version of the application is assumed.
debug	`boolean`	false	Display debug level messages to the standard output. Default value is: `false`
domainHome	`java.lang.String`	false	Location of WLS domain Default value is: `${basedir}/Oracle/Domains/mydomain`
examples	`boolean`	false	Displays example usage of this tool.
failOnError	`boolean`	false	Boolean value to force the Mojo to fail the build upon encountering an error if it would otherwise just log the error Default value is: `true`
graceful	`boolean`	false	Graceful shutdown. If not specified, force shutdown is assumed.
id	`java.lang.String`	false	Optional client supplied unique identifier for the deployment task. Default value is: `${basedir}/Oracle/Software`
ignoresessions	`boolean`	false	Ignore pending HTTP sessions during graceful shutdown. Can be used with -graceful option only. Default is false.
middlewareHome	`java.lang.String`	false	The home directory for Oracle WebLogic Server or Fusion Middleware installation. Required unless WLS was installed in the default location selected by the WLS Maven Plugin's install goal. Default value is: `${basedir}/Oracle/Software`
name	`java.lang.String`	false	Specifies the deployment name to assign to a newly-deployed application or stand-alone module.
noversion	`boolean`	false	Indicates that weblogic.Deployer should ignore all version related code paths on the Administration Server. Default value is: `false`
nowait	`boolean`	false	This option is used to initiate multiple tasks and then monitor them later with the -list action.
password	`java.lang.String`	false	Password of the Administrator user.
planversion	`java.lang.String`	false	<deployment plan version> The version identifier of the deployment plan. If not specified, the currently active version of the applications deployment plan is assumed.
purgetasks	`boolean`	false	Flush out deploymenttasks that are retired java weblogic.Deployer -adminurl url -username username -password password -purgetasks
remote	`boolean`	false	Indicates that the tool is not running on the same machine as the admin server and the "-source" path is the actual path on the server. By default, this tool assumes any "-source" path to be valid on the local machine. In that case, the "-upload" option must be used if the tool needs to copy the application over to the admin server.
rmiGracePeriod	`java.lang.Integer`	false	<The RMI grace period in seconds> Grace period for RMI requests during graceful shutdown. Can be used with -graceful option only. Default is no grace period. Default value is: `-1`
serverClasspath	`java.lang.String`	false	Add additional jars and directories to the classpath making the resources and classes they contain available to the wls-maven-plugin.
submoduletargets	`java.lang.String`	false	<submod@mod-jms.xml@target \| submoduleName@target> SubModule level targets for JMS Modules.
targets	`java.lang.String`	false	A comma separated list of targets for the current operation. If not specified, all configured targets are used. For a new application, the default target is the administration server.
timeout	`java.lang.Integer`	false	Maximum time, in seconds, to wait for the deployment task to complete. Default value is: `-1`
user	`java.lang.String`	false	Administrator username
userConfigFile	`java.lang.String`	false	Location of a user configuration file to use for the administrative username and password. Instead of using user and password directly.
userKeyFile	`java.lang.String`	false	Specifies the location of a user key file to use for encrypting and decrypting the username and password stored in a user configuration file.
verbose	`boolean`	false	Displays additional status during the deployment process. Default value is: `false`
version	`boolean`	false	Prints version information. Default value is: `false`
weblogicHome	`java.lang.String`	false	Location of the WLS install. It can be an absolute path or relative to the 'middlewareHome'. This setting is optional, in the case where the defaults are used and the 'weblogicHome' is a child folder of 'middlewareHome'. If the user has more than one WebLogic Home, or if it is not a child folder of 'middlewareHome'it is mandatory to provide this value.

Goal Name: stop-server

Stop Weblogic Server

Name	Type	Required	Description
adminurl	`java.lang.String`	false	URL for Admininistration Server Default value is: `t3://localhost:7001`
command	`[Ljava.lang.String;`	false	The startWebLogic script to execute. Defaults to stopWebLogic.sh or stopWebLogic.cmd based on platform
domainHome	`java.lang.String`	false	Location of WLS domain Default value is: `${basedir}/Oracle/Domains/mydomain`
middlewareHome	`java.lang.String`	false	The home directory for Oracle WebLogic Server or Fusion Middleware installation. Required unless WLS was installed in the default location selected by the WLS Maven Plugin's install goal. Default value is: `${basedir}/Oracle/Software`
outputLog	`java.lang.String`	false	The log file to redirect script output to. Will default stdout
password	`java.lang.String`	true	Password for administrator user
timeoutSecs	`java.lang.Integer`	false	The timeout for the script. Valid when waitForExit is 'true'. A '0' or negative value indicates that script will not timeout Default value is: `-1`
user	`java.lang.String`	true	Username for administrator user
waitForExit	`boolean`	false	Should wait for the process to exit or not. Defaults to true Default value is: `true`
weblogicHome	`java.lang.String`	false	Location of the WLS install. It can be an absolute path or relative to the 'middlewareHome'. This setting is optional, in the case where the defaults are used and the 'weblogicHome' is a child folder of 'middlewareHome'. If the user has more than one WebLogic Home, or if it is not a child folder of 'middlewareHome'it is mandatory to provide this value.
workingDir	`java.lang.String`	false	The working directory for the script. Defaults to the current working directory. Default value is: `${project.base.directory}`

Goal Name: undeploy

Undeploys the application from weblogic server. Stops the deployment unit and removes staged files from target servers

Name	Type	Required	Description
adminurl	`java.lang.String`	false	The -adminurl value must specify the listen address and listen port of the Administration Server.
advanced	`boolean`	false	Print advanced usage options.
appversion	`java.lang.String`	false	<application version> The version identifier of the application. If not specified, the currently active version of the application is assumed.
debug	`boolean`	false	Display debug level messages to the standard output. Default value is: `false`
examples	`boolean`	false	Displays example usage of this tool.
failOnError	`boolean`	false	Boolean value to force the Mojo to fail the build upon encountering an error if it would otherwise just log the error Default value is: `true`
graceful	`boolean`	false	Graceful shutdown. If not specified, force shutdown is assumed.
id	`java.lang.String`	false	Optional client supplied unique identifier for the deployment task. Default value is: `${basedir}/Oracle/Software`
ignoresessions	`boolean`	false	Ignore pending HTTP sessions during graceful shutdown. Can be used with -graceful option only. Default is false.
middlewareHome	`java.lang.String`	false	The home directory for Oracle WebLogic Server or Fusion Middleware installation. Required unless WLS was installed in the default location selected by the WLS Maven Plugin's install goal. Default value is: `${basedir}/Oracle/Software`
name	`java.lang.String`	false	Specifies the deployment name to assign to a newly-deployed application or stand-alone module.
noversion	`boolean`	false	Indicates that weblogic.Deployer should ignore all version related code paths on the Administration Server. Default value is: `false`
nowait	`boolean`	false	This option is used to initiate multiple tasks and then monitor them later with the -list action.
password	`java.lang.String`	false	Password of the Administrator user.
planversion	`java.lang.String`	false	<deployment plan version> The version identifier of the deployment plan. If not specified, the currently active version of the applications deployment plan is assumed.
purgetasks	`boolean`	false	Flush out deploymenttasks that are retired java weblogic.Deployer -adminurl url -username username -password password -purgetasks
remote	`boolean`	false	Indicates that the tool is not running on the same machine as the admin server and the "-source" path is the actual path on the server. By default, this tool assumes any "-source" path to be valid on the local machine. In that case, the "-upload" option must be used if the tool needs to copy the application over to the admin server.
rmiGracePeriod	`java.lang.Integer`	false	<The RMI grace period in seconds> Grace period for RMI requests during graceful shutdown. Can be used with -graceful option only. Default is no grace period. Default value is: `-1`
serverClasspath	`java.lang.String`	false	Add additional jars and directories to the classpath making the resources and classes they contain available to the wls-maven-plugin.
submoduletargets	`java.lang.String`	false	<submod@mod-jms.xml@target \| submoduleName@target> SubModule level targets for JMS Modules.
targets	`java.lang.String`	false	A comma separated list of targets for the current operation. If not specified, all configured targets are used. For a new application, the default target is the administration server.
timeout	`java.lang.Integer`	false	Maximum time, in seconds, to wait for the deployment task to complete. Default value is: `-1`
user	`java.lang.String`	false	Administrator username
userConfigFile	`java.lang.String`	false	Location of a user configuration file to use for the administrative username and password. Instead of using user and password directly.
userKeyFile	`java.lang.String`	false	Specifies the location of a user key file to use for encrypting and decrypting the username and password stored in a user configuration file.
verbose	`boolean`	false	Displays additional status during the deployment process. Default value is: `false`
version	`boolean`	false	Prints version information. Default value is: `false`
weblogicHome	`java.lang.String`	false	Location of the WLS install. It can be an absolute path or relative to the 'middlewareHome'. This setting is optional, in the case where the defaults are used and the 'weblogicHome' is a child folder of 'middlewareHome'. If the user has more than one WebLogic Home, or if it is not a child folder of 'middlewareHome'it is mandatory to provide this value.

Goal Name: update-app

Updates an application's deployment plan by redistributing the plan files and reconfiguring the application based on the new plan contents.

Name	Type	Required	Description
adminurl	`java.lang.String`	false	The -adminurl value must specify the listen address and listen port of the Administration Server.
advanced	`boolean`	false	Print advanced usage options.
appversion	`java.lang.String`	false	<application version> The version identifier of the application. If not specified, the currently active version of the application is assumed.
debug	`boolean`	false	Display debug level messages to the standard output. Default value is: `false`
domainHome	`java.lang.String`	false	Location of WLS domain Default value is: `${basedir}/Oracle/Domains/mydomain`
examples	`boolean`	false	Displays example usage of this tool.
failOnError	`boolean`	false	Boolean value to force the Mojo to fail the build upon encountering an error if it would otherwise just log the error Default value is: `true`
id	`java.lang.String`	false	Optional client supplied unique identifier for the deployment task. Default value is: `${basedir}/Oracle/Software`
middlewareHome	`java.lang.String`	false	The home directory for Oracle WebLogic Server or Fusion Middleware installation. Required unless WLS was installed in the default location selected by the WLS Maven Plugin's install goal. Default value is: `${basedir}/Oracle/Software`
name	`java.lang.String`	false	Specifies the deployment name to assign to a newly-deployed application or stand-alone module.
noversion	`boolean`	false	Indicates that weblogic.Deployer should ignore all version related code paths on the Administration Server. Default value is: `false`
nowait	`boolean`	false	This option is used to initiate multiple tasks and then monitor them later with the -list action.
password	`java.lang.String`	false	Password of the Administrator user.
plan	`java.lang.String`	false	<Deployment plan path> Specifies location of deployment plan.
planversion	`java.lang.String`	false	<deployment plan version> The version identifier of the deployment plan. If not specified, the currently active version of the applications deployment plan is assumed.
purgetasks	`boolean`	false	Flush out deploymenttasks that are retired java weblogic.Deployer -adminurl url -username username -password password -purgetasks
remote	`boolean`	false	Indicates that the tool is not running on the same machine as the admin server and the "-source" path is the actual path on the server. By default, this tool assumes any "-source" path to be valid on the local machine. In that case, the "-upload" option must be used if the tool needs to copy the application over to the admin server.
rmiGracePeriod	`java.lang.Integer`	false	<The RMI grace period in seconds> Grace period for RMI requests during graceful shutdown. Can be used with -graceful option only. Default is no grace period. Default value is: `-1`
serverClasspath	`java.lang.String`	false	Add additional jars and directories to the classpath making the resources and classes they contain available to the wls-maven-plugin.
submoduletargets	`java.lang.String`	false	<submod@mod-jms.xml@target \| submoduleName@target> SubModule level targets for JMS Modules.
targets	`java.lang.String`	false	A comma separated list of targets for the current operation. If not specified, all configured targets are used. For a new application, the default target is the administration server.
timeout	`java.lang.Integer`	false	Maximum time, in seconds, to wait for the deployment task to complete. Default value is: `-1`
upload	`boolean`	false	Causes the specified source file(s) to be transferred to the administration server. This is used when the Deployer tools is not being used on the same machine as the administration server or the user does not otherwise have access to place the targeted files on the administration server. Default value is: `false`
user	`java.lang.String`	false	Administrator username
userConfigFile	`java.lang.String`	false	Location of a user configuration file to use for the administrative username and password. Instead of using user and password directly.
userKeyFile	`java.lang.String`	false	Specifies the location of a user key file to use for encrypting and decrypting the username and password stored in a user configuration file.
verbose	`boolean`	false	Displays additional status during the deployment process. Default value is: `false`
version	`boolean`	false	Prints version information. Default value is: `false`
weblogicHome	`java.lang.String`	false	Location of the WLS install. It can be an absolute path or relative to the 'middlewareHome'. This setting is optional, in the case where the defaults are used and the 'weblogicHome' is a child folder of 'middlewareHome'. If the user has more than one WebLogic Home, or if it is not a child folder of 'middlewareHome'it is mandatory to provide this value.

Goal Name: wlst

WLST wrapper for Maven

Name	Type	Required	Description
args	`java.lang.String`	false	A string value containing command line arguments to pass to the WLST Python interpreter. The arguments are delimited by spaces.
debug	`boolean`	false	Boolean value specifying verbose option. Default value is: `false`
executeScriptBeforeFile	`boolean`	false	Boolean value specifying whether the script, if supplied, executes before or after the file, if supplied. Either a file or a script is required, and both are allowed. See fileName and script parameters. Default value is: `true`
failOnError	`boolean`	false	Boolean value specifying whether the application's build should fail if the WLST goal fails. The default value is true, and consequently any error condition will cause the build to fail. In some cases, setting failOnError to false will allow the WLST goal to ignore the error. Default value is: `true`
fileName	`java.lang.String`	false	File path of the WLST Python script to be executed. Either a fileName or a script parameter must be specified, and both are allowed.
middlewareHome	`java.lang.String`	false	The home directory for Oracle WebLogic Server or Fusion Middleware installation. Required unless WLS was installed in the default location selected by the WLS Maven Plugin's install goal. Default value is: `${basedir}/Oracle/Software`
propertiesFile	`java.lang.String`	false	Path name to a Java properties file. The property names become defined variables in the WLST Python interpreter and are initialized to the values supplied. For example, if the properties file contains the line "foobar:Very important stuff", the variable foobar can be used in a Python statement in the following manner: "print('foobar has the value: ' + foobar)".
script	`java.lang.String`	false	A string value specifying an inline WLST Python script, for example, "print('Hello, world!')".
serverClasspath	`java.lang.String`	false	Add additional jars and directories to the classpath making the resources and classes they contain available to the wls-maven-plugin.
weblogicHome	`java.lang.String`	false	Location of the WLS install. It can be an absolute path or relative to the 'middlewareHome'. This setting is optional, in the case where the defaults are used and the 'weblogicHome' is a child folder of 'middlewareHome'. If the user has more than one WebLogic Home, or if it is not a child folder of 'middlewareHome'it is mandatory to provide this value.