Description

The Platform Status service is a service that allows components to obtain the status and states of applications that are deployed onto the system.

Configuration

None.

Installation and Uninstallation

The Platform App installs this service by default. It is recommended to not uninstall the platform status service unless absolutely necessary.

Interface Details

The Platform status services comes with a few interfaces that are used.

ApplicationService

The ApplicationService interface is the main class for interaction that will be used for components wanting to query for statuses. It provides three main methods for determining the status of an application:

getApplications

This method returns a set of all applications that are installed on the system. Callers can then use the Application handle to get the name and any underlying features and bundles that this application contains.

isApplicationStarted

This method takes in an application and returns a boolean value that says if the application is started or not. This method is generally called after retrieving a list of applications in the first method.

getApplicationStatus

This method, unlike isApplicationStarted, returns a full status of an application. This status contains detailed information about the health of the application and is described in the ApplicationStatus interface section.

Application

getName

Name of the application. Should be unique among applications.

getFeatures

Retrieves all of the features that this application contains regardless if they are required.

getBundles

Retrieves all of the bundles that are defined by the features and included in this application.

ApplicationStatus

getApplication

Sends back the application that is associated with this status.

getState

Returns the application's state as defined by ApplicationState.

getErrorFeatures

Returns a set of Features that were required for this application but did not start correctly.

getErrorBundles

Returns a set of Bundles that were required for this application but did not start correctly.

Implementation Details

A client of this service is provided as an extension to the administrative console. Information about how to use it is available on the Application Commands page.

Imported Services

Registered Interface	Availability	Multiple	Notes
`org.apache.karaf.features.FeaturesService`	required	false	Provided by Karaf Framework
`org.apache.karaf.bundle.core.BundleStateService`	required	true	Installed as part of Platform Status feature.

Exported Services

Registered Interface	Implementation Class	Notes
`org.codice.ddf.platform.status.ApplicationService`	`org.codice.ddf.platform.status.impl.ApplicationServiceImpl`

Browser not supported