Bundle: httpconsole
Version 4.0.1

Http Console

The Knopflerfish HTTP/HTML OSGi console is a small servlet that can be run on any OSGi platform with an installed HTTP server. It has been designed for use on devices with a small screen like mobile phones and pocket PC devices.

Description

HTTP console on pocketPC 2003
Image 1: HTTP console on pocketPC 2003

The Knopflerfish HTTP/HTML OSGi console is a small servlet that can be run on any OSGi platform with an installed HTTP server.

When started, the servlet registers at /servlet/console and allows access to the standard framework functions as bundle installation (both from URLs and using browser file upload), start, stop, update and uninstall. Additionally, detail info on a bundle such as state, manifest and services can be displayed.

Optionally, the HTTP console can request a login/pwd before enabling access. See configuration for details.

The HTTP console has been tested on Knopflerfish, Eclipse 3.0 and Oscar. It also runs well on Pocket PC (tested using KF on the IBM J9 VM).

The main screen lists all installed bundles. One or more bundles can be selected by marking the check box on the left. After selecting bundles, the operations available as toolbar icons can be performed.

Source is available via KF subversion


Usage

Toolbar

Open a local file
Image 2: Result after starting a bundle

Image 3: Open a local file

The toolbar display a set of command icons. When an icon is selected, the command will be performed. Any command result or errors will be displayed to the right of the bundle list.

Reload view Reload page
Install bundle from file Ask for a local bundle file, upload the file and install the bundle
Install bundle from URL Ask for a bundle URL and install this bundle
Start selected bundles Start selected bundles
Stop selected bundles Stop selected bundles
Update selected bundles Update selected bundles
Uninstall selected bundles Uninstall selected bundles
Show info for selected bundles Info about selected bundles. If no bundle is selected, show framework info
Show help Show help page


Bundle icons

Login screen
Image 4: Login screen

Each bundle is displayed using an icon, the bundle's name and the bundle description. If a bundle's icon is clicked, the bundle is selected, and the bundle info page is displayed.

Bundle with activator
Started bundle with activator
Bundle without activator
Started bundle without activator

Configuration using Framework Properties

The HTTP console can be configured using system properties:

Name Description Value type Default value
org.knopflerfish.httpconsole.alias Alias for servlet registration. If set to '/', the http root will used for the console. String /servlet/console
org.knopflerfish.httpconsole.filter Filter string for matching HttpServices. This can be used to only show the console in some registered HttpServices. String (objectclass=org.osgi.service.http.HttpService)
org.knopflerfish.httpconsole.requirelogin If true, require login, using name and password. boolean false
org.knopflerfish.httpconsole.user User name required for login. String admin
org.knopflerfish.httpconsole.pwd User password required for login. String admin
org.knopflerfish.httpconsole.expirationtime Expiration time for login sessions, in seconds. After this time, the user will be logged out. int (seconds) 600

Bundle Jar docs

httpconsole_all-4.0.1

Exported Packages

No exported packages.