Add an EBA asset to a composition unit using the administrative console
Use the administrative console to add a composition unit that consists of a previously-imported EBA asset plus configuration information. The configuration information can include HTTP session management, context roots, virtual hosts, security roles, run-as roles, JNDI mappings for Session enterprise beans, JNDI mappings for EJB references, and web application or Blueprint resource reference bindings for the OSGi application.
You can add an EBA asset to a business-level application using the administrative console as described in this topic, or using the addCompUnit command as described in Add an EBA asset to a composition unit by using wsadmin commands.
An EBA asset can be added to only one business-level application. A business-level application is scoped to cell scope, therefore only one instance of an OSGi application can be deployed in a cell.
This task makes the following assumptions:
- You have already imported the EBA file as an asset (as described in Deploy an OSGi application as a business-level application), then saved
your changes to the master configuration (which causes any bundle
dependencies to be downloaded from configured bundle repositories).
- You have already defined the target virtual hosts. To check existing virtual hosts using the administrative console, click Environment > Virtual hosts.
- You have already created the JCA authentication alias to associate with each Blueprint resource reference. To check existing JCA authentication aliases using the administrative console, click Security > Global security > [Authentication] Java Authentication and Authorization Service > J2C authentication data.
An OSGi composition unit consists of an EBA asset, (optionally) one or more composite bundle extensions, and some or all of the following configuration information:
- Mappings from the composition unit to a target application server, web server, or cluster.
- Configuration of the session manager, context roots or virtual
hosts of the application.
- Mappings from enterprise beans to JNDI names.
- Bindings to any associated web applications or blueprint resource
references.
- Mappings from security roles to particular users or groups.
Use Set options settings wizard to add a new composition unit to a business-level application. The contents of the asset determine the specific steps in the wizard. This topic describes the main elements configured when adding an EBA asset. For a general description of all the elements that the wizard might prompt you to configure, see Create business-level applications with the console.
In addition to specifying the configuration information for the EBA asset through the following procedure, we can also change it later as described in Modify the configuration of an OSGi composition unit. 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.
- Start the administrative console.
- Add the previously-imported asset (the EBA file) as a deployed asset.
- If we have just created a new business-level application, the general properties for the business-level application are already
displayed, including the option [Deployed
assets] Add > Add Asset.
Otherwise, navigate to Applications > Application Types > Business-level applications > application_name > [Deployed assets] Add > Add Asset. A list of available assets is displayed.
- Select the asset to add, then click Continue. The Set options settings wizard is displayed.
- If we have just created a new business-level application, the general properties for the business-level application are already
displayed, including the option [Deployed
assets] Add > Add Asset.
Otherwise, navigate to Applications > Application Types > Business-level applications > application_name > [Deployed assets] Add > Add Asset. A list of available assets is displayed.
- Wizard step: Set options.
Change the composition unit settings as needed, then click Next. For more information, see Set options settings.
- Wizard step: Map composition unit to a target.
Select the deployment target application server or web server. For more information, see Map target settings.
- Wizard step: Map context root for web modules.
Select a web application bundle (WAB) from the list, then enter the context root for the WAB. For example, /sample. For more information, see Context root for web modules [Settings].
- Wizard step: Map virtual hosts for web modules.
The list of available WABs in this asset is displayed. For each WAB, we can change the associated virtual host by selecting a different one from the list. If we specify an existing virtual host in bm-web-bnd.xml or .xmi file for a WAB, the specified virtual host is set by default. Otherwise, the default virtual host setting is default_host. For more information, see Virtual hosts for web modules [Settings].
- Wizard step: Map security roles to users or groups.
Change the security mapping as needed. For more information, see Security role to user or group mapping [Settings].
- Wizard step: Map RunAs roles to users
You can map a specified user identity and password to a RunAs role. This mapping enables you to specify application-specific privileges for individual users, so that they can run specific tasks using another user identity. For more information, see RunAs roles for users [Collection].
- Wizard step: Bind Blueprint resource references.
The list of available Blueprint resource references in this asset is displayed. For each reference, we can optionally select an authentication alias from the list. Default authentication aliases (from ibm-eba-bnd.xml files) are offered only if they exist on every target server or cluster. For more information, see Blueprint resource references [Settings].
- Wizard step: Map web module resource references to resources.
The list of available web application resource references in this asset is displayed. That is, resources of type resource-ref (resource reference), as defined in the Java specification JSR-250: Common Annotations for the Java Platform. For each reference, specify the JNDI name under which the resource is known in the runtime environment. Optionally, set authentication properties and extended data source custom properties, which affect how the resource is accessed at run time. To specify the JNDI name mapping, either type the JNDI name into the box, or click Browse... then select the resource reference from the list of available resources. To modify the authentication method, or to set extended data source custom properties that apply to the database connection, select a single reference then click Modify Resource Authentication Method... or Extended Properties.... For more information, see Web module resource references [Settings].
- Wizard step: Bind web module message destination references to administered objects.
The list of available web application message destination and resource environment references in this asset is displayed. That is, resources of type message-destination-ref (message destination reference) or resource-env-ref (resource environment reference), as defined in the Java specification JSR-250: Common Annotations for the Java Platform. For each reference, specify the JNDI name under which the resource is known in the runtime environment. For more information, see Web module message destination references [Settings].
- Wizard step: Provide EJB JNDI names
For each Session enterprise bean in the composition unit, we can specify the JNDI name by which the enterprise bean is known in the runtime environment. For more information, see EJB JNDI names [Settings].
- Wizard step: Map EJB References
For each EJB reference defined in either an ejb-jar.xml file, a web.xml file, or an @EJB annotation in the composition unit, we can specify the JNDI name by which the EJB reference is known in the runtime environment. For more information, see EJB references [Settings].
- Wizard step: Map EJB resource references to resources
The list of available EJB resource references in this asset is displayed. That is, resources of type resource-ref (resource reference), as defined in the Java specification JSR-250: Common Annotations for the Java Platform. For each reference, specify the JNDI name under which the resource is known in the runtime environment. For more information, see EJB resource references [Settings].
- Wizard step: Bind EJB message destination references to administered objects
The list of available EJB message destination and resource environment references in this asset is displayed. That is, resources of type message-destination-ref (message destination reference) or resource-env-ref (resource environment reference), as defined in the Java specification JSR-250: Common Annotations for the Java Platform. For each reference, specify the JNDI name under which the resource is known in the runtime environment. For more information, see EJB message destination references [Settings].
-
Wizard step: Map EJB environment entries
For each simple environment entry defined in either an env-entry element in an ejb-jar.xml file or in an @Resource annotation in the composition unit, we can specify the value of the environment entry. For more information, see EJB environment entries [Settings].
- Wizard step: Bind listeners for message-driven beans
For each message-driven bean (MDB) defined in either an ejb-jar.xml file or in an @MessageDriven annotation in the composition unit, we can specify the settings necessary to bind an MDB listener to the MDB. By binding a listener to an MDB, you configure the association of the MDB with the JMS destination from which the MDB receives messages. For more information, see Listeners for message-driven beans [Settings].
- Wizard step: Summary
A summary of the selections is displayed. To complete the creation of the composition unit, click Finish. If there are settings to change, click Previous to review the settings.
- Save the changes to the master configuration.
Results
The product creates composition units for the application, module, or shared library relationships. The unit names are shown in lists of deployed assets on the settings page of the business-level application. To view the settings page, click Applications > Application Types > Business-level applications > application_name.What to do next
After you import the enterprise bundle archive (EBA) file for the OSGi application as an asset, we can update versions of existing bundles but we cannot add extra bundles to the asset. However, after we have added the asset as a composition unit to a business-level application, we can extend the business-level application by adding one or more composite bundles to the composition unit. See Add or removing extensions for an OSGi composition unit.
We are now ready to start the business-level application.
Parent topic: Deploy an OSGi application as a business-level application
Related concepts
Related tasks
Related information: