Managing applications through programming

Through Java™ MBean programming, you can install, update, and delete a Java Platform, Enterprise Edition (Java EE) application on a WebSphere® Application Server deployment target.

Before you begin

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

Before you can install or change an application on a deployment target, you must first create or update your application and assemble it using an assembly tool.
Avoid trouble: During an Enterprise application deployment, it might be necessary to scan the application binary files for annotations that were introduced by Java EE 5 or later. An application might not deploy if it is compiled by using a Java SDK level that is higher than the Java SDK level of a deployment manager. The deployment manager needs to be either at the same Java SDK level or at a higher Java SDK level than the application.

About this task

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

Procedure

  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 enterprise archive (EAR) file is installed.

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

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

    • Edit an application.

      See the example that you can use to edit 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 you 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 you delete a file, the deployed file is uninstalled.

  2. Save your 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 you have further application updates, you can do the updates through programming, the administrative console, or the wsadmin tool.

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