The following sections describe tools for deploying applications and standalone modules to WebLogic Server:
The wldeploy
Ant task enables you to perform weblogic.Deployer
functions using attributes specified in an Ant XML file. You can use wldeploy
along with other WebLogic Server Ant tasks to create a single Ant build script that:
Builds your application from source, using wlcompile
, appc
, and the Web Services Ant tasks.
Creates, starts, and configures a new WebLogic Server domain, using the wlserver
and wlconfig
Ant tasks.
Deploys a compiled application to the newly-created domain, using the wldeploy
Ant task.
See Chapter 2, "Using Ant Tasks to Configure and Use a WebLogic Server Domain," for more information about wlserver
and wlconfig
. See Chapter 4, "Building Applications in a Split Development Directory," for information about wlcompile
.
To use the wldeploy
Ant task:
Set your environment.
On Windows NT, execute the setWLSEnv.cmd
command, located in the directory WL_HOME
\server\bin
, where WL_HOME
is the top-level directory of your WebLogic Server installation.
On UNIX, execute the setWLSEnv.sh
command, located in the directory WL_HOME
/server/bin
, where WL_HOME
is the top-level directory of your WebLogic Server installation.
In the staging directory, create the Ant build file (build.xml
by default). If you want to use an Ant installation that is different from the one installed with WebLogic Server, start by defining the wldeploy
Ant task definition:
<taskdef name="wldeploy" classname="weblogic.ant.taskdefs.management.WLDeploy"/>
If necessary, add task definitions and calls to the wlserver
and wlconfig
tasks in the build script to create and start a new WebLogic Server domain. See Chapter 2, "Using Ant Tasks to Configure and Use a WebLogic Server Domain," for information about wlserver
and wlconfig
.
Add a call to wldeploy
to deploy your application to one or more WebLogic Server instances or clusters. See Sample build.xml Files for wldeploy and wldeploy Ant Task Attribute Reference.
Execute the Ant task or tasks specified in the build.xml
file by typing ant
in the staging directory, optionally passing the command a target argument:
prompt> ant
The following example shows a wldeploy
target that deploys an application to a single WebLogic Server instance:
<target name="deploy"> <wldeploy action="deploy" verbose="true" debug="true" name="DeployExample" source="output/redeployEAR" user="weblogic" password="weblogic" adminurl="t3://localhost:7001" targets="myserver" /> </target>
The following example shows a corresponding task to undeploy the application; the example shows that when you undeploy or redeploy an application, you do not specify the source archive file or exploded directory, but rather, just its deployed name.:
<target name="undeploy"> <wldeploy action="undeploy" verbose="true" debug="true" name="DeployExample" user="weblogic" password="weblogic" adminurl="t3://localhost:7001" targets="myserver" failonerror="false" /> </target>
The following example shows how to perform a partial redeploy of the application; in this case, just a single WAR file in the application is redeployed:
<target name="redeploy_partial"> <wldeploy action="redeploy" verbose="true" name="DeployExample" user="weblogic" password="weblogic" adminurl="t3://localhost:7001" targets="myserver" deltaFiles="examples/general/redeploy/SimpleImpl.war" /> </target>
The following example uses the nested <files>
child element of wldeploy
to specify a particular file in the application that should be undeployed:
<target name="undeploy_partial"> <wldeploy action="undeploy" verbose="true" debug="true" name="DeployExample" user="weblogic" password="weblogic" adminurl="t3://localhost:7001" targets="myserver" failonerror="false"> <files dir="${current-dir}/output/redeployEAR/examples/general/redeploy" includes="SimpleImpl.jsp" /> </wldeploy> </target>
The following example shows how to deploy a Java EE library called myLibrary
whose source files are located in the output/myLibrary
directory:
<target name="deploy"> <wldeploy action="deploy" name="myLibrary" source="output/myLibrary" library="true" user="weblogic" password="weblogic" verbose="true" adminurl="t3://localhost:7001" targets="myserver" /> </target>
The following sections describe the attributes and child element <files>
of the wldeploy
Ant task.
The following table describes the main attributes of the wldeploy
Ant task.
These attributes mirror some of the arguments of the weblogic.Deployer
command. Oracle provides an Ant task version of the weblogic.Deployer
command so that developers can easily deploy and test their applications as part of the iterative development process. Typically, however, administrators use the weblogic.Deployer
command, and not the wldeploy
Ant task, to deploy applications in a production environment. For that reason, see the "weblogic.Deployer Command-Line Reference" in Oracle Fusion Middleware Deploying Applications to Oracle WebLogic Server for the full and complete definition of the attributes of the wldeploy
Ant task. The table below is provided just as a quick summary.
Table B-1 Attributes of the wldeploy Ant Task
Attribute | Description | Data Type |
---|---|---|
action |
The deployment action to perform. Valid values are |
String |
adminmode |
Specifies that the deployment action puts the application into Administration mode. Administration mode restricts access to an application to a configured Administration channel. Valid values for this attribute are |
Boolean |
adminurl |
The URL of the Administration Server. The format of the value of this attribute is Note: In order to use the HTTP protocol, you must enable the http tunnelling option in the Administration Console. |
String |
allversions |
Specifies that the action (redeploy, stop, and so on) applies to all versions of the application. Valid values for this attribute are |
Boolean |
altappdd |
Specifies the name of an alternate Java EE deployment descriptor ( If you do not specify this attribute, and you are deploying an Enterprise application, the default deployment descriptor is called |
String |
altwlsappdd |
Specifies the name of an alternate WebLogic Server deployment descriptor ( If you do not specify this attribute, and you are deploying an Enterprise application, the default deployment descriptor is called |
String |
appversion |
The version identifier of the deployed application. |
String |
debug |
Enable |
Boolean |
deleteFiles |
Specifies whether to remove static files from a server's staging directory. This attribute is valid only for unarchived deployments, and only for applications deployed using Specifying the This attribute can be used only in combination with Because the Valid values for this attribute are true and false. Default value is false. |
Boolean |
deltaFiles |
Specifies a comma- or space-separated list of files, relative to the root directory of the application, which are to be redeployed. Use this attribute only in conjunction with |
String |
enableSecurityValidation |
Specifies whether or not to enable validation of security data. Valid values for this attribute are true and false. Default value is false. |
Boolean |
externalStage |
Specifies whether the deployment uses In this mode, the Ant task does not copy the deployment files to target servers; instead, you must ensure that deployment files have been copied to the correct subdirectory in the target servers' staging directories. You can specify only one of the following attributes: See "Controlling Deployment File Copying with Staging Modes". |
Boolean |
failonerror |
This is a global attribute used by WebLogic Server Ant tasks. It specifies whether the task should fail if it encounters an error during the build. Valid values for this attribute are true and false. Default value is true. |
Boolean |
graceful |
Stops the application after existing HTTP clients have completed their work. You can use this attribute only when stopping or undeploying an application, or in other words, you must also specify either the Valid values for this attribute are |
Boolean |
id |
Identification used for obtaining status or cancelling the deployment. You assign a unique ID to an application when you deploy it, and then subsequently use the ID when redeploying, undeploying, stopping, and so on. If you do not specify this attribute, the Ant task assigns a unique ID to the application. |
String |
ignoresessions |
This option immediately places the application into Administration mode without waiting for current HTTP sessions to complete. You can use this attribute only when stopping or undeploying an application, or in other words, you must also specify either the Valid values for this attribute are |
Boolean |
libImplVer |
Specifies the implementation version of a Java EE library or optional package. This attribute can be used only if the library or package does not include a implementation version in its manifest file. You can specify this attribute only in combination with the See Chapter 9, "Creating Shared Java EE Libraries and Optional Packages." |
String |
library |
Identifies the deployment as a shared Java EE library or optional package. You must specify the Valid values for this attribute are See Chapter 9, "Creating Shared Java EE Libraries and Optional Packages." |
Boolean |
libSpecVer |
Provides the specification version of a Java EE library or optional package. This attribute can be used only if the library or package does not include a specification version in its manifest file. You can specify this attribute only in combination with the See Chapter 9, "Creating Shared Java EE Libraries and Optional Packages." |
String |
name |
The deployment name for the deployed application. If you do not specify this attribute, WebLogic Server assigns a deployment name to the application, based on its archive file or exploded directory. |
String |
nostage |
Specifies whether the deployment uses nostage deployment mode. In this mode, the Ant task does not copy the deployment files to target servers, but leaves them in a fixed location, specified by the You can specify only one of the following attributes: See "Controlling Deployment File Copying with Staging Modes". |
Boolean |
noversion |
Indicates that the If you use this option, you cannot use versioned applications. Valid values for this attribute are true and false. Default value is false. |
Boolean |
nowait |
Specifies whether |
Boolean |
password |
The administrative password. To avoid having the plain text password appear in the build file or in process utilities such as If you want to obtain a username and password from a non-default configuration file and key file, use the See the command reference for |
String |
plan |
Specifies a deployment plan to use when deploying the application or module. By default, |
String |
planversion |
The version identifier of the deployment plan. |
String |
remote |
Specifies whether the server is located on a different machine. This affects how filenames are transmitted. Valid values for this attribute are |
Boolean |
retiretimeout |
Specifies the number of seconds before WebLogic Server undeploys the currently-running version of this application or module so that clients can start using the new version. It is assumed, when you specify this attribute, that you are starting, deploying, or redeploying a new version of an already-running application. |
int |
securityModel |
Specifies the security model to use for this deployment. Possible security models are:
Valid actual values for this attribute are See "Options for Securing Web Application and EJB Resources" for more information on these security models. |
String |
source |
The archive file or exploded directory to deploy. |
File |
stage |
Specifies whether the deployment uses stage deployment mode. In this mode, the Ant task copies deployment files to target servers' staging directories. You can specify only one of the following attributes: See "Controlling Deployment File Copying with Staging Modes". |
Boolean |
submoduletargets |
Specifies JMS server targets for resources defined within a JMS application module. The value of this attribute is a comma-separated list of JMS server names. See "Using Sub-Module Targeting with JMS Application Modules". |
String |
targets |
The list of target servers to which the application is deployed. The value of this attribute is a comma-separated list of the target servers, clusters, or virtual hosts. If you do not specify a target list when deploying an application, the target defaults to the Administration Server instance. |
String |
timeout |
The maximum number of seconds to wait for a deployment to succeed. |
int |
upload |
Specifies whether the source file(s) are copied to the Administration Server's upload directory prior to deployment. Use this attribute when you are on a remote machine and you cannot copy the deployment files to the Administration Server by other means. Valid values for this attribute are |
Boolean |
usenonexclusivelock |
Specifies that the deployment action (deploy, redeploy, stop, and so on) uses the existing lock on the domain that has already been acquired by the same user performing the action. This attribute is particularly useful when the user is using multiple deployment tools (Ant task, command line, Administration console, and so on) simultaneously and one of the tools has already acquired a lock on the domain. Valid values for this attribute are |
Boolean |
user |
The administrative username. |
String |
userconfigfile |
Specifies the location of a user configuration file to use for obtaining the administrative username and password. Use this option, instead of the Before specifying the |
String |
userkeyfile |
Specifies the location of a user key file to use for encrypting and decrypting the username and password information stored in a user configuration file (the Before specifying the |
String |
verbose |
Specifies whether |
Boolean |
The wldeploy
Ant task also includes the <files>
child element that can be nested to specify a list of files on which to perform a deployment action (for example, a list of JSPs to undeploy.)
Note: :
Use of<files>
to redeploy a list of files in an application has been deprecated as of release 9.0 of WebLogic Server. Instead, use the deltaFiles
attribute of wldeploy.The <files>
element works the same as the standard <fileset>
Ant task (except for the difference in actual task name). Therefore, see the Apache Ant Web site at http://ant.apache.org/manual/CoreTypes/fileset.html
for detailed reference information about the attributes you can specify for the <files>
element.