Preparing a module and adding it to an existing application through programming

We can add a module to an existing application through the admin console, wsadmin, or programming. Use this example to add a module through programming.

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.

Before we can add a module to an application on WAS, install the application.

Perform the following tasks to add a module to an application through programming.

 

1. Create an application deployment controller instance to populate the module file with binding information.

2. Save the binding information in the module.

3. Get the installation options.

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 updateApplication MBean API.

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

5. Connect to WAS.

6. Create the application management proxy.

7. Create the notification filter.

8. Add the listener.

9. Add the module to the application.

10. Specify the target for the new module.

11. Wait for some timeout so that the program does not end.

12. Listen to Java Management Extensions (JMX) notifications to understand completion of the operation.

 

Results

After you successfully run the code, the module is added to the application.

 

Example

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

//Inputs:

//moduleName specifies the name of the module that you add to the application.

//moduleURI specifies a URI that gives the target location of the module 

// archive contents on a file system. The URI provides the location of the new 

// module after installation. The URI is relative to the application URL.

//uniquemoduleURI specfies the URI that gives the target location of the 

// deployment descriptor file. The URI is relative to the application URL.

//target specifies the cell, node, and server on which the module is installed.

(Windows)

String moduleName = "C:\apps\foo.jar";

[Linux] [HP-UX] [Solaris]

[AIX]

String moduleName = "/apps/foo.jar";

String moduleURI = "Increment.jar";
 String uniquemoduleURI = "Increment.jar+META-INF/ejb-jar.xml";
 String target = "WebSphere:cell=cellname,node=nodename,server=servername";


//Create an application deployment controller instance, AppDeploymentController, 
//to populate the JAR file with binding information. 

//The binding information is WAS-specific deployment information.
 Hashtable preferences = new Hashtable();
 preferences.put (AppConstants.APPDEPL_LOCALE, Locale.getDefault());
 preferences.put (AppConstants.APPUPDATE_CONTENTTYPE, AppConstants.APPUPDATE_CONTENT_MODULEFILE);
 AppDeploymentController controller = AppManagementFactory.readArchiveForUpdate(
        moduleName, 
        moduleURI, 
        AppConstants.APPUPDATE_ADD,         preferences, 
        null);

If the module that you add to the application lacks any bindings, add the bindings so that the module addition works. Collect and add the bindings by using the public APIs provided with WAS ND. Refer to Java documentation for the com.ibm.websphere.management.application.client.AppDeploymentController instance to learn more about how to collect and populate tasks with WAS-specific binding information. The AppDeploymentController instance contains meta-data defined in XML-based deployment descriptors as well as annotations defined in Java classes within the input module.

//After you collect all the binding information, save it in the module. controller.saveAndClose();


//Get the installation options. Hashtable options = controller. getAppDeploymentSavedResults();


//Connect the admin client, AdminClient, to WAS. AdminClient client = ...;


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


//Update the existing application, MyApp, by adding the module. String appName = "MyApp";
 options.put (AppConstants.APPUPDATE_CONTENTTYPE, 
      AppConstants. APPUPDATE_CONTENT_MODULEFILE);


//Create the notification filter.
  NotificationFilterSupport myFilter = new NotificationFilterSupport();
  myFilter.enableType (NotificationConstants.TYPE_APPMANAGEMENT);
  
//Add the listener.
  NotificationListener listener = new AListener(_soapClient, myFilter, 
"Install: " + appName, AppNotification.UPDATE);




//Specify the target for the new module. Hashtable mod2svr = new Hashtable();
 options.put (AppConstants.APPDEPL_MODULE_TO_SERVER, mod2svr);
 mod2svr.put (uniquemoduleURI, target);
 proxy.updateApplication (  appName, 
        moduleURI, 
        moduleName,         AppConstants.APPUPDATE_ADD,         options,         null);


// 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);
        }
    }
}

 

Next steps

After you add the module successfully, remove the listener and quit.

 

Related tasks

Install an application through programming
Updating enterprise application files
Uninstall an application through programming
Updating an application through programming
Add to, updating, or deleting part of an application through programming
Preparing and updating a module through programming
Delete a module through programming
Add a file through programming
Updating a file through programming
Delete a file through programming