Network Deployment (Distributed operating systems), v8.0 > Administer applications and their environment > Administer OSGi applications > Maintain an OSGi composition unit > Update an OSGi composition unit


Update an OSGi composition unit using the editCompUnit command

Use the editCompUnit command to select a composition unit that contains an enterprise OSGi application, and update the composition unit so that the business-level application uses the newer configuration. If any of the updates contain configuration options, run the editCompUnit command a second time to update the configuration information. We can also take the opportunity to make additional, non-essential configuration changes.


Before you begin

This topic assumes that we have either updated the asset that the composition unit contains, or added a composite bundle as an extension to the composition unit. You do not have to update the composition unit every time you update the asset or add a composite bundle extension. We cannot update the composition unit until all bundle downloads are complete.

We can update an OSGi composition unit by using the editCompUnit command as described in this topic, or by using the administrative console as described in Update an OSGi composition unit.


About this task

An OSGi composition unit consists of an EBA asset, (optionally) one or more composite bundle extensions, and configuration information for running the asset and composite bundle extensions in a business-level application. The configuration information can include HTTP session management, context roots, virtual hosts, security roles, run-as roles, and web application or Blueprint resource reference bindings for your OSGi application.

When all bundle downloads are complete, you can update the OSGi composition unit so that the business-level application uses the newer configuration. If any of the updates contain configuration options, run the editCompUnit command a second time to update the configuration information. We can also take the opportunity to make additional, non-essential configuration changes.

For transitioning users: In the WAS v7 Feature Pack for OSGi Applications and Java Persistence API 2.0, bundle changes to the asset are applied by restarting the business-level application, rather than by updating the composition unit. The current approach means that many bundle changes can be applied in place, without restarting the running business-level application. See the following troubleshooting tip: The behavior has changed for using wsadmin to update bundle versions.


Procedure

  1. Check the update status of the composition unit.

    There are four distinct deployment statuses for an OSGi composition unit:

  2. Update the composition unit to use the latest version of the EBA asset or composite bundle extension.

    If the status is "New OSGi application deployment available", open a wsadmin command prompt then run the following jython command: 

    AdminTask.editCompUnit('[
  -blaID WebSphere:blaname=bla_name
  -cuID WebSphere:cuname=cu_name
  -CompUnitStatusStep [[asset_name.eba true]]
]')
    For example: 
    AdminTask.editCompUnit('[
  -blaId WebSphere:blaname=test.app
  -cuId WebSphere:cuname=com.ibm.ws.eba.extension.componenttest_0001.eba
  -CompUnitStatusStep [[com.ibm.ws.eba.extension.componenttest.eba true]]
]')

  3. If you make bundle changes that require configuration changes to the composition unit, you must update the configuration information for running the asset in the business-level application.

    For example, if you update a bundle in an EBA asset, or replace a composite bundle extension, you might introduce a resource that requires additional configuration, such as a new or changed Blueprint resource reference, or security role mapping.

    If any of the updates contain configuration options, run the editCompUnit command a second time to update the configuration information. We can also take the opportunity to make additional, non-essential configuration changes. See Modify the configuration of an OSGi composition unit using wsadmin.

    CAUTION:

    If you omit this step, then when you save your changes, the application will fail to restart.

  4. Save your changes to the master configuration.

    To save the configuration changes, use the following command:

    AdminConfig.save()


Results

When you save the changes to the composition unit, the associated business-level application is updated to use the new configuration. If the business-level application is running, the bundle and configuration updates are applied immediately. If possible (that is, depending on the nature of the updates) the system applies the updates without restarting the application. If you update a bundle that provides only OSGi services to the rest of the application, then only that bundle is restarted. If you update a bundle that provides one or more packages to other bundles, then those bundles and any bundles to which they provide packages are restarted. If, however, a new package or service dependency is added, or an existing package or service dependency is removed, then the application is restarted; a newly added package and service can come from a newly-provisioned bundle, or from a bundle that has already been provisioned. Messages relating to any restart operations are written to the WAS SystemOut.log file.

Parent topic: Update an OSGi composition unit

Related concepts:

About OSGi Applications

Related tasks:

Secure OSGi Applications

Related reference:

OSGi Applications: Troubleshooting tips

Related information:

Preview composition unit upgrade [Settings]
Task topic Feedback
Copyright IBM Corporation 2009, 2011. All Rights Reserved.
This information center is powered by Eclipse technology.

+

Search Tips   |   Advanced Search