Ways to install Java EE modules on WebSphere deployment targets

Ways to install enterprise applications or modules

The product provides several ways to install Java EE application files.
Installable files include EAR, enterprise bean (EJB), web application archive (WAR), SIP archive (SAR), resource adapter (connector or RAR), and application client modules. They can be installed on a server or cluster. Application client files can be installed in a WebSphere Application Server configuration but cannot be run on a server.

Option Method Modules Comments Starting after install
Admin console Applications > New application > New Enterprise Application EAR EJB, WAR, SAR, RAR, Application client

For applications that do not require changes to the default bindings, after we specify the application file, expand Choose to generate default bindings and mappings, select Generate default bindings, click the Summary step> Finish.
Applications > Application Types > WebSphere enterprise applications > Start
Monitored directory Add an EAR file or module to a monitoredDeployableApps subdirectory of an application server or deployment manager profile.
For base (stand-alone) application servers, the monitored directory is the monitoredDeployableApps/ servers/server directory of the application server profile.
For deployment managers, a deployment manager profile has the following monitored directories:

monitoredDeployableApps/ servers/server
monitoredDeployableApps/ nodes/node /servers/server
monitoredDeployableApps/ clusters/cluster_name

EAR, EJB, WAR, SAR
Use this option for drag and drop deployment of Java EE 5.0 and later modules.
We cannot specify bindings during deployment. For applications that require changes to the bindings, install the application using the administrative console install wizard, application properties files, or wsadmin scripts.
Monitored directory deployment differs from rapid deployment tools in several ways:

Monitored directory deployment supports deployment to base and network deployment environments. Rapid deployment tools support deployment only to the base environment.
Monitored directory deployment does not start a new daemon. Rapid deployment tools start a separate process.
Monitored directory deployment supports deployment of Java EE 5 and later modules. Rapid deployment tools support assembly of J2EE 1.3 and 1.4 modules, and deployment of all Java EE module versions.
Monitored directory deployment supports use of a properties file to specify deployment options. Rapid deployment tools does not support use of a properties file.

After application or module installation or update, the product starts the application or module automatically.
For installations on a deployment manager monitored directory, the product does not start an application or module automatically if the node agent or server is not running.
Application properties files Create a properties file that specifies to install or update application files. Then, run the wsadmin applyConfigProperties command in any of the following ways:

In a script

At a command prompt
By adding the properties file to a monitoredDeployableApps/ deploymentProperties monitored directory

EAR, EJB, WAR, SAR For information on deploying applications using properties files, see the following topics:

Use application properties files to install, update, and delete enterprise application files
Install enterprise application files by adding properties files to a monitored directory

After application or module installation or update, the product starts the application or module automatically.
For installations on a deployment manager monitored directory, the product does not start an application or module automatically if the node agent or server is not running.
wsadmin scripts Invoke AdminApp object install commands in a script or at a command prompt. EAR, EJB, WAR, SAR, RAR, Application client For an overview of wsadmin, see Get started with scripting. Invoke the startApplication method on an ApplicationManager MBean using AdminControl.
Job manager runs wsadmin scripts Invoke AdminTask.submitJob -jobType installApplication command in a script or at a command prompt. EAR, EJB, WAR, SAR, RAR, Application client Use the job manager to submit a job that installs the application. We can also submit jobs that start and stop the application at designated times.

Invoke the AdminTask.submitJob -jobType startApplication command.
Invoke the startApplication method on an ApplicationManager MBean using AdminControl.

Java application programming interfaces Install programs by completing the steps in Installing an application through programming. All EAR files Use JMX MBeans to install the application. For an overview of Java MBean programming, see Managing applications through programming. Start the application by calling the startApplication method on a proxy.
Rapid deployment tools Briefly, do the following:

Update your J2EE application files.
Set up the rapid deployment environment.
Create a free-form project.
Launch a rapid deployment session.
Drop your updated application files into the free-form project.

J2EE modules at the J2EE 1.3 or 1.4 specification levels, including EAR files and the following stand-alone modules:

EJB
WAR
SAR
RAR
Application client

The rapid deployment tools do not support the J2EE 1.2 or Java EE 5.0 and later specification levels. Use this option for drag and drop deployment of J2EE 1.3 or 1.4 modules. Unlike the monitored directory option, the rapid deployment tools do not support drag and drop deployment of Java EE 5.0 and later modules.
Rapid deployment tools offer the following advantages:

We do not need to assemble your J2EE application files prior to deployment.
We do not need to use other installation tools mentioned in this table to deploy the files.

For a list of ways in which the rapid deployment tools differ from monitored directory deployment, see the monitored directory description in this table.
Use any of the options in this table to start the application. Clicking Start on the Enterprise applications page is the easiest option.
Java programs Code programs that use Java EE DeploymentManager (JSR-88) methods.

Deprecated feature: Application installation using JSR-88 was deprecated in WAS v8.0. Use another way listed in this table to deploy applications or modules.depfeat
All Java EE modules, including EAR files and the following stand-alone modules:

EJB
WAR
SAR
RAR
Application client

Uses Java EE Application Deployment Specification (JSR-88).
Can customize modules using DConfigBeans.

Call the Java EE DeploymentManager (JSR-88) start method in a program to start the deployed modules when the module's running environment initializes.

Related:

