org.jahia.osgi

Class FrameworkService

java.lang.Object

org.jahia.osgi.FrameworkService

All Implemented Interfaces:

EventListener, org.osgi.framework.FrameworkListener

public class FrameworkService
extends Object
implements org.osgi.framework.FrameworkListener

OSGi framework service. This class is responsible for setting up and starting the embedded Karaf OSGi runtime.

Author:

Serge Huber

Field Summary

Fields

Modifier and Type	Field and Description
static String	EVENT_TOPIC_LIFECYCLE
static String	EVENT_TYPE_CLUSTERING_FEATURE_INSTALLED
static String	EVENT_TYPE_OSGI_STARTED

Method Summary

Modifier and Type	Method and Description
protected void	destroyTimer()
void	frameworkEvent(org.osgi.framework.FrameworkEvent event)
static org.osgi.framework.BundleContext	getBundleContext() Returns bundle context.
static FrameworkService	getInstance() Returns a singleton instance of this class.
boolean	isFirstStartup() Returns true if this is the first startup of the OSGi container
boolean	isStarted() Returns true if the OSGi container is completely started.
static void	notifyFileInstallStarted(List<Long> createdOnStartup) Notifies the service that the FileInstall watcher has been started and processed the found modules.
static void	sendEvent(String topic, Map<String,?> properties, boolean asynchronous) Initiate synchronous or asynchronous delivery of an OSGi event using EventAdmin service.
void	start()
void	stop() Shuts the OSGi container down.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

EVENT_TOPIC_LIFECYCLE

public static final String EVENT_TOPIC_LIFECYCLE

See Also:

Constant Field Values

EVENT_TYPE_CLUSTERING_FEATURE_INSTALLED

public static final String EVENT_TYPE_CLUSTERING_FEATURE_INSTALLED

See Also:

Constant Field Values

EVENT_TYPE_OSGI_STARTED

public static final String EVENT_TYPE_OSGI_STARTED

See Also:

Constant Field Values

Method Detail

getBundleContext

public static org.osgi.framework.BundleContext getBundleContext()

Returns bundle context.

Returns:

bundle context or null in case the OSGi container has not been started yet

getInstance

public static FrameworkService getInstance()

Returns a singleton instance of this class.

Returns:

a singleton instance of this class

notifyFileInstallStarted

public static void notifyFileInstallStarted(List<Long> createdOnStartup)

Notifies the service that the FileInstall watcher has been started and processed the found modules.

sendEvent

public static void sendEvent(String topic,
                             Map<String,?> properties,
                             boolean asynchronous)

Initiate synchronous or asynchronous delivery of an OSGi event using EventAdmin service. If synchronous delivery is requested, this method does not return to the caller until delivery of the event is completed.

Parameters:

topic - the topic of the event

properties - the event's properties (may be null). A property whose key is not of type String will be ignored.

asynchronous - if true an event is delivered asynchronously; in case of false this method does not return to the caller until delivery of the event is completed

frameworkEvent

public void frameworkEvent(org.osgi.framework.FrameworkEvent event)

Specified by:

frameworkEvent in interface org.osgi.framework.FrameworkListener

isStarted

public boolean isStarted()

Returns true if the OSGi container is completely started.

Returns:

true if the OSGi container is completely started; false otherwise

isFirstStartup

public boolean isFirstStartup()

Returns true if this is the first startup of the OSGi container

Returns:

true if this is the first startup of the OSGi container

start

public void start()

stop

public void stop()
          throws org.osgi.framework.BundleException

Shuts the OSGi container down.

Throws:

org.osgi.framework.BundleException - in case of an error

destroyTimer

protected void destroyTimer()