fr.liglab.adele.icasa.application

Interface Application

All Superinterfaces:

Attributable, Identifiable

public interface Application
extends Attributable, Identifiable

Represents an installed application.

Author:

Thomas Leveque

Field Summary

Fields

Modifier and Type	Field and Description
static String	APP_ID_BUNDLE_HEADER
static String	APP_NAME_BUNDLE_HEADER This header is optional.
static String	APP_VERSION_BUNDLE_HEADER

Method Summary

Methods

Modifier and Type	Method and Description
Set<org.osgi.framework.Bundle>	getBundles() Returns all started bundles which are part of this application implementation.
ApplicationCategory	getCategory() Returns the category of this application.
String	getName() Returns the human readable application name.
ApplicationState	getState() Returns application activation state.
String	getVendor() Returns the vendor of this application.
String	getVersion() Returns installed version of this application.
void	pause(ProgressMonitor monitor) Stop application computation temporary.
void	resume(ProgressMonitor monitor) Resume this application if it has been paused.
void	start(ProgressMonitor monitor) Starts this application.
void	stop(ProgressMonitor monitor) Stops this application.

Methods inherited from interface fr.liglab.adele.icasa.common.Attributable

addVariableExtender, addVariableListener, getStateVariable, getStateVariables, getVariableExtenders, getVariableNames, getVariableValue, hasStateVariable, removeVariableExtender, removeVariableListener, setVariableValue

Methods inherited from interface fr.liglab.adele.icasa.common.Identifiable

getId

Field Detail

APP_ID_BUNDLE_HEADER

static final String APP_ID_BUNDLE_HEADER

See Also:

Constant Field Values

APP_NAME_BUNDLE_HEADER

static final String APP_NAME_BUNDLE_HEADER

This header is optional.

See Also:

Constant Field Values

APP_VERSION_BUNDLE_HEADER

static final String APP_VERSION_BUNDLE_HEADER

See Also:

Constant Field Values

Method Detail

getName

String getName()

Returns the human readable application name. This name should not be more than 80 characters. This value must be set as an attribute value.

Returns:

the human readable application name.

getVendor

String getVendor()

Returns the vendor of this application. This value must be set as an attribute value.

Returns:

the vendor of this application.

getVersion

String getVersion()

Returns installed version of this application. This value must be set as an attribute value.

Returns:

installed version of this application.

getCategory

ApplicationCategory getCategory()

Returns the category of this application. It defines which kind of application is provided and will result on a computed criticity value. This value must be set as an attribute value.

Returns:

the category of this application.

start

void start(ProgressMonitor monitor)

Starts this application. Resources for this application must not be allocated before it has started.

Parameters:

monitor - a operation progress monitor (may be null)

stop

void stop(ProgressMonitor monitor)

Stops this application. Allocated resources must be clean up before returning.

Parameters:

monitor - a operation progress monitor (may be null)

resume

void resume(ProgressMonitor monitor)

Resume this application if it has been paused.

Parameters:

monitor - a operation progress monitor (may be null)

pause

void pause(ProgressMonitor monitor)

Stop application computation temporary. All computation must be stopped or paused. In particular, there should not be any messages sent from this digital application. However, incoming messages may still arrive. Allocated resource could remain in memory.

Parameters:

monitor - a operation progress monitor (may be null)

getBundles

Set<org.osgi.framework.Bundle> getBundles()

Returns all started bundles which are part of this application implementation. The application bundles may be installed but not started, in this case, returns an empty set.

Returns:

all bundles which are part of this application implementation.

getState

ApplicationState getState()

Returns application activation state.

Returns:

application activation state.