+

Search Tips   |   Advanced Search

Install an application through programming

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

The AppDeploymentController instance contains meta-data defined in XMLl-based deployment descriptors as well as annotations defined in Java classes within the input enterprise archive (EAR) file.

Perform the following tasks to install an application through programming.


Tasks

  1. Populate the EAR file with WAS-specific binding information.

    1. Create the controller and populate the EAR file with appropriate options.

    2. Optionally run the default binding generator.

    3. Save and close the EAR file.

    4. Retrieve the saved options table that will be passed to the installApplication MBean API.

  2. Connect to WAS.

  3. Create the application management proxy.

  4. If the preparation phase (population of the EAR file) is not performed, the do the following actions:

    1. Create an options table to be passed to the installApplication Bean API.

    2. Create a table for module to server relations and add the table to the options table.

      Refer to the com.ibm.websphere.management.application.AppManagement class in the application programming interfaces documentation to understand various options that can be passed to the installApplication MBean API.

  5. Create the notification filter for listening to installation events.

  6. Add the listener.

  7. Install the application.
  8. Wait for some timeout so that the program does not end.
  9. Listen to Java Management Extensions (JMX) notifications to understand completion of the operation.

  10. When the installation is done, remove the listener and quit.

After you successfully run the code, the application is installed.


Example

The following example shows how to install an application based on the previous steps. Some statements are split on multiple lines for printing purposes.

import java.lang.*;
import java.io.*;
import java.util.*;
import java.lang.reflect.*;
import com.ibm.websphere.management.application.*;
import com.ibm.websphere.management.application.client.*;
import com.ibm.websphere.management.*;

import javax.management.*;

public class Install {

    public static void main (String [] args) {

        try {
  String earFile = "C:/test/test.ear";
  String appName = "MyApp";
             
// Preparation phase: Begin
// Through the preparation phase you populate the EAR file with 
// product-specific binding information. For example, we can specify Java Naming
// and Directory Interface (JNDI) names for enterprise beans, or virtual hosts for
// web modules, and so on.

// First, create the controller and populate the EAR file with the appropriate options.
  Hashtable prefs = new Hashtable();
  prefs.put(AppConstants.APPDEPL_LOCALE, Locale.getDefault());

// We can optionally run the default binding generator using the following options.
// Refer to Java documentation for the AppDeploymentController class to see all the 
// options that we can set.
  Properties defaultBnd = new Properties();
  prefs.put (AppConstants.APPDEPL_DFLTBNDG, defaultBnd);
  defaultBnd.put (AppConstants.APPDEPL_DFLTBNDG_VHOST, "default_host");
  
// Create the controller.
  AppDeploymentController controller = AppDeploymentController
    .readArchive(earFile, prefs);
  AppDeploymentTask task = controller.getFirstTask();
  while (task != null)
  {
// Populate the task data.
   String[][] data = task.getTaskData();
// Manipulate task data which is a table of stringtask.
   task.setTaskData(data);
   task = controller.getNextTask();
  }
  controller.saveAndClose();
  
  Hashtable options = controller.getAppDeploymentSavedResults();
// The previous options table contains the module-to-server relationship if it was set by
// using tasks.
//Preparation phase: End

// Get a connection to the product.
  String host = "localhost";
  String port = "8880";
  String target = "WebSphere:cell=cellName,node=nodeName,server=server1";

  Properties config = new Properties();
  config.put (AdminClient.CONNECTOR_HOST,  host);
  config.put (AdminClient.CONNECTOR_PORT,  port);
  config.put (AdminClient.CONNECTOR_TYPE, AdminClient.CONNECTOR_TYPE_SOAP);
  System.out.println ("Config: " + config);
     AdminClient _soapClient = AdminClientFactory.createAdminClient(config);

// Create the application management proxy, AppManagement.
  AppManagement proxy = AppManagementProxy. getJMXProxyForClient (_soapClient);

// If code for the preparation phase has been run, then we already have the options table.
// If not, create a new table and add the module-to-server relationship to it by uncommenting
// the next statement.
//Hashtable options = new Hashtable();
  options.put (AppConstants.APPDEPL_LOCALE, Locale.getDefault());

// Uncomment the following statements to add the module to the server relationship table if 
//  the preparation phase does not collect it.
//Hashtable module2server = new Hashtable();
//module2server.put ("*", target);
//options.put (AppConstants.APPDEPL_MODULE_TO_SERVER, module2server);

//Create the notification filter for listening to installation events.
  NotificationFilterSupport myFilter = new NotificationFilterSupport();
  myFilter.enableType (AppConstants.NotificationType);


//Add the listener.
  NotificationListener listener = new AListener(_soapClient, 
myFilter, "Install: " + appName, AppNotification.INSTALL);

// Install the application.
  proxy.installApplication (earFile, appName, options, null);
  System.out.println ("After install App is called..");

// Wait for some timeout. The installation API is 
//  asynchronous and so returns immediately.
// If the program does not wait here, the program ends.
  Thread.sleep(300000); // Wait so that the program does not end.

        }
        catch (Exception e) {
            e.printStackTrace();
        }
    }
}

// Specify the Java Management Extensions (JMX) notification listener for JMX events.
class AListener implements NotificationListener
{
    AdminClient _soapClient;
    NotificationFilterSupport  myFilter;
    Object handback;
    ObjectName on;
    String eventTypeToCheck;

    public AListener(AdminClient cl, NotificationFilterSupport fl, 
Object h, String eType) throws Exception
    {
        _soapClient = cl;
        myFilter = fl;
        handback = h;
        eventTypeToCheck = eType;

        Iterator iter = _soapClient.queryNames (new ObjectName(
"WebSphere:type=AppManagement,*"), null).iterator();
        on = (ObjectName)iter.next();
        System.out.println ("ObjectName: " + on);
        _soapClient.addNotificationListener (on, this, myFilter, handback);
    }

    public void handleNotification (Notification notf, Object handback)
    {
            AppNotification ev = (AppNotification) notf.getUserData();
            System.out.println ("!! JMX event Recd: (handback obj= " + handback+ "): " + ev);


            //When the installation is done, remove the listener and quit.

            if (ev.taskName.equals (eventTypeToCheck) &&
                (ev.taskStatus.equals (AppNotification.STATUS_COMPLETED) ||
                 ev.taskStatus.equals (AppNotification.STATUS_FAILED)))
            {
                    try
                    {
                            _soapClient.removeNotificationListener (on, this);
                    }
            catch (Throwable th)
                    {
                        System.out.println ("Error removing listener: " + th);
                    }
                    System.exit (0);
        }
    }
}


What to do next

Once we install the application, you must explicitly start the application or we must stop and restart the server.


Related:

  • Additional Application Programming Interfaces (APIs)
  • Stopping an application server
  • Starting an application server
  • Manage application servers
  • Uninstall an application through programming
  • Update an application through programming
  • Add to, update, or delete part of an application through programming
  • Prepare a module and adding it to an existing application through programming
  • Prepare and updating a module through programming
  • Deleting a module through programming
  • Add a file through programming
  • Update a file through programming
  • Deleting a file through programming