Manage applications through programming

Through Java MBean programming, we can install, update, and delete a JEE (Java EE) application on a WAS deployment target.

This task assumes a basic familiarity with MBean programming. For information on MBean programming, see MBean Java (API) documentation. In this information center, click Reference > Mbean interfaces.

For information on the restarting of updated applications, refer to Fine-grained recycle behavior in IBM WebSphere Developer Technical Journal: System management for WebSphere Application Server V6 -- Part 5 Flexible options for updating deployed applications.

Before we can install or change an application on a deployment target, first create or update the application and assemble it using an assembly tool.

Besides installing, uninstalling, and updating applications through programming, we can additionally install, uninstall, and update Java EE applications through the administrative console or wsadmin.sh. All three ways provide identical updating capabilities.

1. Perform any or all of the following tasks to manage your Java EE applications through programming.

   • Access the application management function.

     See the following examples to access the application management functionality:

     • From WebSphere Application Server code

     • From outside WebSphere Application Server

     • When WebSphere Application Server is not running

   • Install an application.

     See the example for initially installing an application on a deployment target such as a server or cluster.

   • Uninstall an application.

     See the example for uninstalling an application that resides on a deployment target.

   • Manipulate additional attributes for a deployed application.

     See the example for manipulating attributes that are not exposed through the AppDeploymentTask object.

   • Share sessions for application management.

     See the example for saving application-specific updates for a deployed application to a session, and then to the configuration repository.

   • Update an application.

     See the example for updating the installed application on a server or cluster with a new application. When you completely update an application, the deployed application is uninstalled and the new EAR file is installed.

   • Add to, update, or delete part of an application.

     See the example that we can use to add, update, or delete part of an application on a server or cluster.

   • Edit an application.

     See the example for editing an application on a server or cluster.

   • Add a module.

     See the example for adding a module to an application that resides on a server or cluster.

   • Update a module.

     See the example for updating a module that resides on a server or cluster. When you update a module, the deployed module is uninstalled and the updated module is installed.

   • Delete a module.

     See the example for deleting a module that resides on a server or cluster. When we delete a module, the deployed module is uninstalled.

   • Add a file.

     See the example for adding a file to an application that resides on a server or cluster.

   • Update a file.

     See the example for updating a file on a server or cluster. When you update a file, the deployed file is uninstalled and the updated file is installed.

   • Delete a file.

     See the example for deleting a file on a server or cluster. When we delete a file, the deployed file is uninstalled.

2. Save the changes to the master configuration repository.

3. Synchronize changes to the master configuration across the nodes for the changes to take effect.

What to do next

If we have further application updates, we can do the updates through programming, the administrative console, or wsadmin.sh.

We can use the common deployment framework to add additional logic to application management operations. See Extending application management operations through programming. The tasks that the extensions provide are available through all the administrative clients, such as wsadmin.sh, the administrative console, or through programmatic APIs that the AppManagement MBean provides.

Subtopics

• Access the application management function
  The com.ibm.websphere.management.application.AppManagementProxy class provides uniform access to application management functionality, regardless of whether the functionality is accessed from the server process, administrative client process, or a stand-alone Java program in the absence of WAS. We can use the code excerpts to learn how to obtain an AppManagementProxy instance in a variety of cases.

• Prepare an application for installation using programming
  The product application management architecture provides a set of classes that allows application developers to collect WebSphere Application Server-specific deployment information, hereafter called binding information, and store it in the application EAR file. Such an EAR file can then be installed into a WAS configuration, using application management interfaces described in the topic Installing an application through programming. This topic uses a programming example to explain how an EAR file can be populated with binding information.

• Install an application through programming
  We can install an application through the administrative console, wsadmin.sh, or programming. Use this example to install an application through programming.

• Application management
  

• Start an application through programming
  We can start an application through the administrative console, wsadmin.sh, or programming. Use this example to start an application through programming.

• Share sessions for application management
  With the configuration service interface, ConfigService, we can create a session that is a temporary staging area, where we can save all the configuration modifications. Saving the session saves all the updates from the session into the WAS configuration repository. The application management logic supports session sharing with the configuration service. We can perform all the application management functions in the same session as the one that the configuration service creates. Saving such a session saves all the updates, including the ones that are application-specific.

• Manipulating additional attributes for a deployed application
  We can manipulate attributes for a deployed application through the administrative console, wsadmin.sh, or by programming. Use this example to manipulate attributes that are not exposed during or after application installation through the AppDeploymentTask object.

• Edit applications
  We can edit deployed applications through the administrative console, wsadmin.sh, or by programming. Use this example to edit a deployed application through programming.

• Update an application through programming
  We can update an existing application through the administrative console, wsadmin.sh, or programming. Use this example to completely update an application through programming.

• Add to, updating, or deleting part of an application through programming
  We can add to, update, or delete part of an existing application through the administrative console, wsadmin.sh, or programming. This example changes part of an application through programming. We can use this example whether we add to, update, or delete part of an existing application. Multiple changes to an application can be packaged in a single compressed .zip file.

• Prepare a module and adding it to an existing application through programming
  We can add a module to an existing application through the administrative console, wsadmin.sh, or programming. Use this example to add a module through programming.

• Prepare and updating a module through programming
  We can update a module for an existing application through the administrative console, wsadmin.sh, or programming. When you update a module, you replace the existing module with a new version. Use this example to update a module through programming.

• Add a file through programming
  We can add a file to an existing application through the administrative console, wsadmin.sh, or programming. This example describes how to add a file through programming.

• Update a file through programming
  We can update a file for an existing application through the administrative console, wsadmin.sh, or programming. This example describes how to update a file through programming.

• Uninstall an application through programming
  We can uninstall an application through the administrative console, wsadmin.sh, or programming. Use this example to uninstall an application through programming.

• Delete a module through programming
  We can delete a module from an existing application through the administrative console, wsadmin.sh, or programming. Use this example to delete a module through programming.

• Delete a file through programming
  We can delete a file from an existing application through the administrative console, wsadmin.sh, or programming. Use this example to delete a file through programming.

Related concepts

Ways to install enterprise applications or modules

Ways to update enterprise application files

Related tasks

Deploy

Get started with wsadmin scripting

Assembling applications

Extending application management operations through programming