OSGi blabber sample application

The blabber sample application is a microblogging application, used to enable many different people to share brief comments. This sample application shows how to write and package bundles into an enterprise bundle archive (EBA) file. The sample includes example code for Blueprint management, bean injection, using and publishing services from and to the OSGi service registry, and the use of Java persistence.

Before you begin

The sample application requires that the supplied com.ibm.samples.websphere.osgi.logging.api.jar and com.ibm.samples.websphere.osgi.logging.impl.jar bundles are installed into the internal bundle repository. The following procedure describes how to do this. These two JAR files, and the blabber sample EBA file, are provided in the installableApps directory of the OSGi_blabberSample.zip compressed archive file.

About this task

The blabber sample application consists of two bundles, divided into the following functional areas:
  • com.ibm.samples.websphere.osgi.blabber.persistence, which contains code relating to the Java Persistence API (JPA) layer, and also contains the interface that is used by the main application code.
  • com.ibm.samples.websphere.osgi.blabber, which contains the main application logic code, and interacts between the web front end and the back end persistence code layer.

You can use scripts to completely install the sample application, or you can use scripts to complete the initial configuration of the application then use the administrative console to install the application into the application server. You can also use, modify and remove the sample.

Procedure

Configure and install the blabber sample.

You can either configure and install the sample using scripts (the first optional step below), or you can configure the sample using scripts then install the sample using the administrative console (the second optional step below).

The scripts that you use to do this are provided in the scripts directory of the OSGi_blabberSample.zip compressed archive file. The createblabberDb.sql script contains the necessary configuration commands to create the required Derby database and associated tables. The blabberSampleInstall.py script contains the required jython to create data sources, and to install the blabber sample with default configuration. You should fully qualify the path to the script if you do not run it from the directory that contains the script.

Note: If you have data sources already defined in your environment, and these data sources have the same name as the data sources that are specified in the blabberSampleInstall.py script, then the sample might not install and run successfully.

In the following steps you must substitute your own values for the variables app_server_root, profileName, serverName, nodeName, blabberSample.eba_Location, com.ibm.samples.websphere.osgi.logging.api.jar_Location, com.ibm.samples.websphere.osgi.logging.impl.jar_Location, uncompressed_sample_directory, and path_to_ant.

Use the blabber sample.

Modify the blabber sample.

All the source code for this application is provided in sub-directories below the uncompressed_sample_dir directory. Each part of the project has its own ant build.xml script. To build the whole application into a newly-available EBA file, you use the ant build.xml file located in the uncompressed_sample_dir directory. WebSphere® Application Server ships a version of ant in its bin directory called ws_ant. To build the sample, you also need several JAR files on the ant classpath. To simplify matters, you can edit the was.root property in the supplied build.properties file to point to these JAR files.

Remove the blabber sample.

To remove the blabber sample, you complete the following 3 steps:
  1. Remove the application configuration and the data sources, either by using a script (the first optional step below), or by using the administrative console (the second optional step below).
  2. Remove the shared logging bundles from the internal bundle repository.
  3. Remove the database.
Note: Only remove the bundles if you have no other applications installed that use them. Both the blabber and blog sample applications use the shared logging bundles, so if both applications are installed these bundles should not be removed.

The uninstall script is provided in the scripts directory of the OSGi_blabberSample.zip compressed archive file. The blabberSampleUninstall.py script contains the required jython to remove data sources and to remove the installation of the blabber sample with default configuration. You should fully qualify the path to the script if you do not run it from the directory that contains the script.

In the following steps you must substitute your own values for the variables app_server_root, and profileName.

Results

The following illustration shows the correctly running sample:

A screen capture of the blabber application Home page. The page title is "Generic Status Update Application", below which are two vertical panes: One pane provides the option to register a new user by pressing a button labeled "Click here to sign up!", and the other pane enables existing users to sign in by entering a user name and password, then clicking a button labeled "Sign in!".


Task topic

Terms of use | Feedback


Timestamp icon Last updated: Tuesday, 20 September 2011
http://www14.software.ibm.com/webapp/wsbroker/redirect?version=matt&product=was-base-iseries&topic=sample_osgi_blabber_readme

Copyright IBM Corporation 2009, 2011. All Rights Reserved.
This information center is powered by Eclipse technology. (http://www.eclipse.org)