Application bindings
EJB 3.x module packaging overview
Install enterprise application files with the console
Install enterprise application files by adding them to a monitored directory
Install enterprise application files by adding properties files to a monitored directory
Use application properties files to install, update, and delete enterprise application files
Get started with wsadmin scripting
Install enterprise applications
Starting applications
Run administrative jobs
Administrative job types
Administer jobs in a flexible management environment
Install an application through programming
Starting an application through programming
Manage applications through programming
EJB metadata annotations
JAX-WS annotations
launchClient tool
Rapid deployment of J2EE applications
EJB deployment tool

Option	Method	Modules	Comments	Starting after install
Admin console	Applications > New application > New Enterprise Application	EAR EJB, WAR, SAR, RAR, Application client	For applications that do not require changes to the default bindings, after we specify the application file, expand Choose to generate default bindings and mappings, select Generate default bindings, click the Summary step> Finish.	Applications > Application Types > WebSphere enterprise applications > Start
Monitored directory	Add an EAR file or module to a monitoredDeployableApps subdirectory of an application server or deployment manager profile. For base (stand-alone) application servers, the monitored directory is the monitoredDeployableApps/ servers/server directory of the application server profile. For deployment managers, a deployment manager profile has the following monitored directories: monitoredDeployableApps/ servers/server monitoredDeployableApps/ nodes/node /servers/server monitoredDeployableApps/ clusters/cluster_name	EAR, EJB, WAR, SAR Use this option for drag and drop deployment of Java EE 5.0 and later modules.	We cannot specify bindings during deployment. For applications that require changes to the bindings, install the application using the administrative console install wizard, application properties files, or wsadmin scripts. Monitored directory deployment differs from rapid deployment tools in several ways: Monitored directory deployment supports deployment to base and network deployment environments. Rapid deployment tools support deployment only to the base environment. Monitored directory deployment does not start a new daemon. Rapid deployment tools start a separate process. Monitored directory deployment supports deployment of Java EE 5 and later modules. Rapid deployment tools support assembly of J2EE 1.3 and 1.4 modules, and deployment of all Java EE module versions. Monitored directory deployment supports use of a properties file to specify deployment options. Rapid deployment tools does not support use of a properties file.	After application or module installation or update, the product starts the application or module automatically. For installations on a deployment manager monitored directory, the product does not start an application or module automatically if the node agent or server is not running.
Application properties files	Create a properties file that specifies to install or update application files. Then, run the wsadmin applyConfigProperties command in any of the following ways: In a script At a command prompt By adding the properties file to a monitoredDeployableApps/ deploymentProperties monitored directory	EAR, EJB, WAR, SAR	For information on deploying applications using properties files, see the following topics: Use application properties files to install, update, and delete enterprise application files Install enterprise application files by adding properties files to a monitored directory	After application or module installation or update, the product starts the application or module automatically. For installations on a deployment manager monitored directory, the product does not start an application or module automatically if the node agent or server is not running.
wsadmin scripts	Invoke AdminApp object install commands in a script or at a command prompt.	EAR, EJB, WAR, SAR, RAR, Application client	For an overview of wsadmin, see Get started with scripting.	Invoke the startApplication method on an ApplicationManager MBean using AdminControl.
Job manager runs wsadmin scripts	Invoke AdminTask.submitJob -jobType installApplication command in a script or at a command prompt.	EAR, EJB, WAR, SAR, RAR, Application client	Use the job manager to submit a job that installs the application. We can also submit jobs that start and stop the application at designated times.	Invoke the AdminTask.submitJob -jobType startApplication command. Invoke the startApplication method on an ApplicationManager MBean using AdminControl.
Java application programming interfaces	Install programs by completing the steps in Installing an application through programming.	All EAR files	Use JMX MBeans to install the application. For an overview of Java MBean programming, see Managing applications through programming.	Start the application by calling the startApplication method on a proxy.
Rapid deployment tools	Briefly, do the following: Update your J2EE application files. Set up the rapid deployment environment. Create a free-form project. Launch a rapid deployment session. Drop your updated application files into the free-form project.	J2EE modules at the J2EE 1.3 or 1.4 specification levels, including EAR files and the following stand-alone modules: EJB WAR SAR RAR Application client The rapid deployment tools do not support the J2EE 1.2 or Java EE 5.0 and later specification levels. Use this option for drag and drop deployment of J2EE 1.3 or 1.4 modules. Unlike the monitored directory option, the rapid deployment tools do not support drag and drop deployment of Java EE 5.0 and later modules.	Rapid deployment tools offer the following advantages: We do not need to assemble your J2EE application files prior to deployment. We do not need to use other installation tools mentioned in this table to deploy the files. For a list of ways in which the rapid deployment tools differ from monitored directory deployment, see the monitored directory description in this table.	Use any of the options in this table to start the application. Clicking Start on the Enterprise applications page is the easiest option.
Java programs	Code programs that use Java EE DeploymentManager (JSR-88) methods. Deprecated feature: Application installation using JSR-88 was deprecated in WAS v8.0. Use another way listed in this table to deploy applications or modules.depfeat	All Java EE modules, including EAR files and the following stand-alone modules: EJB WAR SAR RAR Application client	Uses Java EE Application Deployment Specification (JSR-88). Can customize modules using DConfigBeans.	Call the Java EE DeploymentManager (JSR-88) start method in a program to start the deployed modules when the module's running environment initializes.